square.rb 27.0.0.20230419 → 29.0.0.20230608

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdabb66c5a5371d040a4be402521d22cbbae8048a8a454d86de0d3ac139efd73
-  data.tar.gz: cd7609d304a6ff18b1fb32ae192389f0aaec364f8f0af3f3befa192b3141e4be
+  metadata.gz: 6f8d15edb9a8dd68b46a879c0afacf648c322c9e31373fce770c109b4dfae6b6
+  data.tar.gz: 892d648f4b7bfe44d6fb162e13d544867df6a8b6e3b173f5ca516ca78aa3e3e4
 SHA512:
-  metadata.gz: 8400694e8fe8d5c33cf5825cddeb92a1965abf7f9441df640ef0fbeff21ab700a006c349d9449a86f4c7b39a8be4e37815c18159d3de093a6a4196335ee7f843
-  data.tar.gz: c7ebf17f937a606f6ac3b82a46a532015340e8b906fa1908cfc615e1f46527491f1853b0e6d66d054634a294312385befee3ea482c67dd025400d034ea0db36c
+  metadata.gz: 0b83f14d0f0291d461b694c853e38bad88b508a1bbab94df7faac7a550ddd99e499bba08882b4ce82a194eefeae64b5515481a708c6194dfcefa40c2b85eb98e
+  data.tar.gz: 169dc96d375401735be90799acb4b08e96199286a4ec89395015edfcc28736bde58e8e4ed41e784d97e8e5652287a6e96ffd0cc0e6aa8515eebe0fcaf988cb72

data/lib/square/api/base_api.rb

@@ -4,7 +4,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/27.0.0.20230419 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/29.0.0.20230608 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/invoices_api.rb

@@ -9,8 +9,8 @@ module Square
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint.  Provide this cursor to retrieve the
     # next set of results for your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The maximum number of invoices
     # to return (200 is the maximum `limit`).  If not provided, the server uses
     # a default limit of 100 invoices.

data/lib/square/api/merchant_custom_attributes_api.rb

