square.rb 43.0.0.20250618 → 44.0.0.0

data/lib/square/types/v_1_tender.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # A tender represents a discrete monetary exchange. Square represents this
+    # exchange as a money object with a specific currency and amount, where the
+    # amount is given in the smallest denomination of the given currency.
+    #
+    # Square POS can accept more than one form of tender for a single payment (such
+    # as by splitting a bill between a credit card and a gift card). The `tender`
+    # field of the Payment object lists all forms of tender used for the payment.
+    #
+    # Split tender payments behave slightly differently from single tender payments:
+    #
+    # The receipt_url for a split tender corresponds only to the first tender listed
+    # in the tender field. To get the receipt URLs for the remaining tenders, use
+    # the receipt_url fields of the corresponding Tender objects.
+    #
+    # *A note on gift cards**: when a customer purchases a Square gift card from a
+    # merchant, the merchant receives the full amount of the gift card in the
+    # associated payment.
+    #
+    # When that gift card is used as a tender, the balance of the gift card is
+    # reduced and the merchant receives no funds. A `Tender` object with a type of
+    # `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the
+    # associated payment.
+    class V1Tender < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :type, -> { Square::Types::V1TenderType }, optional: true, nullable: false
+      field :name, -> { String }, optional: true, nullable: false
+      field :employee_id, -> { String }, optional: true, nullable: false
+      field :receipt_url, -> { String }, optional: true, nullable: false
+      field :card_brand, -> { Square::Types::V1TenderCardBrand }, optional: true, nullable: false
+      field :pan_suffix, -> { String }, optional: true, nullable: false
+      field :entry_method, -> { Square::Types::V1TenderEntryMethod }, optional: true, nullable: false
+      field :payment_note, -> { String }, optional: true, nullable: false
+      field :total_money, -> { Square::Types::V1Money }, optional: true, nullable: false
+      field :tendered_money, -> { Square::Types::V1Money }, optional: true, nullable: false
+      field :tendered_at, -> { String }, optional: true, nullable: false
+      field :settled_at, -> { String }, optional: true, nullable: false
+      field :change_back_money, -> { Square::Types::V1Money }, optional: true, nullable: false
+      field :refunded_money, -> { Square::Types::V1Money }, optional: true, nullable: false
+      field :is_exchange, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/v_1_tender_card_brand.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1TenderCardBrand
+      extend Square::Internal::Types::Enum
+
+      OTHER_BRAND = "OTHER_BRAND"
+      VISA = "VISA"
+      MASTER_CARD = "MASTER_CARD"
+      AMERICAN_EXPRESS = "AMERICAN_EXPRESS"
+      DISCOVER = "DISCOVER"
+      DISCOVER_DINERS = "DISCOVER_DINERS"
+      JCB = "JCB"
+      CHINA_UNIONPAY = "CHINA_UNIONPAY"
+      SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD"end
+  end
+end

data/lib/square/types/v_1_tender_entry_method.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1TenderEntryMethod
+      extend Square::Internal::Types::Enum
+
+      MANUAL = "MANUAL"
+      SCANNED = "SCANNED"
+      SQUARE_CASH = "SQUARE_CASH"
+      SQUARE_WALLET = "SQUARE_WALLET"
+      SWIPED = "SWIPED"
+      WEB_FORM = "WEB_FORM"
+      OTHER = "OTHER"end
+  end
+end

data/lib/square/types/v_1_tender_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1TenderType
+      extend Square::Internal::Types::Enum
+
+      CREDIT_CARD = "CREDIT_CARD"
+      CASH = "CASH"
+      THIRD_PARTY_CARD = "THIRD_PARTY_CARD"
+      NO_SALE = "NO_SALE"
+      SQUARE_WALLET = "SQUARE_WALLET"
+      SQUARE_GIFT_CARD = "SQUARE_GIFT_CARD"
+      UNKNOWN = "UNKNOWN"
+      OTHER = "OTHER"end
+  end
+end

data/lib/square/types/v_1_update_order_request_action.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module V1UpdateOrderRequestAction
+      extend Square::Internal::Types::Enum
+
+      COMPLETE = "COMPLETE"
+      CANCEL = "CANCEL"
+      REFUND = "REFUND"end
+  end
+end

