inttegro 5.0.0 → 6.0.0

data/lib/inttegro/order/fee_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::FeeLineItemType.
+    #
+    # 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 FeeLineItemType < T::Enum
+      enums do
+        # Serialized wire value: `fee`.
+        # @return [Inttegro::Order::FeeLineItemType]
+        FEE = new("fee")
+      end
+    end
+  end
+end

data/lib/inttegro/order/finalize_envelope.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "order"
+
+module Inttegro
+  class Order
+    # Typed representation of the finalize envelope 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] order
+    #   Complete order record with line items, customer details, payment state, and fulfillment
+    #   information
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `order`.
+    #   @return [Inttegro::Order, nil]
+    class FinalizeEnvelope < T::Struct
+      const :order, T.nilable(Inttegro::Order), default: nil
+    end
+  end
+end

data/lib/inttegro/order/finalize_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 Order
+    # Typed representation of the finalize 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] order_id
+    #   Unique identifier of the order to finalize
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    class FinalizeRequest < T::Struct
+      const :order_id, String
+    end
+  end
+end

data/lib/inttegro/order/invoice.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 "invoice_format"
+
+module Inttegro
+  class Order
+    # Typed representation of the invoice 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
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] format_value
+    #   Value of the `format` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `format`.
+    #   @return [Inttegro::Order::InvoiceFormat]
+    class Invoice < T::Struct
+      const :number, T.nilable(String), default: nil
+      const :format_value, Inttegro::Order::InvoiceFormat, name: "format"
+    end
+  end
+end

data/lib/inttegro/order/invoice_format.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 "document_format"
+
+module Inttegro
+  class Order
+    # Typed representation of the invoice format 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] web
+    #   Value of the `web` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `web`.
+    #   @return [Inttegro::Order::DocumentFormat]
+    #
+    # @!attribute [r] pdf
+    #   Value of the `pdf` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `pdf`.
+    #   @return [Inttegro::Order::DocumentFormat]
+    #
+    # @!attribute [r] receipt
+    #   Value of the `receipt` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `receipt`.
+    #   @return [Inttegro::Order::DocumentFormat, nil]
+    class InvoiceFormat < T::Struct
+      const :web, Inttegro::Order::DocumentFormat
+      const :pdf, Inttegro::Order::DocumentFormat
+      const :receipt, T.nilable(Inttegro::Order::DocumentFormat), default: nil
+    end
+  end
+end

data/lib/inttegro/order/line_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "discount_line_item"
+require_relative "fee_line_item"
+require_relative "product_line_item"
+require_relative "shipping_line_item"
+
+module Inttegro
+  class Order
+    # Typed representation of the line item object in the Inttegro API.
+    #
+    # @api public
+    # @return [Inttegro::Order::ProductLineItem, Inttegro::Order::FeeLineItem, Inttegro::Order::ShippingLineItem, Inttegro::Order::DiscountLineItem]
+    LineItem = T.type_alias { T.any(Inttegro::Order::ProductLineItem, Inttegro::Order::FeeLineItem, Inttegro::Order::ShippingLineItem, Inttegro::Order::DiscountLineItem) }
+  end
+end

data/lib/inttegro/order/line_item_group.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 "../money/amount"
+require_relative "line_item"
+
+module Inttegro
+  class Order
+    # Cart contents and totals
+    #
+    # 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] line_items
+    #   Array of products, fees, and shipping charges
+    #
+    #   Required in the API payload. Wire name: `line_items`.
+    #   @return [Array<Inttegro::Order::LineItem>]
+    #
+    # @!attribute [r] total
+    #   Value of the `total` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `total`.
+    #   @return [Inttegro::Money::Amount]
+    class LineItemGroup < T::Struct
+      const :line_items, T::Array[Inttegro::Order::LineItem]
+      const :total, Inttegro::Money::Amount
+    end
+  end
+end

data/lib/inttegro/order/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 Order
+    # 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] order_id
+    #   Unique identifier of the order to lookup
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :order_id, String
+    end
+  end
+end

data/lib/inttegro/order/order.rb

