inttegro 4.3.1 → 6.0.0

data/lib/inttegro/payment_method/get_settings_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
+  class PaymentMethod
+    # Send an empty JSON object.
+    #
+    # 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 GetSettingsRequest < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/payment_method/get_settings_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 "settings"
+
+module Inttegro
+  class PaymentMethod
+    # Typed representation of the get settings 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] settings
+    #   Payment method acceptance configuration for an application
+    #
+    #   Required in the API payload. Wire name: `settings`.
+    #   @return [Inttegro::PaymentMethod::Settings]
+    class GetSettingsResponse < T::Struct
+      const :settings, Inttegro::PaymentMethod::Settings
+    end
+  end
+end

data/lib/inttegro/payment_method/lookup_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 lookup 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 fetch
+    #
+    #   Required in the API payload. Wire name: `payment_method_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :payment_method_id, String
+    end
+  end
+end

data/lib/inttegro/payment_method/lookup_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 lookup 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 LookupResponse < T::Struct
+      const :payment_method, T.nilable(Inttegro::PaymentMethod), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/mobile_money.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 "../shared/mobile_money_network"
+
+module Inttegro
+  class PaymentMethod
+    # Masked mobile-money wallet details (present 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] account_number
+    #   Masked wallet number. The full account number is never returned.
+    #
+    #   Required in the API payload. Wire name: `account_number`.
+    #   @return [String]
+    #
+    # @!attribute [r] last4
+    #   Last four numeric digits of the normalized wallet number.
+    #
+    #   Required in the API payload. Wire name: `last4`.
+    #   @return [String]
+    #
+    # @!attribute [r] network
+    #   Mobile network operator
+    #
+    #   Required in the API payload. Wire name: `network`.
+    #   @return [Inttegro::Shared::MobileMoneyNetwork]
+    class MobileMoney < T::Struct
+      const :account_number, String
+      const :last4, String
+      const :network, Inttegro::Shared::MobileMoneyNetwork
+    end
+  end
+end

data/lib/inttegro/payment_method/owner.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 "owner_address"
+
+module Inttegro
+  class PaymentMethod
+    # Owner identity captured during tokenization when provided
+    #
+    # 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] address
+    #   Postal address for the owner when available
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `address`.
+    #   @return [Inttegro::PaymentMethod::OwnerAddress, nil]
+    #
+    # @!attribute [r] name
+    #   Owner full legal name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    class Owner < T::Struct
+      const :address, T.nilable(Inttegro::PaymentMethod::OwnerAddress), default: nil
+      const :name, String
+    end
+  end
+end

data/lib/inttegro/payment_method/owner_address.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
+  class PaymentMethod
+    # Postal address for the owner when available
+    #
+    # 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] city
+    #   City or locality
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `city`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Two-letter ISO country code
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!attribute [r] line_1
+    #   First line of the street address
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line_1`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] line_2
+    #   Second line of the street address
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line_2`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] name
+    #   Recipient name at this address, if different from owner name
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] phone_number
+    #   Phone number for this address
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] post_code
+    #   Postal or ZIP code
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `post_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] region
+    #   Region, state, or province
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    class OwnerAddress < T::Struct
+      const :city, T.nilable(String), default: nil
+      const :country, String
+      const :line_1, T.nilable(String), default: nil
+      const :line_2, T.nilable(String), default: nil
+      const :name, T.nilable(String), default: nil
+      const :phone_number, T.nilable(String), default: nil
+      const :post_code, T.nilable(String), default: nil
+      const :region, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/owner_input.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 "owner_input_address"
+
+module Inttegro
+  class PaymentMethod
+    # Typed representation of the owner input 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] address
+    #   Value of the `address` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `address`.
+    #   @return [Inttegro::PaymentMethod::OwnerInputAddress]
+    #
+    # @!attribute [r] name
+    #   Payment method owner's name.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    class OwnerInput < T::Struct
+      const :address, Inttegro::PaymentMethod::OwnerInputAddress
+      const :name, String
+    end
+  end
+end

data/lib/inttegro/payment_method/owner_input_address.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
+  class PaymentMethod
+    # Typed representation of the owner input 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] city
+    #   Value of the `city` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `city`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Country associated with the owner address.
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!attribute [r] line1
+    #   Value of the `line1` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line1`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] line2
+    #   Value of the `line2` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line2`.
+    #   @return [String, nil]
+    #
+    # @!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] phone_number
+    #   Value of the `phone_number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] post_code
+    #   Value of the `post_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `post_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] region
+    #   Value of the `region` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    class OwnerInputAddress < T::Struct
+      const :city, T.nilable(String), default: nil
+      const :country, String
+      const :line1, T.nilable(String), default: nil
+      const :line2, T.nilable(String), default: nil
+      const :name, T.nilable(String), default: nil
+      const :phone_number, T.nilable(String), default: nil
+      const :post_code, T.nilable(String), default: nil
+      const :region, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/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 "payment_method"
+
+module Inttegro
+  class PaymentMethod
+    # 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
+    #   The page number returned
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] payment_methods
+    #   Value of the `payment_methods` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `payment_methods`.
+    #   @return [Array<Inttegro::PaymentMethod>]
+    #
+    # @!attribute [r] size
+    #   The number of payment methods in this page
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    class Page < T::Struct
+      const :number, Integer
+      const :payment_methods, T::Array[Inttegro::PaymentMethod]
+      const :size, Integer
+    end
+  end
+end

