inttegro 5.0.0 → 6.0.1

data/lib/inttegro/payment/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 Payment
+    # Payout configuration for this payment
+    #
+    # 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
+    #   Compatibility flag. Cross-currency payout execution is not currently available.
+    #
+    #   Required in the API payload. Wire name: `enable_fx`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] destination
+    #   Where the funds will be paid out
+    #
+    #   Required in the API payload. Wire name: `destination`.
+    #   @return [Inttegro::Payment::PayoutConfigurationDestination]
+    class PayoutConfiguration < T::Struct
+      const :enable_fx, T::Boolean
+      const :destination, Inttegro::Payment::PayoutConfigurationDestination
+    end
+  end
+end

data/lib/inttegro/payment/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 Payment
+    # Where the funds will be paid out
+    #
+    # 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
+    #   ID of the financial account receiving the payout
+    #
+    #   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/payment/questions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class Payment
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    # Determine whether the payment status is +Status::PAID+.
+    #
+    # @return [Boolean] whether the payment is paid
+    def paid?
+      status == Inttegro::Payment::Status::PAID
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the payment is waiting for customer or merchant action.
+    #
+    # @return [Boolean] whether the status is +Status::REQUIRES_ACTION+
+    def requires_action?
+      status == Inttegro::Payment::Status::REQUIRES_ACTION
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the payment has reached an end state.
+    #
+    # Paid, canceled, expired, and failed payments are terminal according to this local predicate.
+    #
+    # @return [Boolean] whether the current status is terminal
+    def terminal?
+      [
+        Inttegro::Payment::Status::PAID,
+        Inttegro::Payment::Status::CANCELED,
+        Inttegro::Payment::Status::EXPIRED,
+        Inttegro::Payment::Status::FAILED
+      ].include?(status)
+    end
+
+    sig { returns(T.nilable(Inttegro::Payment::NextAction)) }
+    # Return the next action only when the payment currently requires action.
+    #
+    # @return [Inttegro::Payment::NextAction, nil] next action, or +nil+ for every other status
+    def required_action
+      requires_action? ? next_action : nil
+    end
+  end
+end

