inttegro 4.3.1 → 6.0.0

data/lib/inttegro/order/create_new_customer_checkout_settings.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"
+
+module Inttegro
+  class Order
+    # Checkout and payment flow configuration. Strongly recommended to provide both redirect_url
+    # and cancel_url for a delightful customer experience.
+    #
+    # 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] redirect_url
+    #   URL to redirect customer after payment completion
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `redirect_url`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] cancel_url
+    #   URL to redirect customer if they cancel payment
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `cancel_url`.
+    #   @return [String, nil]
+    class CreateNewCustomerCheckoutSettings < T::Struct
+      const :redirect_url, T.nilable(String), default: nil
+      const :cancel_url, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/create_new_customer_request_meta.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
+    # Optional metadata controlling request processing
+    #
+    # 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] idempotency_key
+    #   Unique key to prevent duplicate order creation
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    class CreateNewCustomerRequestMeta < T::Struct
+      const :idempotency_key, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/created_from.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 "created_from_resource_type"
+
+module Inttegro
+  class Order
+    # Attribution for the public resource that created this order, when available.
+    #
+    # 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] source
+    #   Value of the `source` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `source`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] resource_type
+    #   Value of the `resource_type` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `resource_type`.
+    #   @return [Inttegro::Order::CreatedFromResourceType, nil]
+    #
+    # @!attribute [r] resource_id
+    #   Value of the `resource_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `resource_id`.
+    #   @return [String, nil]
+    class CreatedFrom < T::Struct
+      const :source, T.nilable(String), default: nil
+      const :resource_type, T.nilable(Inttegro::Order::CreatedFromResourceType), default: nil
+      const :resource_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/created_from_resource_type.rb

@@ -0,0 +1,25 @@
+# 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::CreatedFromResourceType.
+    #
+    # 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 CreatedFromResourceType < T::Enum
+      enums do
+        # Serialized wire value: `purchase_intent`.
+        # @return [Inttegro::Order::CreatedFromResourceType]
+        PURCHASE_INTENT = new("purchase_intent")
+      end
+    end
+  end
+end

data/lib/inttegro/order/customer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "address"
+
+module Inttegro
+  class Order
+    # Typed representation of the customer object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] guest
+    #   Value of the `guest` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `guest`.
+    #   @return [Boolean]
+    #
+    # @!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] email_address
+    #   Value of the `email_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_address`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] phone_number
+    #   Value of the `phone_number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] billing_address
+    #   Value of the `billing_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `billing_address`.
+    #   @return [Inttegro::Order::Address, nil]
+    #
+    # @!attribute [r] shipping_address
+    #   Value of the `shipping_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `shipping_address`.
+    #   @return [Inttegro::Order::Address, nil]
+    class Customer < T::Struct
+      const :id, String
+      const :guest, T::Boolean
+      const :name, String
+      const :email_address, T.nilable(String), default: nil
+      const :phone_number, T.nilable(String), default: nil
+      const :billing_address, T.nilable(Inttegro::Order::Address), default: nil
+      const :shipping_address, T.nilable(Inttegro::Order::Address), default: nil
+    end
+  end
+end

data/lib/inttegro/order/discount.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 Order
+    # Typed representation of the discount object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    class Discount < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/order/discount_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 "discount"
+require_relative "discount_line_item_type"
+
+module Inttegro
+  class Order
+    # Typed representation of the discount 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::DiscountLineItemType]
+    #
+    # @!attribute [r] discount
+    #   Value of the `discount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `discount`.
+    #   @return [Inttegro::Order::Discount]
+    class DiscountLineItem < T::Struct
+      const :type, Inttegro::Order::DiscountLineItemType
+      const :discount, Inttegro::Order::Discount
+    end
+  end
+end

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

data/lib/inttegro/order/document_delivery.rb

@@ -0,0 +1,67 @@
+# 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/delivery_channel"
+require_relative "document_delivery_attempt"
+require_relative "document_delivery_failure"
+require_relative "document_kind"
+
+module Inttegro
+  class Order
+    # Delivery result for one hosted order document link.
+    #
+    # 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] deliveries
+    #   Chime messages that were accepted for delivery.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `deliveries`.
+    #   @return [Array<Inttegro::Order::DocumentDeliveryAttempt>, nil]
+    #
+    # @!attribute [r] document_kind
+    #   Hosted document that was delivered.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `document_kind`.
+    #   @return [Inttegro::Order::DocumentKind, nil]
+    #
+    # @!attribute [r] document_url
+    #   Hosted invoice or receipt URL sent to the customer. Receipt URLs use the hosted receipt
+    #   path, not the invoice PDF path.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `document_url`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] failed_channels
+    #   Channels that failed to send.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `failed_channels`.
+    #   @return [Array<Inttegro::Shared::DeliveryChannel>, nil]
+    #
+    # @!attribute [r] failures
+    #   Per-channel delivery failures.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `failures`.
+    #   @return [Array<Inttegro::Order::DocumentDeliveryFailure>, nil]
+    #
+    # @!attribute [r] sent_channels
+    #   Channels accepted by Chime.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_channels`.
+    #   @return [Array<Inttegro::Shared::DeliveryChannel>, nil]
+    class DocumentDelivery < T::Struct
+      const :deliveries, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryAttempt]), default: nil
+      const :document_kind, T.nilable(Inttegro::Order::DocumentKind), default: nil
+      const :document_url, T.nilable(String), default: nil
+      const :failed_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
+      const :failures, T.nilable(T::Array[Inttegro::Order::DocumentDeliveryFailure]), default: nil
+      const :sent_channels, T.nilable(T::Array[Inttegro::Shared::DeliveryChannel]), default: nil
+    end
+  end
+end

