square.rb 44.2.0.20251016 → 45.0.1.20260122

data/lib/square/types/terminal_refund.rb

@@ -2,7 +2,8 @@
 
 module Square
   module Types
-    # Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.
+    # Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network)
+    # payment refunds.
     class TerminalRefund < Internal::Types::Model
       field :id, -> { String }, optional: true, nullable: false
       field :refund_id, -> { String }, optional: true, nullable: false

data/lib/square/types/test_webhook_subscription_response.rb

@@ -2,14 +2,14 @@
 
 module Square
   module Types
-    # Defines the fields that are included in the response body of
-    # a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint.
-    #
-    # Note: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not
-    # present.
+    # Defines the fields that are included in the response body of a request to the TestWebhookSubscription endpoint.
     class TestWebhookSubscriptionResponse < Internal::Types::Model
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
       field :subscription_test_result, -> { Square::Types::SubscriptionTestResult }, optional: true, nullable: false
+      field :notification_url, -> { String }, optional: true, nullable: false
+      field :status_code, -> { Integer }, optional: true, nullable: false
+      field :passes_filter, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      field :payload, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/timecard_filter.rb

@@ -8,7 +8,7 @@ module Square
       field :location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
       field :status, -> { Square::Types::TimecardFilterStatus }, optional: true, nullable: false
       field :start, -> { Square::Types::TimeRange }, optional: true, nullable: false
-      field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false
+      field :end_, -> { Square::Types::TimeRange }, optional: true, nullable: false, api_name: "end"
       field :workday, -> { Square::Types::TimecardWorkday }, optional: true, nullable: false
       field :team_member_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
     end

data/lib/square/types/transfer_order.rb

@@ -28,9 +28,7 @@ module Square
       field :notes, -> { String }, optional: true, nullable: false
       field :tracking_number, -> { String }, optional: true, nullable: false
       field :created_by_team_member_id, -> { String }, optional: true, nullable: false
-      field :line_items, lambda {
-        Internal::Types::Array[Square::Types::TransferOrderLine]
-      }, optional: true, nullable: false
+      field :line_items, -> { Internal::Types::Array[Square::Types::TransferOrderLine] }, optional: true, nullable: false
       field :version, -> { Integer }, optional: true, nullable: false
     end
   end

data/lib/square/types/transfer_order_filter.rb

@@ -6,9 +6,7 @@ module Square
     class TransferOrderFilter < Internal::Types::Model
       field :source_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
       field :destination_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
-      field :statuses, lambda {
-        Internal::Types::Array[Square::Types::TransferOrderStatus]
-      }, optional: true, nullable: false
+      field :statuses, -> { Internal::Types::Array[Square::Types::TransferOrderStatus] }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/transfer_order_goods_receipt.rb

@@ -21,9 +21,7 @@ module Square
     # - Adjusts received quantities
     # - Updates inventory levels at both source and destination [Location](entity:Location)s
     class TransferOrderGoodsReceipt < Internal::Types::Model
-      field :line_items, lambda {
-        Internal::Types::Array[Square::Types::TransferOrderGoodsReceiptLineItem]
-      }, optional: true, nullable: false
+      field :line_items, -> { Internal::Types::Array[Square::Types::TransferOrderGoodsReceiptLineItem] }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/update_booking_custom_attribute_definition_response.rb

@@ -2,12 +2,12 @@
 
 module Square
   module Types
-    # Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition) response.
+    # Represents an
+    # [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpdateBookingCustomAttributeDefinitionResponse < Internal::Types::Model
-      field :custom_attribute_definition, lambda {
-        Square::Types::CustomAttributeDefinition
-      }, optional: true, nullable: false
+      field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
     end
   end

data/lib/square/types/update_customer_custom_attribute_definition_response.rb

@@ -2,12 +2,12 @@
 
 module Square
   module Types
-    # Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response.
+    # Represents an
+    # [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpdateCustomerCustomAttributeDefinitionResponse < Internal::Types::Model
-      field :custom_attribute_definition, lambda {
-        Square::Types::CustomAttributeDefinition
-      }, optional: true, nullable: false
+      field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
     end
   end

data/lib/square/types/update_location_custom_attribute_definition_response.rb

@@ -2,12 +2,12 @@
 
 module Square
   module Types
