inttegro 4.3.1 → 6.0.0

data/lib/inttegro/order/product_line_item.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 "product_line_item_product"
+require_relative "product_line_item_type"
+
+module Inttegro
+  class Order
+    # Typed representation of the product line item 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] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Order::ProductLineItemType]
+    #
+    # @!attribute [r] product
+    #   Value of the `product` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `product`.
+    #   @return [Inttegro::Order::ProductLineItemProduct]
+    class ProductLineItem < T::Struct
+      const :type, Inttegro::Order::ProductLineItemType
+      const :product, Inttegro::Order::ProductLineItemProduct
+    end
+  end
+end

data/lib/inttegro/order/product_line_item_product.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../price/price"
+
+module Inttegro
+  class Order
+    # Typed representation of the product line item product 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
+    #   Immutable order-line identifier with the `oli_` prefix.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] product_id
+    #   Source catalog product ID when this line snapshots a catalog product.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `product_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] price_id
+    #   Source catalog price ID when this line snapshots a saved price.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `price_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] reference
+    #   Value of the `reference` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] about
+    #   Value of the `about` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, 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] tax_code
+    #   Value of the `tax_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `tax_code`.
+    #   @return [String, nil]
+    #
+    # @!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] category
+    #   Value of the `category` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `category`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `type`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] price
+    #   An inline price returned by the API.
+    #
+    #   Required in the API payload. Wire name: `price`.
+    #   @return [Inttegro::Price]
+    #
+    # @!attribute [r] quantity
+    #   Value of the `quantity` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `quantity`.
+    #   @return [Integer]
+    class ProductLineItemProduct < T::Struct
+      const :id, String
+      const :product_id, T.nilable(String), default: nil
+      const :price_id, T.nilable(String), default: nil
+      const :reference, T.nilable(String), default: nil
+      const :about, T.nilable(String), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :name, String
+      const :category, T.nilable(String), default: nil
+      const :type, T.nilable(String), default: nil
+      const :price, Inttegro::Price
+      const :quantity, Integer
+    end
+  end
+end

data/lib/inttegro/order/product_line_item_type.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
+  class Order
+    # String-backed values accepted by the Inttegro API for Inttegro::Order::ProductLineItemType.
+    #
+    # 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 ProductLineItemType < T::Enum
+      enums do
+        # Serialized wire value: `product`.
+        # @return [Inttegro::Order::ProductLineItemType]
+        PRODUCT = new("product")
+      end
+    end
+  end
+end

data/lib/inttegro/order/questions.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class Order
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    # Determine whether this order is recorded as paid.
+    #
+    # An order is considered paid when its status is +Status::PAID+ or the API supplied
+    # {#paid_at}. This is a convenience query over the current object and performs no network call.
+    #
+    # @return [Boolean] whether payment is recorded on the order
+    def paid?
+      status == Inttegro::Order::Status::PAID || !paid_at.nil?
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the order currently requires payment.
+    #
+    # @return [Boolean] whether {#status} is +Status::REQUIRES_PAYMENT+
+    def requires_payment?
+      status == Inttegro::Order::Status::REQUIRES_PAYMENT
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the order has reached an end state.
+    #
+    # Paid, completed, canceled, and expired orders are terminal according to this local predicate.
+    #
+    # @return [Boolean] whether the current status is terminal
+    def terminal?
+      [
+        Inttegro::Order::Status::PAID,
+        Inttegro::Order::Status::COMPLETED,
+        Inttegro::Order::Status::CANCELED,
+        Inttegro::Order::Status::EXPIRED
+      ].include?(status)
+    end
+
+    sig { returns(T.nilable(Inttegro::Payment::NextAction)) }
+    # Return the action a customer must complete for the current payment, if any.
+    #
+    # The result is delegated to {Inttegro::Payment#required_action}; orders without a payment,
+    # payments outside +requires_action+, and payments without action data return +nil+.
+    #
+    # @return [Inttegro::Payment::NextAction, nil] actionable payment instructions, when required
+    def required_payment_action
+      payment&.required_action
+    end
+  end
+end

