inttegro 4.3.1 → 6.0.0

data/lib/inttegro/otp/initiate_request.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 "alphabet_type"
+
+module Inttegro
+  module OTP
+    # Typed representation of the initiate 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] async_delivery
+    #   Return after accepting the transaction while SMS delivery continues asynchronously.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `async_delivery`.
+    #   @return [Boolean, nil]
+    #
+    # @!attribute [r] message_template
+    #   SMS text containing the required `{token}` placeholder and optional `{service}` placeholder.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `message_template`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purpose
+    #   Your label for the verification flow.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] recipient
+    #   Phone number in international format (E.164)
+    #
+    #   Required in the API payload. Wire name: `recipient`.
+    #   @return [String]
+    #
+    # @!attribute [r] sender
+    #   Optional sender identifier shown to the recipient (3-12 characters).
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sender`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] service_name
+    #   Service name substituted for `{service}` (2-20 characters).
+    #
+    #   Required in the API payload. Wire name: `service_name`.
+    #   @return [String]
+    #
+    # @!attribute [r] token_alphabet
+    #   Custom alphabet for token generation (mutually exclusive with token_alphabet_type)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `token_alphabet`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] token_alphabet_type
+    #   Predefined alphabet type (mutually exclusive with token_alphabet)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `token_alphabet_type`.
+    #   @return [Inttegro::OTP::AlphabetType, nil]
+    #
+    # @!attribute [r] token_size
+    #   Length of generated token (5-10 characters)
+    #
+    #   Required in the API payload. Wire name: `token_size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] validity_duration_in_minutes
+    #   How long the token remains valid (3-10080 minutes)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `validity_duration_in_minutes`.
+    #   @return [Integer, nil]
+    class InitiateRequest < T::Struct
+      const :async_delivery, T.nilable(T::Boolean), default: nil
+      const :message_template, T.nilable(String), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :recipient, String
+      const :sender, T.nilable(String), default: nil
+      const :service_name, String
+      const :token_alphabet, T.nilable(String), default: nil
+      const :token_alphabet_type, T.nilable(Inttegro::OTP::AlphabetType), default: nil
+      const :token_size, Integer
+      const :validity_duration_in_minutes, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/otp/initiate_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 "transaction"
+
+module Inttegro
+  module OTP
+    # Typed representation of the initiate 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] transaction
+    #   OTP transaction object returned by initiate, verify, and lookup endpoints
+    #
+    #   Required in the API payload. Wire name: `transaction`.
+    #   @return [Inttegro::OTP::Transaction]
+    class InitiateResponse < T::Struct
+      const :transaction, Inttegro::OTP::Transaction
+    end
+  end
+end

data/lib/inttegro/otp/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
+  module OTP
+    # 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
+    #   ID of the OTP transaction to lookup (with ot_ prefix)
+    #
+    #   Required in the API payload. Wire name: `transaction_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :transaction_id, String
+    end
+  end
+end

data/lib/inttegro/otp/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 "transaction"
+
+module Inttegro
+  module OTP
+    # 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] transaction
+    #   OTP transaction object returned by initiate, verify, and lookup endpoints
+    #
+    #   Required in the API payload. Wire name: `transaction`.
+    #   @return [Inttegro::OTP::Transaction]
+    class LookupResponse < T::Struct
+      const :transaction, Inttegro::OTP::Transaction
+    end
+  end
+end

data/lib/inttegro/otp/status.rb

