Merge pull request #113 from square/release/27.0.0.20230419

Generated PR for Release: 27.0.0.20230419

Author: daphnechiu

README.md

@@ -126,6 +126,9 @@ rake
 * [Mobile Authorization]
 * [OAuth]
 
+### Webhook Subscriptions
+* [Webhook Subscriptions]
+
 ## Deprecated APIs
 
 The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle):
@@ -176,3 +179,4 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Gift Card Activities]: doc/api/gift-card-activities.md
 [Employees]: doc/api/employees.md
 [Transactions]: doc/api/transactions.md
+[Webhook Subscriptions]: doc/api/webhook-subscriptions.md

doc/api/apple-pay.md

@@ -40,8 +40,10 @@ def register_domain(body:)
 ## Example Usage
 
 ```ruby
-body = {}
-body[:domain_name] = 'example.com'
+body = {
+  :domain_name => 'example.com'
+}
+
 
 result = apple_pay_api.register_domain(body: body)
 

doc/api/bank-accounts.md

@@ -40,7 +40,7 @@ def list_bank_accounts(cursor: nil,
 ## Example Usage
 
 ```ruby
-result = bank_accounts_api.list_bank_accounts()
+result = bank_accounts_api.list_bank_accounts
 
 if result.success?
   puts result.data
@@ -73,6 +73,7 @@ def get_bank_account_by_v1_id(v1_bank_account_id:)
 ```ruby
 v1_bank_account_id = 'v1_bank_account_id8'
 
+
 result = bank_accounts_api.get_bank_account_by_v1_id(v1_bank_account_id: v1_bank_account_id)
 
 if result.success?
@@ -107,6 +108,7 @@ def get_bank_account(bank_account_id:)
 ```ruby
 bank_account_id = 'bank_account_id0'
 
+
 result = bank_accounts_api.get_bank_account(bank_account_id: bank_account_id)
 
 if result.success?

doc/api/booking-custom-attributes.md

