square.rb 44.0.1.20250820 → 44.2.0.20251016

data/lib/square/types/create_transfer_order_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Data for creating a new transfer order to move [CatalogItemVariation](entity:CatalogItemVariation)s
+    # between [Location](entity:Location)s. Used with the [CreateTransferOrder](api-endpoint:TransferOrders-CreateTransferOrder)
+    # endpoint.
+    class CreateTransferOrderData < Internal::Types::Model
+      field :source_location_id, -> { String }, optional: false, nullable: false
+      field :destination_location_id, -> { String }, optional: false, nullable: false
+      field :expected_at, -> { String }, optional: true, nullable: false
+      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::CreateTransferOrderLineData]
+      }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/create_transfer_order_line_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Data for creating a new transfer order line item. Each line item specifies a
+    # [CatalogItemVariation](entity:CatalogItemVariation) and quantity to transfer.
+    class CreateTransferOrderLineData < Internal::Types::Model
+      field :item_variation_id, -> { String }, optional: false, nullable: false
+      field :quantity_ordered, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/square/types/create_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for creating a transfer order.
+    class CreateTransferOrderResponse < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/delete_transfer_order_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for deleting a transfer order
+    class DeleteTransferOrderResponse < Internal::Types::Model
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/device_attributes.rb

@@ -3,7 +3,7 @@
 module Square
   module Types
     class DeviceAttributes < Internal::Types::Model
-      field :type, -> { String }, optional: false, nullable: false
+      field :type, -> { Square::Types::DeviceAttributesDeviceType }, optional: false, nullable: false
       field :manufacturer, -> { String }, optional: false, nullable: false
       field :model, -> { String }, optional: true, nullable: false
       field :name, -> { String }, optional: true, nullable: false

data/lib/square/types/device_attributes_device_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module DeviceAttributesDeviceType
+      extend Square::Internal::Types::Enum
+
+      TERMINAL = "TERMINAL"
+      HANDHELD = "HANDHELD"
+    end
+  end
+end

data/lib/square/types/device_component_details_ethernet_details.rb

@@ -5,6 +5,7 @@ module Square
     class DeviceComponentDetailsEthernetDetails < Internal::Types::Model
       field :active, -> { Internal::Types::Boolean }, optional: true, nullable: false
       field :ip_address_v_4, -> { String }, optional: true, nullable: false
+      field :mac_address, -> { String }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/device_component_details_wi_fi_details.rb

@@ -8,6 +8,7 @@ module Square
       field :ip_address_v_4, -> { String }, optional: true, nullable: false
       field :secure_connection, -> { String }, optional: true, nullable: false
       field :signal_strength, -> { Square::Types::DeviceComponentDetailsMeasurement }, optional: true, nullable: false
+      field :mac_address, -> { String }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/list_channels_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class ListChannelsResponse < Internal::Types::Model
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+      field :channels, -> { Internal::Types::Array[Square::Types::Channel] }, optional: true, nullable: false
+      field :cursor, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/receive_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for receiving items for a transfer order
+    class ReceiveTransferOrderResponse < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/reference.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class Reference < Internal::Types::Model
+      field :type, -> { Square::Types::ReferenceType }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/reference_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module ReferenceType
+      extend Square::Internal::Types::Enum
+
+      UNKNOWN_TYPE = "UNKNOWN_TYPE"
+      LOCATION = "LOCATION"
+      FIRST_PARTY_INTEGRATION = "FIRST_PARTY_INTEGRATION"
+      OAUTH_APPLICATION = "OAUTH_APPLICATION"
+      ONLINE_SITE = "ONLINE_SITE"
+      ONLINE_CHECKOUT = "ONLINE_CHECKOUT"
+      INVOICE = "INVOICE"
+      GIFT_CARD = "GIFT_CARD"
+      GIFT_CARD_MARKETPLACE = "GIFT_CARD_MARKETPLACE"
+      RECURRING_SUBSCRIPTION = "RECURRING_SUBSCRIPTION"
+      ONLINE_BOOKING_FLOW = "ONLINE_BOOKING_FLOW"
+      SQUARE_ASSISTANT = "SQUARE_ASSISTANT"
+      CASH_LOCAL = "CASH_LOCAL"
+      POINT_OF_SALE = "POINT_OF_SALE"
+      KIOSK = "KIOSK"
+    end
+  end
+end

