square.rb 25.0.0.20221116 → 26.1.0.20230119

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dc4e9fcd63b3813aa4ad5988917a80efbd309ea3b794f430c8b272936337c97
-  data.tar.gz: 403fdfd4137b70d63cc475967d937ec84022732b3b6a553b31320e700acfa7d9
+  metadata.gz: ac8d00e1d947c816019d207e36e19a85ef2f8d66e3b5c4295e3e19f6cfcd5af6
+  data.tar.gz: ba91ef39e6e11e16af9a859abe126cd8f25e0d0751a65a101e63dfb0bbbf4718
 SHA512:
-  metadata.gz: f4200d28c6187cc9c01c528a01626bf2d5e38288ef66100ad799a0948485af0ca2b5b3ace39d6b84cb3685abe45f2a5298e5e93392b1cb2b396b873a65fb3e73
-  data.tar.gz: 7e3f21e90b2e4609c48463883c9ec4fa6555d28b6eccc9e71a89879384de1d9635309a5bbe1c0c0e5b7661a2fffa4b6b95b6d1ab2700a6d7d19a2d66f9e7d1f9
+  metadata.gz: 23f2218d4d9757a648c69c5d6d21eb764f121695c6a11ac80607f24bb86301745f410b1103937ad49a157f150784ea1d396ea57393d0743c0742848b8beba0fa
+  data.tar.gz: fc4af83a8b04a151839c45f6f0c632f2b6b5b65abfcde66027d89714ac8566770b5f70407d021337d7cae3daa67957b06ca373eaf4b3b6791aef13ae1029ca87

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Square, Inc.
+Copyright 2023 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

data/lib/square/api/base_api.rb

@@ -45,7 +45,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/25.0.0.20221116 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/26.1.0.20230119 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/location_custom_attributes_api.rb