@@ -0,0 +1,39 @@
+# 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 OTP
+    # String-backed values accepted by the Inttegro API for Inttegro::OTP::Status.
+    #
+    # 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 Status < T::Enum
+      enums do
+        # Serialized wire value: `canceled`.
+        # @return [Inttegro::OTP::Status]
+        CANCELED = new("canceled")
+        # Serialized wire value: `expired`.
+        # @return [Inttegro::OTP::Status]
+        EXPIRED = new("expired")
+        # Serialized wire value: `pending`.
+        # @return [Inttegro::OTP::Status]
+        PENDING = new("pending")
+        # Serialized wire value: `pending_delivery`.
+        # @return [Inttegro::OTP::Status]
+        PENDING_DELIVERY = new("pending_delivery")
+        # Serialized wire value: `pending_verification`.
+        # @return [Inttegro::OTP::Status]
+        PENDING_VERIFICATION = new("pending_verification")
+        # Serialized wire value: `verified`.
+        # @return [Inttegro::OTP::Status]
+        VERIFIED = new("verified")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/transaction.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "status"
+require_relative "transmission"
+
+module Inttegro
+  module OTP
+    # OTP transaction object returned by initiate, verify, and lookup endpoints
+    #
+    # 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] cancel_reason
+    #   Omitted unless the transaction was canceled.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `cancel_reason`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] canceled_at
+    #   Omitted unless the transaction was canceled.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `canceled_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] expires_at
+    #   Value of the `expires_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `expires_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] full_message
+    #   Message text with the `{token}` placeholder preserved; no generated token is returned.
+    #
+    #   Required in the API payload. Wire name: `full_message`.
+    #   @return [String]
+    #
+    # @!attribute [r] id
+    #   Unique identifier with ot_ prefix
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] initiated_at
+    #   Value of the `initiated_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `initiated_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [Inttegro::OTP::Status]
+    #
+    # @!attribute [r] transmission
+    #   Value of the `transmission` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `transmission`.
+    #   @return [Inttegro::OTP::Transmission, nil]
+    class Transaction < T::Struct
+      const :cancel_reason, T.nilable(String), default: nil
+      const :canceled_at, T.nilable(Time), default: nil
+      const :expires_at, Time
+      const :full_message, String
+      const :id, String
+      const :initiated_at, Time
+      const :status, Inttegro::OTP::Status
+      const :transmission, T.nilable(Inttegro::OTP::Transmission), default: nil
+    end
+  end
+end

data/lib/inttegro/otp/transmission.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "transmission_sent_via"
+require_relative "transmission_status"
+
+module Inttegro
+  module OTP
+    # Typed representation of the transmission 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] recipient
+    #   Value of the `recipient` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipient`.
+    #   @return [String]
+    #
+    # @!attribute [r] sender_id
+    #   Value of the `sender_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sender_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] sent_at
+    #   Value of the `sent_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] sent_via
+    #   Value of the `sent_via` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_via`.
+    #   @return [Inttegro::OTP::TransmissionSentVia, nil]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `status`.
+    #   @return [Inttegro::OTP::TransmissionStatus, nil]
+    class Transmission < T::Struct
+      const :recipient, String
+      const :sender_id, String
+      const :sent_at, T.nilable(Time), default: nil
+      const :sent_via, T.nilable(Inttegro::OTP::TransmissionSentVia), default: nil
+      const :status, T.nilable(Inttegro::OTP::TransmissionStatus), default: nil
+    end
+  end
+end

data/lib/inttegro/otp/transmission_sent_via.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module OTP
+    # String-backed values accepted by the Inttegro API for Inttegro::OTP::TransmissionSentVia.
+    #
+    # 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 TransmissionSentVia < T::Enum
+      enums do
+        # Serialized wire value: `sms`.
+        # @return [Inttegro::OTP::TransmissionSentVia]
+        SMS = new("sms")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/transmission_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 OTP
+    # String-backed values accepted by the Inttegro API for Inttegro::OTP::TransmissionStatus.
+    #
+    # 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 TransmissionStatus < T::Enum
+      enums do
+        # Serialized wire value: `delivered`.
+        # @return [Inttegro::OTP::TransmissionStatus]
+        DELIVERED = new("delivered")
+        # Serialized wire value: `failed`.
+        # @return [Inttegro::OTP::TransmissionStatus]
+        FAILED = new("failed")
+        # Serialized wire value: `submitted`.
+        # @return [Inttegro::OTP::TransmissionStatus]
+        SUBMITTED = new("submitted")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/verification.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "transaction"
+require_relative "verification_attempt"
+
+module Inttegro
+  module OTP
+    # Typed representation of the verification 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
+    #   OTP transaction object returned by initiate, verify, and lookup endpoints
+    #
+    #   Required in the API payload. Wire name: `transaction`.
+    #   @return [Inttegro::OTP::Transaction]
+    #
+    # @!attribute [r] verification_attempt
+    #   Details of a verification attempt
+    #
+    #   Required in the API payload. Wire name: `verification_attempt`.
+    #   @return [Inttegro::OTP::VerificationAttempt]
+    class Verification < T::Struct
+      const :transaction, Inttegro::OTP::Transaction
+      const :verification_attempt, Inttegro::OTP::VerificationAttempt
+    end
+  end
+end

