inttegro 4.3.1 → 6.0.0

data/lib/inttegro/price/embedded_product.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../product/dimensions"
+require_relative "../product/media"
+require_relative "../product/shipment"
+require_relative "../product/type"
+require_relative "../purchase_intent/product_attributes_item"
+
+module Inttegro
+  class Price
+    # Typed representation of the embedded product 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
+    #   Unique product identifier with prod_ prefix
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] about
+    #   Full product description
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] active
+    #   Whether product is published and available
+    #
+    #   Required in the API payload. Wire name: `active`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] archived_at
+    #   Archive timestamp (if archived)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `archived_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] attributes
+    #   Product attributes
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `attributes`.
+    #   @return [Array<Inttegro::PurchaseIntent::ProductAttributesItem>, nil]
+    #
+    # @!attribute [r] category
+    #   Product category
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `category`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] created_at
+    #   Product creation timestamp
+    #
+    #   Required in the API payload. Wire name: `created_at`.
+    #   @return [Time]
+    #
+    # @!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] description
+    #   Short description
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] dimensions
+    #   Product dimensions and size metadata
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `dimensions`.
+    #   @return [Inttegro::Product::Dimensions, nil]
+    #
+    # @!attribute [r] media
+    #   Product media assets
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `media`.
+    #   @return [Inttegro::Product::Media, nil]
+    #
+    # @!attribute [r] name
+    #   Product name
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] published_at
+    #   When the product was published
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `published_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] reference
+    #   External reference or SKU
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] shipment
+    #   Shipment and fulfillment details
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `shipment`.
+    #   @return [Inttegro::Product::Shipment, 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
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::Type]
+    #
+    # @!attribute [r] unit_dim
+    #   Unit dimension label
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `unit_dim`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] updated_at
+    #   Last update timestamp
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `updated_at`.
+    #   @return [Time, nil]
+    class EmbeddedProduct < T::Struct
+      const :id, String
+      const :about, T.nilable(String), default: nil
+      const :active, T::Boolean
+      const :archived_at, T.nilable(Time), default: nil
+      const :attributes, T.nilable(T::Array[Inttegro::PurchaseIntent::ProductAttributesItem]), default: nil
+      const :category, T.nilable(String), default: nil
+      const :created_at, Time
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :description, T.nilable(String), default: nil
+      const :dimensions, T.nilable(Inttegro::Product::Dimensions), default: nil
+      const :media, T.nilable(Inttegro::Product::Media), default: nil
+      const :name, String
+      const :published_at, T.nilable(Time), default: nil
+      const :reference, T.nilable(String), default: nil
+      const :shipment, T.nilable(Inttegro::Product::Shipment), default: nil
+      const :tax_code, T.nilable(String), default: nil
+      const :type, Inttegro::Product::Type
+      const :unit_dim, T.nilable(String), default: nil
+      const :updated_at, T.nilable(Time), default: nil
+    end
+  end
+end

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

data/lib/inttegro/price/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 "page_item"
+
+module Inttegro
+  class Price
+    # Typed representation of the page object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] number
+    #   The page number returned
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] size
+    #   The number of prices in this page
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] prices
+    #   Value of the `prices` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `prices`.
+    #   @return [Array<Inttegro::Price::PageItem>, nil]
+    class Page < T::Struct
+      const :number, T.nilable(Integer), default: nil
+      const :size, T.nilable(Integer), default: nil
+      const :prices, T.nilable(T::Array[Inttegro::Price::PageItem]), default: nil
+    end
+  end
+end

data/lib/inttegro/price/page_item.rb

@@ -0,0 +1,17 @@
+# 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_price"
+
+module Inttegro
+  class Price
+    # Typed representation of the page item object in the Inttegro API.
+    #
+    # @api public
+    # @return [Inttegro::Price::CatalogPrice]
+    PageItem = T.type_alias { Inttegro::Price::CatalogPrice }
+  end
+end

data/lib/inttegro/price/page_request.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 Price
+    # 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
+    #   Page index to fetch. Omit it or send 0 to request page 1; otherwise use 1 through 10.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] page_size
+    #   Number of prices per page (1-256)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] product_id
+    #   Optional product ID to scope the page to a single product
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `product_id`.
+    #   @return [String, nil]
+    class PageRequest < T::Struct
+      const :page_number, T.nilable(Integer), default: nil
+      const :page_size, T.nilable(Integer), default: nil
+      const :product_id, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/price/page_response.rb

@@ -0,0 +1,37 @@
+# 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 "page"
+
+module Inttegro
+  class Price
+    # 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.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page`.
+    #   @return [Inttegro::Price::Page, 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]
+    class PageResponse < T::Struct
+      const :page, T.nilable(Inttegro::Price::Page), default: nil
+      const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
+    end
+  end
+end

