inttegro 5.0.0 → 6.0.0

data/lib/inttegro/purchase_intent/usage_order.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class PurchaseIntent
+    # Typed representation of the usage order 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] created_at
+    #   When order creation consumed the single-use Buy link
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] id
+    #   Order that consumed the Buy link
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    class UsageOrder < T::Struct
+      const :created_at, Time
+      const :id, String
+    end
+  end
+end

data/lib/inttegro/purchase_intent/variant.rb

@@ -0,0 +1,64 @@
+# 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"
+require_relative "product"
+
+module Inttegro
+  class PurchaseIntent
+    # Typed representation of the variant 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] active
+    #   Value of the `active` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `active`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] position
+    #   Value of the `position` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `position`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] price
+    #   Value of the `price` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `price`.
+    #   @return [Inttegro::PurchaseIntent::Price, nil]
+    #
+    # @!attribute [r] product
+    #   Value of the `product` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `product`.
+    #   @return [Inttegro::PurchaseIntent::Product, nil]
+    #
+    # @!attribute [r] product_id
+    #   Value of the `product_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `product_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] variant_values
+    #   Product variant attribute selections keyed by attribute name.
+    #
+    #   Required in the API payload. Wire name: `variant_values`.
+    #   @return [Hash{String => String}]
+    class Variant < T::Struct
+      const :active, T::Boolean
+      const :position, T.nilable(Integer), default: nil
+      const :price, T.nilable(Inttegro::PurchaseIntent::Price), default: nil
+      const :product, T.nilable(Inttegro::PurchaseIntent::Product), default: nil
+      const :product_id, String
+      const :variant_values, T::Hash[String, String]
+    end
+  end
+end

data/lib/inttegro/purchase_intent/variant_axis.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
+  class PurchaseIntent
+    # Typed representation of the variant axis 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] key
+    #   Value of the `key` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `key`.
+    #   @return [String]
+    #
+    # @!attribute [r] label
+    #   Value of the `label` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `label`.
+    #   @return [String]
+    #
+    # @!attribute [r] position
+    #   Value of the `position` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `position`.
+    #   @return [Integer]
+    class VariantAxis < T::Struct
+      const :key, String
+      const :label, String
+      const :position, Integer
+    end
+  end
+end

data/lib/inttegro/purchase_intent/variant_set.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 "variant"
+require_relative "variant_axis"
+
+module Inttegro
+  class PurchaseIntent
+    # Typed representation of the variant set 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] active
+    #   Value of the `active` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `active`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] default_product_id
+    #   Value of the `default_product_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `default_product_id`.
+    #   @return [String, nil]
+    #
+    # @!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] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!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] 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] variant_axes
+    #   Value of the `variant_axes` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `variant_axes`.
+    #   @return [Array<Inttegro::PurchaseIntent::VariantAxis>]
+    #
+    # @!attribute [r] variants
+    #   Value of the `variants` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `variants`.
+    #   @return [Array<Inttegro::PurchaseIntent::Variant>]
+    class VariantSet < T::Struct
+      const :active, T::Boolean
+      const :default_product_id, T.nilable(String), default: nil
+      const :description, T.nilable(String), default: nil
+      const :id, String
+      const :name, String
+      const :reference, T.nilable(String), default: nil
+      const :variant_axes, T::Array[Inttegro::PurchaseIntent::VariantAxis]
+      const :variants, T::Array[Inttegro::PurchaseIntent::Variant]
+    end
+  end
+end

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

data/lib/inttegro/refund/cancel_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 "request_meta"
+
+module Inttegro
+  class Refund
+    # Typed representation of the cancel request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] refund_id
+    #   Refund to cancel before processing begins.
+    #
+    #   Required in the API payload. Wire name: `refund_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] request_meta
+    #   Value of the `request_meta` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `request_meta`.
+    #   @return [Inttegro::Refund::RequestMeta, nil]
+    class CancelRequest < T::Struct
+      const :refund_id, String
+      const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
+    end
+  end
+end

data/lib/inttegro/refund/create_line_item.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 "../money/amount_params"
+require_relative "reason"
+
+module Inttegro
+  class Refund
+    # Typed representation of the create 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] order_line_item_id
+    #   Strong identifier for the paid order line item being refunded.
+    #
+    #   Required in the API payload. Wire name: `order_line_item_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] reason
+    #   Value of the `reason` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason`.
+    #   @return [Inttegro::Refund::Reason, nil]
+    #
+    # @!attribute [r] reason_details
+    #   Line-specific explanation. Requires a line-level reason; required when that reason is
+    #   `custom`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason_details`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] refund_amount
+    #   Value of the `refund_amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `refund_amount`.
+    #   @return [Inttegro::Money::AmountParams]
+    class CreateLineItem < T::Struct
+      const :order_line_item_id, String
+      const :reason, T.nilable(Inttegro::Refund::Reason), default: nil
+      const :reason_details, T.nilable(String), default: nil
+      const :refund_amount, Inttegro::Money::AmountParams
+    end
+  end
+end

