inttegro 4.3.1 → 6.0.0

data/lib/inttegro/shared/error_envelope.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "error_payload"
+
+module Inttegro
+  module Shared
+    # Typed representation of the error envelope 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] error
+    #   Standard error response structure returned by all API endpoints. Provides machine-readable
+    #   codes, human-readable messages, and actionable guidance for resolution.
+    #
+    #   Required in the API payload. Wire name: `error`.
+    #   @return [Inttegro::Shared::ErrorPayload]
+    class ErrorEnvelope < T::Struct
+      const :error, Inttegro::Shared::ErrorPayload
+    end
+  end
+end

data/lib/inttegro/shared/error_payload.rb

@@ -0,0 +1,76 @@
+# 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 Shared
+    # Standard error response structure returned by all API endpoints. Provides machine-readable
+    # codes, human-readable messages, and actionable guidance for resolution.
+    #
+    # 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] message
+    #   Concise, caller-safe explanation of why the request was rejected or could not finish.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `message`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] fix_code
+    #   Machine-readable suggestion for how to resolve the error (e.g.,
+    #   "retry_with_exponential_backoff", "change_request_parameters").
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `fix_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] detail
+    #   Explanation of the relevant rule and next safe action. It never contains raw dependency,
+    #   storage, or implementation errors.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `detail`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] cause
+    #   Stable category describing the reason for failure, such as invalid input, an unmet
+    #   precondition, or a state conflict.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `cause`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] type
+    #   Broad error category to help clients determine retry strategies (e.g.,
+    #   "invalid_request_parameter", "transient_error").
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [String]
+    #
+    # @!attribute [r] code
+    #   Unique machine-readable identifier for this specific error condition. Unlike type and cause
+    #   which group errors, code pinpoints the exact problem.
+    #
+    #   Required in the API payload. Wire name: `code`.
+    #   @return [String]
+    #
+    # @!attribute [r] url
+    #   Link to error reference documentation with detailed explanation, common causes, and
+    #   resolution guidance.
+    #
+    #   Required in the API payload. Wire name: `url`.
+    #   @return [String]
+    class ErrorPayload < T::Struct
+      const :message, T.nilable(String), default: nil
+      const :fix_code, T.nilable(String), default: nil
+      const :detail, T.nilable(String), default: nil
+      const :cause, T.nilable(String), default: nil
+      const :type, String
+      const :code, String
+      const :url, String
+    end
+  end
+end

data/lib/inttegro/shared/fee_details.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../money/amount_params"
+
+module Inttegro
+  module Shared
+    # Typed representation of the fee details 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] id
+    #   Fee identifier
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] label
+    #   Customer-facing label for this fee
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] tax_code
+    #   The tax classification code for the shipping fee
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `tax_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] description
+    #   Customer-facing description for this fee
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined string values attached to a resource. SDKs expose this as a semantic
+    #   collection rather than a raw map.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => String}, nil]
+    #
+    # @!attribute [r] amount
+    #   Value of the `amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Inttegro::Money::AmountParams]
+    class FeeDetails < T::Struct
+      const :id, T.nilable(String), default: nil
+      const :label, T.nilable(String), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :description, T.nilable(String), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :amount, Inttegro::Money::AmountParams
+    end
+  end
+end

data/lib/inttegro/shared/fee_line_item.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 "fee_details"
+require_relative "fee_line_item_type"
+
+module Inttegro
+  module Shared
+    # Typed representation of the fee line item 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] type
+    #   Line item type discriminator
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Shared::FeeLineItemType]
+    #
+    # @!attribute [r] fee
+    #   Value of the `fee` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `fee`.
+    #   @return [Inttegro::Shared::FeeDetails]
+    class FeeLineItem < T::Struct
+      const :type, Inttegro::Shared::FeeLineItemType
+      const :fee, Inttegro::Shared::FeeDetails
+    end
+  end
+end

data/lib/inttegro/shared/fee_line_item_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 Shared
+    # Line item type discriminator
+    #
+    # 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 FeeLineItemType < T::Enum
+      enums do
+        # Serialized wire value: `fee`.
+        # @return [Inttegro::Shared::FeeLineItemType]
+        FEE = new("fee")
+      end
+    end
+  end
+end

data/lib/inttegro/shared/financial_institution.rb

@@ -0,0 +1,64 @@
+# 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_institution_bank"
+require_relative "financial_institution_mobile_money_provider"
+
+module Inttegro
+  module Shared
+    # Typed representation of the financial institution 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] bank
+    #   Value of the `bank` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `bank`.
+    #   @return [Inttegro::Shared::FinancialInstitutionBank, nil]
+    #
+    # @!attribute [r] country
+    #   Value of the `country` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!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] mobile_money_provider
+    #   Value of the `mobile_money_provider` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `mobile_money_provider`.
+    #   @return [Inttegro::Shared::FinancialInstitutionMobileMoneyProvider, nil]
+    #
+    # @!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] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [String]
+    class FinancialInstitution < T::Struct
+      const :bank, T.nilable(Inttegro::Shared::FinancialInstitutionBank), default: nil
+      const :country, String
+      const :id, String
+      const :mobile_money_provider, T.nilable(Inttegro::Shared::FinancialInstitutionMobileMoneyProvider), default: nil
+      const :name, String
+      const :type, String
+    end
+  end
+end

