Skip to content

Commit 71867a0

Browse files
Merge pull request #152 from square/release/37.1.1
Generated PR for Release: 37.1.1
2 parents 5a9c46d + a181272 commit 71867a0

File tree

94 files changed

+866
-1301
lines changed

Some content is hidden

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

94 files changed

+866
-1301
lines changed

doc/api/apple-pay.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,17 @@ an Apple Pay enabled domain.
1818
This endpoint provides an easy way for platform developers to bulk activate
1919
Apple Pay on the Web with Square for merchants using their platform.
2020

21-
Note: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022.
22-
You must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate).
21+
Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The
22+
current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
23+
and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your
24+
domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding
25+
long-lived caches that might not keep in sync with the correct file version.
2326

2427
To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
2528

2629
```ts
27-
async registerDomain(
28-
body: RegisterDomainRequest,
29-
requestOptions?: RequestOptions
30-
): Promise<ApiResponse<RegisterDomainResponse>>
30+
async registerDomain( body: RegisterDomainRequest,
31+
requestOptions?: RequestOptions): Promise<ApiResponse<RegisterDomainResponse>>
3132
```
3233

3334
## Parameters

doc/api/bank-accounts.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,10 @@ const bankAccountsApi = client.bankAccountsApi;
2020
Returns a list of [BankAccount](../../doc/models/bank-account.md) objects linked to a Square account.
2121

2222
```ts
23-
async listBankAccounts(
24-
cursor?: string,
23+
async listBankAccounts( cursor?: string,
2524
limit?: number,
2625
locationId?: string,
27-
requestOptions?: RequestOptions
28-
): Promise<ApiResponse<ListBankAccountsResponse>>
26+
requestOptions?: RequestOptions): Promise<ApiResponse<ListBankAccountsResponse>>
2927
```
3028