data/lib/inttegro/refund/create_request.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "create_line_item"
+require_relative "reason"
+require_relative "request_meta"
+
+module Inttegro
+  class Refund
+    # Typed representation of the create 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] 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] line_items
+    #   Value of the `line_items` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `line_items`.
+    #   @return [Array<Inttegro::Refund::CreateLineItem>]
+    #
+    # @!attribute [r] order_id
+    #   Paid order to refund.
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] reason
+    #   Value of the `reason` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `reason`.
+    #   @return [Inttegro::Refund::Reason]
+    #
+    # @!attribute [r] reason_details
+    #   Overall explanation. Required when `reason` is `custom`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason_details`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] reference
+    #   Your reconciliation reference.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] request_meta
+    #   Value of the `request_meta` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `request_meta`.
+    #   @return [Inttegro::Refund::RequestMeta, nil]
+    class CreateRequest < T::Struct
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :line_items, T::Array[Inttegro::Refund::CreateLineItem]
+      const :order_id, String
+      const :reason, Inttegro::Refund::Reason
+      const :reason_details, T.nilable(String), default: nil
+      const :reference, T.nilable(String), default: nil
+      const :request_meta, T.nilable(Inttegro::Refund::RequestMeta), default: nil
+    end
+  end
+end

data/lib/inttegro/refund/line_item.rb

@@ -0,0 +1,64 @@
+# 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 "reason"
+
+module Inttegro
+  class Refund
+    # Typed representation of the 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] id
+    #   Server-generated refund line-item identifier.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] order_line_item_id
+    #   Value of the `order_line_item_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `order_line_item_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] original_amount_paid
+    #   Value of the `original_amount_paid` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `original_amount_paid`.
+    #   @return [Inttegro::Money::Amount]
+    #
+    # @!attribute [r] reason
+    #   Value of the `reason` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason`.
+    #   @return [Inttegro::Refund::Reason, nil]
+    #
+    # @!attribute [r] reason_details
+    #   Value of the `reason_details` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason_details`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] refund_amount
+    #   Value of the `refund_amount` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `refund_amount`.
+    #   @return [Inttegro::Money::Amount]
+    class LineItem < T::Struct
+      const :id, String
+      const :order_line_item_id, String
+      const :original_amount_paid, Inttegro::Money::Amount
+      const :reason, T.nilable(Inttegro::Refund::Reason), default: nil
+      const :reason_details, T.nilable(String), default: nil
+      const :refund_amount, Inttegro::Money::Amount
+    end
+  end
+end

data/lib/inttegro/refund/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 Refund
+    # 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] refund_id
+    #   Refund identifier to retrieve.
+    #
+    #   Required in the API payload. Wire name: `refund_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :refund_id, String
+    end
+  end
+end

data/lib/inttegro/refund/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 "refund"
+
+module Inttegro
+  class Refund
+    # 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
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] refunds
+    #   Value of the `refunds` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `refunds`.
+    #   @return [Array<Inttegro::Refund>]
+    #
+    # @!attribute [r] size
+    #   Number of refunds returned in this page.
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    class Page < T::Struct
+      const :number, Integer
+      const :refunds, T::Array[Inttegro::Refund]
+      const :size, Integer
+    end
+  end
+end

data/lib/inttegro/refund/page_request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class Refund
+    # 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
+    #   One-based page number.
+    #
+    #   Required in the API payload. Wire name: `page_number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] page_size
+    #   Maximum number of refunds to return.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    class PageRequest < T::Struct
+      const :page_number, Integer
+      const :page_size, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/refund/page_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "page"
+
+module Inttegro
+  class Refund
+    # Typed representation of the page response object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] page
+    #   Value of the `page` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `page`.
+    #   @return [Inttegro::Refund::Page]
+    class PageResponse < T::Struct
+      const :page, Inttegro::Refund::Page
+    end
+  end
+end

data/lib/inttegro/refund/reason.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class Refund
+    # String-backed values accepted by the Inttegro API for Inttegro::Refund::Reason.
+    #
+    # 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 Reason < T::Enum
+      enums do
+        # Serialized wire value: `requested_by_customer`.
+        # @return [Inttegro::Refund::Reason]
+        REQUESTED_BY_CUSTOMER = new("requested_by_customer")
+        # Serialized wire value: `duplicate`.
+        # @return [Inttegro::Refund::Reason]
+        DUPLICATE = new("duplicate")
+        # Serialized wire value: `fraudulent`.
+        # @return [Inttegro::Refund::Reason]
+        FRAUDULENT = new("fraudulent")
+        # Serialized wire value: `order_canceled`.
+        # @return [Inttegro::Refund::Reason]
+        ORDER_CANCELED = new("order_canceled")
+        # Serialized wire value: `item_returned`.
+        # @return [Inttegro::Refund::Reason]
+        ITEM_RETURNED = new("item_returned")
+        # Serialized wire value: `item_damaged`.
+        # @return [Inttegro::Refund::Reason]
+        ITEM_DAMAGED = new("item_damaged")
+        # Serialized wire value: `item_not_received`.
+        # @return [Inttegro::Refund::Reason]
+        ITEM_NOT_RECEIVED = new("item_not_received")
+        # Serialized wire value: `item_not_as_described`.
+        # @return [Inttegro::Refund::Reason]
+        ITEM_NOT_AS_DESCRIBED = new("item_not_as_described")
+        # Serialized wire value: `custom`.
+        # @return [Inttegro::Refund::Reason]
+        CUSTOM = new("custom")
+      end
+    end
+  end
+end