inttegro 5.0.0 → 6.0.0

data/lib/inttegro/app/relationship_status.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class Application
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::Application::RelationshipStatus.
+    #
+    # 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 RelationshipStatus < T::Enum
+      enums do
+        # Serialized wire value: `active`.
+        # @return [Inttegro::Application::RelationshipStatus]
+        ACTIVE = new("active")
+        # Serialized wire value: `inactive`.
+        # @return [Inttegro::Application::RelationshipStatus]
+        INACTIVE = new("inactive")
+        # Serialized wire value: `suspended`.
+        # @return [Inttegro::Application::RelationshipStatus]
+        SUSPENDED = new("suspended")
+        # Serialized wire value: `revoked`.
+        # @return [Inttegro::Application::RelationshipStatus]
+        REVOKED = new("revoked")
+      end
+    end
+  end
+end

data/lib/inttegro/app/secret_key.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 Application
+    # Typed representation of the secret key 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.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] token_type
+    #   Value of the `token_type` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `token_type`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] issued_at
+    #   Value of the `issued_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `issued_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] token
+    #   Value of the `token` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `token`.
+    #   @return [String, nil]
+    class SecretKey < T::Struct
+      const :id, T.nilable(String), default: nil
+      const :token_type, T.nilable(String), default: nil
+      const :issued_at, T.nilable(Time), default: nil
+      const :token, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/app/update_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 Application
+    # Typed representation of the update 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] name
+    #   Display name for the application. Cannot be empty.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] alias
+    #   Short name for the application. Use an empty string to clear it.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `alias`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] description
+    #   Application description. Use an empty string to clear it.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] legal_entity_type
+    #   Caller-defined legal-entity label. Send an empty string to clear it.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `legal_entity_type`.
+    #   @return [String, nil]
+    class UpdateRequest < T::Struct
+      const :name, T.nilable(String), default: nil
+      const :alias, T.nilable(String), default: nil
+      const :description, T.nilable(String), default: nil
+      const :legal_entity_type, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/app/update_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 "updated"
+
+module Inttegro
+  class Application
+    # Typed representation of the update 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] app
+    #   Value of the `app` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `app`.
+    #   @return [Inttegro::Application::Updated]
+    class UpdateResponse < T::Struct
+      const :app, Inttegro::Application::Updated
+    end
+  end
+end

data/lib/inttegro/app/updated.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
+  class Application
+    # Typed representation of the updated object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] 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] alias
+    #   Value of the `alias` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `alias`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] description
+    #   Value of the `description` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] created_at
+    #   Value of the `created_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] updated_at
+    #   Value of the `updated_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `updated_at`.
+    #   @return [Time, nil]
+    class Updated < T::Struct
+      const :id, String
+      const :name, String
+      const :alias, T.nilable(String), default: nil
+      const :description, T.nilable(String), default: nil
+      const :created_at, Time
+      const :updated_at, T.nilable(Time), default: nil
+    end
+  end
+end

data/lib/inttegro/balance/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 balance 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 Balance
+  end
+end

data/lib/inttegro/balance/currency_snapshot.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "currency_snapshot_refund"
+require_relative "currency_snapshot_reserved"
+require_relative "value"
+
+module Inttegro
+  module Balance
+    # Typed representation of the currency snapshot 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] available
+    #   Value of the `available` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `available`.
+    #   @return [Inttegro::Balance::Value]
+    #
+    # @!attribute [r] includes_transactions_before
+    #   The snapshot includes transactions created before this timestamp
+    #
+    #   Required in the API payload. Wire name: `includes_transactions_before`.
+    #   @return [Time]
+    #
+    # @!attribute [r] pending
+    #   Value of the `pending` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `pending`.
+    #   @return [Inttegro::Balance::Value]
+    #
+    # @!attribute [r] refund
+    #   Funds assigned to refund activity at the snapshot cutoff
+    #
+    #   Required in the API payload. Wire name: `refund`.
+    #   @return [Inttegro::Balance::CurrencySnapshotRefund]
+    #
+    # @!attribute [r] reserved
+    #   Funds held back from payout at the snapshot cutoff
+    #
+    #   Required in the API payload. Wire name: `reserved`.
+    #   @return [Inttegro::Balance::CurrencySnapshotReserved]
+    class CurrencySnapshot < T::Struct
+      const :available, Inttegro::Balance::Value
+      const :includes_transactions_before, Time
+      const :pending, Inttegro::Balance::Value
+      const :refund, Inttegro::Balance::CurrencySnapshotRefund
+      const :reserved, Inttegro::Balance::CurrencySnapshotReserved
+    end
+  end
+end

data/lib/inttegro/balance/currency_snapshot_refund.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 Balance
+    # Funds assigned to refund activity at the snapshot cutoff
+    #
+    # 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] amount
+    #   Amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Integer]
+    class CurrencySnapshotRefund < T::Struct
+      const :amount, Integer
+    end
+  end
+end