data/lib/inttegro/otp/verification_attempt.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 "verification_attempt_result"
+
+module Inttegro
+  module OTP
+    # Details of a verification attempt
+    #
+    # 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] attempted_at
+    #   Value of the `attempted_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `attempted_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] presented_token
+    #   Token submitted for this verification attempt.
+    #
+    #   Required in the API payload. Wire name: `presented_token`.
+    #   @return [String]
+    #
+    # @!attribute [r] recipient
+    #   Value of the `recipient` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipient`.
+    #   @return [String]
+    #
+    # @!attribute [r] result
+    #   Value of the `result` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `result`.
+    #   @return [Inttegro::OTP::VerificationAttemptResult]
+    class VerificationAttempt < T::Struct
+      const :attempted_at, Time
+      const :id, String
+      const :presented_token, String
+      const :recipient, String
+      const :result, Inttegro::OTP::VerificationAttemptResult
+    end
+  end
+end

data/lib/inttegro/otp/verification_attempt_result.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 "verification_verdict"
+
+module Inttegro
+  module OTP
+    # Typed representation of the verification attempt result 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] detail
+    #   Omitted when no detail is available.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `detail`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] verdict
+    #   Value of the `verdict` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `verdict`.
+    #   @return [Inttegro::OTP::VerificationVerdict]
+    class VerificationAttemptResult < T::Struct
+      const :detail, T.nilable(String), default: nil
+      const :verdict, Inttegro::OTP::VerificationVerdict
+    end
+  end
+end

data/lib/inttegro/otp/verification_verdict.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 OTP
+    # String-backed values accepted by the Inttegro API for Inttegro::OTP::VerificationVerdict.
+    #
+    # 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 VerificationVerdict < T::Enum
+      enums do
+        # Serialized wire value: `fail`.
+        # @return [Inttegro::OTP::VerificationVerdict]
+        FAIL = new("fail")
+        # Serialized wire value: `pass`.
+        # @return [Inttegro::OTP::VerificationVerdict]
+        PASS = new("pass")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/verify_request.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 OTP
+    # Typed representation of the verify 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
+    #   ID of the OTP transaction to verify (with ot_ prefix)
+    #
+    #   Required in the API payload. Wire name: `transaction_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] recipient
+    #   Phone number that received the OTP
+    #
+    #   Required in the API payload. Wire name: `recipient`.
+    #   @return [String]
+    #
+    # @!attribute [r] token
+    #   OTP token submitted by the user
+    #
+    #   Required in the API payload. Wire name: `token`.
+    #   @return [String]
+    class VerifyRequest < T::Struct
+      const :transaction_id, String
+      const :recipient, String
+      const :token, String
+    end
+  end
+end

data/lib/inttegro/payment/attempt_status.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 Payment
+    # String-backed values accepted by the Inttegro API for Inttegro::Payment::AttemptStatus.
+    #
+    # 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 AttemptStatus < T::Enum
+      enums do
+        # Serialized wire value: `initiated`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        INITIATED = new("initiated")
+        # Serialized wire value: `executed`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        EXECUTED = new("executed")
+        # Serialized wire value: `succeeded`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        SUCCEEDED = new("succeeded")
+        # Serialized wire value: `canceled`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        CANCELED = new("canceled")
+        # Serialized wire value: `expired`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        EXPIRED = new("expired")
+        # Serialized wire value: `failed`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        FAILED = new("failed")
+        # Serialized wire value: `unknown`.
+        # @return [Inttegro::Payment::AttemptStatus]
+        UNKNOWN = new("unknown")
+      end
+    end
+  end
+end

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