3129
## Parameters
@@ -62,10 +60,8 @@ try {
6260
Returns details of a [BankAccount](../../doc/models/bank-account.md) identified by V1 bank account ID.
6361

6462
```ts
65-
async getBankAccountByV1Id(
66-
v1BankAccountId: string,
67-
requestOptions?: RequestOptions
68-
): Promise<ApiResponse<GetBankAccountByV1IdResponse>>
63+
async getBankAccountByV1Id( v1BankAccountId: string,
64+
requestOptions?: RequestOptions): Promise<ApiResponse<GetBankAccountByV1IdResponse>>
6965
```
7066

7167
## Parameters
@@ -103,10 +99,8 @@ Returns details of a [BankAccount](../../doc/models/bank-account.md)
10399
linked to a Square account.
104100

105101
```ts
106-
async getBankAccount(
107-
bankAccountId: string,
108-
requestOptions?: RequestOptions
109-
): Promise<ApiResponse<GetBankAccountResponse>>
102+
async getBankAccount( bankAccountId: string,
103+
requestOptions?: RequestOptions): Promise<ApiResponse<GetBankAccountResponse>>
110104
```
111105

112106
## Parameters

doc/api/booking-custom-attributes.md

Lines changed: 22 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,9 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
3131
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
3232

3333
```ts
34-
async listBookingCustomAttributeDefinitions(
35-
limit?: number,
34+
async listBookingCustomAttributeDefinitions( limit?: number,
3635
cursor?: string,
37-
requestOptions?: RequestOptions
38-
): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
36+
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
3937
```
4038

4139
## Parameters
@@ -77,10 +75,8 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
7775
or *Appointments Premium*.
7876

7977
```ts
80-
async createBookingCustomAttributeDefinition(
81-
body: CreateBookingCustomAttributeDefinitionRequest,
82-
requestOptions?: RequestOptions
83-
): Promise<ApiResponse<CreateBookingCustomAttributeDefinitionResponse>>
78+
async createBookingCustomAttributeDefinition( body: CreateBookingCustomAttributeDefinitionRequest,
79+
requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingCustomAttributeDefinitionResponse>>
8480
```
8581

8682
## Parameters
@@ -125,10 +121,8 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
125121
or *Appointments Premium*.
126122

127123
```ts
128-
async deleteBookingCustomAttributeDefinition(
129-
key: string,
130-
requestOptions?: RequestOptions
131-
): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
124+
async deleteBookingCustomAttributeDefinition( key: string,
125+
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
132126
```
133127

134128
## Parameters
@@ -168,11 +162,9 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
168162
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
169163

170164
```ts
171-
async retrieveBookingCustomAttributeDefinition(
172-
key: string,
165+
async retrieveBookingCustomAttributeDefinition( key: string,
173166
version?: number,
174-
requestOptions?: RequestOptions
175-
): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
167+
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
176168
```
177169

178170
## Parameters
@@ -216,11 +208,9 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
216208
or *Appointments Premium*.
217209

218210
```ts
219-
async updateBookingCustomAttributeDefinition(
220-
key: string,
211+
async updateBookingCustomAttributeDefinition( key: string,
221212
body: UpdateBookingCustomAttributeDefinitionRequest,
222-
requestOptions?: RequestOptions
223-
): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
213+
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
224214
```
225215

226216
## Parameters
@@ -271,10 +261,8 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
271261
or *Appointments Premium*.
272262

273263
```ts
274-
async bulkDeleteBookingCustomAttributes(
275-
body: BulkDeleteBookingCustomAttributesRequest,
276-
requestOptions?: RequestOptions
277-
): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
264+
async bulkDeleteBookingCustomAttributes( body: BulkDeleteBookingCustomAttributesRequest,
265+
requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
278266
```
279267

280268
## Parameters
@@ -328,10 +316,8 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
328316
or *Appointments Premium*.
329317

330318
```ts
331-
async bulkUpsertBookingCustomAttributes(
332-
body: BulkUpsertBookingCustomAttributesRequest,
333-
requestOptions?: RequestOptions
334-
): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
319+
async bulkUpsertBookingCustomAttributes( body: BulkUpsertBookingCustomAttributesRequest,
320+
requestOptions?: RequestOptions): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
335321
```
336322

337323
## Parameters
@@ -382,13 +368,11 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
382368
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
383369

384370
```ts
385-
async listBookingCustomAttributes(
386-
bookingId: string,
371+
async listBookingCustomAttributes( bookingId: string,
387372
limit?: number,
388373
cursor?: string,
389374
withDefinitions?: boolean,
390-
requestOptions?: RequestOptions
391-
): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
375+
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
392376
```
393377

394378
## Parameters
@@ -441,11 +425,9 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
441425
or *Appointments Premium*.
442426

443427
```ts
444-
async deleteBookingCustomAttribute(
445-
bookingId: string,
428+
async deleteBookingCustomAttribute( bookingId: string,
446429
key: string,
447-
requestOptions?: RequestOptions
448-
): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
430+
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
449431
```
450432

451433
## Parameters
@@ -491,13 +473,11 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
491473
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
492474

493475
```ts
494-
async retrieveBookingCustomAttribute(
495-
bookingId: string,
476+
async retrieveBookingCustomAttribute( bookingId: string,
496477
key: string,
497478
withDefinition?: boolean,
498479
version?: number,
499-
requestOptions?: RequestOptions
500-
): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
480+
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
501481
```
502482

503483
## Parameters
@@ -551,12 +531,10 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
551531
or *Appointments Premium*.
552532

553533
```ts
554-
async upsertBookingCustomAttribute(
555-
bookingId: string,
534+
async upsertBookingCustomAttribute( bookingId: string,
556535
key: string,
557536
body: UpsertBookingCustomAttributeRequest,
558-
requestOptions?: RequestOptions
559-
): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
537+
requestOptions?: RequestOptions): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
560538
```
561539

562540
## Parameters

doc/api/bookings.md

Lines changed: 25 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,14 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
3333
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
3434

3535
```ts
36-
async listBookings(
37-
limit?: number,
36+
async listBookings( limit?: number,
3837
cursor?: string,
3938
customerId?: string,
4039
teamMemberId?: string,
4140
locationId?: string,
4241
startAtMin?: string,
4342
startAtMax?: string,
44-
requestOptions?: RequestOptions
45-
): Promise<ApiResponse<ListBookingsResponse>>
43+
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingsResponse>>
4644
```
4745

4846
## Parameters
@@ -97,10 +95,8 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
9795
or *Appointments Premium*.
9896

9997
```ts
100-
async createBooking(
101-
body: CreateBookingRequest,
102-
requestOptions?: RequestOptions
103-
): Promise<ApiResponse<CreateBookingResponse>>
98+
async createBooking( body: CreateBookingRequest,
99+
requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingResponse>>
104100
```
105101

106102
## Parameters
@@ -142,10 +138,8 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
142138
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
143139

144140
```ts
145-
async searchAvailability(
146-
body: SearchAvailabilityRequest,
147-
requestOptions?: RequestOptions
148-
): Promise<ApiResponse<SearchAvailabilityResponse>>
141+
async searchAvailability( body: SearchAvailabilityRequest,
142+
requestOptions?: RequestOptions): Promise<ApiResponse<SearchAvailabilityResponse>>
149143
```
150144

151145
## Parameters
@@ -191,10 +185,8 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
191185
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
192186

193187
```ts
194-
async bulkRetrieveBookings(
195-
body: BulkRetrieveBookingsRequest,
196-
requestOptions?: RequestOptions
197-
): Promise<ApiResponse<BulkRetrieveBookingsResponse>>
188+
async bulkRetrieveBookings( body: BulkRetrieveBookingsRequest,
189+
requestOptions?: RequestOptions): Promise<ApiResponse<BulkRetrieveBookingsResponse>>
198190
```
199191

200192
## Parameters
@@ -237,9 +229,7 @@ try {
237229
Retrieves a seller's booking profile.
238230

239231
```ts
240-
async retrieveBusinessBookingProfile(
241-
requestOptions?: RequestOptions
242-
): Promise<ApiResponse<RetrieveBusinessBookingProfileResponse>>
232+
async retrieveBusinessBookingProfile(requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBusinessBookingProfileResponse>>
243233
```
244234

245235
## Parameters
@@ -273,11 +263,9 @@ try {
273263
Lists location booking profiles of a seller.
274264

275265
```ts
276-
async listLocationBookingProfiles(
277-
limit?: number,
266+
async listLocationBookingProfiles( limit?: number,
278267
cursor?: string,
279-
requestOptions?: RequestOptions
280-
): Promise<ApiResponse<ListLocationBookingProfilesResponse>>
268+
requestOptions?: RequestOptions): Promise<ApiResponse<ListLocationBookingProfilesResponse>>
281269
```
282270

283271
## Parameters
@@ -313,10 +301,8 @@ try {
313301
Retrieves a seller's location booking profile.
314302

315303
```ts
316-
async retrieveLocationBookingProfile(
317-
locationId: string,
318-
requestOptions?: RequestOptions
319-
): Promise<ApiResponse<RetrieveLocationBookingProfileResponse>>
304+
async retrieveLocationBookingProfile( locationId: string,
305+
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveLocationBookingProfileResponse>>
320306
```
321307

322308
## Parameters
@@ -353,13 +339,11 @@ try {
353339
Lists booking profiles for team members.
354340

355341
```ts
356-
async listTeamMemberBookingProfiles(
357-
bookableOnly?: boolean,
342+
async listTeamMemberBookingProfiles( bookableOnly?: boolean,
358343
limit?: number,
359344
cursor?: string,
360345
locationId?: string,
361-
requestOptions?: RequestOptions
362-
): Promise<ApiResponse<ListTeamMemberBookingProfilesResponse>>
346+
requestOptions?: RequestOptions): Promise<ApiResponse<ListTeamMemberBookingProfilesResponse>>
363347
```
364348

365349
## Parameters
@@ -399,10 +383,8 @@ try {
399383
Retrieves one or more team members' booking profiles.
400384

401385
```ts
402-
async bulkRetrieveTeamMemberBookingProfiles(
403-
body: BulkRetrieveTeamMemberBookingProfilesRequest,
404-
requestOptions?: RequestOptions
405-
): Promise<ApiResponse<BulkRetrieveTeamMemberBookingProfilesResponse>>
386+
async bulkRetrieveTeamMemberBookingProfiles( body: BulkRetrieveTeamMemberBookingProfilesRequest,
387+
requestOptions?: RequestOptions): Promise<ApiResponse<BulkRetrieveTeamMemberBookingProfilesResponse>>
406388
```
407389

408390
## Parameters
@@ -445,10 +427,8 @@ try {
445427
Retrieves a team member's booking profile.
446428

447429
```ts
448-
async retrieveTeamMemberBookingProfile(
449-
teamMemberId: string,
450-
requestOptions?: RequestOptions
451-
): Promise<ApiResponse<RetrieveTeamMemberBookingProfileResponse>>
430+
async retrieveTeamMemberBookingProfile( teamMemberId: string,
431+
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveTeamMemberBookingProfileResponse>>
452432
```
453433

454434
## Parameters
@@ -488,10 +468,8 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
488468
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
489469

490470
```ts
491-
async retrieveBooking(
492-
bookingId: string,
493-
requestOptions?: RequestOptions
494-
): Promise<ApiResponse<RetrieveBookingResponse>>
471+
async retrieveBooking( bookingId: string,
472+
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingResponse>>
495473
```
496474

497475
## Parameters
@@ -534,11 +512,9 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
534512
or *Appointments Premium*.
535513

536514
```ts
537-
async updateBooking(
538-
bookingId: string,
515+
async updateBooking( bookingId: string,
539516
body: UpdateBookingRequest,
540-
requestOptions?: RequestOptions
541-
): Promise<ApiResponse<UpdateBookingResponse>>
517+
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingResponse>>
542518
```
543519

544520
## Parameters
@@ -589,11 +565,9 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
589565
or *Appointments Premium*.
590566

591567
```ts
592-
async cancelBooking(
593-
bookingId: string,
568+
async cancelBooking( bookingId: string,
594569
body: CancelBookingRequest,
595-
requestOptions?: RequestOptions
596-
): Promise<ApiResponse<CancelBookingResponse>>
570+
requestOptions?: RequestOptions): Promise<ApiResponse<CancelBookingResponse>>
597571
```
598572

599573
## Parameters

0 commit comments

Comments
 (0)