inttegro 4.3.1 → 6.0.0

data/lib/inttegro/product/catalog_with_price_reference.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 Product
+    # Typed representation of the catalog with price reference 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] price_id
+    #   Existing product price to snapshot onto the order line item. It must belong to the same
+    #   application and product.
+    #
+    #   Required in the API payload. Wire name: `price_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] product_id
+    #   Existing catalog product ID to snapshot onto the order line item
+    #
+    #   Required in the API payload. Wire name: `product_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] quantity
+    #   How many units of the catalog product the customer is purchasing
+    #
+    #   Required in the API payload. Wire name: `quantity`.
+    #   @return [Integer]
+    class CatalogWithPriceReference < T::Struct
+      const :price_id, String
+      const :product_id, String
+      const :quantity, Integer
+    end
+  end
+end

data/lib/inttegro/product/create_request.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "attribute"
+require_relative "dimensions"
+require_relative "media"
+require_relative "shipment_input"
+require_relative "type"
+
+module Inttegro
+  class Product
+    # 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] type
+    #   Product type - determines fulfillment requirements
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::Type]
+    #
+    # @!attribute [r] reference
+    #   External reference or SKU from your system
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] name
+    #   Customer-facing product name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] description
+    #   Short product description or tagline
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] about
+    #   Full product description with details and features
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] tax_code
+    #   Tax classification code for tax calculations
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `tax_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] category
+    #   Product category for organization
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `category`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] shipment
+    #   Value of the `shipment` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `shipment`.
+    #   @return [Inttegro::Product::ShipmentInput, nil]
+    #
+    # @!attribute [r] dimensions
+    #   At most one of `physical`, `digital`, or `custom`.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `dimensions`.
+    #   @return [Inttegro::Product::Dimensions, nil]
+    #
+    # @!attribute [r] unit_dimension
+    #   Value of the `unit_dimension` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `unit_dimension`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] media
+    #   Value of the `media` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `media`.
+    #   @return [Inttegro::Product::Media, nil]
+    #
+    # @!attribute [r] attributes
+    #   Product attributes (size, color, material, etc.)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `attributes`.
+    #   @return [Array<Inttegro::Product::Attribute>, nil]
+    #
+    # @!attribute [r] publish
+    #   Whether to publish the product immediately
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `publish`.
+    #   @return [Boolean, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined string values attached to a resource. SDKs expose this as a semantic
+    #   collection rather than a raw map.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => String}, nil]
+    class CreateRequest < T::Struct
+      const :type, Inttegro::Product::Type
+      const :reference, T.nilable(String), default: nil
+      const :name, String
+      const :description, T.nilable(String), default: nil
+      const :about, T.nilable(String), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :category, T.nilable(String), default: nil
+      const :shipment, T.nilable(Inttegro::Product::ShipmentInput), default: nil
+      const :dimensions, T.nilable(Inttegro::Product::Dimensions), default: nil
+      const :unit_dimension, T.nilable(String), default: nil
+      const :media, T.nilable(Inttegro::Product::Media), default: nil
+      const :attributes, T.nilable(T::Array[Inttegro::Product::Attribute]), default: nil
+      const :publish, T.nilable(T::Boolean), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    end
+  end
+end

data/lib/inttegro/product/delivery.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 Product
+    # Delivery fulfillment marker.
+    #
+    # 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 Delivery < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/product/details.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "catalog_with_price_data"
+require_relative "catalog_with_price_reference"
+require_relative "inline_details"
+
+module Inttegro
+  class Product
+    # Provide either inline product data or a `product_id` reference to an existing catalog
+    # product. Catalog-backed product line items can use an explicit `price` or an existing
+    # `price_id`. Inttegro never falls back to a product's default unit price during order
+    # creation.
+    #
+    # @api public
+    # @return [Inttegro::Product::InlineDetails, Inttegro::Product::CatalogWithPriceData, Inttegro::Product::CatalogWithPriceReference]
+    Details = T.type_alias { T.any(Inttegro::Product::InlineDetails, Inttegro::Product::CatalogWithPriceData, Inttegro::Product::CatalogWithPriceReference) }
+  end
+end

data/lib/inttegro/product/dimensions.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "dimensions_custom"
+require_relative "dimensions_digital"
+require_relative "dimensions_physical"
+
+module Inttegro
+  class Product
+    # At most one of `physical`, `digital`, or `custom`.
+    #
+    # 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] physical
+    #   Value of the `physical` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `physical`.
+    #   @return [Inttegro::Product::DimensionsPhysical, nil]
+    #
+    # @!attribute [r] digital
+    #   Value of the `digital` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `digital`.
+    #   @return [Inttegro::Product::DimensionsDigital, nil]
+    #
+    # @!attribute [r] custom
+    #   Value of the `custom` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom`.
+    #   @return [Inttegro::Product::DimensionsCustom, nil]
+    class Dimensions < T::Struct
+      const :physical, T.nilable(Inttegro::Product::DimensionsPhysical), default: nil
+      const :digital, T.nilable(Inttegro::Product::DimensionsDigital), default: nil
+      const :custom, T.nilable(Inttegro::Product::DimensionsCustom), default: nil
+    end
+  end
+end