data/lib/inttegro/price/price.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"
+require_relative "../money/currency"
+
+module Inttegro
+  # An inline price returned by the 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] currency
+  #   A currency code recognized by the Inttegro API. Individual operations can support a subset
+  #   of these currencies.
+  #
+  #   Required in the API payload. Wire name: `currency`.
+  #   @return [Inttegro::Money::Currency]
+  #
+  # @!attribute [r] value
+  #   Amount in the currency's smallest unit.
+  #
+  #   Required in the API payload. Wire name: `value`.
+  #   @return [Integer]
+  class Price
+    const :currency, Inttegro::Money::Currency
+    const :value, Integer
+  end
+end

data/lib/inttegro/price/price_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../money/currency"
+
+module Inttegro
+  class Price
+    # An inline price supplied in a request.
+    #
+    # 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] currency
+    #   A currency code recognized by the Inttegro API. Individual operations can support a subset
+    #   of these currencies.
+    #
+    #   Required in the API payload. Wire name: `currency`.
+    #   @return [Inttegro::Money::Currency]
+    #
+    # @!attribute [r] value
+    #   Price in the currency's smallest unit.
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [Integer]
+    class PriceParams < T::Struct
+      const :currency, Inttegro::Money::Currency
+      const :value, Integer
+    end
+  end
+end

data/lib/inttegro/price/response.rb

@@ -0,0 +1,37 @@
+# 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 "catalog_price"
+
+module Inttegro
+  class Price
+    # Typed representation of the 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] 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::Price::CatalogPrice, 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]
+    class Response < T::Struct
+      const :price, T.nilable(Inttegro::Price::CatalogPrice), default: nil
+      const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
+    end
+  end
+end

data/lib/inttegro/price/update_request.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 Price
+    # Typed representation of the update 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] price_id
+    #   The unique identifier of the price to update
+    #
+    #   Required in the API payload. Wire name: `price_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] label
+    #   Short label for this price (max 100 characters)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] about
+    #   Longer description of this price (max 500 characters)
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    class UpdateRequest < T::Struct
+      const :price_id, String
+      const :label, T.nilable(String), default: nil
+      const :about, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/product/action_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 action 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 perform action on
+    #
+    #   Required in the API payload. Wire name: `product_id`.
+    #   @return [String]
+    class ActionRequest < T::Struct
+      const :product_id, String
+    end
+  end
+end

data/lib/inttegro/product/add_price_request.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_params"
+
+module Inttegro
+  class Product
+    # Typed representation of the add price 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 attach the new price to
+    #
+    #   Required in the API payload. Wire name: `product_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] label
+    #   Optional short label for the new price
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] about
+    #   Optional internal description for the new price
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @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::AmountParams]
+    class AddPriceRequest < T::Struct
+      const :product_id, String
+      const :label, T.nilable(String), default: nil
+      const :about, T.nilable(String), default: nil
+      const :amount, Inttegro::Money::AmountParams
+    end
+  end
+end

data/lib/inttegro/product/add_price_response.rb

@@ -0,0 +1,37 @@
+# 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/catalog_price"
+require_relative "../shared/error_payload"
+
+module Inttegro
+  class Product
+    # Typed representation of the add price 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] 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::Price::CatalogPrice, 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]
+    class AddPriceResponse < T::Struct
+      const :price, T.nilable(Inttegro::Price::CatalogPrice), default: nil
+      const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
+    end
+  end
+end

data/lib/inttegro/product/attribute.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 Product
+    # Typed representation of the attribute 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] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] value
+    #   Value of the `value` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [String]
+    class Attribute < T::Struct
+      const :name, String
+      const :value, String
+    end
+  end
+end

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

data/lib/inttegro/product/catalog_with_price_data.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 "../price/price_params"
+
+module Inttegro
+  class Product
+    # Typed representation of the catalog with price data 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
+    #   An inline price supplied in a request.
+    #
+    #   Required in the API payload. Wire name: `price`.
+    #   @return [Inttegro::Price::PriceParams]
+    #
+    # @!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 CatalogWithPriceData < T::Struct
+      const :price, Inttegro::Price::PriceParams
+      const :product_id, String
+      const :quantity, Integer
+    end
+  end
+end