@@ -0,0 +1,584 @@
+module Square
+  # LocationCustomAttributesApi
+  class LocationCustomAttributesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists the location-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 [ListLocationCustomAttributeDefinitionsResponse Hash] response from the API call
+    def list_location_custom_attribute_definitions(visibility_filter: nil,
+                                                   limit: nil,
+                                                   cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attribute-definitions'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'visibility_filter' => visibility_filter,
+        'limit' => limit,
+        'cursor' => cursor
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Creates a location-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
+    # Use this endpoint to define a custom attribute that can be associated with
+    # locations.
+    # A custom attribute definition specifies the `key`, `visibility`, `schema`,
+    # and other properties
+    # for a custom attribute. After the definition is created, you can call
+    # [UpsertLocationCustomAttribute]($e/LocationCustomAttributes/UpsertLocation
+    # CustomAttribute) or
+    # [BulkUpsertLocationCustomAttributes]($e/LocationCustomAttributes/BulkUpser
+    # tLocationCustomAttributes)
+    # to set the custom attribute for locations.
+    # @param [CreateLocationCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [CreateLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    def create_location_custom_attribute_definition(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attribute-definitions'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deletes a location-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
+    # Deleting a custom attribute definition also deletes the corresponding
+    # custom attribute from
+    # all locations.
+    # 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 [DeleteLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    def delete_location_custom_attribute_definition(key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a location-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 [RetrieveLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    def retrieve_location_custom_attribute_definition(key:,
+                                                      version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Updates a location-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 [UpdateLocationCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    def update_location_custom_attribute_definition(key:,
+                                                    body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk
+    # operation.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [BulkDeleteLocationCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkDeleteLocationCustomAttributesResponse Hash] response from the API call
+    def bulk_delete_location_custom_attributes(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attributes/bulk-delete'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Creates or updates [custom attributes]($m/CustomAttribute) for locations
+    # as a bulk operation.
+    # Use this endpoint to set the value of one or more custom attributes for
+    # one or more locations.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which is
+    # created using the
+    # [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/Crea
+    # teLocationCustomAttributeDefinition) endpoint.
+    # This `BulkUpsertLocationCustomAttributes` 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 location 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 [BulkUpsertLocationCustomAttributesRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [BulkUpsertLocationCustomAttributesResponse Hash] response from the API call
+    def bulk_upsert_location_custom_attributes(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/custom-attributes/bulk-upsert'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Lists the [custom attributes]($m/CustomAttribute) associated with a
+    # location.
+    # 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] location_id Required parameter: The ID of the target
+    # [location]($m/Location).
+    # @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]($m/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 [ListLocationCustomAttributesResponse Hash] response from the API call
+    def list_location_custom_attributes(location_id:,
+                                        visibility_filter: nil,
+                                        limit: nil,
+                                        cursor: nil,
+                                        with_definitions: false)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/custom-attributes'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => { 'value' => location_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'visibility_filter' => visibility_filter,
+        'limit' => limit,
+        'cursor' => cursor,
+        'with_definitions' => with_definitions
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deletes a [custom attribute]($m/CustomAttribute) associated with a
+    # location.
+    # To delete a custom attribute owned by another application, the
+    # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] location_id Required parameter: The ID of the target
+    # [location]($m/Location).
+    # @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 [DeleteLocationCustomAttributeResponse Hash] response from the API call
+    def delete_location_custom_attribute(location_id:,
+                                         key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a [custom attribute]($m/CustomAttribute) associated with a
+    # location.
+    # 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] location_id Required parameter: The ID of the target
+    # [location]($m/Location).
+    # @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]($m/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 [RetrieveLocationCustomAttributeResponse Hash] response from the API call
+    def retrieve_location_custom_attribute(location_id:,
+                                           key:,
+                                           with_definition: false,
+                                           version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'with_definition' => with_definition,
+        'version' => version
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Creates or updates a [custom attribute]($m/CustomAttribute) for a
+    # location.
+    # Use this endpoint to set the value of a custom attribute for a specified
+    # location.
+    # A custom attribute is based on a custom attribute definition in a Square
+    # seller account, which
+    # is created using the
+    # [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/Crea
+    # teLocationCustomAttributeDefinition) endpoint.
+    # To create or update a custom attribute owned by another application, the
+    # `visibility` setting
+    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # @param [String] location_id Required parameter: The ID of the target
+    # [location]($m/Location).
+    # @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 [UpsertLocationCustomAttributeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpsertLocationCustomAttributeResponse Hash] response from the API call
+    def upsert_location_custom_attribute(location_id:,
+                                         key:,
+                                         body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/locations/{location_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+  end
+end

data/lib/square/api/o_auth_api.rb

@@ -168,5 +168,52 @@ module Square
         _response, data: decoded, errors: _errors
       )
     end
+
+    # Returns information about an [OAuth access
+    # token](https://developer.squareup.com/docs/build-basics/access-tokens#get-
+    # an-oauth-access-token) or an application’s [personal access
+    # token](https://developer.squareup.com/docs/build-basics/access-tokens#get-
+    # a-personal-access-token).
+    # Add the access token to the Authorization header of the request.
+    # __Important:__ The `Authorization` header you provide to this endpoint
+    # must have the following format:
+    # ```
+    # Authorization: Bearer ACCESS_TOKEN
+    # ```
+    # where `ACCESS_TOKEN` is a
+    # [valid production authorization
+    # credential](https://developer.squareup.com/docs/build-basics/access-tokens
+    # ).
+    # If the access token is expired or not a valid access token, the endpoint
+    # returns an `UNAUTHORIZED` error.
+    # @param [String] authorization Required parameter: Client
+    # APPLICATION_SECRET
+    # @return [RetrieveTokenStatusResponse Hash] response from the API call
+    def retrieve_token_status(authorization:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth2/token/status'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => authorization
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers
+      )
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
   end
 end

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '25.0.0.20221116'
+      '26.1.0.20230119'
     end
 
     def square_version
@@ -153,6 +153,12 @@ module Square
       @locations ||= LocationsApi.new config
     end
 
+    # Access to location_custom_attributes controller.
+    # @return [LocationCustomAttributesApi] Returns the controller instance.
+    def location_custom_attributes
+      @location_custom_attributes ||= LocationCustomAttributesApi.new config
+    end
+
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
@@ -254,7 +260,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-11-16', access_token: '',
+                   square_version: '2023-01-19', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -20,7 +20,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-11-16', access_token: '',
+                   square_version: '2023-01-19', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square/http/http_client.rb

@@ -106,7 +106,7 @@ module Square
     # @param [Hash, Optional] The context for the HTTP Request.
     def delete(query_url,
                headers: {},
-               parameters: {},
+               parameters: nil,
                context: {})
       HttpRequest.new(HttpMethodEnum::DELETE,
                       query_url,

data/lib/square.rb

@@ -54,6 +54,7 @@ require_relative 'square/api/inventory_api'
 require_relative 'square/api/invoices_api'
 require_relative 'square/api/labor_api'
 require_relative 'square/api/locations_api'
+require_relative 'square/api/location_custom_attributes_api'
 require_relative 'square/api/checkout_api'
 require_relative 'square/api/transactions_api'
 require_relative 'square/api/loyalty_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 25.0.0.20221116
+  version: 26.1.0.20230119
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -213,6 +213,7 @@ files:
 - lib/square/api/inventory_api.rb
 - lib/square/api/invoices_api.rb
 - lib/square/api/labor_api.rb
+- lib/square/api/location_custom_attributes_api.rb
 - lib/square/api/locations_api.rb
 - lib/square/api/loyalty_api.rb
 - lib/square/api/merchants_api.rb