data/lib/inttegro/product/dimensions_custom.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 Product
+    # Typed representation of the dimensions custom 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] size_unit
+    #   Value of the `size_unit` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size_unit`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] size
+    #   Value of the `size` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] details
+    #   Named string measurements or descriptors for a product dimension.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `details`.
+    #   @return [Hash{String => String}, nil]
+    class DimensionsCustom < T::Struct
+      const :size_unit, T.nilable(String), default: nil
+      const :size, T.nilable(T.any(Integer, Float)), default: nil
+      const :details, T.nilable(T::Hash[String, String]), default: nil
+    end
+  end
+end

data/lib/inttegro/product/dimensions_digital.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 Product
+    # Typed representation of the dimensions digital 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] bytes
+    #   Value of the `bytes` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `bytes`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] size_unit
+    #   Value of the `size_unit` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size_unit`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] size
+    #   Value of the `size` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, Float, nil]
+    class DimensionsDigital < T::Struct
+      const :bytes, T.nilable(T.any(Integer, Float)), default: nil
+      const :size_unit, T.nilable(String), default: nil
+      const :size, T.nilable(T.any(Integer, Float)), default: nil
+    end
+  end
+end

data/lib/inttegro/product/dimensions_physical.rb

@@ -0,0 +1,76 @@
+# 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 Product
+    # Typed representation of the dimensions physical 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] weight_unit
+    #   Value of the `weight_unit` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `weight_unit`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] weight
+    #   Value of the `weight` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `weight`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] size
+    #   Legacy alias for weight in requests.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] volume_unit
+    #   Value of the `volume_unit` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `volume_unit`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] volume
+    #   Value of the `volume` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `volume`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] length
+    #   Value of the `length` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `length`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] height
+    #   Value of the `height` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `height`.
+    #   @return [Integer, Float, nil]
+    #
+    # @!attribute [r] width
+    #   Value of the `width` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `width`.
+    #   @return [Integer, Float, nil]
+    class DimensionsPhysical < T::Struct
+      const :weight_unit, T.nilable(String), default: nil
+      const :weight, T.nilable(T.any(Integer, Float)), default: nil
+      const :size, T.nilable(T.any(Integer, Float)), default: nil
+      const :volume_unit, T.nilable(String), default: nil
+      const :volume, T.nilable(T.any(Integer, Float)), default: nil
+      const :length, T.nilable(T.any(Integer, Float)), default: nil
+      const :height, T.nilable(T.any(Integer, Float)), default: nil
+      const :width, T.nilable(T.any(Integer, Float)), default: nil
+    end
+  end
+end

data/lib/inttegro/product/download.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 Product
+    # Download fulfillment marker.
+    #
+    # 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 Download < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/product/inline_details.rb

@@ -0,0 +1,79 @@
+# 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 "type"
+
+module Inttegro
+  class Product
+    # Typed representation of the inline details 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] about
+    #   Long-form description or marketing copy
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined string values attached to a resource. SDKs expose this as a semantic
+    #   collection rather than a raw map.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => String}, nil]
+    #
+    # @!attribute [r] name
+    #   Product name shown to the customer
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] price
+    #   An inline price supplied in a request.
+    #
+    #   Required in the API payload. Wire name: `price`.
+    #   @return [Inttegro::Price::PriceParams]
+    #
+    # @!attribute [r] quantity
+    #   How many units the customer is purchasing
+    #
+    #   Required in the API payload. Wire name: `quantity`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] reference
+    #   Your SKU or internal product reference
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] tax_code
+    #   Tax classification code
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `tax_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] type
+    #   Product type—affects shipping requirements
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::Type]
+    class InlineDetails < T::Struct
+      const :about, T.nilable(String), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :name, String
+      const :price, Inttegro::Price::PriceParams
+      const :quantity, Integer
+      const :reference, T.nilable(String), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :type, Inttegro::Product::Type
+    end
+  end
+end

data/lib/inttegro/product/line_item.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "details"
+require_relative "line_item_type"
+
+module Inttegro
+  class Product
+    # 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] type
+    #   Line item type discriminator
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::LineItemType]
+    #
+    # @!attribute [r] product
+    #   Provide either inline product data or a `product_id` reference to an existing catalog
+    #   product. Catalog-backed product line items can use an explicit `price` or an existing
+    #   `price_id`. Inttegro never falls back to a product's default unit price during order
+    #   creation.
+    #
+    #   Required in the API payload. Wire name: `product`.
+    #   @return [Inttegro::Product::Details]
+    class LineItem < T::Struct
+      const :type, Inttegro::Product::LineItemType
+      const :product, Inttegro::Product::Details
+    end
+  end
+end

data/lib/inttegro/product/line_item_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class Product
+    # Line item type discriminator
+    #
+    # 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 LineItemType < T::Enum
+      enums do
+        # Serialized wire value: `product`.
+        # @return [Inttegro::Product::LineItemType]
+        PRODUCT = new("product")
+      end
+    end
+  end
+end

data/lib/inttegro/product/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 Product
+    # 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] product_id
+    #   Product ID to lookup
+    #
+    #   Required in the API payload. Wire name: `product_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :product_id, String
+    end
+  end
+end