square.rb 44.0.1.20250820 → 44.2.0.20251016

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b7ba53660ef4f45bce2164d8fb018797c280503fa6c59b94f8a658c76eb912
-  data.tar.gz: 5f02ad617c72d33f32e16eb13adf4165204d1b8348b46ed91e29d7bb7616ad88
+  metadata.gz: fc644952318e3b6c73ba6051c84c8d48ba7b71159718d157d166a898aa7b8927
+  data.tar.gz: 9f826398732a94f77edc36321870fbc4c4fc7877e813e891c14d409ef5640879
 SHA512:
-  metadata.gz: 35e1648199a54c20bd6d800f34f1e9988d46032d65e9f246c26b7376dda89223501295351d4ae9e64c014a13945cd518f7cdcff74e6fb7c0088513108ad65c1e
-  data.tar.gz: 8bb6b4fd497f3e7e0c30851a59ccf03d58ae3383f3db9f6faee82b92650ec6eaaa2e2fccaf87d4b3d3ba4887a0424fef2752ce0785ce83ff7c8c0a30db4f63b6
+  metadata.gz: 77e474f38cc44948e191b349a687fb6b309fd722e2062d4d9932953246f6abeca552da862f8f810dd42231e9edbe240bb06e4f97b6674ff8578df11b760eb39e
+  data.tar.gz: 4bf717bfbe85b04e95160831c21c039bac603e4b5a02736c95169abdfa4fd34364502fcca1a33864c7b3f4ccdbf3d0cb5cb843d160ef5d83419dedfa5162f96e

data/lib/square/channels/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Square
+  module Channels
+    class Client
+      # @return [Square::Channels::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @return [Square::Types::ListChannelsResponse]
+      def list(request_options: {}, **params)
+        _query_param_names = [
+          %w[reference_type reference_id status cursor limit],
+          %i[reference_type reference_id status cursor limit]
+        ].flatten
+        _query = params.slice(*_query_param_names)
+        params.except(*_query_param_names)
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "GET",
+          path: "v2/channels",
+          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::ListChannelsResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # @return [Square::Types::BulkRetrieveChannelsResponse]
+      def bulk_retrieve(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/channels/bulk-retrieve",
+          body: params
+        )
+        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::BulkRetrieveChannelsResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # @return [Square::Types::RetrieveChannelResponse]
+      def get(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "GET",
+          path: "v2/channels/#{params[:channel_id]}"
+        )
+        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::RetrieveChannelResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/square/channels/types/bulk_retrieve_channels_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Channels
+    module Types
+      class BulkRetrieveChannelsRequest < Internal::Types::Model
+        field :channel_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/channels/types/get_channels_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Channels
+    module Types
+      class GetChannelsRequest < Internal::Types::Model
+        field :channel_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/channels/types/list_channels_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Channels
+    module Types
+      class ListChannelsRequest < Internal::Types::Model
+        field :reference_type, -> { Square::Types::ReferenceType }, optional: true, nullable: false
+        field :reference_id, -> { String }, optional: true, nullable: false
+        field :status, -> { Square::Types::ChannelStatus }, optional: true, nullable: false
+        field :cursor, -> { String }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/client.rb

