Skip to content

Commit 4af0226

Browse files
authored
Merge pull request #161 from square/release/2024-12-18
Generated PR for Release: 2024-12-18
2 parents 10dfded + 0effdb5 commit 4af0226

File tree

98 files changed

+2727
-988
lines changed

Some content is hidden

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

98 files changed

+2727
-988
lines changed

doc/api/apple-pay.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ long-lived caches that might not keep in sync with the correct file version.
2727
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).
2828

2929
```ts
30-
async registerDomain( body: RegisterDomainRequest,
31-
requestOptions?: RequestOptions): Promise<ApiResponse<RegisterDomainResponse>>
30+
async registerDomain(
31+
body: RegisterDomainRequest,
32+
requestOptions?: RequestOptions
33+
): Promise<ApiResponse<RegisterDomainResponse>>
3234
```
3335

3436
## Parameters

doc/api/bank-accounts.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ 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( cursor?: string,
23+
async listBankAccounts(
24+
cursor?: string,
2425
limit?: number,
2526
locationId?: string,
26-
requestOptions?: RequestOptions): Promise<ApiResponse<ListBankAccountsResponse>>
27+
requestOptions?: RequestOptions
28+
): Promise<ApiResponse<ListBankAccountsResponse>>
2729
```
2830

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

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

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

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

106112
## Parameters

doc/api/booking-custom-attributes.md

Lines changed: 54 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ 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( limit?: number,
34+
async listBookingCustomAttributeDefinitions(
35+
limit?: number,
3536
cursor?: string,
36-
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
37+
requestOptions?: RequestOptions
38+
): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
3739
```
3840

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

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

8286
## Parameters
@@ -94,7 +98,8 @@ requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingCustomAttribu
9498

9599
```ts
96100
const body: CreateBookingCustomAttributeDefinitionRequest = {
97-
customAttributeDefinition: {},
101+
customAttributeDefinition: {
102+
},
98103
};
99104

100105
try {
@@ -121,8 +126,10 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
121126
or *Appointments Premium*.
122127

123128
```ts
124-
async deleteBookingCustomAttributeDefinition( key: string,
125-
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
129+
async deleteBookingCustomAttributeDefinition(
130+
key: string,
131+
requestOptions?: RequestOptions
132+
): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
126133
```
127134

128135
## Parameters
@@ -162,9 +169,11 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
162169
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
163170

164171
```ts
165-
async retrieveBookingCustomAttributeDefinition( key: string,
172+
async retrieveBookingCustomAttributeDefinition(
173+
key: string,
166174
version?: number,
167-
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
175+
requestOptions?: RequestOptions
176+
): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
168177
```
169178

170179
## Parameters
@@ -208,9 +217,11 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
208217
or *Appointments Premium*.
209218

210219
```ts
211-
async updateBookingCustomAttributeDefinition( key: string,
220+
async updateBookingCustomAttributeDefinition(
221+
key: string,
212222
body: UpdateBookingCustomAttributeDefinitionRequest,
213-
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
223+
requestOptions?: RequestOptions
224+
): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
214225
```
215226

216227
## Parameters
@@ -231,7 +242,8 @@ requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingCustomAttribu
231242
const key = 'key0';
232243

233244
const body: UpdateBookingCustomAttributeDefinitionRequest = {
234-
customAttributeDefinition: {},
245+
customAttributeDefinition: {
246+
},
235247
};
236248

237249
try {
@@ -261,8 +273,10 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
261273
or *Appointments Premium*.
262274

263275
```ts
264-
async bulkDeleteBookingCustomAttributes( body: BulkDeleteBookingCustomAttributesRequest,
265-
requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
276+
async bulkDeleteBookingCustomAttributes(
277+
body: BulkDeleteBookingCustomAttributesRequest,
278+
requestOptions?: RequestOptions
279+
): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
266280
```
267281

268282
## Parameters
@@ -316,8 +330,10 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
316330
or *Appointments Premium*.
317331

318332
```ts
319-
async bulkUpsertBookingCustomAttributes( body: BulkUpsertBookingCustomAttributesRequest,
320-
requestOptions?: RequestOptions): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
333+
async bulkUpsertBookingCustomAttributes(
334+
body: BulkUpsertBookingCustomAttributesRequest,
335+
requestOptions?: RequestOptions
336+
): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
321337
```
322338

323339
## Parameters
@@ -338,11 +354,13 @@ const body: BulkUpsertBookingCustomAttributesRequest = {
338354
values: {
339355
'key0': {
340356
bookingId: 'booking_id4',
341-
customAttribute: {},
357+
customAttribute: {
358+
},
342359
},
343360
'key1': {
344361
bookingId: 'booking_id4',
345-
customAttribute: {},
362+
customAttribute: {
363+
},
346364
}
347365
},
348366
};
@@ -368,11 +386,13 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
368386
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
369387

370388
```ts
371-
async listBookingCustomAttributes( bookingId: string,
389+
async listBookingCustomAttributes(
390+
bookingId: string,
372391
limit?: number,
373392
cursor?: string,
374393
withDefinitions?: boolean,
375-
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
394+
requestOptions?: RequestOptions
395+
): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
376396
```
377397

378398
## Parameters
@@ -425,9 +445,11 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
425445
or *Appointments Premium*.
426446

427447
```ts
428-
async deleteBookingCustomAttribute( bookingId: string,
448+
async deleteBookingCustomAttribute(
449+
bookingId: string,
429450
key: string,
430-
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
451+
requestOptions?: RequestOptions
452+
): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
431453
```
432454

433455
## Parameters
@@ -473,11 +495,13 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
473495
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
474496

475497
```ts
476-
async retrieveBookingCustomAttribute( bookingId: string,
498+
async retrieveBookingCustomAttribute(
499+
bookingId: string,
477500
key: string,
478501
withDefinition?: boolean,
479502
version?: number,
480-
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
503+
requestOptions?: RequestOptions
504+
): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
481505
```
482506

483507
## Parameters
@@ -531,10 +555,12 @@ For calls to this endpoint with seller-level permissions to succeed, the seller
531555
or *Appointments Premium*.
532556

533557
```ts
534-
async upsertBookingCustomAttribute( bookingId: string,
558+
async upsertBookingCustomAttribute(
559+
bookingId: string,
535560
key: string,
536561
body: UpsertBookingCustomAttributeRequest,
537-
requestOptions?: RequestOptions): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
562+
requestOptions?: RequestOptions
563+
): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
538564
```
539565

540566
## Parameters
@@ -558,7 +584,8 @@ const bookingId = 'booking_id4';
558584
const key = 'key0';
559585

560586
const body: UpsertBookingCustomAttributeRequest = {
561-
customAttribute: {},
587+
customAttribute: {
588+
},
562589
};
563590

564591
try {

0 commit comments

Comments
 (0)