@@ -0,0 +1,177 @@
+# 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/payment"
+require_relative "../refund/refund"
+require_relative "../shared/invoice_settings"
+require_relative "checkout_settings"
+require_relative "created_from"
+require_relative "customer"
+require_relative "invoice"
+require_relative "line_item_group"
+require_relative "status"
+
+module Inttegro
+  # Complete order record with line items, customer details, payment state, and fulfillment
+  # information
+  #
+  # 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] canceled_at
+  #   When the order was canceled. Omitted otherwise.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `canceled_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] checkout_settings
+  #   Checkout and payment flow configuration for this order
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `checkout_settings`.
+  #   @return [Inttegro::Order::CheckoutSettings, nil]
+  #
+  # @!attribute [r] completed_at
+  #   When the order was completed. Omitted otherwise.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `completed_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] created_from
+  #   Attribution for the public resource that created this order, when available.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `created_from`.
+  #   @return [Inttegro::Order::CreatedFrom, 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] customer
+  #   Value of the `customer` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `customer`.
+  #   @return [Inttegro::Order::Customer]
+  #
+  # @!attribute [r] expires_at
+  #   When the order expires. Omitted when no expiry is set.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `expires_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] id
+  #   Unique identifier for this order
+  #
+  #   Required in the API payload. Wire name: `id`.
+  #   @return [String]
+  #
+  # @!attribute [r] initiated_at
+  #   When order processing began
+  #
+  #   Required in the API payload. Wire name: `initiated_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] invoice
+  #   Value of the `invoice` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `invoice`.
+  #   @return [Inttegro::Order::Invoice, nil]
+  #
+  # @!attribute [r] number
+  #   Human-readable order number
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] receipt_number
+  #   Merchant-provided receipt number, when set
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `receipt_number`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] refunds
+  #   All refunds issued for this order, newest first. Omitted when no refunds exist.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `refunds`.
+  #   @return [Array<Inttegro::Refund>, 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] status
+  #   Current lifecycle state of the order
+  #
+  #   Required in the API payload. Wire name: `status`.
+  #   @return [Inttegro::Order::Status]
+  #
+  # @!attribute [r] sealed_at
+  #   When the order was finalized and became immutable—ready for payment or fulfillment
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `sealed_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] line_item_group
+  #   Cart contents and totals
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `line_item_group`.
+  #   @return [Inttegro::Order::LineItemGroup, nil]
+  #
+  # @!attribute [r] payment
+  #   Payment intent tied to this order
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment`.
+  #   @return [Inttegro::Payment, nil]
+  #
+  # @!attribute [r] paid_at
+  #   When the order became paid
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `paid_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] payment_due_at
+  #   When the order payment becomes overdue
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_due_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] reference
+  #   External order reference when present
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+  #   @return [String, nil]
+  class Order
+    const :canceled_at, T.nilable(Time), default: nil
+    const :checkout_settings, T.nilable(Inttegro::Order::CheckoutSettings), default: nil
+    const :completed_at, T.nilable(Time), default: nil
+    const :created_from, T.nilable(Inttegro::Order::CreatedFrom), default: nil
+    const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    const :customer, Inttegro::Order::Customer
+    const :expires_at, T.nilable(Time), default: nil
+    const :id, String
+    const :initiated_at, Time
+    const :invoice, T.nilable(Inttegro::Order::Invoice), default: nil
+    const :number, T.nilable(String), default: nil
+    const :receipt_number, T.nilable(String), default: nil
+    const :refunds, T.nilable(T::Array[Inttegro::Refund]), default: nil
+    const :invoice_settings, T.nilable(Inttegro::Shared::InvoiceSettings), default: nil
+    const :status, Inttegro::Order::Status
+    const :sealed_at, T.nilable(Time), default: nil
+    const :line_item_group, T.nilable(Inttegro::Order::LineItemGroup), default: nil
+    const :payment, T.nilable(Inttegro::Payment), default: nil
+    const :paid_at, T.nilable(Time), default: nil
+    const :payment_due_at, T.nilable(Time), default: nil
+    const :reference, T.nilable(String), default: nil
+  end
+end

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

data/lib/inttegro/order/page_envelope.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 Order
+    # Typed representation of the page envelope 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::Order::Page, nil]
+    class PageEnvelope < T::Struct
+      const :page, T.nilable(Inttegro::Order::Page), default: nil
+    end
+  end
+end

data/lib/inttegro/order/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 Order
+    # 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
+    #   Zero-based page index to fetch (0-10 inclusive)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] page_size
+    #   Number of orders per page (1-256)
+    #
+    #   Required in the API payload. Wire name: `page_size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] customer_id
+    #   When provided, restricts results to orders belonging to this customer. The customer must
+    #   belong to the authenticated application.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_id`.
+    #   @return [String, nil]
+    class PageRequest < T::Struct
+      const :page_number, T.nilable(Integer), default: nil
+      const :page_size, Integer
+      const :customer_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/pay_request.rb

@@ -0,0 +1,51 @@
+# 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"
+
+module Inttegro
+  class Order
+    # Typed representation of the pay 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] order_id
+    #   Unique identifier of the order to pay
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] payment_method_data
+    #   Payment instrument details for tokenization
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method_data`.
+    #   @return [Inttegro::PaymentMethod::Data, nil]
+    #
+    # @!attribute [r] payment_method_id
+    #   ID of a saved payment method to use for this payment
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_method_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] paid_out_of_band
+    #   Set to true if payment was received outside Inttegro (cash, bank transfer, check). Marks the
+    #   payment as paid offline. Mutually exclusive with payment_method_id and payment_method_data.
+    #   Defaults to false.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `paid_out_of_band`.
+    #   @return [Boolean, nil]
+    class PayRequest < T::Struct
+      const :order_id, String
+      const :payment_method_data, T.nilable(Inttegro::PaymentMethod::Data), default: nil
+      const :payment_method_id, T.nilable(String), default: nil
+      const :paid_out_of_band, T.nilable(T::Boolean), default: nil
+    end
+  end
+end

data/lib/inttegro/order/payout_settings_request.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 "payout_settings_request_destination"
+
+module Inttegro
+  class Order
+    # Typed representation of the payout settings 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] destination
+    #   Value of the `destination` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `destination`.
+    #   @return [Inttegro::Order::PayoutSettingsRequestDestination, nil]
+    #
+    # @!attribute [r] enable_fx
+    #   Omit this field or set it to false. Cross-currency payouts are not currently available.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `enable_fx`.
+    #   @return [Boolean, nil]
+    class PayoutSettingsRequest < T::Struct
+      const :destination, T.nilable(Inttegro::Order::PayoutSettingsRequestDestination), default: nil
+      const :enable_fx, T.nilable(T::Boolean), default: nil
+    end
+  end
+end

data/lib/inttegro/order/payout_settings_request_destination.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 Order
+    # Typed representation of the payout settings request destination 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] financial_account_id
+    #   Same-currency financial account with push capability enabled
+    #
+    #   Required in the API payload. Wire name: `financial_account_id`.
+    #   @return [String]
+    class PayoutSettingsRequestDestination < T::Struct
+      const :financial_account_id, String
+    end
+  end
+end