data/lib/inttegro/balance/currency_snapshot_reserved.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 Balance
+    # Funds held back from payout at the snapshot cutoff
+    #
+    # 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] amount
+    #   Amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Integer]
+    class CurrencySnapshotReserved < T::Struct
+      const :amount, Integer
+    end
+  end
+end

data/lib/inttegro/balance/lookup_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 Balance
+    # 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
+    class LookupRequest < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/balance/snapshot.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 "currency_snapshot"
+
+module Inttegro
+  module Balance
+    # The latest GHS balance snapshot for the application.
+    #
+    # 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] ghs
+    #   Value of the `ghs` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `ghs`.
+    #   @return [Inttegro::Balance::CurrencySnapshot]
+    class Snapshot < T::Struct
+      const :ghs, Inttegro::Balance::CurrencySnapshot
+    end
+  end
+end

data/lib/inttegro/balance/snapshot_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 "snapshot"
+
+module Inttegro
+  module Balance
+    # Typed representation of the snapshot 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] balances
+    #   The latest GHS balance snapshot for the application.
+    #
+    #   Required in the API payload. Wire name: `balances`.
+    #   @return [Inttegro::Balance::Snapshot]
+    class SnapshotResponse < T::Struct
+      const :balances, Inttegro::Balance::Snapshot
+    end
+  end
+end

data/lib/inttegro/balance/value.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 Balance
+    # Typed representation of the value 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] amount
+    #   Amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Integer]
+    class Value < T::Struct
+      const :amount, Integer
+    end
+  end
+end

data/lib/inttegro/balance_transaction/amount.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class BalanceTransaction
+    # Typed representation of the amount 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] currency
+    #   Currency code as stored on the transaction
+    #
+    #   Required in the API payload. Wire name: `currency`.
+    #   @return [String]
+    #
+    # @!attribute [r] value
+    #   Unsigned amount in the currency's smallest unit
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [Integer]
+    class Amount < T::Struct
+      const :currency, String
+      const :value, Integer
+    end
+  end
+end

data/lib/inttegro/balance_transaction/balance_transaction.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "amount"
+require_relative "payout_configuration"
+require_relative "type"
+
+module Inttegro
+  # Merchant balance entry caused by a payment or refund. `type` describes the semantic source,
+  # not direction. A payment transaction contains `payment_id`; a refund transaction contains
+  # `refund_id`. Exactly one matching reference is present.
+  #
+  # 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] amount
+  #   Value of the `amount` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `amount`.
+  #   @return [Inttegro::BalanceTransaction::Amount]
+  #
+  # @!attribute [r] available_at
+  #   Value of the `available_at` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `available_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] claimed_at
+  #   Value of the `claimed_at` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `claimed_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] created_at
+  #   Value of the `created_at` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `created_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] id
+  #   Value of the `id` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `id`.
+  #   @return [String]
+  #
+  # @!attribute [r] order_id
+  #   Value of the `order_id` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `order_id`.
+  #   @return [String]
+  #
+  # @!attribute [r] paid_at
+  #   Value of the `paid_at` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `paid_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] payment_id
+  #   Present when `type` is `payment`; omitted when `type` is `refund`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_id`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] payout_id
+  #   Value of the `payout_id` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `payout_id`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] payout_configuration
+  #   Value of the `payout_configuration` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `payout_configuration`.
+  #   @return [Inttegro::BalanceTransaction::PayoutConfiguration, nil]
+  #
+  # @!attribute [r] refund_id
+  #   Present when `type` is `refund`; omitted when `type` is `payment`.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `refund_id`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] type
+  #   Semantic source or cause of the transaction, not its direction.
+  #
+  #   Required in the API payload. Wire name: `type`.
+  #   @return [Inttegro::BalanceTransaction::Type]
+  class BalanceTransaction
+    const :amount, Inttegro::BalanceTransaction::Amount
+    const :available_at, T.nilable(Time), default: nil
+    const :claimed_at, T.nilable(Time), default: nil
+    const :created_at, Time
+    const :id, String
+    const :order_id, String
+    const :paid_at, T.nilable(Time), default: nil
+    const :payment_id, T.nilable(String), default: nil
+    const :payout_id, T.nilable(String), default: nil
+    const :payout_configuration, T.nilable(Inttegro::BalanceTransaction::PayoutConfiguration), default: nil
+    const :refund_id, T.nilable(String), default: nil
+    const :type, Inttegro::BalanceTransaction::Type
+  end
+end

data/lib/inttegro/balance_transaction/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 BalanceTransaction < T::Struct
+  end
+end

data/lib/inttegro/balance_transaction/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 BalanceTransaction
+    # 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] transaction_id
+    #   Unique identifier of the balance transaction
+    #
+    #   Required in the API payload. Wire name: `transaction_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :transaction_id, String
+    end
+  end
+end