inttegro 4.3.1 → 6.0.0

data/lib/inttegro/secret_key/usage.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "secret_key"
+require_relative "usage_page"
+
+module Inttegro
+  class SecretKey
+    # Typed representation of the usage 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] key
+    #   Public secret key metadata. The bearer token is never returned by read or mutation
+    #   endpoints.
+    #
+    #   Required in the API payload. Wire name: `key`.
+    #   @return [Inttegro::SecretKey]
+    #
+    # @!attribute [r] usage
+    #   Value of the `usage` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `usage`.
+    #   @return [Inttegro::SecretKey::UsagePage]
+    class Usage < T::Struct
+      const :key, Inttegro::SecretKey
+      const :usage, Inttegro::SecretKey::UsagePage
+    end
+  end
+end

data/lib/inttegro/secret_key/usage_page.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 "usage_row"
+
+module Inttegro
+  class SecretKey
+    # Typed representation of the usage 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] count
+    #   Value of the `count` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `count`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] total
+    #   Value of the `total` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `total`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] has_more
+    #   Value of the `has_more` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `has_more`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] rows
+    #   Value of the `rows` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `rows`.
+    #   @return [Array<Inttegro::SecretKey::UsageRow>]
+    class UsagePage < T::Struct
+      const :number, Integer
+      const :size, Integer
+      const :count, Integer
+      const :total, Integer
+      const :has_more, T::Boolean
+      const :rows, T::Array[Inttegro::SecretKey::UsageRow]
+    end
+  end
+end

data/lib/inttegro/secret_key/usage_request.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 SecretKey
+    # Typed representation of the usage 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] number
+    #   Page number. Omitted or 0 is normalized to 1.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] page
+    #   Page number alias. Omitted or 0 is normalized to 1.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] secret_key_id
+    #   Secret key identifier whose recent activity should be returned.
+    #
+    #   Required in the API payload. Wire name: `secret_key_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] size
+    #   Requested page size. Omitted or 0 becomes 50; values above 100 are capped at 100.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, nil]
+    class UsageRequest < T::Struct
+      const :number, T.nilable(Integer), default: nil
+      const :page, T.nilable(Integer), default: nil
+      const :secret_key_id, String
+      const :size, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/secret_key/usage_row.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 "auth_result"
+
+module Inttegro
+  class SecretKey
+    # Public authentication outcome associated with the selected key.
+    #
+    # 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] secret_key_id
+    #   Value of the `secret_key_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `secret_key_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] occurred_at
+    #   Value of the `occurred_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `occurred_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] auth_result
+    #   Value of the `auth_result` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `auth_result`.
+    #   @return [Inttegro::SecretKey::AuthResult]
+    class UsageRow < T::Struct
+      const :secret_key_id, String
+      const :occurred_at, Time
+      const :auth_result, Inttegro::SecretKey::AuthResult
+    end
+  end
+end

data/lib/inttegro/shared/address.rb

@@ -0,0 +1,83 @@
+# 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 address 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] name
+    #   Recipient name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] phone_number
+    #   Contact phone number
+    #
+    #   Required in the API payload. Wire name: `phone_number`.
+    #   @return [String]
+    #
+    # @!attribute [r] line1
+    #   Street address line 1
+    #
+    #   Required in the API payload. Wire name: `line1`.
+    #   @return [String]
+    #
+    # @!attribute [r] line2
+    #   Street address line 2 (optional)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line2`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] town
+    #   City or town
+    #
+    #   Required in the API payload. Wire name: `town`.
+    #   @return [String]
+    #
+    # @!attribute [r] region
+    #   State, province, or region
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] district
+    #   District or area
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `district`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Country name
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!attribute [r] post_code
+    #   Postal/ZIP code
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `post_code`.
+    #   @return [String, nil]
+    class Address < T::Struct
+      const :name, String
+      const :phone_number, String
+      const :line1, String
+      const :line2, T.nilable(String), default: nil
+      const :town, String
+      const :region, T.nilable(String), default: nil
+      const :district, T.nilable(String), default: nil
+      const :country, String
+      const :post_code, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/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 shared 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 Shared
+  end
+end

data/lib/inttegro/shared/billing_details.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "address"
+
+module Inttegro
+  module Shared
+    # Typed representation of the billing 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] name
+    #   Billing contact name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] email_address
+    #   Billing email address
+    #
+    #   Required in the API payload. Wire name: `email_address`.
+    #   @return [String]
+    #
+    # @!attribute [r] phone_number
+    #   Billing phone number
+    #
+    #   Required in the API payload. Wire name: `phone_number`.
+    #   @return [String]
+    #
+    # @!attribute [r] address
+    #   Value of the `address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `address`.
+    #   @return [Inttegro::Shared::Address, nil]
+    class BillingDetails < T::Struct
+      const :name, String
+      const :email_address, String
+      const :phone_number, String
+      const :address, T.nilable(Inttegro::Shared::Address), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/content_safety_status.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"
+
+module Inttegro
+  module Shared
+    # Safety decision for the email content
+    #
+    # 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 ContentSafetyStatus < T::Enum
+      enums do
+        # Serialized wire value: `allowed`.
+        # @return [Inttegro::Shared::ContentSafetyStatus]
+        ALLOWED = new("allowed")
+        # Serialized wire value: `rejected`.
+        # @return [Inttegro::Shared::ContentSafetyStatus]
+        REJECTED = new("rejected")
+        # Serialized wire value: `quarantined`.
+        # @return [Inttegro::Shared::ContentSafetyStatus]
+        QUARANTINED = new("quarantined")
+      end
+    end
+  end
+end

