square.rb 44.1.0.20250924 → 45.0.1.20260122

data/lib/square/locations/client.rb

@@ -3,7 +3,9 @@
 module Square
   module Locations
     class Client
-      # @return [Square::Locations::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
@@ -11,24 +13,34 @@ module Square
       # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
       # including those with an inactive status. Locations are listed alphabetically by `name`.
       #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
       # @return [Square::Types::ListLocationsResponse]
-      def list(request_options: {}, **_params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+      def list(request_options: {}, **params)
+        Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "GET",
-          path: "v2/locations"
+          path: "v2/locations",
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::ListLocationsResponse.load(_response.body)
+          Square::Types::ListLocationsResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
@@ -40,75 +52,110 @@ module Square
       # are visible to the seller for their own management. Therefore, ensure that
       # each location has a sensible and unique name.
       #
+      # @param request_options [Hash]
+      # @param params [Square::Locations::Types::CreateLocationRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
       # @return [Square::Types::CreateLocationResponse]
       def create(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "POST",
           path: "v2/locations",
-          body: params
+          body: Square::Locations::Types::CreateLocationRequest.new(params).to_h,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::CreateLocationResponse.load(_response.body)
+          Square::Types::CreateLocationResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
       # Retrieves details of a single location. Specify "main"
-      # as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).
+      # as the location ID to retrieve details of the [main
+      # location](https://developer.squareup.com/docs/locations-api#about-the-main-location).
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :location_id
       #
       # @return [Square::Types::GetLocationResponse]
       def get(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "GET",
-          path: "v2/locations/#{params[:location_id]}"
+          path: "v2/locations/#{params[:location_id]}",
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::GetLocationResponse.load(_response.body)
+          Square::Types::GetLocationResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
       # Updates a [location](https://developer.squareup.com/docs/locations-api).
       #
+      # @param request_options [Hash]
+      # @param params [Square::Locations::Types::UpdateLocationRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :location_id
+      #
       # @return [Square::Types::UpdateLocationResponse]
       def update(request_options: {}, **params)
-        _path_param_names = ["location_id"]
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request_data = Square::Locations::Types::UpdateLocationRequest.new(params).to_h
+        non_body_param_names = ["location_id"]
+        body = request_data.except(*non_body_param_names)
 
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "PUT",
           path: "v2/locations/#{params[:location_id]}",
-          body: params.except(*_path_param_names)
+          body: body,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::UpdateLocationResponse.load(_response.body)
+          Square::Types::UpdateLocationResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 
@@ -118,29 +165,43 @@ module Square
       #
       #
       # NOTE: The Checkout API has been updated with new features.
-      # For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).
+      # For more information, see [Checkout API
+      # highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).
+      #
+      # @param request_options [Hash]
+      # @param params [Square::Locations::Types::CreateCheckoutRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :location_id
       #
       # @return [Square::Types::CreateCheckoutResponse]
       def checkouts(request_options: {}, **params)
-        _path_param_names = ["location_id"]
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request_data = Square::Locations::Types::CreateCheckoutRequest.new(params).to_h
+        non_body_param_names = ["location_id"]
+        body = request_data.except(*non_body_param_names)
 
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "POST",
           path: "v2/locations/#{params[:location_id]}/checkouts",
-          body: params.except(*_path_param_names)
+          body: body,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::CreateCheckoutResponse.load(_response.body)
+          Square::Types::CreateCheckoutResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 

data/lib/square/locations/custom_attribute_definitions/client.rb

@@ -4,46 +4,70 @@ module Square
   module Locations
     module CustomAttributeDefinitions
       class Client
-        # @return [Square::Locations::CustomAttributeDefinitions::Client]
+        # @param client [Square::Internal::Http::RawClient]
+        #
+        # @return [void]
         def initialize(client:)
           @client = client
         end
 
-        # Lists the location-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.
+        # Lists the location-related [custom attribute definitions](entity: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 request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [Square::Types::VisibilityFilter, nil] :visibility_filter
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :cursor
+        #
         # @return [Square::Types::ListLocationCustomAttributeDefinitionsResponse]
         def list(request_options: {}, **params)
-          _query_param_names = [
-            %w[visibility_filter limit cursor],
-            %i[visibility_filter limit cursor]
-          ].flatten
-          _query = params.slice(*_query_param_names)
-          params.except(*_query_param_names)
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          query_param_names = %i[visibility_filter limit cursor]
+          query_params = {}
+          query_params["visibility_filter"] = params[:visibility_filter] if params.key?(:visibility_filter)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+          params.except(*query_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-            method: "GET",
-            path: "v2/locations/custom-attribute-definitions",
-            query: _query
-          )
-          begin
-            _response = @client.send(_request)
-          rescue Net::HTTPRequestTimeout
-            raise Square::Errors::TimeoutError
-          end
-          code = _response.code.to_i
-          if code.between?(200, 299)
-            Square::Types::ListLocationCustomAttributeDefinitionsResponse.load(_response.body)
-          else
-            error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+          Square::Internal::CursorItemIterator.new(
+            cursor_field: :cursor,
+            item_field: :custom_attribute_definitions,
+            initial_cursor: query_params[:cursor]
+          ) do |next_cursor|
+            query_params[:cursor] = next_cursor
+            request = Square::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "GET",
+              path: "v2/locations/custom-attribute-definitions",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Square::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Square::Types::ListLocationCustomAttributeDefinitionsResponse.load(response.body)
+            else
+              error_class = Square::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
           end
         end
 
-        # Creates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.
+        # Creates a location-related [custom attribute definition](entity: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
@@ -51,113 +75,160 @@ module Square
         # [BulkUpsertLocationCustomAttributes](api-endpoint:LocationCustomAttributes-BulkUpsertLocationCustomAttributes)
         # to set the custom attribute for locations.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Locations::CustomAttributeDefinitions::Types::CreateLocationCustomAttributeDefinitionRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
         # @return [Square::Types::CreateLocationCustomAttributeDefinitionResponse]
         def create(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/locations/custom-attribute-definitions",
-            body: params
+            body: Square::Locations::CustomAttributeDefinitions::Types::CreateLocationCustomAttributeDefinitionRequest.new(params).to_h,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::CreateLocationCustomAttributeDefinitionResponse.load(_response.body)
+            Square::Types::CreateLocationCustomAttributeDefinitionResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
-        # Retrieves a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.
+        # Retrieves a location-related [custom attribute definition](entity: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 request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :key
+        # @option params [Integer, nil] :version
+        #
         # @return [Square::Types::RetrieveLocationCustomAttributeDefinitionResponse]
         def get(request_options: {}, **params)
-          _query_param_names = [
-            ["version"],
-            %i[version]
-          ].flatten
-          _query = params.slice(*_query_param_names)
-          params = params.except(*_query_param_names)
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          query_param_names = %i[version]
+          query_params = {}
+          query_params["version"] = params[:version] if params.key?(:version)
+          params = params.except(*query_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "GET",
             path: "v2/locations/custom-attribute-definitions/#{params[:key]}",
-            query: _query
+            query: query_params,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::RetrieveLocationCustomAttributeDefinitionResponse.load(_response.body)
+            Square::Types::RetrieveLocationCustomAttributeDefinitionResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
-        # Updates a location-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.
+        # Updates a location-related [custom attribute definition](entity: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 request_options [Hash]
+        # @param params [Square::Locations::CustomAttributeDefinitions::Types::UpdateLocationCustomAttributeDefinitionRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :key
+        #
         # @return [Square::Types::UpdateLocationCustomAttributeDefinitionResponse]
         def update(request_options: {}, **params)
-          _path_param_names = ["key"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Locations::CustomAttributeDefinitions::Types::UpdateLocationCustomAttributeDefinitionRequest.new(params).to_h
+          non_body_param_names = ["key"]
+          body = request_data.except(*non_body_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "PUT",
             path: "v2/locations/custom-attribute-definitions/#{params[:key]}",
-            body: params.except(*_path_param_names)
+            body: body,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::UpdateLocationCustomAttributeDefinitionResponse.load(_response.body)
+            Square::Types::UpdateLocationCustomAttributeDefinitionResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
-        # Deletes a location-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.
+        # Deletes a location-related [custom attribute definition](entity: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 request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :key
+        #
         # @return [Square::Types::DeleteLocationCustomAttributeDefinitionResponse]
         def delete(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "DELETE",
-            path: "v2/locations/custom-attribute-definitions/#{params[:key]}"
+            path: "v2/locations/custom-attribute-definitions/#{params[:key]}",
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::DeleteLocationCustomAttributeDefinitionResponse.load(_response.body)
+            Square::Types::DeleteLocationCustomAttributeDefinitionResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
       end

data/lib/square/locations/custom_attribute_definitions/types/create_location_custom_attribute_definition_request.rb

@@ -5,9 +5,7 @@ module Square
     module CustomAttributeDefinitions
       module Types
         class CreateLocationCustomAttributeDefinitionRequest < Internal::Types::Model
-          field :custom_attribute_definition, lambda {
-            Square::Types::CustomAttributeDefinition
-          }, optional: false, nullable: false
+          field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: false, nullable: false
           field :idempotency_key, -> { String }, optional: true, nullable: false
         end
       end

data/lib/square/locations/custom_attribute_definitions/types/update_location_custom_attribute_definition_request.rb

@@ -6,9 +6,7 @@ module Square
       module Types
         class UpdateLocationCustomAttributeDefinitionRequest < Internal::Types::Model
           field :key, -> { String }, optional: false, nullable: false
-          field :custom_attribute_definition, lambda {
-            Square::Types::CustomAttributeDefinition
-          }, optional: false, nullable: false
+          field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: false, nullable: false
           field :idempotency_key, -> { String }, optional: true, nullable: false
         end
       end