-    # Represents an [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition) response.
+    # Represents an
+    # [UpdateLocationCustomAttributeDefinition](api-endpoint:LocationCustomAttributes-UpdateLocationCustomAttributeDefinition)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpdateLocationCustomAttributeDefinitionResponse < Internal::Types::Model
-      field :custom_attribute_definition, lambda {
-        Square::Types::CustomAttributeDefinition
-      }, optional: true, nullable: false
+      field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
     end
   end

data/lib/square/types/update_merchant_custom_attribute_definition_response.rb

@@ -2,12 +2,12 @@
 
 module Square
   module Types
-    # Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) response.
+    # Represents an
+    # [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpdateMerchantCustomAttributeDefinitionResponse < Internal::Types::Model
-      field :custom_attribute_definition, lambda {
-        Square::Types::CustomAttributeDefinition
-      }, optional: true, nullable: false
+      field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
     end
   end

data/lib/square/types/update_order_custom_attribute_definition_response.rb

@@ -4,9 +4,7 @@ module Square
   module Types
     # Represents a response from updating an order custom attribute definition.
     class UpdateOrderCustomAttributeDefinitionResponse < Internal::Types::Model
-      field :custom_attribute_definition, lambda {
-        Square::Types::CustomAttributeDefinition
-      }, optional: true, nullable: false
+      field :custom_attribute_definition, -> { Square::Types::CustomAttributeDefinition }, optional: true, nullable: false
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
     end
   end

data/lib/square/types/update_transfer_order_data.rb

@@ -9,9 +9,7 @@ module Square
       field :expected_at, -> { String }, optional: true, nullable: false
       field :notes, -> { String }, optional: true, nullable: false
       field :tracking_number, -> { String }, optional: true, nullable: false
-      field :line_items, lambda {
-        Internal::Types::Array[Square::Types::UpdateTransferOrderLineData]
-      }, optional: true, nullable: false
+      field :line_items, -> { Internal::Types::Array[Square::Types::UpdateTransferOrderLineData] }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/update_webhook_subscription_response.rb

@@ -3,7 +3,8 @@
 module Square
   module Types
     # Defines the fields that are included in the response body of
-    # a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) endpoint.
+    # a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription)
+    # endpoint.
     #
     # Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not
     # present.

data/lib/square/types/update_webhook_subscription_signature_key_response.rb

@@ -3,7 +3,9 @@
 module Square
   module Types
     # Defines the fields that are included in the response body of
-    # a request to the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) endpoint.
+    # a request to the
+    # [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey)
+    # endpoint.
     #
     # Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not
     # present.

data/lib/square/types/upsert_booking_custom_attribute_response.rb

@@ -2,7 +2,8 @@
 
 module Square
   module Types
-    # Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response.
+    # Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpsertBookingCustomAttributeResponse < Internal::Types::Model
       field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: true, nullable: false

data/lib/square/types/upsert_catalog_object_response.rb

@@ -5,9 +5,7 @@ module Square
     class UpsertCatalogObjectResponse < Internal::Types::Model
       field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
       field :catalog_object, -> { Square::Types::CatalogObject }, optional: true, nullable: false
-      field :id_mappings, lambda {
-        Internal::Types::Array[Square::Types::CatalogIdMapping]
-      }, optional: true, nullable: false
+      field :id_mappings, -> { Internal::Types::Array[Square::Types::CatalogIdMapping] }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/upsert_customer_custom_attribute_response.rb

@@ -2,7 +2,8 @@
 
 module Square
   module Types
-    # Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) response.
+    # Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpsertCustomerCustomAttributeResponse < Internal::Types::Model
       field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: true, nullable: false

data/lib/square/types/upsert_location_custom_attribute_response.rb

@@ -2,7 +2,8 @@
 
 module Square
   module Types
-    # Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute) response.
+    # Represents an [UpsertLocationCustomAttribute](api-endpoint:LocationCustomAttributes-UpsertLocationCustomAttribute)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpsertLocationCustomAttributeResponse < Internal::Types::Model
       field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: true, nullable: false

data/lib/square/types/upsert_merchant_custom_attribute_response.rb

@@ -2,7 +2,8 @@
 
 module Square
   module Types
-    # Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) response.
+    # Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute)
+    # response.
     # Either `custom_attribute_definition` or `errors` is present in the response.
     class UpsertMerchantCustomAttributeResponse < Internal::Types::Model
       field :custom_attribute, -> { Square::Types::CustomAttribute }, optional: true, nullable: false