@@ -49,7 +49,7 @@ def list_booking_custom_attribute_definitions(limit: nil,
 ## Example Usage
 
 ```ruby
-result = booking_custom_attributes_api.list_booking_custom_attribute_definitions()
+result = booking_custom_attributes_api.list_booking_custom_attribute_definitions
 
 if result.success?
   puts result.data
@@ -86,8 +86,10 @@ def create_booking_custom_attribute_definition(body:)
 ## Example Usage
 
 ```ruby
-body = {}
-body[:custom_attribute_definition] = {}
+body = {
+  :custom_attribute_definition => {}
+}
+
 
 result = booking_custom_attributes_api.create_booking_custom_attribute_definition(body: body)
 
@@ -128,6 +130,7 @@ def delete_booking_custom_attribute_definition(key:)
 ```ruby
 key = 'key0'
 
+
 result = booking_custom_attributes_api.delete_booking_custom_attribute_definition(key: key)
 
 if result.success?
@@ -166,7 +169,8 @@ def retrieve_booking_custom_attribute_definition(key:,
 ```ruby
 key = 'key0'
 
-result = booking_custom_attributes_api.retrieve_booking_custom_attribute_definition(key: key, )
+
+result = booking_custom_attributes_api.retrieve_booking_custom_attribute_definition(key: key)
 
 if result.success?
   puts result.data
@@ -206,10 +210,16 @@ def update_booking_custom_attribute_definition(key:,
 
 ```ruby
 key = 'key0'
-body = {}
-body[:custom_attribute_definition] = {}
 
-result = booking_custom_attributes_api.update_booking_custom_attribute_definition(key: key, body: body)
+body = {
+  :custom_attribute_definition => {}
+}
+
+
+result = booking_custom_attributes_api.update_booking_custom_attribute_definition(
+  key: key,
+  body: body
+)
 
 if result.success?
   puts result.data
@@ -246,10 +256,19 @@ def bulk_delete_booking_custom_attributes(body:)
 ## Example Usage
 
 ```ruby
-body = {}
-body[:values] = {}
-body[:values][:booking_id] = nil
-body[:values][:key] = nil
+body = {
+  :values => {
+    'key0': {
+      :booking_id => 'booking_id8',
+      :key => 'key4'
+    },
+    'key1': {
+      :booking_id => 'booking_id9',
+      :key => 'key5'
+    }
+  }
+}
+
 
 result = booking_custom_attributes_api.bulk_delete_booking_custom_attributes(body: body)
 
@@ -288,10 +307,19 @@ def bulk_upsert_booking_custom_attributes(body:)
 ## Example Usage
 
 ```ruby
-body = {}
-body[:values] = {}
-body[:values][:booking_id] = nil
-body[:values][:custom_attribute] = {}
+body = {
+  :values => {
+    'key0': {
+      :booking_id => 'booking_id8',
+      :custom_attribute => {}
+    },
+    'key1': {
+      :booking_id => 'booking_id9',
+      :custom_attribute => {}
+    }
+  }
+}
+
 
 result = booking_custom_attributes_api.bulk_upsert_booking_custom_attributes(body: body)
 
@@ -321,10 +349,10 @@ def list_booking_custom_attributes(booking_id:,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). |
+| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
 | `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.<br>The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.<br>The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `cursor` | `String` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request. For more<br>information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
-| `with_definitions` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) in the `definition` field of each<br>custom attribute. Set this parameter to `true` to get the name and description of each custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
+| `with_definitions` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each<br>custom attribute. Set this parameter to `true` to get the name and description of each custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
 
 ## Response Type
 
@@ -334,9 +362,14 @@ def list_booking_custom_attributes(booking_id:,
 
 ```ruby
 booking_id = 'booking_id4'
+
 with_definitions = false
 
-result = booking_custom_attributes_api.list_booking_custom_attributes(booking_id: booking_id, with_definitions: with_definitions)
+
+result = booking_custom_attributes_api.list_booking_custom_attributes(
+  booking_id: booking_id,
+  with_definitions: with_definitions
+)
 
 if result.success?
   puts result.data
@@ -365,7 +398,7 @@ def delete_booking_custom_attribute(booking_id:,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). |
+| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
 | `key` | `String` | Template, Required | The key of the custom attribute to delete. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
 
 ## Response Type
@@ -376,9 +409,14 @@ def delete_booking_custom_attribute(booking_id:,
 
 ```ruby
 booking_id = 'booking_id4'
+
 key = 'key0'
 
-result = booking_custom_attributes_api.delete_booking_custom_attribute(booking_id: booking_id, key: key)
+
+result = booking_custom_attributes_api.delete_booking_custom_attribute(
+  booking_id: booking_id,
+  key: key
+)
 
 if result.success?
   puts result.data
@@ -406,9 +444,9 @@ def retrieve_booking_custom_attribute(booking_id:,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). |
+| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
 | `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
-| `with_definition` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) in the `definition` field of<br>the custom attribute. Set this parameter to `true` to get the name and description of the custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
+| `with_definition` | `TrueClass\|FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of<br>the custom attribute. Set this parameter to `true` to get the name and description of the custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
 | `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to<br>guarantee that you receive the most up-to-date data. When included in the request, Square<br>returns the specified version or a higher version if one exists. If the specified version is<br>higher than the current version, Square returns a `BAD_REQUEST` error. |
 
 ## Response Type
@@ -419,10 +457,17 @@ def retrieve_booking_custom_attribute(booking_id:,
 
 ```ruby
 booking_id = 'booking_id4'
+
 key = 'key0'
+
 with_definition = false
 
-result = booking_custom_attributes_api.retrieve_booking_custom_attribute(booking_id: booking_id, key: key, with_definition: with_definition, )
+
+result = booking_custom_attributes_api.retrieve_booking_custom_attribute(
+  booking_id: booking_id,
+  key: key,
+  with_definition: with_definition
+)
 
 if result.success?
   puts result.data
@@ -452,7 +497,7 @@ def upsert_booking_custom_attribute(booking_id:,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). |
+| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
 | `key` | `String` | Template, Required | The key of the custom attribute to create or update. This key must match the `key` of a<br>custom attribute definition in the Square seller account. If the requesting application is not<br>the definition owner, you must use the qualified key. |
 | `body` | [`Upsert Booking Custom Attribute Request Hash`](../../doc/models/upsert-booking-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
 
@@ -464,11 +509,19 @@ def upsert_booking_custom_attribute(booking_id:,
 
 ```ruby
 booking_id = 'booking_id4'
+
 key = 'key0'
-body = {}
-body[:custom_attribute] = {}
 
-result = booking_custom_attributes_api.upsert_booking_custom_attribute(booking_id: booking_id, key: key, body: body)
+body = {
+  :custom_attribute => {}
+}
+
+
+result = booking_custom_attributes_api.upsert_booking_custom_attribute(
+  booking_id: booking_id,
+  key: key,
+  body: body
+)
 
 if result.success?
   puts result.data