Skip to content

Commit 4f0533c

Browse files
author
autobot
committed
Generated PR for Release: 20.0.0.20220512
1 parent db578f5 commit 4f0533c

File tree

439 files changed

+5420
-4537
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

439 files changed

+5420
-4537
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve Square SDKs
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Expected behavior**
14+
A clear and concise description of what you expected to happen.
15+
16+
**To Reproduce**
17+
Steps to reproduce the bug:
18+
1. (step 1)
19+
2. (step 2)
20+
3. (step 3)
21+
4. ...
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain the bug.
25+
26+
**Square SDK version**
27+
For example: 17.2.x
28+
29+
**Additional context**
30+
Add any other context about the problem here.

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to Square SDKs
2+
3+
Thank you for your willingness to help improve the Square SDKs. Your feedback and expertise ultimately benefits everyone who builds with Square.
4+
5+
If you encounter a bug while using Square SDKs, please [let us know](#bug-reporting). We'll investigate the issue and fix it as soon as possible.
6+
7+
We also accept feedback in the form of a pull request (PR), and will follow up with you if we need more information. However, any code changes required will be perfomed by Square engineering, and we'll close the PR.
8+
9+
## Bug report
10+
11+
To report a bug:
12+
* Go to the **[Issues](../../issues)** page.
13+
* Click **New issue**.
14+
* Click **Get started**.
15+
16+
## Other support
17+
18+
For all other support, including new feature requests, see:
19+
20+
* Square developer forums: [https://developer.squareup.com/forums](https://developer.squareup.com/forums)
21+
* Square support center: [https://squareup.com/help/us/en](https://squareup.com/help/us/en)

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Use this library to integrate Square payments into your app and grow your busine
1212

1313
Use of the Square Ruby SDK requires:
1414

15-
* Ruby 2.7 through 3.1
15+
* Ruby 2.6 through 3.1
1616

1717
## Installation
1818

@@ -82,6 +82,7 @@ rake
8282

8383
### Customers
8484
* [Customers]
85+
* [Customer Custom Attributes]
8586
* [Customer Groups]
8687
* [Customer Segments]
8788

@@ -100,6 +101,7 @@ rake
100101
* [Locations]
101102
* [Devices]
102103
* [Cash Drawers]
104+
* [Vendors]
103105

104106
### Team
105107
* [Team]
@@ -135,13 +137,15 @@ rake
135137
[Terminal]: doc/api/terminal.md
136138
[Team]: doc/api/team.md
137139
[Cash Drawers]: doc/api/cash-drawers.md
140+
[Vendors]: doc/api/vendors.md
138141
[Customer Groups]: doc/api/customer-groups.md
139142
[Customer Segments]: doc/api/customer-segments.md
140143
[Bank Accounts]: doc/api/bank-accounts.md
141144
[Payments]: doc/api/payments.md
142145
[Checkout]: doc/api/checkout.md
143146
[Catalog]: doc/api/catalog.md
144147
[Customers]: doc/api/customers.md
148+
[Customer Custom Attributes]: doc/api/customer-custom-attributes.md
145149
[Employees]: doc/api/employees.md
146150
[Inventory]: doc/api/inventory.md
147151
[Labor]: doc/api/labor.md

doc/api/bank-accounts.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,7 @@ def list_bank_accounts(cursor: nil,
4040
## Example Usage
4141

4242
```ruby
43-
cursor = 'cursor6'
44-
limit = 172
45-
location_id = 'location_id4'
46-
47-
result = bank_accounts_api.list_bank_accounts(cursor: cursor, limit: limit, location_id: location_id)
43+
result = bank_accounts_api.list_bank_accounts()
4844

4945
if result.success?
5046
puts result.data

doc/api/bookings.md

+11-47
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,7 @@ def list_bookings(limit: nil,
5555
## Example Usage
5656

5757
```ruby
58-
limit = 172
59-
cursor = 'cursor6'
60-
team_member_id = 'team_member_id0'
61-
location_id = 'location_id4'
62-
start_at_min = 'start_at_min8'
63-
start_at_max = 'start_at_max8'
64-
65-
result = bookings_api.list_bookings(limit: limit, cursor: cursor, team_member_id: team_member_id, location_id: location_id, start_at_min: start_at_min, start_at_max: start_at_max)
58+
result = bookings_api.list_bookings()
6659

6760
if result.success?
6861
puts result.data
@@ -79,6 +72,9 @@ Creates a booking.
7972
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
8073
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
8174

75+
For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
76+
or *Appointments Premium*.
77+
8278
```ruby
8379
def create_booking(body:)
8480
```
@@ -97,13 +93,7 @@ def create_booking(body:)
9793

9894
```ruby
9995
body = {}
100-
body[:idempotency_key] = 'idempotency_key2'
10196
body[:booking] = {}
102-
body[:booking][:id] = 'id8'
103-
body[:booking][:version] = 148
104-
body[:booking][:status] = 'ACCEPTED'
105-
body[:booking][:created_at] = 'created_at6'
106-
body[:booking][:updated_at] = 'updated_at4'
10797

10898
result = bookings_api.create_booking(body: body)
10999

@@ -143,27 +133,6 @@ body = {}
143133
body[:query] = {}
144134
body[:query][:filter] = {}
145135
body[:query][:filter][:start_at_range] = {}
146-
body[:query][:filter][:start_at_range][:start_at] = 'start_at8'
147-
body[:query][:filter][:start_at_range][:end_at] = 'end_at4'
148-
body[:query][:filter][:location_id] = 'location_id6'
149-
body[:query][:filter][:segment_filters] = []
150-
151-
152-
body[:query][:filter][:segment_filters][0] = {}
153-
body[:query][:filter][:segment_filters][0][:service_variation_id] = 'service_variation_id8'
154-
body[:query][:filter][:segment_filters][0][:team_member_id_filter] = {}
155-
body[:query][:filter][:segment_filters][0][:team_member_id_filter][:all] = ['all7']
156-
body[:query][:filter][:segment_filters][0][:team_member_id_filter][:any] = ['any0', 'any1']
157-
body[:query][:filter][:segment_filters][0][:team_member_id_filter][:none] = ['none5']
158-
159-
body[:query][:filter][:segment_filters][1] = {}
160-
body[:query][:filter][:segment_filters][1][:service_variation_id] = 'service_variation_id7'
161-
body[:query][:filter][:segment_filters][1][:team_member_id_filter] = {}
162-
body[:query][:filter][:segment_filters][1][:team_member_id_filter][:all] = ['all6', 'all7', 'all8']
163-
body[:query][:filter][:segment_filters][1][:team_member_id_filter][:any] = ['any1', 'any2', 'any3']
164-
body[:query][:filter][:segment_filters][1][:team_member_id_filter][:none] = ['none6', 'none7']
165-
166-
body[:query][:filter][:booking_id] = 'booking_id6'
167136

168137
result = bookings_api.search_availability(body: body)
169138

@@ -228,11 +197,8 @@ def list_team_member_booking_profiles(bookable_only: false,
228197

229198
```ruby
230199
bookable_only = false
231-
limit = 172
232-
cursor = 'cursor6'
233-
location_id = 'location_id4'
234200

235-
result = bookings_api.list_team_member_booking_profiles(bookable_only: bookable_only, limit: limit, cursor: cursor, location_id: location_id)
201+
result = bookings_api.list_team_member_booking_profiles(bookable_only: bookable_only, )
236202

237203
if result.success?
238204
puts result.data
@@ -318,6 +284,9 @@ Updates a booking.
318284
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
319285
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
320286

287+
For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
288+
or *Appointments Premium*.
289+
321290
```ruby
322291
def update_booking(booking_id:,
323292
body:)
@@ -339,13 +308,7 @@ def update_booking(booking_id:,
339308
```ruby
340309
booking_id = 'booking_id4'
341310
body = {}
342-
body[:idempotency_key] = 'idempotency_key2'
343311
body[:booking] = {}
344-
body[:booking][:id] = 'id8'
345-
body[:booking][:version] = 148
346-
body[:booking][:status] = 'ACCEPTED'
347-
body[:booking][:created_at] = 'created_at6'
348-
body[:booking][:updated_at] = 'updated_at4'
349312

350313
result = bookings_api.update_booking(booking_id: booking_id, body: body)
351314

@@ -364,6 +327,9 @@ Cancels an existing booking.
364327
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
365328
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
366329

330+
For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
331+
or *Appointments Premium*.
332+
367333
```ruby
368334
def cancel_booking(booking_id:,
369335
body:)
@@ -385,8 +351,6 @@ def cancel_booking(booking_id:,
385351
```ruby
386352
booking_id = 'booking_id4'
387353
body = {}
388-
body[:idempotency_key] = 'idempotency_key2'
389-
body[:booking_version] = 8
390354

391355
result = bookings_api.cancel_booking(booking_id: booking_id, body: body)
392356

doc/api/cards.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,9 @@ def list_cards(cursor: nil,
4646
## Example Usage
4747

4848
```ruby
49-
cursor = 'cursor6'
50-
customer_id = 'customer_id8'
5149
include_disabled = false
52-
reference_id = 'reference_id2'
53-
sort_order = 'DESC'
5450

55-
result = cards_api.list_cards(cursor: cursor, customer_id: customer_id, include_disabled: include_disabled, reference_id: reference_id, sort_order: sort_order)
51+
result = cards_api.list_cards(include_disabled: include_disabled, )
5652

5753
if result.success?
5854
puts result.data
@@ -86,20 +82,12 @@ def create_card(body:)
8682
body = {}
8783
body[:idempotency_key] = '4935a656-a929-4792-b97c-8848be85c27c'
8884
body[:source_id] = 'cnon:uIbfJXhXETSP197M3GB'
89-
body[:verification_token] = 'verification_token0'
9085
body[:card] = {}
91-
body[:card][:id] = 'id0'
92-
body[:card][:card_brand] = 'INTERAC'
93-
body[:card][:last_4] = 'last_42'
94-
body[:card][:exp_month] = 236
95-
body[:card][:exp_year] = 60
9686
body[:card][:cardholder_name] = 'Amelia Earhart'
9787
body[:card][:billing_address] = {}
9888
body[:card][:billing_address][:address_line_1] = '500 Electric Ave'
9989
body[:card][:billing_address][:address_line_2] = 'Suite 600'
100-
body[:card][:billing_address][:address_line_3] = 'address_line_34'
10190
body[:card][:billing_address][:locality] = 'New York'
102-
body[:card][:billing_address][:sublocality] = 'sublocality8'
10391
body[:card][:billing_address][:administrative_district_level_1] = 'NY'
10492
body[:card][:billing_address][:postal_code] = '10003'
10593
body[:card][:billing_address][:country] = 'US'

doc/api/cash-drawers.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,8 @@ def list_cash_drawer_shifts(location_id:,
4848

4949
```ruby
5050
location_id = 'location_id4'
51-
sort_order = 'DESC'
52-
begin_time = 'begin_time2'
53-
end_time = 'end_time2'
54-
limit = 172
55-
cursor = 'cursor6'
5651

57-
result = cash_drawers_api.list_cash_drawer_shifts(location_id: location_id, sort_order: sort_order, begin_time: begin_time, end_time: end_time, limit: limit, cursor: cursor)
52+
result = cash_drawers_api.list_cash_drawer_shifts(location_id: location_id, )
5853

5954
if result.success?
6055
puts result.data
@@ -130,10 +125,8 @@ def list_cash_drawer_shift_events(location_id:,
130125
```ruby
131126
location_id = 'location_id4'
132127
shift_id = 'shift_id0'
133-
limit = 172
134-
cursor = 'cursor6'
135128

136-
result = cash_drawers_api.list_cash_drawer_shift_events(location_id: location_id, shift_id: shift_id, limit: limit, cursor: cursor)
129+
result = cash_drawers_api.list_cash_drawer_shift_events(location_id: location_id, shift_id: shift_id, )
137130

138131
if result.success?
139132
puts result.data

0 commit comments

Comments
 (0)