Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/api/apple-pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@ long-lived caches that might not keep in sync with the correct file version.
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).

```ts
async registerDomain( body: RegisterDomainRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<RegisterDomainResponse>>
async registerDomain(
body: RegisterDomainRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<RegisterDomainResponse>>
```

## Parameters
Expand Down
18 changes: 12 additions & 6 deletions doc/api/bank-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ const bankAccountsApi = client.bankAccountsApi;
Returns a list of [BankAccount](../../doc/models/bank-account.md) objects linked to a Square account.

```ts
async listBankAccounts( cursor?: string,
async listBankAccounts(
cursor?: string,
limit?: number,
locationId?: string,
requestOptions?: RequestOptions): Promise<ApiResponse<ListBankAccountsResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<ListBankAccountsResponse>>
```

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

```ts
async getBankAccountByV1Id( v1BankAccountId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<GetBankAccountByV1IdResponse>>
async getBankAccountByV1Id(
v1BankAccountId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<GetBankAccountByV1IdResponse>>
```

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

```ts
async getBankAccount( bankAccountId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<GetBankAccountResponse>>
async getBankAccount(
bankAccountId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<GetBankAccountResponse>>
```

## Parameters
Expand Down
81 changes: 54 additions & 27 deletions doc/api/booking-custom-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

```ts
async listBookingCustomAttributeDefinitions( limit?: number,
async listBookingCustomAttributeDefinitions(
limit?: number,
cursor?: string,
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<ListBookingCustomAttributeDefinitionsResponse>>
```

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

```ts
async createBookingCustomAttributeDefinition( body: CreateBookingCustomAttributeDefinitionRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingCustomAttributeDefinitionResponse>>
async createBookingCustomAttributeDefinition(
body: CreateBookingCustomAttributeDefinitionRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<CreateBookingCustomAttributeDefinitionResponse>>
```

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

```ts
const body: CreateBookingCustomAttributeDefinitionRequest = {
customAttributeDefinition: {},
customAttributeDefinition: {
},
};

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

```ts
async deleteBookingCustomAttributeDefinition( key: string,
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
async deleteBookingCustomAttributeDefinition(
key: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<DeleteBookingCustomAttributeDefinitionResponse>>
```

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

```ts
async retrieveBookingCustomAttributeDefinition( key: string,
async retrieveBookingCustomAttributeDefinition(
key: string,
version?: number,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveBookingCustomAttributeDefinitionResponse>>
```

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

```ts
async updateBookingCustomAttributeDefinition( key: string,
async updateBookingCustomAttributeDefinition(
key: string,
body: UpdateBookingCustomAttributeDefinitionRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<UpdateBookingCustomAttributeDefinitionResponse>>
```

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

const body: UpdateBookingCustomAttributeDefinitionRequest = {
customAttributeDefinition: {},
customAttributeDefinition: {
},
};

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

```ts
async bulkDeleteBookingCustomAttributes( body: BulkDeleteBookingCustomAttributesRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
async bulkDeleteBookingCustomAttributes(
body: BulkDeleteBookingCustomAttributesRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<BulkDeleteBookingCustomAttributesResponse>>
```

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

```ts
async bulkUpsertBookingCustomAttributes( body: BulkUpsertBookingCustomAttributesRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
async bulkUpsertBookingCustomAttributes(
body: BulkUpsertBookingCustomAttributesRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<BulkUpsertBookingCustomAttributesResponse>>
```

## Parameters
Expand All @@ -338,11 +354,13 @@ const body: BulkUpsertBookingCustomAttributesRequest = {
values: {
'key0': {
bookingId: 'booking_id4',
customAttribute: {},
customAttribute: {
},
},
'key1': {
bookingId: 'booking_id4',
customAttribute: {},
customAttribute: {
},
}
},
};
Expand All @@ -368,11 +386,13 @@ To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

```ts
async listBookingCustomAttributes( bookingId: string,
async listBookingCustomAttributes(
bookingId: string,
limit?: number,
cursor?: string,
withDefinitions?: boolean,
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<ListBookingCustomAttributesResponse>>
```

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

```ts
async deleteBookingCustomAttribute( bookingId: string,
async deleteBookingCustomAttribute(
bookingId: string,
key: string,
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<DeleteBookingCustomAttributeResponse>>
```

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

```ts
async retrieveBookingCustomAttribute( bookingId: string,
async retrieveBookingCustomAttribute(
bookingId: string,
key: string,
withDefinition?: boolean,
version?: number,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveBookingCustomAttributeResponse>>
```

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

```ts
async upsertBookingCustomAttribute( bookingId: string,
async upsertBookingCustomAttribute(
bookingId: string,
key: string,
body: UpsertBookingCustomAttributeRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
requestOptions?: RequestOptions
): Promise<ApiResponse<UpsertBookingCustomAttributeResponse>>
```

## Parameters
Expand All @@ -558,7 +584,8 @@ const bookingId = 'booking_id4';
const key = 'key0';

const body: UpsertBookingCustomAttributeRequest = {
customAttribute: {},
customAttribute: {
},
};

try {
Expand Down
Loading
Loading