data/lib/inttegro/order/document_delivery_attempt.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 "../shared/delivery_channel"
+
+module Inttegro
+  class Order
+    # Chime delivery accepted for one channel.
+    #
+    # 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] channel
+    #   Delivery channel.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `channel`.
+    #   @return [Inttegro::Shared::DeliveryChannel, nil]
+    #
+    # @!attribute [r] chime_id
+    #   Chime ID created for this delivery.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `chime_id`.
+    #   @return [String, nil]
+    class DocumentDeliveryAttempt < T::Struct
+      const :channel, T.nilable(Inttegro::Shared::DeliveryChannel), default: nil
+      const :chime_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/document_delivery_failure.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 "../shared/delivery_channel"
+
+module Inttegro
+  class Order
+    # Chime delivery failure for one channel.
+    #
+    # 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] channel
+    #   Delivery channel.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `channel`.
+    #   @return [Inttegro::Shared::DeliveryChannel, nil]
+    #
+    # @!attribute [r] error
+    #   Provider or Chime error for this channel.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `error`.
+    #   @return [String, nil]
+    class DocumentDeliveryFailure < T::Struct
+      const :channel, T.nilable(Inttegro::Shared::DeliveryChannel), default: nil
+      const :error, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/order/document_delivery_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 document delivery 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
+    #   Order whose hosted invoice or receipt link should be delivered.
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    class DocumentDeliveryRequest < T::Struct
+      const :order_id, String
+    end
+  end
+end

data/lib/inttegro/order/document_delivery_result.rb

@@ -0,0 +1,46 @@
+# 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/error_payload"
+require_relative "document_delivery"
+require_relative "order"
+
+module Inttegro
+  class Order
+    # Response returned by deliberate order document delivery 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] delivery
+    #   Delivery result for one hosted order document link.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `delivery`.
+    #   @return [Inttegro::Order::DocumentDelivery, nil]
+    #
+    # @!attribute [r] error
+    #   Standard error response structure returned by all API endpoints. Provides machine-readable
+    #   codes, human-readable messages, and actionable guidance for resolution.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `error`.
+    #   @return [Inttegro::Shared::ErrorPayload, nil]
+    #
+    # @!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 DocumentDeliveryResult < T::Struct
+      const :delivery, T.nilable(Inttegro::Order::DocumentDelivery), default: nil
+      const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
+      const :order, T.nilable(Inttegro::Order), default: nil
+    end
+  end
+end

data/lib/inttegro/order/document_format.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 document 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] url
+    #   Value of the `url` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `url`.
+    #   @return [String]
+    class DocumentFormat < T::Struct
+      const :url, String
+    end
+  end
+end

data/lib/inttegro/order/document_kind.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
+    # Hosted document that was delivered.
+    #
+    # 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 DocumentKind < T::Enum
+      enums do
+        # Serialized wire value: `invoice`.
+        # @return [Inttegro::Order::DocumentKind]
+        INVOICE = new("invoice")
+        # Serialized wire value: `receipt`.
+        # @return [Inttegro::Order::DocumentKind]
+        RECEIPT = new("receipt")
+      end
+    end
+  end
+end

data/lib/inttegro/order/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 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
+    #
+    #   Required in the API payload. Wire name: `order`.
+    #   @return [Inttegro::Order]
+    class Envelope < T::Struct
+      const :order, Inttegro::Order
+    end
+  end
+end

data/lib/inttegro/order/fee_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 "fee_line_item_fee"
+require_relative "fee_line_item_type"
+
+module Inttegro
+  class Order
+    # Typed representation of the fee 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::FeeLineItemType]
+    #
+    # @!attribute [r] fee
+    #   Value of the `fee` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `fee`.
+    #   @return [Inttegro::Order::FeeLineItemFee]
+    class FeeLineItem < T::Struct
+      const :type, Inttegro::Order::FeeLineItemType
+      const :fee, Inttegro::Order::FeeLineItemFee
+    end
+  end
+end

data/lib/inttegro/order/fee_line_item_fee.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 "../money/amount"
+
+module Inttegro
+  class Order
+    # Typed representation of the fee line item fee 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] description
+    #   Value of the `description` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] 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] amount
+    #   Value of the `amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `amount`.
+    #   @return [Inttegro::Money::Amount]
+    #
+    # @!attribute [r] label
+    #   Value of the `label` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `label`.
+    #   @return [String]
+    class FeeLineItemFee < T::Struct
+      const :id, String
+      const :description, T.nilable(String), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :amount, Inttegro::Money::Amount
+      const :label, String
+    end
+  end
+end