@@ -0,0 +1,419 @@
+module Square
+  # MerchantCustomAttributesApi
+  class MerchantCustomAttributesApi < BaseApi
+    # Lists the merchant-related [custom attribute
+    # definitions]($m/CustomAttributeDefinition) that belong to a Square seller
+    # account.
+    # When all response pages are retrieved, the results include all custom
+    # attribute definitions
+    # that are visible to the requesting application, including those that are
+    # created by other
+    # applications and set to `VISIBILITY_READ_ONLY` or
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [VisibilityFilter] visibility_filter Optional parameter: Filters
+    # the `CustomAttributeDefinition` results by their `visibility` values.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ListMerchantCustomAttributeDefinitionsResponse Hash] response from the API call
+    def list_merchant_custom_attribute_definitions(visibility_filter: nil,
+                                                   limit: nil,
+                                                   cursor: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/custom-attribute-definitions',
+                                     'default')
+                   .query_param(new_parameter(visibility_filter, key: 'visibility_filter'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
+    # Use this endpoint to define a custom attribute that can be associated with
+    # a merchant connecting to your application.
+    # A custom attribute definition specifies the `key`, `visibility`, `schema`,
+    # and other properties
+    # for a custom attribute. After the definition is created, you can call
+    # [UpsertMerchantCustomAttribute]($e/MerchantCustomAttributes/UpsertMerchant
+    # CustomAttribute) or
+    # [BulkUpsertMerchantCustomAttributes]($e/MerchantCustomAttributes/BulkUpser
+    # tMerchantCustomAttributes)
+    # to set the custom attribute for a merchant.
+    # @param [CreateMerchantCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [CreateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def create_merchant_custom_attribute_definition(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attribute-definitions',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
+    # Deleting a custom attribute definition also deletes the corresponding
+    # custom attribute from
+    # the merchant.
+    # Only the definition owner can delete a custom attribute definition.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to delete.
+    # @return [DeleteMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def delete_merchant_custom_attribute_definition(key:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
+    # To retrieve a custom attribute definition created by another application,
+    # the `visibility`
+    # setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to retrieve. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute definition, which is used for strongly consistent reads
+    # to guarantee that you receive the most up-to-date data. When included in
+    # the request, Square returns the specified version or a higher version if
+    # one exists. If the specified version is higher than the current version,
+    # Square returns a `BAD_REQUEST` error.
+    # @return [RetrieveMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def retrieve_merchant_custom_attribute_definition(key:,
+                                                      version: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Updates a merchant-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
+    # Use this endpoint to update the following fields: `name`, `description`,
+    # `visibility`, or the
+    # `schema` for a `Selection` data type.
+    # Only the definition owner can update a custom attribute definition.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to update.
+    # @param [UpdateMerchantCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    def update_merchant_custom_attribute_definition(key:,
+                                                    body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v2/merchants/custom-attribute-definitions/{key}',
+                                     'default')
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk
+    # operation.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkDeleteMerchantCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkDeleteMerchantCustomAttributesResponse Hash] response from the API call
+    def bulk_delete_merchant_custom_attributes(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attributes/bulk-delete',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates or updates [custom attributes]($m/CustomAttribute) for a merchant
+    # as a bulk operation.
+    # Use this endpoint to set the value of one or more custom attributes for a
+    # merchant.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which is
+    # created using the
+    # [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/Crea
+    # teMerchantCustomAttributeDefinition) endpoint.
+    # This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to
+    # 25 individual upsert
+    # requests and returns a map of individual upsert responses. Each upsert
+    # request has a unique ID
+    # and provides a merchant ID and custom attribute. Each upsert response is
+    # returned with the ID
+    # of the corresponding request.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkUpsertMerchantCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkUpsertMerchantCustomAttributesResponse Hash] response from the API call
+    def bulk_upsert_merchant_custom_attributes(body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/custom-attributes/bulk-upsert',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Lists the [custom attributes]($m/CustomAttribute) associated with a
+    # merchant.
+    # You can use the `with_definitions` query parameter to also retrieve custom
+    # attribute definitions
+    # in the same call.
+    # When all response pages are retrieved, the results include all custom
+    # attributes that are
+    # visible to the requesting application, including those that are owned by
+    # other applications
+    # and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [VisibilityFilter] visibility_filter Optional parameter: Filters
+    # the `CustomAttributeDefinition` results by their `visibility` values.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition](entity:CustomAttributeDefinition) in the `definition` field of
+    # each custom attribute. Set this parameter to `true` to get the name and
+    # description of each custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
+    # @return [ListMerchantCustomAttributesResponse Hash] response from the API call
+    def list_merchant_custom_attributes(merchant_id:,
+                                        visibility_filter: nil,
+                                        limit: nil,
+                                        cursor: nil,
+                                        with_definitions: false)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/{merchant_id}/custom-attributes',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(visibility_filter, key: 'visibility_filter'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(with_definitions, key: 'with_definitions'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Deletes a [custom attribute]($m/CustomAttribute) associated with a
+    # merchant.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # delete. This key must match the `key` of a custom attribute definition in
+    # the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @return [DeleteMerchantCustomAttributeResponse Hash] response from the API call
+    def delete_merchant_custom_attribute(merchant_id:,
+                                         key:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Retrieves a [custom attribute]($m/CustomAttribute) associated with a
+    # merchant.
+    # You can use the `with_definition` query parameter to also retrieve the
+    # custom attribute definition
+    # in the same call.
+    # To retrieve a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # retrieve. This key must match the `key` of a custom attribute definition
+    # in the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition](entity:CustomAttributeDefinition) in the `definition` field of
+    # the custom attribute. Set this parameter to `true` to get the name and
+    # description of the custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute, which is used for strongly consistent reads to guarantee
+    # that you receive the most up-to-date data. When included in the request,
+    # Square returns the specified version or a higher version if one exists. If
+    # the specified version is higher than the current version, Square returns a
+    # `BAD_REQUEST` error.
+    # @return [RetrieveMerchantCustomAttributeResponse Hash] response from the API call
+    def retrieve_merchant_custom_attribute(merchant_id:,
+                                           key:,
+                                           with_definition: false,
+                                           version: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .query_param(new_parameter(with_definition, key: 'with_definition'))
+                   .query_param(new_parameter(version, key: 'version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Creates or updates a [custom attribute]($m/CustomAttribute) for a
+    # merchant.
+    # Use this endpoint to set the value of a custom attribute for a specified
+    # merchant.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which
+    # is created using the
+    # [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/Crea
+    # teMerchantCustomAttributeDefinition) endpoint.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] merchant_id Required parameter: The ID of the target
+    # [merchant](entity:Merchant).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # create or update. This key must match the `key` of a custom attribute
+    # definition in the Square seller account. If the requesting application is
+    # not the definition owner, you must use the qualified key.
+    # @param [UpsertMerchantCustomAttributeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpsertMerchantCustomAttributeResponse Hash] response from the API call
+    def upsert_merchant_custom_attribute(merchant_id:,
+                                         key:,
+                                         body:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/merchants/{merchant_id}/custom-attributes/{key}',
+                                     'default')
+                   .template_param(new_parameter(merchant_id, key: 'merchant_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(key, key: 'key')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+  end
+end

data/lib/square/api/o_auth_api.rb

@@ -20,10 +20,10 @@ module Square
     # Authorization: Client APPLICATION_SECRET
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the
-    # Credentials
+    # **Credentials**
     # page in the [Developer Dashboard](https://developer.squareup.com/apps).
     # @param [String] client_id Required parameter: Your application ID, which
-    # is available in the OAuth page in the [Developer
+    # is available on the **OAuth** page in the [Developer
     # Dashboard](https://developer.squareup.com/apps).
     # @param [RenewTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
@@ -65,8 +65,8 @@ module Square
     # ```
     # Authorization: Client APPLICATION_SECRET
     # ```
-    # Replace `APPLICATION_SECRET` with the application secret on the OAuth
-    # page for your application on the Developer Dashboard.
+    # Replace `APPLICATION_SECRET` with the application secret on the **OAuth**
+    # page for your application in the Developer Dashboard.
     # @param [RevokeTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -97,7 +97,7 @@ module Square
     # The `grant_type` parameter specifies the type of OAuth request. If
     # `grant_type` is `authorization_code`, you must include the authorization
     # code you received when a seller granted you authorization. If `grant_type`
-    # is `refresh_token`, you must provide a valid refresh token. If you are
+    # is `refresh_token`, you must provide a valid refresh token. If you're
     # using
     # an old version of the Square APIs (prior to March 13, 2019), `grant_type`
     # can be `migration_token` and you must provide a valid migration token.

data/lib/square/api/subscriptions_api.rb

@@ -1,13 +1,16 @@
 module Square
   # SubscriptionsApi
   class SubscriptionsApi < BaseApi
-    # Creates a subscription to a subscription plan by a customer.
+    # Enrolls a customer in a subscription.
     # If you provide a card on file in the request, Square charges the card for
-    # the subscription. Otherwise, Square bills an invoice to the customer's
+    # the subscription. Otherwise, Square sends an invoice to the customer's
     # email
     # address. The subscription starts immediately, unless the request includes
     # the optional `start_date`. Each individual subscription is associated with
     # a particular location.
+    # For more information, see [Create a
+    # subscription](https://developer.squareup.com/docs/subscriptions-api/manage
+    # -subscriptions#create-a-subscription).
     # @param [CreateSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -42,10 +45,6 @@ module Square
     # If the request specifies customer IDs, the endpoint orders results
     # first by location, within location by customer ID, and within
     # customer by subscription creation date.
-    # For more information, see
-    # [Retrieve
-    # subscriptions](https://developer.squareup.com/docs/subscriptions-api/overv
-    # iew#retrieve-subscriptions).
     # @param [SearchSubscriptionsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -67,7 +66,7 @@ module Square
         .execute
     end
 
-    # Retrieves a subscription.
+    # Retrieves a specific subscription.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve.
     # @param [String] include Optional parameter: A query parameter to specify
@@ -93,8 +92,9 @@ module Square
         .execute
     end
 
-    # Updates a subscription. You can set, modify, and clear the
-    # `subscription` field values.
+    # Updates a subscription by modifying or clearing `subscription` field
+    # values.
+    # To clear a field, set its value to `null`.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to update.
     # @param [UpdateSubscriptionRequest] body Required parameter: An object
@@ -146,11 +146,10 @@ module Square
         .execute
     end
 
-    # Schedules a `CANCEL` action to cancel an active subscription
-    # by setting the `canceled_date` field to the end of the active billing
-    # period
-    # and changing the subscription status from ACTIVE to CANCELED after this
-    # date.
+    # Schedules a `CANCEL` action to cancel an active subscription. This
+    # sets the `canceled_date` field to the end of the active billing period.
+    # After this date,
+    # the subscription status changes from ACTIVE to CANCELED.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to cancel.
     # @return [CancelSubscriptionResponse Hash] response from the API call
@@ -170,7 +169,9 @@ module Square
         .execute
     end
 
-    # Lists all events for a specific subscription.
+    # Lists all
+    # [events](https://developer.squareup.com/docs/subscriptions-api/actions-eve
+    # nts) for a specific subscription.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve the events for.
     # @param [String] cursor Optional parameter: When the total number of
@@ -178,8 +179,8 @@ module Square
     # specify the cursor returned from a preceding response here to fetch the
     # next set of results. If the cursor is unset, the response contains the
     # last page of the results.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The upper limit on the number
     # of subscription events to return in a paged response.
     # @return [ListSubscriptionEventsResponse Hash] response from the API call
@@ -258,8 +259,11 @@ module Square
         .execute
     end
 
-    # Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing
-    # subscription.
+    # Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an
+    # existing subscription.
+    # For more information, see [Swap Subscription Plan
+    # Variations](https://developer.squareup.com/docs/subscriptions-api/swap-pla
+    # n-variations).
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to swap the subscription plan for.
     # @param [SwapPlanRequest] body Required parameter: An object containing the

data/lib/square/api/terminal_api.rb

@@ -50,7 +50,7 @@ module Square
     # Retrieves a Terminal action request by `action_id`. Terminal action
     # requests are available for 30 days.
     # @param [String] action_id Required parameter: Unique ID for the desired
-    # `TerminalAction`
+    # `TerminalAction`.
     # @return [GetTerminalActionResponse Hash] response from the API call
     def get_terminal_action(action_id:)
       new_api_call_builder
@@ -70,7 +70,7 @@ module Square
 
     # Cancels a Terminal action request if the status of the request permits it.
     # @param [String] action_id Required parameter: Unique ID for the desired
-    # `TerminalAction`
+    # `TerminalAction`.
     # @return [CancelTerminalActionResponse Hash] response from the API call
     def cancel_terminal_action(action_id:)
       new_api_call_builder
@@ -88,6 +88,30 @@ module Square
         .execute
     end
 
+    # Dismisses a Terminal action request if the status and type of the request
+    # permits it.
+    # See [Link and Dismiss
+    # Actions](https://developer.squareup.com/docs/terminal-api/advanced-feature
+    # s/custom-workflows/link-and-dismiss-actions) for more details.
+    # @param [String] action_id Required parameter: Unique ID for the
+    # `TerminalAction` associated with the waiting dialog to be dismissed.
+    # @return [DismissTerminalActionResponse Hash] response from the API call
+    def dismiss_terminal_action(action_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/terminals/actions/{action_id}/dismiss',
+                                     'default')
+                   .template_param(new_parameter(action_id, key: 'action_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Creates a Terminal checkout request and sends it to the specified device
     # to take a payment
     # for the requested amount.

data/lib/square/api/webhook_subscriptions_api.rb

@@ -25,8 +25,8 @@ module Square
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # .
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [TrueClass|FalseClass] include_disabled Optional parameter:
     # Includes disabled [Subscription](entity:WebhookSubscription)s. By default,
     # all enabled [Subscription](entity:WebhookSubscription)s are returned.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '27.0.0.20230419'
+      '29.0.0.20230608'
     end
 
     def square_version
@@ -183,6 +183,12 @@ module Square
       @merchants ||= MerchantsApi.new @global_configuration
     end
 
+    # Access to merchant_custom_attributes controller.
+    # @return [MerchantCustomAttributesApi] Returns the controller instance.
+    def merchant_custom_attributes
+      @merchant_custom_attributes ||= MerchantCustomAttributesApi.new @global_configuration
+    end
+
     # Access to orders controller.
     # @return [OrdersApi] Returns the controller instance.
     def orders
@@ -261,7 +267,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-04-19', user_agent_detail: '',
+                   square_version: '2023-06-08', user_agent_detail: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -19,7 +19,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-04-19', user_agent_detail: '',
+                   square_version: '2023-06-08', user_agent_detail: '',
                    additional_headers: {})
 
       super connection: connection, adapter: adapter, timeout: timeout,

data/lib/square.rb

@@ -59,6 +59,7 @@ require_relative 'square/api/checkout_api'
 require_relative 'square/api/transactions_api'
 require_relative 'square/api/loyalty_api'
 require_relative 'square/api/merchants_api'
+require_relative 'square/api/merchant_custom_attributes_api'
 require_relative 'square/api/orders_api'
 require_relative 'square/api/order_custom_attributes_api'
 require_relative 'square/api/payments_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 27.0.0.20230419
+  version: 29.0.0.20230608
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -120,6 +120,7 @@ files:
 - lib/square/api/location_custom_attributes_api.rb
 - lib/square/api/locations_api.rb
 - lib/square/api/loyalty_api.rb
+- lib/square/api/merchant_custom_attributes_api.rb
 - lib/square/api/merchants_api.rb
 - lib/square/api/mobile_authorization_api.rb
 - lib/square/api/o_auth_api.rb