inttegro 4.3.1 → 6.0.0

data/lib/inttegro/purchase_intent/activity_visitor.rb

@@ -0,0 +1,97 @@
+# 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 activity visitor 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] browser
+    #   Value of the `browser` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `browser`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] city
+    #   Value of the `city` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `city`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Value of the `country` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `country`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] device
+    #   Value of the `device` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `device`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] ip_address
+    #   Request IP address when retained for the activity type
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `ip_address`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] os
+    #   Value of the `os` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `os`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] region
+    #   Value of the `region` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] session_id
+    #   Value of the `session_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `session_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] timezone
+    #   Value of the `timezone` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `timezone`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] user_agent
+    #   Value of the `user_agent` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `user_agent`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] visitor_id
+    #   Value of the `visitor_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `visitor_id`.
+    #   @return [String, nil]
+    class ActivityVisitor < T::Struct
+      const :browser, T.nilable(String), default: nil
+      const :city, T.nilable(String), default: nil
+      const :country, T.nilable(String), default: nil
+      const :device, T.nilable(String), default: nil
+      const :ip_address, T.nilable(String), default: nil
+      const :os, T.nilable(String), default: nil
+      const :region, T.nilable(String), default: nil
+      const :session_id, T.nilable(String), default: nil
+      const :timezone, T.nilable(String), default: nil
+      const :user_agent, T.nilable(String), default: nil
+      const :visitor_id, T.nilable(String), default: nil
+    end
+  end
+end

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

data/lib/inttegro/purchase_intent/cancel_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 PurchaseIntent
+    # 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] id
+    #   Purchase intent ID to cancel. Send this or purchase_intent_id.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purchase_intent_id
+    #   Alias for id. If both are present, this value takes precedence.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purchase_intent_id`.
+    #   @return [String, nil]
+    class CancelRequest < T::Struct
+      const :id, T.nilable(String), default: nil
+      const :purchase_intent_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request.rb

@@ -0,0 +1,75 @@
+# 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_request_price"
+require_relative "create_request_product"
+require_relative "create_request_quantity"
+require_relative "create_request_usage"
+
+module Inttegro
+  class PurchaseIntent
+    # 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] product
+    #   Product selection with optional variant-set configuration. Use this instead of product_id.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `product`.
+    #   @return [Inttegro::PurchaseIntent::CreateRequestProduct, nil]
+    #
+    # @!attribute [r] product_id
+    #   App-owned product ID to sell through the Buy link when not using product
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `product_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] price
+    #   Price selection for the Buy link. Send exactly one of id or nominal and at most one of
+    #   original or original_id.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `price`.
+    #   @return [Inttegro::PurchaseIntent::CreateRequestPrice, nil]
+    #
+    # @!attribute [r] price_id
+    #   Active, unarchived app-owned price ID that belongs to the selected product
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `price_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] quantity
+    #   Quantity bounds the Buy link should enforce. Omit max when the Buy link has no upper
+    #   quantity bound. When present, max must be greater than or equal to min.
+    #
+    #   Required in the API payload. Wire name: `quantity`.
+    #   @return [Inttegro::PurchaseIntent::CreateRequestQuantity]
+    #
+    # @!attribute [r] usage
+    #   Optional link-use policy. Omit to create a reusable Buy link.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `usage`.
+    #   @return [Inttegro::PurchaseIntent::CreateRequestUsage, nil]
+    #
+    # @!attribute [r] expires_at
+    #   Future RFC3339 timestamp after which the Buy link stops accepting purchases
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `expires_at`.
+    #   @return [Time, nil]
+    class CreateRequest < T::Struct
+      const :product, T.nilable(Inttegro::PurchaseIntent::CreateRequestProduct), default: nil
+      const :product_id, T.nilable(String), default: nil
+      const :price, T.nilable(Inttegro::PurchaseIntent::CreateRequestPrice), default: nil
+      const :price_id, T.nilable(String), default: nil
+      const :quantity, Inttegro::PurchaseIntent::CreateRequestQuantity
+      const :usage, T.nilable(Inttegro::PurchaseIntent::CreateRequestUsage), default: nil
+      const :expires_at, T.nilable(Time), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request_price.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 "../price/price_params"
+require_relative "create_request_price_original"
+
+module Inttegro
+  class PurchaseIntent
+    # Price selection for the Buy link. Send exactly one of id or nominal and at most one of
+    # original or original_id.
+    #
+    # 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
+    #   Active, unarchived app-owned price ID that belongs to the selected product
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] nominal
+    #   Inline offer amount when no price ID is provided
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `nominal`.
+    #   @return [Inttegro::Price::PriceParams, nil]
+    #
+    # @!attribute [r] original
+    #   Optional original price used for comparison display
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `original`.
+    #   @return [Inttegro::PurchaseIntent::CreateRequestPriceOriginal, nil]
+    #
+    # @!attribute [r] original_id
+    #   App-owned comparison price ID when not using original.id
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `original_id`.
+    #   @return [String, nil]
+    class CreateRequestPrice < T::Struct
+      const :id, T.nilable(String), default: nil
+      const :nominal, T.nilable(Inttegro::Price::PriceParams), default: nil
+      const :original, T.nilable(Inttegro::PurchaseIntent::CreateRequestPriceOriginal), default: nil
+      const :original_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request_price_original.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 "../price/price_params"
+
+module Inttegro
+  class PurchaseIntent
+    # Optional original price used for comparison display
+    #
+    # 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
+    #   App-owned comparison price ID that belongs to the selected product
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] nominal
+    #   Inline original price amount
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `nominal`.
+    #   @return [Inttegro::Price::PriceParams, nil]
+    class CreateRequestPriceOriginal < T::Struct
+      const :id, T.nilable(String), default: nil
+      const :nominal, T.nilable(Inttegro::Price::PriceParams), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request_product.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
+    # Product selection with optional variant-set configuration. Use this instead of product_id.
+    #
+    # 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
+    #   Product ID to sell through the Buy link
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] variant_set_id
+    #   Optional variant set ID the hosted checkout may use for sibling product selection
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `variant_set_id`.
+    #   @return [String, nil]
+    class CreateRequestProduct < T::Struct
+      const :id, String
+      const :variant_set_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request_quantity.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 PurchaseIntent
+    # Quantity bounds the Buy link should enforce. Omit max when the Buy link has no upper
+    # quantity bound. When present, max must be greater than or equal to min.
+    #
+    # 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] min
+    #   Minimum quantity the customer can buy
+    #
+    #   Required in the API payload. Wire name: `min`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] max
+    #   Optional maximum quantity the customer can buy. It must be greater than or equal to min.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `max`.
+    #   @return [Integer, nil]
+    class CreateRequestQuantity < T::Struct
+      const :min, Integer
+      const :max, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/create_request_usage.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
+    # Optional link-use policy. Omit to create a reusable Buy 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] single_use
+    #   Creating the first order consumes the Buy link
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `single_use`.
+    #   @return [Boolean, nil]
+    #
+    # @!attribute [r] multi_use
+    #   The Buy link may create multiple orders
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `multi_use`.
+    #   @return [Boolean, nil]
+    class CreateRequestUsage < T::Struct
+      const :single_use, T.nilable(T::Boolean), default: nil
+      const :multi_use, T.nilable(T::Boolean), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/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 PurchaseIntent
+    # 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] id
+    #   Purchase intent ID to look up
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :id, String
+    end
+  end
+end