@@ -7,7 +7,7 @@ module Square
       @raw_client = Square::Internal::Http::RawClient.new(
         base_url: base_url,
         headers: {
-          "User-Agent": "square.rb/44.0.1.20250820",
+          "User-Agent": "square.rb/44.2.0.20251016",
           "X-Fern-Language": "Ruby",
           Authorization: "Bearer #{token}"
         }
@@ -54,6 +54,11 @@ module Square
       @catalog ||= Square::Catalog::Client.new(client: @raw_client)
     end
 
+    # @return [Square::Channels::Client]
+    def channels
+      @channels ||= Square::Channels::Client.new(client: @raw_client)
+    end
+
     # @return [Square::Customers::Client]
     def customers
       @customers ||= Square::Customers::Client.new(client: @raw_client)
@@ -169,6 +174,11 @@ module Square
       @terminal ||= Square::Terminal::Client.new(client: @raw_client)
     end
 
+    # @return [Square::TransferOrders::Client]
+    def transfer_orders
+      @transfer_orders ||= Square::TransferOrders::Client.new(client: @raw_client)
+    end
+
     # @return [Square::Vendors::Client]
     def vendors
       @vendors ||= Square::Vendors::Client.new(client: @raw_client)

data/lib/square/loyalty/programs/promotions/types/cancel_promotions_request.rb

@@ -6,8 +6,8 @@ module Square
       module Promotions
         module Types
           class CancelPromotionsRequest < Internal::Types::Model
-            field :promotion_id, -> { String }, optional: false, nullable: false
             field :program_id, -> { String }, optional: false, nullable: false
+            field :promotion_id, -> { String }, optional: false, nullable: false
           end
         end
       end

data/lib/square/loyalty/programs/promotions/types/get_promotions_request.rb

@@ -6,8 +6,8 @@ module Square
       module Promotions
         module Types
           class GetPromotionsRequest < Internal::Types::Model
-            field :promotion_id, -> { String }, optional: false, nullable: false
             field :program_id, -> { String }, optional: false, nullable: false
+            field :promotion_id, -> { String }, optional: false, nullable: false
           end
         end
       end

data/lib/square/transfer_orders/client.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    class Client
+      # @return [Square::TransferOrders::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Creates a new transfer order in [DRAFT](entity:TransferOrderStatus) status. A transfer order represents the intent
+      # to move [CatalogItemVariation](entity:CatalogItemVariation)s from one [Location](entity:Location) to another.
+      # The source and destination locations must be different and must belong to your Square account.
+      #
+      # In [DRAFT](entity:TransferOrderStatus) status, you can:
+      # - Add or remove items
+      # - Modify quantities
+      # - Update shipping information
+      # - Delete the entire order via [DeleteTransferOrder](api-endpoint:TransferOrders-DeleteTransferOrder)
+      #
+      # The request requires source_location_id and destination_location_id.
+      # Inventory levels are not affected until the order is started via
+      # [StartTransferOrder](api-endpoint:TransferOrders-StartTransferOrder).
+      #
+      # Common integration points:
+      # - Sync with warehouse management systems
+      # - Automate regular stock transfers
+      # - Initialize transfers from inventory optimization systems
+      #
+      # Creates a [transfer_order.created](webhook:transfer_order.created) webhook event.
+      #
+      # @return [Square::Types::CreateTransferOrderResponse]
+      def create(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/transfer-orders",
+          body: params
+        )
+        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::CreateTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Searches for transfer orders using filters. Returns a paginated list of matching
+      # [TransferOrder](entity:TransferOrder)s sorted by creation date.
+      #
+      # Common search scenarios:
+      # - Find orders for a source [Location](entity:Location)
+      # - Find orders for a destination [Location](entity:Location)
+      # - Find orders in a particular [TransferOrderStatus](entity:TransferOrderStatus)
+      #
+      # @return [Square::Types::SearchTransferOrdersResponse]
+      def search(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/transfer-orders/search",
+          body: params
+        )
+        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::SearchTransferOrdersResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieves a specific [TransferOrder](entity:TransferOrder) by ID. Returns the complete
+      # order details including:
+      #
+      # - Basic information (status, dates, notes)
+      # - Line items with ordered and received quantities
+      # - Source and destination [Location](entity:Location)s
+      # - Tracking information (if available)
+      #
+      # @return [Square::Types::RetrieveTransferOrderResponse]
+      def get(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "GET",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}"
+        )
+        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::RetrieveTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Updates an existing transfer order. This endpoint supports sparse updates,
+      # allowing you to modify specific fields without affecting others.
+      #
+      # Creates a [transfer_order.updated](webhook:transfer_order.updated) webhook event.
+      #
+      # @return [Square::Types::UpdateTransferOrderResponse]
+      def update(request_options: {}, **params)
+        _path_param_names = ["transfer_order_id"]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "PUT",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}",
+          body: params.except(*_path_param_names)
+        )
+        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::UpdateTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Deletes a transfer order in [DRAFT](entity:TransferOrderStatus) status.
+      # Only draft orders can be deleted. Once an order is started via
+      # [StartTransferOrder](api-endpoint:TransferOrders-StartTransferOrder), it can no longer be deleted.
+      #
+      # Creates a [transfer_order.deleted](webhook:transfer_order.deleted) webhook event.
+      #
+      # @return [Square::Types::DeleteTransferOrderResponse]
+      def delete(request_options: {}, **params)
+        _query_param_names = [
+          ["version"],
+          %i[version]
+        ].flatten
+        _query = params.slice(*_query_param_names)
+        params = params.except(*_query_param_names)
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "DELETE",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}",
+          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::DeleteTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Cancels a transfer order in [STARTED](entity:TransferOrderStatus) or
+      # [PARTIALLY_RECEIVED](entity:TransferOrderStatus) status. Any unreceived quantities will no
+      # longer be receivable and will be immediately returned to the source [Location](entity:Location)'s inventory.
+      #
+      # Common reasons for cancellation:
+      # - Items no longer needed at destination
+      # - Source location needs the inventory
+      # - Order created in error
+      #
+      # Creates a [transfer_order.updated](webhook:transfer_order.updated) webhook event.
+      #
+      # @return [Square::Types::CancelTransferOrderResponse]
+      def cancel(request_options: {}, **params)
+        _path_param_names = ["transfer_order_id"]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}/cancel",
+          body: params.except(*_path_param_names)
+        )
+        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::CancelTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Records receipt of [CatalogItemVariation](entity:CatalogItemVariation)s for a transfer order.
+      # This endpoint supports partial receiving - you can receive items in multiple batches.
+      #
+      # For each line item, you can specify:
+      # - Quantity received in good condition (added to destination inventory with [InventoryState](entity:InventoryState) of IN_STOCK)
+      # - Quantity damaged during transit/handling (added to destination inventory with [InventoryState](entity:InventoryState) of WASTE)
+      # - Quantity canceled (returned to source location's inventory)
+      #
+      # The order must be in [STARTED](entity:TransferOrderStatus) or [PARTIALLY_RECEIVED](entity:TransferOrderStatus) status.
+      # Received quantities are added to the destination [Location](entity:Location)'s inventory according to their condition.
+      # Canceled quantities are immediately returned to the source [Location](entity:Location)'s inventory.
+      #
+      # When all items are either received, damaged, or canceled, the order moves to
+      # [COMPLETED](entity:TransferOrderStatus) status.
+      #
+      # Creates a [transfer_order.updated](webhook:transfer_order.updated) webhook event.
+      #
+      # @return [Square::Types::ReceiveTransferOrderResponse]
+      def receive(request_options: {}, **params)
+        _path_param_names = ["transfer_order_id"]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}/receive",
+          body: params.except(*_path_param_names)
+        )
+        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::ReceiveTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Changes a [DRAFT](entity:TransferOrderStatus) transfer order to [STARTED](entity:TransferOrderStatus) status.
+      # This decrements inventory at the source [Location](entity:Location) and marks it as in-transit.
+      #
+      # The order must be in [DRAFT](entity:TransferOrderStatus) status and have all required fields populated.
+      # Once started, the order can no longer be deleted, but it can be canceled via
+      # [CancelTransferOrder](api-endpoint:TransferOrders-CancelTransferOrder).
+      #
+      # Creates a [transfer_order.updated](webhook:transfer_order.updated) webhook event.
+      #
+      # @return [Square::Types::StartTransferOrderResponse]
+      def start(request_options: {}, **params)
+        _path_param_names = ["transfer_order_id"]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          method: "POST",
+          path: "v2/transfer-orders/#{params[:transfer_order_id]}/start",
+          body: params.except(*_path_param_names)
+        )
+        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::StartTransferOrderResponse.load(_response.body)
+        else
+          error_class = Square::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/cancel_transfer_order_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class CancelTransferOrderRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/create_transfer_order_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class CreateTransferOrderRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :transfer_order, -> { Square::Types::CreateTransferOrderData }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/delete_transfer_orders_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class DeleteTransferOrdersRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+        field :version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/get_transfer_orders_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class GetTransferOrdersRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/receive_transfer_order_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class ReceiveTransferOrderRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :receipt, -> { Square::Types::TransferOrderGoodsReceipt }, optional: false, nullable: false
+        field :version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/search_transfer_orders_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class SearchTransferOrdersRequest < Internal::Types::Model
+        field :query, -> { Square::Types::TransferOrderQuery }, optional: true, nullable: false
+        field :cursor, -> { String }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/start_transfer_order_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class StartTransferOrderRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/transfer_orders/types/update_transfer_order_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module TransferOrders
+    module Types
+      class UpdateTransferOrderRequest < Internal::Types::Model
+        field :transfer_order_id, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :transfer_order, -> { Square::Types::UpdateTransferOrderData }, optional: false, nullable: false
+        field :version, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/types/bulk_retrieve_channels_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Defines the fields that are included in the request body for the
+    # [BulkRetrieveChannels](api-endpoint:Channels-BulkRetrieveChannels) endpoint.
+    class BulkRetrieveChannelsResponse < Internal::Types::Model
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+      field :responses, lambda {
+        Internal::Types::Hash[String, Square::Types::RetrieveChannelResponse]
+      }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/cancel_transfer_order_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Response for canceling a transfer order
+    class CancelTransferOrderResponse < 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/channel.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class Channel < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :name, -> { String }, optional: true, nullable: false
+      field :version, -> { Integer }, optional: true, nullable: false
+      field :reference, -> { Square::Types::Reference }, optional: true, nullable: false
+      field :status, -> { Square::Types::ChannelStatus }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :updated_at, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/channel_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module ChannelStatus
+      extend Square::Internal::Types::Enum
+
+      ACTIVE = "ACTIVE"
+      INACTIVE = "INACTIVE"
+    end
+  end
+end