data/lib/inttegro/payment_method/page_request.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"
+
+module Inttegro
+  class PaymentMethod
+    # 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] customer_id
+    #   Optional customer ID to scope the page to a single customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] page_number
+    #   Page index to fetch. `0` is accepted and normalized to page 1; returned pages are numbered
+    #   1-10.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] page_size
+    #   Number of payment methods per page (1-256)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    class PageRequest < T::Struct
+      const :customer_id, T.nilable(String), default: nil
+      const :page_number, T.nilable(Integer), default: nil
+      const :page_size, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/payment_method/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 PaymentMethod
+    # 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::PaymentMethod::Page]
+    class PageResponse < T::Struct
+      const :page, Inttegro::PaymentMethod::Page
+    end
+  end
+end

data/lib/inttegro/payment_method/payment_method.rb

@@ -0,0 +1,138 @@
+# 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"
+require_relative "card"
+require_relative "mobile_money"
+require_relative "owner"
+require_relative "supplied"
+require_relative "type"
+require_relative "verification"
+
+module Inttegro
+  # A tokenized payment instrument tied to a customer
+  #
+  # 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] active
+  #   Whether this payment method is active and reusable in new payment flows
+  #
+  #   Required in the API payload. Wire name: `active`.
+  #   @return [Boolean]
+  #
+  # @!attribute [r] archived_at
+  #   Timestamp when the payment method was archived. Omitted while unarchived.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `archived_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] bank_account
+  #   Bank account details (present when type is bank_account)
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `bank_account`.
+  #   @return [Inttegro::PaymentMethod::BankAccount, nil]
+  #
+  # @!attribute [r] card
+  #   Card marker. Nested card credentials are not returned.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `card`.
+  #   @return [Inttegro::PaymentMethod::Card, nil]
+  #
+  # @!attribute [r] created_at
+  #   When this payment method was tokenized
+  #
+  #   Required in the API payload. Wire name: `created_at`.
+  #   @return [Time]
+  #
+  # @!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] customer_id
+  #   Customer who owns this payment method
+  #
+  #   Required in the API payload. Wire name: `customer_id`.
+  #   @return [String]
+  #
+  # @!attribute [r] ephemeral
+  #   Whether the method is limited to its originating flow and cannot be reused.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `ephemeral`.
+  #   @return [Boolean, nil]
+  #
+  # @!attribute [r] expires_on
+  #   When this payment method expires. Omitted when no expiry is available.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `expires_on`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] id
+  #   Unique identifier for this payment method
+  #
+  #   Required in the API payload. Wire name: `id`.
+  #   @return [String]
+  #
+  # @!attribute [r] mobile_money
+  #   Masked mobile-money wallet details (present when type is mobile_money)
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `mobile_money`.
+  #   @return [Inttegro::PaymentMethod::MobileMoney, nil]
+  #
+  # @!attribute [r] owner
+  #   Owner identity captured during tokenization when provided
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `owner`.
+  #   @return [Inttegro::PaymentMethod::Owner, nil]
+  #
+  # @!attribute [r] type
+  #   Payment rail type
+  #
+  #   Required in the API payload. Wire name: `type`.
+  #   @return [Inttegro::PaymentMethod::Type]
+  #
+  # @!attribute [r] supplied
+  #   Public provenance for how the payment method was supplied.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `supplied`.
+  #   @return [Inttegro::PaymentMethod::Supplied, nil]
+  #
+  # @!attribute [r] verification
+  #   Most recent verification record when the payment method has entered a verification flow.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `verification`.
+  #   @return [Inttegro::PaymentMethod::Verification, nil]
+  #
+  # @!attribute [r] verified_at
+  #   When ownership verification was completed
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `verified_at`.
+  #   @return [Time, nil]
+  class PaymentMethod
+    const :active, T::Boolean
+    const :archived_at, T.nilable(Time), default: nil
+    const :bank_account, T.nilable(Inttegro::PaymentMethod::BankAccount), default: nil
+    const :card, T.nilable(Inttegro::PaymentMethod::Card), default: nil
+    const :created_at, Time
+    const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    const :customer_id, String
+    const :ephemeral, T.nilable(T::Boolean), default: nil
+    const :expires_on, T.nilable(Time), default: nil
+    const :id, String
+    const :mobile_money, T.nilable(Inttegro::PaymentMethod::MobileMoney), default: nil
+    const :owner, T.nilable(Inttegro::PaymentMethod::Owner), default: nil
+    const :type, Inttegro::PaymentMethod::Type
+    const :supplied, T.nilable(Inttegro::PaymentMethod::Supplied), default: nil
+    const :verification, T.nilable(Inttegro::PaymentMethod::Verification), default: nil
+    const :verified_at, T.nilable(Time), default: nil
+  end
+end

data/lib/inttegro/payment_method/questions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class PaymentMethod
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    # Determine whether the API supplied an archive timestamp.
+    #
+    # @return [Boolean] whether this payment method is archived
+    def archived?
+      !archived_at.nil?
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the API supplied a verification timestamp.
+    #
+    # @return [Boolean] whether this payment method is verified
+    def verified?
+      !verified_at.nil?
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the payment method can be treated as reusable by local application code.
+    #
+    # This predicate requires an active, non-archived, non-ephemeral method. It does not contact
+    # the API or guarantee that a future payment attempt will succeed.
+    #
+    # @return [Boolean] whether the current model satisfies the reusable-method conditions
+    def reusable?
+      active && !archived? && ephemeral != true
+    end
+  end
+end