data/lib/inttegro/purchase_intent/merchant.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 PurchaseIntent
+    # Merchant identity captured for the hosted checkout. Individual fields are omitted when
+    # unavailable.
+    #
+    # 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] app_name
+    #   Value of the `app_name` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `app_name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] organization_id
+    #   Value of the `organization_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `organization_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] organization_name
+    #   Value of the `organization_name` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `organization_name`.
+    #   @return [String, nil]
+    class Merchant < T::Struct
+      const :app_name, T.nilable(String), default: nil
+      const :organization_id, T.nilable(String), default: nil
+      const :organization_name, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/purchase_intent/original_price.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 PurchaseIntent
+    # Typed representation of the original price 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
+    #   Whether the resolved comparison price is active
+    #
+    #   Required in the API payload. Wire name: `active`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] id
+    #   Catalog price ID when the comparison price is not inline
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] label
+    #   Catalog price label when available
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] nominal
+    #   Value of the `nominal` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `nominal`.
+    #   @return [Inttegro::Money::Amount]
+    class OriginalPrice < T::Struct
+      const :active, T::Boolean
+      const :id, T.nilable(String), default: nil
+      const :label, T.nilable(String), default: nil
+      const :nominal, Inttegro::Money::Amount
+    end
+  end
+end

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

data/lib/inttegro/purchase_intent/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 PurchaseIntent
+    # 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 to retrieve
+    #
+    #   Required in the API payload. Wire name: `page_number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] page_size
+    #   Maximum number of purchase intents to return on this page
+    #
+    #   Required in the API payload. Wire name: `page_size`.
+    #   @return [Integer]
+    class PageRequest < T::Struct
+      const :page_number, Integer
+      const :page_size, Integer
+    end
+  end
+end

data/lib/inttegro/purchase_intent/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 PurchaseIntent
+    # 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::PurchaseIntent::Page]
+    class PageResponse < T::Struct
+      const :page, Inttegro::PurchaseIntent::Page
+    end
+  end
+end