data/lib/inttegro/payment/result.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "result_status"
+
+module Inttegro
+  class Payment
+    # Response after initiating payment
+    #
+    # 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] payment_id
+    #   Unique identifier for the payment
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] order_id
+    #   Associated order ID
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `order_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] status
+    #   Payment status
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `status`.
+    #   @return [Inttegro::Payment::ResultStatus, nil]
+    #
+    # @!attribute [r] requires_confirmation
+    #   Whether payment requires token confirmation
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `requires_confirmation`.
+    #   @return [Boolean, nil]
+    #
+    # @!attribute [r] confirmation_sent
+    #   Whether confirmation token was sent to customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `confirmation_sent`.
+    #   @return [Boolean, nil]
+    class Result < T::Struct
+      const :payment_id, T.nilable(String), default: nil
+      const :order_id, T.nilable(String), default: nil
+      const :status, T.nilable(Inttegro::Payment::ResultStatus), default: nil
+      const :requires_confirmation, T.nilable(T::Boolean), default: nil
+      const :confirmation_sent, T.nilable(T::Boolean), default: nil
+    end
+  end
+end

data/lib/inttegro/payment/result_status.rb

@@ -0,0 +1,36 @@
+# 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 Payment
+    # Payment status
+    #
+    # 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 ResultStatus < T::Enum
+      enums do
+        # Serialized wire value: `pending`.
+        # @return [Inttegro::Payment::ResultStatus]
+        PENDING = new("pending")
+        # Serialized wire value: `requires_confirmation`.
+        # @return [Inttegro::Payment::ResultStatus]
+        REQUIRES_CONFIRMATION = new("requires_confirmation")
+        # Serialized wire value: `processing`.
+        # @return [Inttegro::Payment::ResultStatus]
+        PROCESSING = new("processing")
+        # Serialized wire value: `succeeded`.
+        # @return [Inttegro::Payment::ResultStatus]
+        SUCCEEDED = new("succeeded")
+        # Serialized wire value: `failed`.
+        # @return [Inttegro::Payment::ResultStatus]
+        FAILED = new("failed")
+      end
+    end
+  end
+end

data/lib/inttegro/payment/status.rb

@@ -0,0 +1,48 @@
+# 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 Payment
+    # Payment state
+    #
+    # 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 Status < T::Enum
+      enums do
+        # Serialized wire value: `initiated`.
+        # @return [Inttegro::Payment::Status]
+        INITIATED = new("initiated")
+        # Serialized wire value: `requires_action`.
+        # @return [Inttegro::Payment::Status]
+        REQUIRES_ACTION = new("requires_action")
+        # Serialized wire value: `overdue`.
+        # @return [Inttegro::Payment::Status]
+        OVERDUE = new("overdue")
+        # Serialized wire value: `executed`.
+        # @return [Inttegro::Payment::Status]
+        EXECUTED = new("executed")
+        # Serialized wire value: `paid`.
+        # @return [Inttegro::Payment::Status]
+        PAID = new("paid")
+        # Serialized wire value: `canceled`.
+        # @return [Inttegro::Payment::Status]
+        CANCELED = new("canceled")
+        # Serialized wire value: `expired`.
+        # @return [Inttegro::Payment::Status]
+        EXPIRED = new("expired")
+        # Serialized wire value: `failed`.
+        # @return [Inttegro::Payment::Status]
+        FAILED = new("failed")
+        # Serialized wire value: `unknown`.
+        # @return [Inttegro::Payment::Status]
+        UNKNOWN = new("unknown")
+      end
+    end
+  end
+end

data/lib/inttegro/payment_method/activate_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
+  class PaymentMethod
+    # Typed representation of the activate 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] payment_method_id
+    #   ID of the payment method to activate
+    #
+    #   Required in the API payload. Wire name: `payment_method_id`.
+    #   @return [String]
+    class ActivateRequest < T::Struct
+      const :payment_method_id, String
+    end
+  end
+end

data/lib/inttegro/payment_method/activate_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 "payment_method"
+
+module Inttegro
+  class PaymentMethod
+    # Typed representation of the activate 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] payment_method
+    #   A tokenized payment instrument tied to a customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method`.
+    #   @return [Inttegro::PaymentMethod, nil]
+    class ActivateResponse < T::Struct
+      const :payment_method, T.nilable(Inttegro::PaymentMethod), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/archive_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
+  class PaymentMethod
+    # Typed representation of the archive 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] payment_method_id
+    #   ID of the payment method to archive
+    #
+    #   Required in the API payload. Wire name: `payment_method_id`.
+    #   @return [String]
+    class ArchiveRequest < T::Struct
+      const :payment_method_id, String
+    end
+  end
+end

data/lib/inttegro/payment_method/archive_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 "payment_method"
+
+module Inttegro
+  class PaymentMethod
+    # Typed representation of the archive 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] payment_method
+    #   A tokenized payment instrument tied to a customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method`.
+    #   @return [Inttegro::PaymentMethod, nil]
+    class ArchiveResponse < T::Struct
+      const :payment_method, T.nilable(Inttegro::PaymentMethod), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/bank_account.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../bank_account/type"
+require_relative "bank_account_ghana_bank_account"
+
+module Inttegro
+  class PaymentMethod
+    # Bank account details (present when type is bank_account)
+    #
+    # 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] ghana_bank_account
+    #   Ghana bank account details
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `ghana_bank_account`.
+    #   @return [Inttegro::PaymentMethod::BankAccountGhanaBankAccount, nil]
+    #
+    # @!attribute [r] type
+    #   Bank account sub-type
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::BankAccount::Type]
+    class BankAccount < T::Struct
+      const :ghana_bank_account, T.nilable(Inttegro::PaymentMethod::BankAccountGhanaBankAccount), default: nil
+      const :type, Inttegro::BankAccount::Type
+    end
+  end
+end

data/lib/inttegro/payment_method/bank_account_ghana_bank_account.rb