data/lib/square/types/vendor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents a supplier to a seller.
+    class Vendor < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :created_at, -> { String }, optional: true, nullable: false
+      field :updated_at, -> { String }, optional: true, nullable: false
+      field :name, -> { String }, optional: true, nullable: false
+      field :address, -> { Square::Types::Address }, optional: true, nullable: false
+      field :contacts, -> { Internal::Types::Array[Square::Types::VendorContact] }, optional: true, nullable: false
+      field :account_number, -> { String }, optional: true, nullable: false
+      field :note, -> { String }, optional: true, nullable: false
+      field :version, -> { Integer }, optional: true, nullable: false
+      field :status, -> { Square::Types::VendorStatus }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_contact.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents a contact of a [Vendor](entity:Vendor).
+    class VendorContact < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :name, -> { String }, optional: true, nullable: false
+      field :email_address, -> { String }, optional: true, nullable: false
+      field :phone_number, -> { String }, optional: true, nullable: false
+      field :removed, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      field :ordinal, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_created_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Published when a [Vendor](entity:Vendor) is created.
+    class VendorCreatedEvent < Internal::Types::Model
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :location_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::VendorCreatedEventData }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_created_event_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Defines the `vendor.created` event data structure.
+    class VendorCreatedEventData < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+      field :object, -> { Square::Types::VendorCreatedEventObject }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_created_event_object.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class VendorCreatedEventObject < Internal::Types::Model
+      field :operation, -> { String }, optional: true, nullable: false
+      field :vendor, -> { Square::Types::Vendor }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_status.rb

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

data/lib/square/types/vendor_updated_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Published when a [Vendor](entity:Vendor) is updated.
+    class VendorUpdatedEvent < Internal::Types::Model
+      field :merchant_id, -> { String }, optional: true, nullable: false
+      field :location_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::VendorUpdatedEventData }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_updated_event_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Defines the `vendor.updated` event data structure.
+    class VendorUpdatedEventData < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+      field :id, -> { String }, optional: true, nullable: false
+      field :object, -> { Square::Types::VendorUpdatedEventObject }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/vendor_updated_event_object.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    class VendorUpdatedEventObject < Internal::Types::Model
+      field :operation, -> { String }, optional: true, nullable: false
+      field :vendor, -> { Square::Types::Vendor }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/visibility_filter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module VisibilityFilter
+      extend Square::Internal::Types::Enum
+
+      ALL = "ALL"
+      READ = "READ"
+      READ_WRITE = "READ_WRITE"end
+  end
+end

data/lib/square/types/void_transaction_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Defines the fields that are included in the response body of
+    # a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint.
+    class VoidTransactionResponse < Internal::Types::Model
+      field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/wage_setting.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents information about the overtime exemption status, job assignments, and compensation
+    # 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 :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
+      field :updated_at, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/square/types/webhook_subscription.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Represents the details of a webhook subscription, including notification URL,
+    # event types, and signature key.
+    class WebhookSubscription < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :name, -> { String }, optional: true, nullable: false
+      field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      field :event_types, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+      field :notification_url, -> { String }, optional: true, nullable: false
+      field :api_version, -> { String }, optional: true, nullable: false
+      field :signature_key, -> { String }, 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/weekday.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    module Weekday
+      extend Square::Internal::Types::Enum
+
+      MON = "MON"
+      TUE = "TUE"
+      WED = "WED"
+      THU = "THU"
+      FRI = "FRI"
+      SAT = "SAT"
+      SUN = "SUN"end
+  end
+end

data/lib/square/types/workweek_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Square
+  module Types
+    # Sets the day of the week and hour of the day that a business starts a
+    # workweek. This is used to calculate overtime pay.
+    class WorkweekConfig < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+      field :start_of_week, -> { Square::Types::Weekday }, optional: false, nullable: false
+      field :start_of_day_local_time, -> { String }, optional: false, nullable: false
+      field :version, -> { Integer }, 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/v_1_transactions/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Square
+  module V1Transactions
+    class Client
+      # @return [Square::V1Transactions::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Provides summary information for a merchant's online store orders.
+      #
+      # @return [Array[Square::Types::V1Order]]
+      def v_1_list_orders(request_options: {}, **params)
+        _query_param_names = %w[order limit batch_token]
+        _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::SANDBOX,
+          method: "GET",
+          path: "v1/#{params[:location_id]}/orders",
+          query: _query
+        )
+        _response = @client.send(_request)
+        return if _response.code >= "200" && _response.code < "300"
+
+        raise _response.body
+      end
+
+      # Provides comprehensive information for a single online store order, including the order's history.
+      #
+      # @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::SANDBOX,
+          method: "GET",
+          path: "v1/#{params[:location_id]}/orders/#{params[:order_id]}"
+        )
+        _response = @client.send(_request)
+        return Square::Types::V1Order.load(_response.body) if _response.code >= "200" && _response.code < "300"
+
+        raise _response.body
+      end
+
+      # Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
+      #
+      # @return [Square::Types::V1Order]
+      def v_1_update_order(request_options: {}, **params)
+        _path_param_names = %w[location_id order_id]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "PUT",
+          path: "v1/#{params[:location_id]}/orders/#{params[:order_id]}",
+          body: params.except(*_path_param_names)
+        )
+        _response = @client.send(_request)
+        return Square::Types::V1Order.load(_response.body) if _response.code >= "200" && _response.code < "300"
+
+        raise _response.body
+      end
+    end
+  end
+end

