Merge pull request #161 from square/release/2024-12-18

Generated PR for Release: 2024-12-18
square · Dec 18, 2024 · 4af0226 · 4af0226
2 parents 10dfded + 0effdb5
commit 4af0226
Show file tree

Hide file tree

Showing 98 changed files with 2,727 additions and 988 deletions.
diff --git a/doc/api/apple-pay.md b/doc/api/apple-pay.md
@@ -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

diff --git a/doc/api/bank-accounts.md b/doc/api/bank-accounts.md
@@ -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
@@ -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
@@ -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

diff --git a/doc/api/booking-custom-attributes.md b/doc/api/booking-custom-attributes.md
@@ -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
@@ -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
@@ -94,7 +98,8 @@ requestOptions?: RequestOptions): Promise<ApiResponse<CreateBookingCustomAttribu
 
 ```ts
 const body: CreateBookingCustomAttributeDefinitionRequest = {
-  customAttributeDefinition: {},
+  customAttributeDefinition: {
+  },
 };
 
 try {
@@ -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
@@ -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
@@ -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
@@ -231,7 +242,8 @@ requestOptions?: RequestOptions): Promise<ApiResponse<UpdateBookingCustomAttribu
 const key = 'key0';
 
 const body: UpdateBookingCustomAttributeDefinitionRequest = {
-  customAttributeDefinition: {},
+  customAttributeDefinition: {
+  },
 };
 
 try {
@@ -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
@@ -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
@@ -338,11 +354,13 @@ const body: BulkUpsertBookingCustomAttributesRequest = {
   values: {
     'key0': {
       bookingId: 'booking_id4',
-      customAttribute: {},
+      customAttribute: {
+      },
     },
     'key1': {
       bookingId: 'booking_id4',
-      customAttribute: {},
+      customAttribute: {
+      },
     }
   },
 };
@@ -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
@@ -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
@@ -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
@@ -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
@@ -558,7 +584,8 @@ const bookingId = 'booking_id4';
 const key = 'key0';
 
 const body: UpsertBookingCustomAttributeRequest = {
-  customAttribute: {},
+  customAttribute: {
+  },
 };
 
 try {