inttegro 5.0.0 → 6.0.1

data/lib/inttegro/payment_method/verification.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class PaymentMethod
+    # Most recent verification record when the payment method has entered a verification flow.
+    #
+    # 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] completed_at
+    #   When verification was completed
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `completed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] initiated_at
+    #   When verification was initiated
+    #
+    #   Required in the API payload. Wire name: `initiated_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] mechanism
+    #   Verification mechanism used
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `mechanism`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] request_id
+    #   ID of the verification request
+    #
+    #   Required in the API payload. Wire name: `request_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] type
+    #   Verification type
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [String]
+    class Verification < T::Struct
+      const :completed_at, T.nilable(Time), default: nil
+      const :initiated_at, Time
+      const :mechanism, T.nilable(String), default: nil
+      const :request_id, String
+      const :type, String
+    end
+  end
+end

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

data/lib/inttegro/payout/cancel_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 Payout
+    # Typed representation of the cancel 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] payout_id
+    #   Scheduled payout ID
+    #
+    #   Required in the API payload. Wire name: `payout_id`.
+    #   @return [String]
+    class CancelRequest < T::Struct
+      const :payout_id, String
+    end
+  end
+end

data/lib/inttegro/payout/cancel_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 "payout"
+
+module Inttegro
+  class Payout
+    # Typed representation of the cancel 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] payout
+    #   A payout scheduled from your Inttegro balance to a destination financial account
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payout`.
+    #   @return [Inttegro::Payout, nil]
+    class CancelResponse < T::Struct
+      const :payout, T.nilable(Inttegro::Payout), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/disable_automatic_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 Payout
+    # 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 DisableAutomaticRequest < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/payout/disable_automatic_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_mutation"
+
+module Inttegro
+  class Payout
+    # Typed representation of the disable automatic 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
+    #   Payout settings fields returned after a mutation
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `settings`.
+    #   @return [Inttegro::Payout::SettingsMutation, nil]
+    class DisableAutomaticResponse < T::Struct
+      const :settings, T.nilable(Inttegro::Payout::SettingsMutation), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/enable_automatic_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 Payout
+    # 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 EnableAutomaticRequest < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/payout/enable_automatic_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_mutation"
+
+module Inttegro
+  class Payout
+    # Typed representation of the enable automatic 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
+    #   Payout settings fields returned after a mutation
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `settings`.
+    #   @return [Inttegro::Payout::SettingsMutation, nil]
+    class EnableAutomaticResponse < T::Struct
+      const :settings, T.nilable(Inttegro::Payout::SettingsMutation), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/error.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 Payout
+    # Public failure details when execution fails
+    #
+    # 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] cause
+    #   Value of the `cause` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `cause`.
+    #   @return [String]
+    #
+    # @!attribute [r] message
+    #   Value of the `message` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `message`.
+    #   @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] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [String]
+    class Error < T::Struct
+      const :cause, String
+      const :message, String
+      const :occurred_at, Time
+      const :type, String
+    end
+  end
+end

data/lib/inttegro/payout/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 Payout
+    # 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/payout/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_lookup"
+
+module Inttegro
+  class Payout
+    # 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
+    #   Complete payout settings read model
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `settings`.
+    #   @return [Inttegro::Payout::SettingsLookup, nil]
+    class GetSettingsResponse < T::Struct
+      const :settings, T.nilable(Inttegro::Payout::SettingsLookup), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/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 Payout
+    # 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] payout_id
+    #   Payout identifier returned when the payout was created
+    #
+    #   Required in the API payload. Wire name: `payout_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :payout_id, String
+    end
+  end
+end

data/lib/inttegro/payout/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 "payout"
+
+module Inttegro
+  class Payout
+    # 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] payout
+    #   A payout scheduled from your Inttegro balance to a destination financial account
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payout`.
+    #   @return [Inttegro::Payout, nil]
+    class LookupResponse < T::Struct
+      const :payout, T.nilable(Inttegro::Payout), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/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 "payout"
+
+module Inttegro
+  class Payout
+    # 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
+    #   Page number returned
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] size
+    #   Number of payouts returned
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] payouts
+    #   Value of the `payouts` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payouts`.
+    #   @return [Array<Inttegro::Payout>, nil]
+    class Page < T::Struct
+      const :number, Integer
+      const :size, Integer
+      const :payouts, T.nilable(T::Array[Inttegro::Payout]), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/page_request.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 Payout
+    # 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] page_number
+    #   1-based page index to fetch (1-10 inclusive)
+    #
+    #   Required in the API payload. Wire name: `page_number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] page_size
+    #   Maximum number of payouts to return (1-256)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    class PageRequest < T::Struct
+      const :page_number, Integer
+      const :page_size, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/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 Payout
+    # 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.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page`.
+    #   @return [Inttegro::Payout::Page, nil]
+    class PageResponse < T::Struct
+      const :page, T.nilable(Inttegro::Payout::Page), default: nil
+    end
+  end
+end