data/lib/square/types/v_1_get_payment_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1GetPaymentRequest
+      # V1GetPaymentRequest is an alias for Object
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/square/types/v_1_get_settlement_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1GetSettlementRequest
+      # V1GetSettlementRequest is an alias for Object
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/square/types/v_1_order.rb

@@ -25,9 +25,7 @@ module Square
       field :refunded_note, -> { String }, optional: true, nullable: false
       field :canceled_note, -> { String }, optional: true, nullable: false
       field :tender, -> { Square::Types::V1Tender }, optional: true, nullable: false
-      field :order_history, lambda {
-        Internal::Types::Array[Square::Types::V1OrderHistoryEntry]
-      }, optional: true, nullable: false
+      field :order_history, -> { Internal::Types::Array[Square::Types::V1OrderHistoryEntry] }, optional: true, nullable: false
       field :promo_code, -> { String }, optional: true, nullable: false
       field :btc_receive_address, -> { String }, optional: true, nullable: false
       field :btc_price_satoshi, -> { Integer }, optional: true, nullable: false

data/lib/square/types/vendor_created_event_object_operation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module VendorCreatedEventObjectOperation
+      # VendorCreatedEventObjectOperation is an alias for Object
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/square/types/vendor_updated_event_object_operation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module VendorUpdatedEventObjectOperation
+      # VendorUpdatedEventObjectOperation is an alias for Object
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/square/types/wage_setting.rb

@@ -6,9 +6,7 @@ module Square
     # for a [team member](entity:TeamMember).
     class WageSetting < Internal::Types::Model
       field :team_member_id, -> { String }, optional: true, nullable: false
-      field :job_assignments, lambda {
-        Internal::Types::Array[Square::Types::JobAssignment]
-      }, optional: true, nullable: false
+      field :job_assignments, -> { Internal::Types::Array[Square::Types::JobAssignment] }, optional: true, nullable: false
       field :is_overtime_exempt, -> { Internal::Types::Boolean }, optional: true, nullable: false
       field :version, -> { Integer }, optional: true, nullable: false
       field :created_at, -> { String }, optional: true, nullable: false

data/lib/square/v_1_transactions/client.rb

@@ -3,86 +3,129 @@
 module Square
   module V1Transactions
     class Client
-      # @return [Square::V1Transactions::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
 
       # Provides summary information for a merchant's online store orders.
       #
+      # @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
+      # @option params [Square::Types::SortOrder, nil] :order
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :batch_token
+      #
       # @return [Array[Square::Types::V1Order]]
       def v_1_list_orders(request_options: {}, **params)
-        _query_param_names = [
-          %w[order limit batch_token],
-          %i[order limit batch_token]
-        ].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[order limit batch_token]
+        query_params = {}
+        query_params["order"] = params[:order] if params.key?(:order)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["batch_token"] = params[:batch_token] if params.key?(:batch_token)
+        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: "v1/#{params[:location_id]}/orders",
-          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
         return if code.between?(200, 299)
 
         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
 
       # Provides comprehensive information for a single online store order, including the order's history.
       #
+      # @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
+      # @option params [String] :order_id
+      #
       # @return [Square::Types::V1Order]
       def v_1_retrieve_order(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: "v1/#{params[:location_id]}/orders/#{params[:order_id]}"
+          path: "v1/#{params[:location_id]}/orders/#{params[:order_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::V1Order.load(_response.body)
+          Square::Types::V1Order.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 the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+      # Updates the details of an online store order. Every update you perform on an order corresponds to one of three
+      # actions:
+      #
+      # @param request_options [Hash]
+      # @param params [Square::V1Transactions::Types::V1UpdateOrderRequest]
+      # @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
+      # @option params [String] :order_id
       #
       # @return [Square::Types::V1Order]
       def v_1_update_order(request_options: {}, **params)
-        _path_param_names = %w[location_id order_id]
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request_data = Square::V1Transactions::Types::V1UpdateOrderRequest.new(params).to_h
+        non_body_param_names = %w[location_id order_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: "v1/#{params[:location_id]}/orders/#{params[:order_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::V1Order.load(_response.body)
+          Square::Types::V1Order.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