@@ -0,0 +1,55 @@
+# 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 PaymentMethod
+    # Ghana bank account details
+    #
+    # 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
+    #   Branch name
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `branch`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] name
+    #   Account holder name
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] account_number
+    #   Account number
+    #
+    #   Required in the API payload. Wire name: `account_number`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code
+    #   Bank sort code
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] swift_code
+    #   SWIFT/BIC code
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `swift_code`.
+    #   @return [String, nil]
+    class BankAccountGhanaBankAccount < T::Struct
+      const :branch, T.nilable(String), default: nil
+      const :name, T.nilable(String), default: nil
+      const :account_number, String
+      const :sort_code, T.nilable(String), default: nil
+      const :swift_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  class PaymentMethod < T::Struct
+  end
+end

data/lib/inttegro/payment_method/card.rb

@@ -0,0 +1,21 @@
+# 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 PaymentMethod
+    # Card marker. Nested card credentials are not returned.
+    #
+    # 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
+    class Card < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/payment_method/data.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "data_mobile_money"
+require_relative "data_type"
+
+module Inttegro
+  class PaymentMethod
+    # Payment instrument details for tokenization
+    #
+    # 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] type
+    #   Payment rail type (currently only mobile_money supported)
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::PaymentMethod::DataType]
+    #
+    # @!attribute [r] mobile_money
+    #   Mobile money wallet details (required when type is mobile_money)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `mobile_money`.
+    #   @return [Inttegro::PaymentMethod::DataMobileMoney, nil]
+    class Data < T::Struct
+      const :type, Inttegro::PaymentMethod::DataType
+      const :mobile_money, T.nilable(Inttegro::PaymentMethod::DataMobileMoney), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/data_mobile_money.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 "../shared/mobile_money_network"
+
+module Inttegro
+  class PaymentMethod
+    # Mobile money wallet details (required when type is mobile_money)
+    #
+    # 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] network
+    #   Mobile money network provider
+    #
+    #   Required in the API payload. Wire name: `network`.
+    #   @return [Inttegro::Shared::MobileMoneyNetwork]
+    #
+    # @!attribute [r] account_number
+    #   Mobile money account number (international or local format)
+    #
+    #   Required in the API payload. Wire name: `account_number`.
+    #   @return [String]
+    class DataMobileMoney < T::Struct
+      const :network, Inttegro::Shared::MobileMoneyNetwork
+      const :account_number, String
+    end
+  end
+end

data/lib/inttegro/payment_method/data_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
+  class PaymentMethod
+    # Payment rail type (currently only mobile_money supported)
+    #
+    # 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 DataType < T::Enum
+      enums do
+        # Serialized wire value: `mobile_money`.
+        # @return [Inttegro::PaymentMethod::DataType]
+        MOBILE_MONEY = new("mobile_money")
+      end
+    end
+  end
+end

data/lib/inttegro/payment_method/deletion.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class PaymentMethod
+    # Confirmation returned after deleting a saved payment method.
+    #
+    # @api public
+    # @!attribute [r] deleted
+    #   Whether the API reports that the payment method was deleted.
+    #   @return [Boolean]
+    # @!attribute [r] payment_method_id
+    #   Identifier of the payment method addressed by the delete operation.
+    #   @return [String]
+    class Deletion < T::Struct
+      const :deleted, T::Boolean
+      const :payment_method_id, String
+    end
+  end
+end

data/lib/inttegro/payment_method/disactivate_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
+  class PaymentMethod
+    # Typed representation of the disactivate 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] payment_method_id
+    #   ID of the payment method to mark inactive
+    #
+    #   Required in the API payload. Wire name: `payment_method_id`.
+    #   @return [String]
+    class DisactivateRequest < T::Struct
+      const :payment_method_id, String
+    end
+  end
+end

data/lib/inttegro/payment_method/disactivate_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 "payment_method"
+
+module Inttegro
+  class PaymentMethod
+    # Typed representation of the disactivate 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] payment_method
+    #   A tokenized payment instrument tied to a customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method`.
+    #   @return [Inttegro::PaymentMethod, nil]
+    class DisactivateResponse < T::Struct
+      const :payment_method, T.nilable(Inttegro::PaymentMethod), default: nil
+    end
+  end
+end