Skip to content

Commit

Permalink
Merge pull request #152 from square/release/37.1.1
Browse files Browse the repository at this point in the history 
Generated PR for Release: 37.1.1
  • Loading branch information
@jessdelacruzsantos
jessdelacruzsantos authored Jul 17, 2024
2 parents 5a9c46d + a181272 commit 71867a0
Show file tree
Hide file tree
Showing 94 changed files with 866 additions and 1,301 deletions.
13 changes: 7 additions & 6 deletions doc/api/apple-pay.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,17 @@ an Apple Pay enabled domain.
This endpoint provides an easy way for platform developers to bulk activate
Apple Pay on the Web with Square for merchants using their platform.

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.
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).
Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The
current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your
domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding
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: 6 additions & 12 deletions doc/api/bank-accounts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,10 @@ 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 @@ -62,10 +60,8 @@ 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 @@ -103,10 +99,8 @@ 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
66 changes: 22 additions & 44 deletions doc/api/booking-custom-attributes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,9 @@ 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 @@ -77,10 +75,8 @@ 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 Down Expand Up @@ -125,10 +121,8 @@ 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 @@ -168,11 +162,9 @@ 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 @@ -216,11 +208,9 @@ 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 Down Expand Up @@ -271,10 +261,8 @@ 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 @@ -328,10 +316,8 @@ 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 Down Expand Up @@ -382,13 +368,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 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 @@ -441,11 +425,9 @@ 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 @@ -491,13 +473,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 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 @@ -551,12 +531,10 @@ 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 Down
76 changes: 25 additions & 51 deletions doc/api/bookings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,14 @@ 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 listBookings(
limit?: number,
async listBookings( limit?: number,
cursor?: string,
customerId?: string,
teamMemberId?: string,
locationId?: string,
startAtMin?: string,
startAtMax?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<ListBookingsResponse>>
requestOptions?: RequestOptions): Promise<ApiResponse<ListBookingsResponse>>
```

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

```ts
async createBooking(
body: CreateBookingRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<CreateBookingResponse>>
async createBooking( body: CreateBookingRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingResponse>>
```

## Parameters
Expand Down Expand Up @@ -142,10 +138,8 @@ 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 searchAvailability(
body: SearchAvailabilityRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<SearchAvailabilityResponse>>
async searchAvailability( body: SearchAvailabilityRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<SearchAvailabilityResponse>>
```

## Parameters
Expand Down Expand Up @@ -191,10 +185,8 @@ 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 bulkRetrieveBookings(
body: BulkRetrieveBookingsRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<BulkRetrieveBookingsResponse>>
async bulkRetrieveBookings( body: BulkRetrieveBookingsRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkRetrieveBookingsResponse>>
```

## Parameters
Expand Down Expand Up @@ -237,9 +229,7 @@ try {
Retrieves a seller's booking profile.

```ts
async retrieveBusinessBookingProfile(
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveBusinessBookingProfileResponse>>
async retrieveBusinessBookingProfile(requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBusinessBookingProfileResponse>>
```

## Parameters
Expand Down Expand Up @@ -273,11 +263,9 @@ try {
Lists location booking profiles of a seller.

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

## Parameters
Expand Down Expand Up @@ -313,10 +301,8 @@ try {
Retrieves a seller's location booking profile.

```ts
async retrieveLocationBookingProfile(
locationId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveLocationBookingProfileResponse>>
async retrieveLocationBookingProfile( locationId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveLocationBookingProfileResponse>>
```

## Parameters
Expand Down Expand Up @@ -353,13 +339,11 @@ try {
Lists booking profiles for team members.

```ts
async listTeamMemberBookingProfiles(
bookableOnly?: boolean,
async listTeamMemberBookingProfiles( bookableOnly?: boolean,
limit?: number,
cursor?: string,
locationId?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<ListTeamMemberBookingProfilesResponse>>
requestOptions?: RequestOptions): Promise<ApiResponse<ListTeamMemberBookingProfilesResponse>>
```

## Parameters
Expand Down Expand Up @@ -399,10 +383,8 @@ try {
Retrieves one or more team members' booking profiles.

```ts
async bulkRetrieveTeamMemberBookingProfiles(
body: BulkRetrieveTeamMemberBookingProfilesRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<BulkRetrieveTeamMemberBookingProfilesResponse>>
async bulkRetrieveTeamMemberBookingProfiles( body: BulkRetrieveTeamMemberBookingProfilesRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkRetrieveTeamMemberBookingProfilesResponse>>
```

## Parameters
Expand Down Expand Up @@ -445,10 +427,8 @@ try {
Retrieves a team member's booking profile.

```ts
async retrieveTeamMemberBookingProfile(
teamMemberId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveTeamMemberBookingProfileResponse>>
async retrieveTeamMemberBookingProfile( teamMemberId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveTeamMemberBookingProfileResponse>>
```

## Parameters
Expand Down Expand Up @@ -488,10 +468,8 @@ 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 retrieveBooking(
bookingId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<RetrieveBookingResponse>>
async retrieveBooking( bookingId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveBookingResponse>>
```

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

```ts
async updateBooking(
bookingId: string,
async updateBooking( bookingId: string,
body: UpdateBookingRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<UpdateBookingResponse>>
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingResponse>>
```

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

```ts
async cancelBooking(
bookingId: string,
async cancelBooking( bookingId: string,
body: CancelBookingRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<CancelBookingResponse>>
requestOptions?: RequestOptions): Promise<ApiResponse<CancelBookingResponse>>
```

## Parameters
Expand Down
Loading

0 comments on commit 71867a0

Please sign in to comment.