data/lib/inttegro/order/shipping_line_item.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 "shipping_line_item_shipping"
+require_relative "shipping_line_item_type"
+
+module Inttegro
+  class Order
+    # Typed representation of the shipping line item 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] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Order::ShippingLineItemType]
+    #
+    # @!attribute [r] shipping
+    #   Value of the `shipping` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `shipping`.
+    #   @return [Inttegro::Order::ShippingLineItemShipping]
+    class ShippingLineItem < T::Struct
+      const :type, Inttegro::Order::ShippingLineItemType
+      const :shipping, Inttegro::Order::ShippingLineItemShipping
+    end
+  end
+end

data/lib/inttegro/order/shipping_line_item_shipping.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../money/amount"
+
+module Inttegro
+  class Order
+    # Typed representation of the shipping line item shipping 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
+    #   Immutable order-line identifier with the `oli_` prefix.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] tax_code
+    #   Value of the `tax_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `tax_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] label
+    #   Value of the `label` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] fee
+    #   Value of the `fee` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `fee`.
+    #   @return [Inttegro::Money::Amount]
+    class ShippingLineItemShipping < T::Struct
+      const :id, String
+      const :tax_code, T.nilable(String), default: nil
+      const :label, T.nilable(String), default: nil
+      const :fee, Inttegro::Money::Amount
+    end
+  end
+end

data/lib/inttegro/order/shipping_line_item_type.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
+  class Order
+    # String-backed values accepted by the Inttegro API for Inttegro::Order::ShippingLineItemType.
+    #
+    # 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 ShippingLineItemType < T::Enum
+      enums do
+        # Serialized wire value: `shipping`.
+        # @return [Inttegro::Order::ShippingLineItemType]
+        SHIPPING = new("shipping")
+      end
+    end
+  end
+end

data/lib/inttegro/order/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 Order
+    # Current lifecycle state of the order
+    #
+    # 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: `preparing`.
+        # @return [Inttegro::Order::Status]
+        PREPARING = new("preparing")
+        # Serialized wire value: `requires_payment`.
+        # @return [Inttegro::Order::Status]
+        REQUIRES_PAYMENT = new("requires_payment")
+        # Serialized wire value: `paid`.
+        # @return [Inttegro::Order::Status]
+        PAID = new("paid")
+        # Serialized wire value: `completed`.
+        # @return [Inttegro::Order::Status]
+        COMPLETED = new("completed")
+        # Serialized wire value: `canceled`.
+        # @return [Inttegro::Order::Status]
+        CANCELED = new("canceled")
+        # Serialized wire value: `expired`.
+        # @return [Inttegro::Order::Status]
+        EXPIRED = new("expired")
+        # Serialized wire value: `unknown`.
+        # @return [Inttegro::Order::Status]
+        UNKNOWN = new("unknown")
+      end
+    end
+  end
+end

data/lib/inttegro/order/update_request.rb