data/lib/inttegro/shared/financial_institution_bank.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 "financial_institution_bank_branch"
+
+module Inttegro
+  module Shared
+    # Typed representation of the financial institution bank 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] bank_account_type
+    #   Value of the `bank_account_type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `bank_account_type`.
+    #   @return [String]
+    #
+    # @!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 [Inttegro::Shared::FinancialInstitutionBankBranch, nil]
+    #
+    # @!attribute [r] code_scheme
+    #   Value of the `code_scheme` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `code_scheme`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code_prefix
+    #   Value of the `sort_code_prefix` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code_prefix`.
+    #   @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 FinancialInstitutionBank < T::Struct
+      const :bank_account_type, String
+      const :branch, T.nilable(Inttegro::Shared::FinancialInstitutionBankBranch), default: nil
+      const :code_scheme, String
+      const :sort_code_prefix, T.nilable(String), default: nil
+      const :swift_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/financial_institution_bank_branch.rb

@@ -0,0 +1,41 @@
+# 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 Shared
+    # Typed representation of the financial institution bank branch 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] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!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] sort_code
+    #   Value of the `sort_code` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sort_code`.
+    #   @return [String]
+    class FinancialInstitutionBankBranch < T::Struct
+      const :id, String
+      const :name, String
+      const :sort_code, String
+    end
+  end
+end

data/lib/inttegro/shared/financial_institution_mobile_money_provider.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"
+
+module Inttegro
+  module Shared
+    # Typed representation of the financial institution mobile money provider 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] provider
+    #   Value of the `provider` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `provider`.
+    #   @return [String]
+    class FinancialInstitutionMobileMoneyProvider < T::Struct
+      const :provider, String
+    end
+  end
+end

data/lib/inttegro/shared/invoice_settings.rb

@@ -0,0 +1,51 @@
+# 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 Shared
+    # Order-level invoice rendering data. Pages uses this data when rendering invoice web and
+    # download views.
+    #
+    # 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
+    #   Optional invoice number. When omitted, invoice delivery falls back to the order number and
+    #   then the order ID for labels.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] memo
+    #   Optional invoice memo.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `memo`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] footer
+    #   Optional invoice footer.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `footer`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined string values attached to a resource. SDKs expose this as a semantic
+    #   collection rather than a raw map.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => String}, nil]
+    class InvoiceSettings < T::Struct
+      const :number, T.nilable(String), default: nil
+      const :memo, T.nilable(String), default: nil
+      const :footer, T.nilable(String), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/line_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../product/line_item"
+require_relative "fee_line_item"
+require_relative "shipping_line_item"
+
+module Inttegro
+  module Shared
+    # Typed representation of the line item object in the Inttegro API.
+    #
+    # @api public
+    # @return [Inttegro::Product::LineItem, Inttegro::Shared::FeeLineItem, Inttegro::Shared::ShippingLineItem]
+    LineItem = T.type_alias { T.any(Inttegro::Product::LineItem, Inttegro::Shared::FeeLineItem, Inttegro::Shared::ShippingLineItem) }
+  end
+end

data/lib/inttegro/shared/list_country_specs_request.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
+  module Shared
+    # No request body required
+    #
+    # 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 ListCountrySpecsRequest < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/shared/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 "mobile_money_network"
+
+module Inttegro
+  module Shared
+    # Typed representation of the mobile money 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] network
+    #   Mobile money service provider
+    #
+    #   Required in the API payload. Wire name: `network`.
+    #   @return [Inttegro::Shared::MobileMoneyNetwork]
+    #
+    # @!attribute [r] account_number
+    #   Mobile money account number
+    #
+    #   Required in the API payload. Wire name: `account_number`.
+    #   @return [String]
+    class MobileMoney < T::Struct
+      const :network, Inttegro::Shared::MobileMoneyNetwork
+      const :account_number, String
+    end
+  end
+end

data/lib/inttegro/shared/mobile_money_network.rb

@@ -0,0 +1,33 @@
+# 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 Shared
+    # Mobile money service provider
+    #
+    # 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 MobileMoneyNetwork < T::Enum
+      enums do
+        # Serialized wire value: `airtel`.
+        # @return [Inttegro::Shared::MobileMoneyNetwork]
+        AIRTEL = new("airtel")
+        # Serialized wire value: `mtn`.
+        # @return [Inttegro::Shared::MobileMoneyNetwork]
+        MTN = new("mtn")
+        # Serialized wire value: `telecel`.
+        # @return [Inttegro::Shared::MobileMoneyNetwork]
+        TELECEL = new("telecel")
+        # Serialized wire value: `vodafone`.
+        # @return [Inttegro::Shared::MobileMoneyNetwork]
+        VODAFONE = new("vodafone")
+      end
+    end
+  end
+end

data/lib/inttegro/shared/request_confirmation_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 Shared
+    # Typed representation of the request confirmation 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] order_id
+    #   Unique identifier of the order
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    class RequestConfirmationRequest < T::Struct
+      const :order_id, String
+    end
+  end
+end

data/lib/inttegro/shared/resource_supply.rb

@@ -0,0 +1,62 @@
+# 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 Shared
+    # Typed representation of the resource supply 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] attempt_id
+    #   Value of the `attempt_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `attempt_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] by
+    #   Value of the `by` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `by`.
+    #   @return [String]
+    #
+    # @!attribute [r] channel
+    #   Value of the `channel` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `channel`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] resource_id
+    #   Value of the `resource_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `resource_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] resource_type
+    #   Value of the `resource_type` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `resource_type`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] supplied_at
+    #   Value of the `supplied_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `supplied_at`.
+    #   @return [Time]
+    class ResourceSupply < T::Struct
+      const :attempt_id, T.nilable(String), default: nil
+      const :by, String
+      const :channel, T.nilable(String), default: nil
+      const :resource_id, T.nilable(String), default: nil
+      const :resource_type, T.nilable(String), default: nil
+      const :supplied_at, Time
+    end
+  end
+end