data/lib/inttegro/shared/country_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 "country_bank_branch"
+
+module Inttegro
+  module Shared
+    # A banking institution available in a country
+    #
+    # 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
+    #   Stable bank identifier
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] name
+    #   Bank display name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] swift_code
+    #   SWIFT/BIC code for the bank, when available
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `swift_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] sort_code_prefix
+    #   Ghana sort code prefix for the bank
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort_code_prefix`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] branches
+    #   Branches available for this bank
+    #
+    #   Required in the API payload. Wire name: `branches`.
+    #   @return [Array<Inttegro::Shared::CountryBankBranch>]
+    class CountryBank < T::Struct
+      const :id, String
+      const :name, String
+      const :swift_code, T.nilable(String), default: nil
+      const :sort_code_prefix, T.nilable(String), default: nil
+      const :branches, T::Array[Inttegro::Shared::CountryBankBranch]
+    end
+  end
+end

data/lib/inttegro/shared/country_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
+    # A bank branch in a country bank directory
+    #
+    # 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
+    #   Stable branch identifier
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] name
+    #   Branch display name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] sort_code
+    #   Ghana bank branch sort code
+    #
+    #   Required in the API payload. Wire name: `sort_code`.
+    #   @return [String]
+    class CountryBankBranch < T::Struct
+      const :id, String
+      const :name, String
+      const :sort_code, String
+    end
+  end
+end

data/lib/inttegro/shared/country_bank_directory.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 "country_bank"
+
+module Inttegro
+  module Shared
+    # Bank reference data available for country-specific bank accounts
+    #
+    # 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
+    #   Country-specific bank account subtype used by financial account APIs
+    #
+    #   Required in the API payload. Wire name: `bank_account_type`.
+    #   @return [String]
+    #
+    # @!attribute [r] code_scheme
+    #   Identifier scheme used for bank branch codes
+    #
+    #   Required in the API payload. Wire name: `code_scheme`.
+    #   @return [String]
+    #
+    # @!attribute [r] items
+    #   Banking institutions available in this country
+    #
+    #   Required in the API payload. Wire name: `items`.
+    #   @return [Array<Inttegro::Shared::CountryBank>]
+    class CountryBankDirectory < T::Struct
+      const :bank_account_type, String
+      const :code_scheme, String
+      const :items, T::Array[Inttegro::Shared::CountryBank]
+    end
+  end
+end

data/lib/inttegro/shared/country_specification.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "country_bank_directory"
+
+module Inttegro
+  module Shared
+    # Complete specification for a country including supported features and requirements
+    #
+    # 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] country_code
+    #   ISO 3166-1 alpha-2 country code
+    #
+    #   Required in the API payload. Wire name: `country_code`.
+    #   @return [String]
+    #
+    # @!attribute [r] country_name
+    #   Full country name
+    #
+    #   Required in the API payload. Wire name: `country_name`.
+    #   @return [String]
+    #
+    # @!attribute [r] currencies
+    #   Supported currencies in this country
+    #
+    #   Required in the API payload. Wire name: `currencies`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] payment_methods
+    #   Supported payment methods in this country
+    #
+    #   Required in the API payload. Wire name: `payment_methods`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] payout_schedules
+    #   Available payout schedules for this country
+    #
+    #   Required in the API payload. Wire name: `payout_schedules`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] bt_aging_specs
+    #   Balance transaction aging specifications available
+    #
+    #   Required in the API payload. Wire name: `bt_aging_specs`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] legal_entity_types
+    #   Legal entity types that can operate in this country
+    #
+    #   Required in the API payload. Wire name: `legal_entity_types`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] financial_account_types
+    #   Financial account types available in this country
+    #
+    #   Required in the API payload. Wire name: `financial_account_types`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] id_document_types
+    #   Identification document types accepted in this country
+    #
+    #   Required in the API payload. Wire name: `id_document_types`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] banks
+    #   Bank reference data available for country-specific bank accounts
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `banks`.
+    #   @return [Inttegro::Shared::CountryBankDirectory, nil]
+    class CountrySpecification < T::Struct
+      const :country_code, String
+      const :country_name, String
+      const :currencies, T::Array[String]
+      const :payment_methods, T::Array[String]
+      const :payout_schedules, T::Array[String]
+      const :bt_aging_specs, T::Array[String]
+      const :legal_entity_types, T::Array[String]
+      const :financial_account_types, T::Array[String]
+      const :id_document_types, T::Array[String]
+      const :banks, T.nilable(Inttegro::Shared::CountryBankDirectory), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/country_specifications.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 "country_specification"
+
+module Inttegro
+  module Shared
+    # Typed representation of the country specifications 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] countries
+    #   Country specifications keyed by country code.
+    #
+    #   Required in the API payload. Wire name: `countries`.
+    #   @return [Hash{String => Inttegro::Shared::CountrySpecification}]
+    class CountrySpecifications < T::Struct
+      const :countries, T::Hash[String, Inttegro::Shared::CountrySpecification]
+    end
+  end
+end

data/lib/inttegro/shared/delivery_channel.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
+    # Delivery channel.
+    #
+    # 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 DeliveryChannel < T::Enum
+      enums do
+        # Serialized wire value: `email`.
+        # @return [Inttegro::Shared::DeliveryChannel]
+        EMAIL = new("email")
+        # Serialized wire value: `sms`.
+        # @return [Inttegro::Shared::DeliveryChannel]
+        SMS = new("sms")
+      end
+    end
+  end
+end

data/lib/inttegro/shared/dosh_account.rb

@@ -0,0 +1,22 @@
+# 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
+    # Dosh account marker. Dosh credentials and internal identifiers are not supplied by callers
+    # or returned publicly.
+    #
+    # 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 DoshAccount < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end