data/lib/square/v_1_transactions/types/v_1_list_orders_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Square
+  module V1Transactions
+    module Types
+      class V1ListOrdersRequest < Internal::Types::Model
+        field :location_id, -> { String }, optional: false, nullable: false
+        field :order, -> { Square::Types::SortOrder }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :batch_token, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/v_1_transactions/types/v_1_retrieve_order_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module V1Transactions
+    module Types
+      class V1RetrieveOrderRequest < Internal::Types::Model
+        field :location_id, -> { String }, optional: false, nullable: false
+        field :order_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/v_1_transactions/types/v_1_update_order_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Square
+  module V1Transactions
+    module Types
+      class V1UpdateOrderRequest < Internal::Types::Model
+        field :location_id, -> { String }, optional: false, nullable: false
+        field :order_id, -> { String }, optional: false, nullable: false
+        field :action, -> { Square::Types::V1UpdateOrderRequestAction }, optional: false, nullable: false
+        field :shipped_tracking_number, -> { String }, optional: true, nullable: false
+        field :completed_note, -> { String }, optional: true, nullable: false
+        field :refunded_note, -> { String }, optional: true, nullable: false
+        field :canceled_note, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/square/vendors/client.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Square
+  module Vendors
+    class Client
+      # @return [Square::Vendors::Client]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Creates one or more [Vendor](entity:Vendor) objects to represent suppliers to a seller.
+      #
+      # @return [Square::Types::BatchCreateVendorsResponse]
+      def batch_create(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/vendors/bulk-create",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::BatchCreateVendorsResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Retrieves one or more vendors of specified [Vendor](entity:Vendor) IDs.
+      #
+      # @return [Square::Types::BatchGetVendorsResponse]
+      def batch_get(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/vendors/bulk-retrieve",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::BatchGetVendorsResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Updates one or more of existing [Vendor](entity:Vendor) objects as suppliers to a seller.
+      #
+      # @return [Square::Types::BatchUpdateVendorsResponse]
+      def batch_update(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "PUT",
+          path: "v2/vendors/bulk-update",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::BatchUpdateVendorsResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Creates a single [Vendor](entity:Vendor) object to represent a supplier to a seller.
+      #
+      # @return [Square::Types::CreateVendorResponse]
+      def create(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/vendors/create",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::CreateVendorResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter.
+      #
+      # @return [Square::Types::SearchVendorsResponse]
+      def search(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "POST",
+          path: "v2/vendors/search",
+          body: params
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::SearchVendorsResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Retrieves the vendor of a specified [Vendor](entity:Vendor) ID.
+      #
+      # @return [Square::Types::GetVendorResponse]
+      def get(request_options: {}, **params)
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "GET",
+          path: "v2/vendors/#{params[:vendor_id]}"
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::GetVendorResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+
+      # Updates an existing [Vendor](entity:Vendor) object as a supplier to a seller.
+      #
+      # @return [Square::Types::UpdateVendorResponse]
+      def update(request_options: {}, **params)
+        _path_param_names = ["vendor_id"]
+
+        _request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Square::Environment::SANDBOX,
+          method: "PUT",
+          path: "v2/vendors/#{params[:vendor_id]}",
+          body: params.except(*_path_param_names)
+        )
+        _response = @client.send(_request)
+        if _response.code >= "200" && _response.code < "300"
+          return Square::Types::UpdateVendorResponse.load(_response.body)
+        end
+
+        raise _response.body
+      end
+    end
+  end
+end

data/lib/square/vendors/types/batch_create_vendors_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Square
+  module Vendors
+    module Types
+      class BatchCreateVendorsRequest < Internal::Types::Model
+        field :vendors, -> { Internal::Types::Hash[String, Square::Types::Vendor] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/vendors/types/batch_get_vendors_request.rb

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

data/lib/square/vendors/types/batch_update_vendors_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Square
+  module Vendors
+    module Types
+      class BatchUpdateVendorsRequest < Internal::Types::Model
+        field :vendors, lambda {
+          Internal::Types::Hash[String, Square::Types::UpdateVendorRequest]
+        }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/square/vendors/types/create_vendor_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Square
+  module Vendors
+    module Types
+      class CreateVendorRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+        field :vendor, -> { Square::Types::Vendor }, optional: true, nullable: false
+      end
+    end
+  end
+end