inttegro 5.0.0 → 6.0.0

data/lib/inttegro/balance_transaction/page.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "balance_transaction"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the page object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] size
+    #   Value of the `size` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] transactions
+    #   Newest transactions first. Omitted when the page is empty.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `transactions`.
+    #   @return [Array<Inttegro::BalanceTransaction>, nil]
+    class Page < T::Struct
+      const :number, Integer
+      const :size, Integer
+      const :transactions, T.nilable(T::Array[Inttegro::BalanceTransaction]), default: nil
+    end
+  end
+end

data/lib/inttegro/balance_transaction/page_request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the page request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] page_number
+    #   Page number to fetch. Use 1 for the first page; 0 is accepted but returns an empty page.
+    #
+    #   Required in the API payload. Wire name: `page_number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] page_size
+    #   Number of transactions per page (1-256)
+    #
+    #   Required in the API payload. Wire name: `page_size`.
+    #   @return [Integer]
+    class PageRequest < T::Struct
+      const :page_number, Integer
+      const :page_size, Integer
+    end
+  end
+end

data/lib/inttegro/balance_transaction/page_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "page"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the page response object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] page
+    #   Value of the `page` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `page`.
+    #   @return [Inttegro::BalanceTransaction::Page]
+    class PageResponse < T::Struct
+      const :page, Inttegro::BalanceTransaction::Page
+    end
+  end
+end

data/lib/inttegro/balance_transaction/payout_configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "payout_configuration_destination"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the payout configuration object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] enable_fx
+    #   Value of the `enable_fx` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `enable_fx`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] destination
+    #   Value of the `destination` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `destination`.
+    #   @return [Inttegro::BalanceTransaction::PayoutConfigurationDestination]
+    class PayoutConfiguration < T::Struct
+      const :enable_fx, T::Boolean
+      const :destination, Inttegro::BalanceTransaction::PayoutConfigurationDestination
+    end
+  end
+end

data/lib/inttegro/balance_transaction/payout_configuration_destination.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the payout configuration destination object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] financial_account_id
+    #   Value of the `financial_account_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `financial_account_id`.
+    #   @return [String]
+    class PayoutConfigurationDestination < T::Struct
+      const :financial_account_id, String
+    end
+  end
+end

data/lib/inttegro/balance_transaction/questions.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class BalanceTransaction
+    extend T::Sig
+
+    sig { returns(T.nilable(String)) }
+    # Return the resource identifier that originated this transaction when the source is unambiguous.
+    #
+    # Payment transactions return {#payment_id}; refund transactions return {#refund_id}. The
+    # method returns +nil+ when the matching identifier is absent, empty, or conflicts with the
+    # identifier for the other source type.
+    #
+    # @return [String, nil] payment or refund identifier associated with this transaction
+    def source_id
+      payment = payment_id
+      refund = refund_id
+      if type == Inttegro::BalanceTransaction::Type::PAYMENT && payment && !payment.empty? && refund.nil?
+        return payment
+      end
+      if type == Inttegro::BalanceTransaction::Type::REFUND && refund && !refund.empty? && payment.nil?
+        return refund
+      end
+
+      nil
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether this transaction identifies exactly one source matching {#type}.
+    #
+    # @return [Boolean] +true+ when {#source_id} can resolve the source
+    def valid_source?
+      !source_id.nil?
+    end
+
+    sig { returns(T::Boolean) }
+    # Check the minimum identity invariants needed to address this transaction.
+    #
+    # A valid transaction has non-empty transaction and order identifiers as well as an
+    # unambiguous source identifier. This is a local structural check; it does not contact the API.
+    #
+    # @return [Boolean] whether the transaction satisfies the local identity checks
+    def valid?
+      !id.empty? && !order_id.empty? && valid_source?
+    end
+  end
+end

data/lib/inttegro/balance_transaction/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "balance_transaction"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the response object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] transaction
+    #   Merchant balance entry caused by a payment or refund. `type` describes the semantic source,
+    #   not direction. A payment transaction contains `payment_id`; a refund transaction contains
+    #   `refund_id`. Exactly one matching reference is present.
+    #
+    #   Required in the API payload. Wire name: `transaction`.
+    #   @return [Inttegro::BalanceTransaction]
+    class Response < T::Struct
+      const :transaction, Inttegro::BalanceTransaction
+    end
+  end
+end

data/lib/inttegro/balance_transaction/type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Semantic source or cause of the transaction, not its direction.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class Type < T::Enum
+      enums do
+        # Serialized wire value: `payment`.
+        # @return [Inttegro::BalanceTransaction::Type]
+        PAYMENT = new("payment")
+        # Serialized wire value: `refund`.
+        # @return [Inttegro::BalanceTransaction::Type]
+        REFUND = new("refund")
+      end
+    end
+  end
+end

data/lib/inttegro/bank_account/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  # Namespace for generated bank account models and enums.
+  #
+  # Each public type in this namespace is defined in its own file and follows the field names
+  # and wire values declared by the Inttegro OpenAPI contract.
+  #
+  # @api public
+  module BankAccount
+  end
+end