data/lib/inttegro/payout/payout.rb

@@ -0,0 +1,176 @@
+# 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"
+require_relative "error"
+require_relative "status"
+
+module Inttegro
+  # A payout scheduled from your Inttegro balance to a destination financial account
+  #
+  # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+  # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+  # field names and serialized enum values.
+  #
+  # @api public
+  #
+  # @!attribute [r] amount
+  #   Value of the `amount` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `amount`.
+  #   @return [Inttegro::Money::Amount, nil]
+  #
+  # @!attribute [r] balance_transactions
+  #   Balance transaction IDs linked to this payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `balance_transactions`.
+  #   @return [Array<String>, nil]
+  #
+  # @!attribute [r] canceled_at
+  #   When the payout was canceled
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `canceled_at`.
+  #   @return [Time, 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] destination_id
+  #   Financial account receiving the funds
+  #
+  #   Required in the API payload. Wire name: `destination_id`.
+  #   @return [String]
+  #
+  # @!attribute [r] error
+  #   Public failure details when execution fails
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `error`.
+  #   @return [Inttegro::Payout::Error, nil]
+  #
+  # @!attribute [r] execute_after
+  #   Earliest moment payout execution may begin
+  #
+  #   Required in the API payload. Wire name: `execute_after`.
+  #   @return [Time]
+  #
+  # @!attribute [r] executed_by
+  #   Actor that executed the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `executed_by`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] expected_at
+  #   Expected completion time
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `expected_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] failed_at
+  #   When the payout entered its unsuccessful terminal state
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `failed_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] id
+  #   Unique payout identifier
+  #
+  #   Required in the API payload. Wire name: `id`.
+  #   @return [String]
+  #
+  # @!attribute [r] initiated_at
+  #   When the payout was created
+  #
+  #   Required in the API payload. Wire name: `initiated_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] initiated_by
+  #   Actor that initiated the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `initiated_by`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] max_amount
+  #   Value of the `max_amount` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `max_amount`.
+  #   @return [Inttegro::Money::Amount]
+  #
+  # @!attribute [r] reference
+  #   Merchant reference carried on the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] schedule_id
+  #   Schedule associated with the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `schedule_id`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] scheduled_at
+  #   When the payout was scheduled
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `scheduled_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] scheduled_by
+  #   Actor that scheduled the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `scheduled_by`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] sent_at
+  #   When the transfer was sent
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] source_id
+  #   Source identifier associated with the payout
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `source_id`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] status
+  #   Current payout lifecycle state
+  #
+  #   Required in the API payload. Wire name: `status`.
+  #   @return [Inttegro::Payout::Status]
+  #
+  # @!attribute [r] succeeded_at
+  #   When the payout succeeded
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `succeeded_at`.
+  #   @return [Time, nil]
+  class Payout
+    const :amount, T.nilable(Inttegro::Money::Amount), default: nil
+    const :balance_transactions, T.nilable(T::Array[String]), default: nil
+    const :canceled_at, T.nilable(Time), default: nil
+    const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    const :destination_id, String
+    const :error, T.nilable(Inttegro::Payout::Error), default: nil
+    const :execute_after, Time
+    const :executed_by, T.nilable(String), default: nil
+    const :expected_at, T.nilable(Time), default: nil
+    const :failed_at, T.nilable(Time), default: nil
+    const :id, String
+    const :initiated_at, Time
+    const :initiated_by, T.nilable(String), default: nil
+    const :max_amount, Inttegro::Money::Amount
+    const :reference, T.nilable(String), default: nil
+    const :schedule_id, T.nilable(String), default: nil
+    const :scheduled_at, T.nilable(Time), default: nil
+    const :scheduled_by, T.nilable(String), default: nil
+    const :sent_at, T.nilable(Time), default: nil
+    const :source_id, T.nilable(String), default: nil
+    const :status, Inttegro::Payout::Status
+    const :succeeded_at, T.nilable(Time), default: nil
+  end
+end