data/lib/square/types/retrieve_channel_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class RetrieveChannelResponse < Internal::Types::Model
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+      field :channel, -> { Square::Types::Channel }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/retrieve_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response containing the requested transfer order
+    class RetrieveTransferOrderResponse < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/search_transfer_orders_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for searching transfer orders
+    class SearchTransferOrdersResponse < Internal::Types::Model
+      field :transfer_orders, lambda {
+        Internal::Types::Array[Square::Types::TransferOrder]
+      }, optional: true, nullable: false
+      field :cursor, -> { String }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/start_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for starting a transfer order.
+    class StartTransferOrderResponse < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/subscription.rb

@@ -26,6 +26,7 @@ module Square
       field :actions, -> { Internal::Types::Array[Square::Types::SubscriptionAction] }, optional: true, nullable: false
       field :monthly_billing_anchor_date, -> { Integer }, optional: true, nullable: false
       field :phases, -> { Internal::Types::Array[Square::Types::Phase] }, optional: true, nullable: false
+      field :completed_date, -> { String }, optional: true, nullable: false
     end
   end
 end

data/lib/square/types/subscription_action_type.rb

@@ -10,6 +10,7 @@ module Square
       RESUME = "RESUME"
       SWAP_PLAN = "SWAP_PLAN"
       CHANGE_BILLING_ANCHOR_DATE = "CHANGE_BILLING_ANCHOR_DATE"
+      COMPLETE = "COMPLETE"
     end
   end
 end

data/lib/square/types/subscription_status.rb

@@ -10,6 +10,7 @@ module Square
       CANCELED = "CANCELED"
       DEACTIVATED = "DEACTIVATED"
       PAUSED = "PAUSED"
+      COMPLETED = "COMPLETED"
     end
   end
 end

data/lib/square/types/transfer_order.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents a transfer order for moving [CatalogItemVariation](entity:CatalogItemVariation)s
+    # between [Location](entity:Location)s. Transfer orders track the entire lifecycle of an inventory
+    # transfer, including:
+    # - What items and quantities are being moved
+    # - Source and destination locations
+    # - Current [TransferOrderStatus](entity:TransferOrderStatus)
+    # - Shipping information and tracking
+    # - Which [TeamMember](entity:TeamMember) initiated the transfer
+    #
+    # This object is commonly used to:
+    # - Track [CatalogItemVariation](entity:CatalogItemVariation) movements between [Location](entity:Location)s
+    # - Reconcile expected vs received quantities
+    # - Monitor transfer progress and shipping status
+    # - Audit inventory movement history
+    class TransferOrder < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :source_location_id, -> { String }, optional: true, nullable: false
+      field :destination_location_id, -> { String }, optional: true, nullable: false
+      field :status, -> { Square::Types::TransferOrderStatus }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :updated_at, -> { String }, optional: true, nullable: false
+      field :expected_at, -> { String }, optional: true, nullable: false
+      field :completed_at, -> { String }, optional: true, nullable: false
+      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 :version, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_created_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Published when a transfer_order is created.
+    class TransferOrderCreatedEvent < Internal::Types::Model
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :type, -> { String }, optional: true, nullable: false
+      field :event_id, -> { String }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :data, -> { Square::Types::TransferOrderCreatedEventData }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_created_event_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class TransferOrderCreatedEventData < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+      field :object, -> { Square::Types::TransferOrderCreatedEventObject }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_created_event_object.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class TransferOrderCreatedEventObject < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_deleted_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Published when a transfer_order is deleted.
+    class TransferOrderDeletedEvent < Internal::Types::Model
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :type, -> { String }, optional: true, nullable: false
+      field :event_id, -> { String }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :data, -> { Square::Types::TransferOrderDeletedEventData }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_deleted_event_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class TransferOrderDeletedEventData < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+      field :deleted, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Filter criteria for searching transfer orders
+    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
+    end
+  end
+end