@@ -0,0 +1,117 @@
+# 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/invoice_settings"
+require_relative "../shared/line_item"
+require_relative "update_request_payment_method_data"
+
+module Inttegro
+  class Order
+    # 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] clear_payment_method
+    #   Clears the currently attached payment method. Mutually exclusive with `payment_method_id`
+    #   and `payment_method_data`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `clear_payment_method`.
+    #   @return [Boolean, 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] invoice_settings
+    #   Order-level invoice rendering data. Pages uses this data when rendering invoice web and
+    #   download views.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `invoice_settings`.
+    #   @return [Inttegro::Shared::InvoiceSettings, nil]
+    #
+    # @!attribute [r] finalize
+    #   Explicit seal decision. Set to `false` to reopen a sealed order and leave it open, or `true`
+    #   to seal or reseal the order after applying the requested mutations.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `finalize`.
+    #   @return [Boolean, nil]
+    #
+    # @!attribute [r] line_items
+    #   Full replacement for the order's line items. Omit this field to keep the current line items
+    #   unchanged.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line_items`.
+    #   @return [Array<Inttegro::Shared::LineItem>, nil]
+    #
+    # @!attribute [r] number
+    #   Replacement order number.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] receipt_number
+    #   Replacement receipt number. Once set, it cannot be unset; provide a different non-empty
+    #   value to change it. No uniqueness is enforced.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `receipt_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] order_id
+    #   Unique identifier of the order to update.
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] payment_method_data
+    #   New payment method details to tokenize and attach to the order. Currently only
+    #   `mobile_money` is supported for order updates. When using inline mobile money details,
+    #   include `billing_details.name` and `billing_details.address.country`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method_data`.
+    #   @return [Inttegro::Order::UpdateRequestPaymentMethodData, nil]
+    #
+    # @!attribute [r] payment_method_id
+    #   ID of a saved payment method to attach to the order. Mutually exclusive with
+    #   `payment_method_data` and `clear_payment_method`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] statement_descriptor
+    #   Replacement payment statement descriptor for the order's payment.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `statement_descriptor`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] statement_descriptor_prefix
+    #   Static prefix used to build the replacement descriptor as `prefix*order_id`. Mutually
+    #   exclusive with `statement_descriptor`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `statement_descriptor_prefix`.
+    #   @return [String, nil]
+    class UpdateRequest < T::Struct
+      const :clear_payment_method, T.nilable(T::Boolean), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :invoice_settings, T.nilable(Inttegro::Shared::InvoiceSettings), default: nil
+      const :finalize, T.nilable(T::Boolean), default: nil
+      const :line_items, T.nilable(T::Array[Inttegro::Shared::LineItem]), default: nil
+      const :number, T.nilable(String), default: nil
+      const :receipt_number, T.nilable(String), default: nil
+      const :order_id, String
+      const :payment_method_data, T.nilable(Inttegro::Order::UpdateRequestPaymentMethodData), default: nil
+      const :payment_method_id, T.nilable(String), default: nil
+      const :statement_descriptor, T.nilable(String), default: nil
+      const :statement_descriptor_prefix, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/update_request_payment_method_data.rb

@@ -0,0 +1,38 @@
+# 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/data_mobile_money"
+require_relative "update_request_payment_method_data_type"
+
+module Inttegro
+  class Order
+    # New payment method details to tokenize and attach to the order. Currently only
+    # `mobile_money` is supported for order updates. When using inline mobile money details,
+    # include `billing_details.name` and `billing_details.address.country`.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] type
+    #   Payment rail type (currently only mobile_money supported)
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Order::UpdateRequestPaymentMethodDataType]
+    #
+    # @!attribute [r] mobile_money
+    #   Mobile money wallet details (required when type is mobile_money)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `mobile_money`.
+    #   @return [Inttegro::PaymentMethod::DataMobileMoney, nil]
+    class UpdateRequestPaymentMethodData < T::Struct
+      const :type, Inttegro::Order::UpdateRequestPaymentMethodDataType
+      const :mobile_money, T.nilable(Inttegro::PaymentMethod::DataMobileMoney), default: nil
+    end
+  end
+end

data/lib/inttegro/order/update_request_payment_method_data_type.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
+  class Order
+    # Payment rail type (currently only mobile_money supported)
+    #
+    # 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 UpdateRequestPaymentMethodDataType < T::Enum
+      enums do
+        # Serialized wire value: `mobile_money`.
+        # @return [Inttegro::Order::UpdateRequestPaymentMethodDataType]
+        MOBILE_MONEY = new("mobile_money")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/alphabet_type.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
+    # Predefined alphabet type (mutually exclusive with token_alphabet)
+    #
+    # 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 AlphabetType < T::Enum
+      enums do
+        # Serialized wire value: `numeric`.
+        # @return [Inttegro::OTP::AlphabetType]
+        NUMERIC = new("numeric")
+        # Serialized wire value: `alpha`.
+        # @return [Inttegro::OTP::AlphabetType]
+        ALPHA = new("alpha")
+        # Serialized wire value: `alphanumeric`.
+        # @return [Inttegro::OTP::AlphabetType]
+        ALPHANUMERIC = new("alphanumeric")
+      end
+    end
+  end
+end

data/lib/inttegro/otp/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 otp 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 OTP
+  end
+end