data/lib/inttegro/bank_account/created.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../financial_account/created_owner"
+
+module Inttegro
+  module BankAccount
+    # Typed representation of the created object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] branch
+    #   Value of the `branch` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `branch`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] holder
+    #   Value of the `holder` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `holder`.
+    #   @return [Inttegro::FinancialAccount::CreatedOwner]
+    #
+    # @!attribute [r] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code
+    #   Value of the `sort_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] swift_code
+    #   Value of the `swift_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `swift_code`.
+    #   @return [String, nil]
+    class Created < T::Struct
+      const :branch, T.nilable(String), default: nil
+      const :holder, Inttegro::FinancialAccount::CreatedOwner
+      const :name, String
+      const :number, String
+      const :sort_code, T.nilable(String), default: nil
+      const :swift_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/bank_account/ghana_bank_account.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../financial_account/owner"
+
+module Inttegro
+  module BankAccount
+    # Typed representation of the ghana bank account object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] branch
+    #   Value of the `branch` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `branch`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] holder
+    #   Value of the `holder` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `holder`.
+    #   @return [Inttegro::FinancialAccount::Owner]
+    #
+    # @!attribute [r] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code
+    #   Value of the `sort_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] swift_code
+    #   Value of the `swift_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `swift_code`.
+    #   @return [String, nil]
+    class GhanaBankAccount < T::Struct
+      const :branch, T.nilable(String), default: nil
+      const :holder, Inttegro::FinancialAccount::Owner
+      const :name, T.nilable(String), default: nil
+      const :number, String
+      const :sort_code, T.nilable(String), default: nil
+      const :swift_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/bank_account/type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module BankAccount
+    # Bank account sub-type
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class Type < T::Enum
+      enums do
+        # Serialized wire value: `ghana_bank_account`.
+        # @return [Inttegro::BankAccount::Type]
+        GHANA_BANK_ACCOUNT = new("ghana_bank_account")
+      end
+    end
+  end
+end

data/lib/inttegro/bank_account/updated.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../financial_account/owner"
+
+module Inttegro
+  module BankAccount
+    # Typed representation of the updated object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] branch
+    #   Value of the `branch` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `branch`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] holder
+    #   Value of the `holder` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `holder`.
+    #   @return [Inttegro::FinancialAccount::Owner]
+    #
+    # @!attribute [r] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code
+    #   Value of the `sort_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] swift_code
+    #   Value of the `swift_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `swift_code`.
+    #   @return [String, nil]
+    class Updated < T::Struct
+      const :branch, T.nilable(String), default: nil
+      const :holder, Inttegro::FinancialAccount::Owner
+      const :name, String
+      const :number, String
+      const :sort_code, T.nilable(String), default: nil
+      const :swift_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  # Namespace for generated broadcast models and enums.
+  #
+  # Each public type in this namespace is defined in its own file and follows the field names
+  # and wire values declared by the Inttegro OpenAPI contract.
+  #
+  # @api public
+  module Broadcast
+  end
+end

data/lib/inttegro/broadcast/cancel_detail.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../chime/email_message"
+require_relative "error"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the cancel detail object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] chime_ids
+    #   Value of the `chime_ids` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `chime_ids`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] content
+    #   Value of the `content` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `content`.
+    #   @return [String]
+    #
+    # @!attribute [r] created_at
+    #   Value of the `created_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] customer_ids
+    #   Value of the `customer_ids` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_ids`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] email
+    #   Email content, safety scan result, and system-generated schema markup for email chimes.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::Chime::EmailMessage, nil]
+    #
+    # @!attribute [r] errors
+    #   Value of the `errors` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `errors`.
+    #   @return [Array<Inttegro::Broadcast::Error>, nil]
+    #
+    # @!attribute [r] executed_at
+    #   Value of the `executed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `executed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] idempotency_key
+    #   Value of the `idempotency_key` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] recipients
+    #   Value of the `recipients` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipients`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] send_after
+    #   Value of the `send_after` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `send_after`.
+    #   @return [Time]
+    #
+    # @!attribute [r] sender_id
+    #   Value of the `sender_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sender_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] canceled_at
+    #   Value of the `canceled_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `canceled_at`.
+    #   @return [Time, nil]
+    class CancelDetail < T::Struct
+      const :chime_ids, T.nilable(T::Array[String]), default: nil
+      const :content, String
+      const :created_at, Time
+      const :customer_ids, T.nilable(T::Array[String]), default: nil
+      const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
+      const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
+      const :executed_at, T.nilable(Time), default: nil
+      const :id, String
+      const :idempotency_key, T.nilable(String), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :recipients, T::Array[String]
+      const :send_after, Time
+      const :sender_id, String
+      const :canceled_at, T.nilable(Time), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/cancel_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the cancel request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] broadcast_id
+    #   Value of the `broadcast_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `broadcast_id`.
+    #   @return [String]
+    class CancelRequest < T::Struct
+      const :broadcast_id, String
+    end
+  end
+end