data/lib/square/types/transfer_order_goods_receipt.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # The goods receipt details for a transfer order. This object represents a single receipt
+    # of goods against a transfer order, tracking:
+    #
+    # - Which [CatalogItemVariation](entity:CatalogItemVariation)s were received
+    # - Quantities received in good condition
+    # - Quantities damaged during transit/handling
+    # - Quantities canceled during receipt
+    #
+    # Multiple goods receipts can be created for a single transfer order to handle:
+    # - Partial deliveries
+    # - Multiple shipments
+    # - Split receipts across different dates
+    # - Cancellations of specific quantities
+    #
+    # Each receipt automatically:
+    # - Updates the transfer order status
+    # - 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
+    end
+  end
+end

data/lib/square/types/transfer_order_goods_receipt_line_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # A simplified line item for goods receipts in transfer orders
+    class TransferOrderGoodsReceiptLineItem < Internal::Types::Model
+      field :transfer_order_line_uid, -> { String }, optional: false, nullable: false
+      field :quantity_received, -> { String }, optional: true, nullable: false
+      field :quantity_damaged, -> { String }, optional: true, nullable: false
+      field :quantity_canceled, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_line.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents a line item in a transfer order. Each line item tracks a specific
+    # [CatalogItemVariation](entity:CatalogItemVariation) being transferred, including ordered quantities
+    # and receipt status.
+    class TransferOrderLine < Internal::Types::Model
+      field :uid, -> { String }, optional: true, nullable: false
+      field :item_variation_id, -> { String }, optional: false, nullable: false
+      field :quantity_ordered, -> { String }, optional: false, nullable: false
+      field :quantity_pending, -> { String }, optional: true, nullable: false
+      field :quantity_received, -> { String }, optional: true, nullable: false
+      field :quantity_damaged, -> { String }, optional: true, nullable: false
+      field :quantity_canceled, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_query.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Query parameters for searching transfer orders
+    class TransferOrderQuery < Internal::Types::Model
+      field :filter, -> { Square::Types::TransferOrderFilter }, optional: true, nullable: false
+      field :sort, -> { Square::Types::TransferOrderSort }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_sort.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Sort configuration for search results
+    class TransferOrderSort < Internal::Types::Model
+      field :field, -> { Square::Types::TransferOrderSortField }, optional: true, nullable: false
+      field :order, -> { Square::Types::SortOrder }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_sort_field.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module TransferOrderSortField
+      extend Square::Internal::Types::Enum
+
+      CREATED_AT = "CREATED_AT"
+      UPDATED_AT = "UPDATED_AT"
+    end
+  end
+end

data/lib/square/types/transfer_order_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module TransferOrderStatus
+      extend Square::Internal::Types::Enum
+
+      DRAFT = "DRAFT"
+      STARTED = "STARTED"
+      PARTIALLY_RECEIVED = "PARTIALLY_RECEIVED"
+      COMPLETED = "COMPLETED"
+      CANCELED = "CANCELED"
+    end
+  end
+end

data/lib/square/types/transfer_order_updated_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Published when a transfer_order is updated.
+    class TransferOrderUpdatedEvent < Internal::Types::Model
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :type, -> { String }, optional: true, nullable: false
+      field :event_id, -> { String }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :data, -> { Square::Types::TransferOrderUpdatedEventData }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_updated_event_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class TransferOrderUpdatedEventData < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+      field :object, -> { Square::Types::TransferOrderUpdatedEventObject }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/transfer_order_updated_event_object.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class TransferOrderUpdatedEventObject < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/update_transfer_order_data.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Data model for updating a transfer order. All fields are optional.
+    class UpdateTransferOrderData < Internal::Types::Model
+      field :source_location_id, -> { String }, optional: true, nullable: false
+      field :destination_location_id, -> { String }, optional: true, nullable: false
+      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
+    end
+  end
+end

data/lib/square/types/update_transfer_order_line_data.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents a line item update in a transfer order
+    class UpdateTransferOrderLineData < Internal::Types::Model
+      field :uid, -> { String }, optional: true, nullable: false
+      field :item_variation_id, -> { String }, optional: true, nullable: false
+      field :quantity_ordered, -> { String }, optional: true, nullable: false
+      field :remove, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/update_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for updating a transfer order
+    class UpdateTransferOrderResponse < Internal::Types::Model
+      field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Square
-  VERSION = "44.0.1.20250820"
+  VERSION = "44.2.0.20251016"
 end