inttegro 4.3.1 → 6.0.0

data/lib/inttegro/product/media.rb

@@ -0,0 +1,83 @@
+# 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 media 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] hero_image
+    #   Value of the `hero_image` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `hero_image`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] thumbnail
+    #   Value of the `thumbnail` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `thumbnail`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] web_page_url
+    #   Value of the `web_page_url` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `web_page_url`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] brand_logo
+    #   Value of the `brand_logo` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `brand_logo`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] infographic
+    #   Value of the `infographic` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `infographic`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] promo_video
+    #   Value of the `promo_video` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `promo_video`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] demo_video
+    #   Value of the `demo_video` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `demo_video`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] gallery
+    #   Value of the `gallery` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `gallery`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] downloads
+    #   Value of the `downloads` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `downloads`.
+    #   @return [Array<String>, nil]
+    class Media < T::Struct
+      const :hero_image, T.nilable(String), default: nil
+      const :thumbnail, T.nilable(String), default: nil
+      const :web_page_url, T.nilable(String), default: nil
+      const :brand_logo, T.nilable(String), default: nil
+      const :infographic, T.nilable(String), default: nil
+      const :promo_video, T.nilable(String), default: nil
+      const :demo_video, T.nilable(String), default: nil
+      const :gallery, T.nilable(T::Array[String]), default: nil
+      const :downloads, T.nilable(T::Array[String]), default: nil
+    end
+  end
+end

data/lib/inttegro/product/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 "product"
+
+module Inttegro
+  class Product
+    # 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 products in this page
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] products
+    #   Value of the `products` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `products`.
+    #   @return [Array<Inttegro::Product>, nil]
+    class Page < T::Struct
+      const :number, T.nilable(Integer), default: nil
+      const :size, T.nilable(Integer), default: nil
+      const :products, T.nilable(T::Array[Inttegro::Product]), default: nil
+    end
+  end
+end

data/lib/inttegro/product/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 Product
+    # 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
+    #   1-based page index to fetch (1-10 inclusive)
+    #
+    #   Required in the API payload. Wire name: `page_number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] page_size
+    #   Number of products per page (1-256)
+    #
+    #   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/product/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 Product
+    # 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::Product::Page, nil]
+    class PageResponse < T::Struct
+      const :page, T.nilable(Inttegro::Product::Page), default: nil
+    end
+  end
+end

data/lib/inttegro/product/price_summary.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 Product
+    # Typed representation of the price summary 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 price identifier with pr_ prefix
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] active
+    #   Whether this price is active and usable in new flows
+    #
+    #   Required in the API payload. Wire name: `active`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] label
+    #   Short label for this price
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `label`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] nominal
+    #   Price amount
+    #
+    #   Required in the API payload. Wire name: `nominal`.
+    #   @return [Inttegro::Money::Amount]
+    class PriceSummary < T::Struct
+      const :id, String
+      const :active, T::Boolean
+      const :label, T.nilable(String), default: nil
+      const :nominal, Inttegro::Money::Amount
+    end
+  end
+end

data/lib/inttegro/product/product.rb

@@ -0,0 +1,165 @@
+# 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 "price_summary"
+require_relative "shipment"
+require_relative "type"
+
+module Inttegro
+  # Typed representation of the 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] type
+  #   Product type
+  #
+  #   Required in the API payload. Wire name: `type`.
+  #   @return [Inttegro::Product::Type]
+  #
+  # @!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] name
+  #   Product name
+  #
+  #   Required in the API payload. Wire name: `name`.
+  #   @return [String]
+  #
+  # @!attribute [r] description
+  #   Short description
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `description`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] about
+  #   Full product description
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+  #   @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] category
+  #   Product category
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `category`.
+  #   @return [String, nil]
+  #
+  # @!attribute [r] prices
+  #   Non-archived prices that belong to this product
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `prices`.
+  #   @return [Array<Inttegro::Product::PriceSummary>, 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::Shipment, 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
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `attributes`.
+  #   @return [Array<Inttegro::Product::Attribute>, 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] 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] active
+  #   Whether product is published and available
+  #
+  #   Required in the API payload. Wire name: `active`.
+  #   @return [Boolean]
+  #
+  # @!attribute [r] created_at
+  #   Product creation timestamp
+  #
+  #   Required in the API payload. Wire name: `created_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] updated_at
+  #   Last update timestamp
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `updated_at`.
+  #   @return [Time, nil]
+  #
+  # @!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] 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] unit_dim
+  #   Unit dimension label
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `unit_dim`.
+  #   @return [String, nil]
+  class Product
+    const :id, String
+    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 :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
+    const :shipment, T.nilable(Inttegro::Product::Shipment), default: nil
+    const :media, T.nilable(Inttegro::Product::Media), default: nil
+    const :attributes, T.nilable(T::Array[Inttegro::Product::Attribute]), default: nil
+    const :dimensions, T.nilable(Inttegro::Product::Dimensions), default: nil
+    const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    const :active, T::Boolean
+    const :created_at, Time
+    const :updated_at, T.nilable(Time), default: nil
+    const :archived_at, T.nilable(Time), default: nil
+    const :published_at, T.nilable(Time), default: nil
+    const :unit_dim, T.nilable(String), default: nil
+  end
+end

data/lib/inttegro/product/questions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class Product
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    # Determine whether the API supplied an archive timestamp.
+    #
+    # @return [Boolean] whether this product is archived
+    def archived?
+      !archived_at.nil?
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the product is currently active and not archived.
+    #
+    # This local predicate does not infer publication from {#published_at}; it reflects the
+    # +active+ and +archived_at+ fields on the current model.
+    #
+    # @return [Boolean] whether the product is currently published by this definition
+    def published?
+      active && !archived?
+    end
+
+    sig { returns(T::Boolean) }
+    # Determine whether the product has ever received a publication timestamp.
+    #
+    # @return [Boolean] whether {#published_at} is present
+    def ever_published?
+      !published_at.nil?
+    end
+  end
+end

data/lib/inttegro/product/render.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
+    # Rendered 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 Render < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/product/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 "product"
+
+module Inttegro
+  class Product
+    # 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] 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::Product, 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 :product, T.nilable(Inttegro::Product), default: nil
+      const :error, T.nilable(Inttegro::Shared::ErrorPayload), default: nil
+    end
+  end
+end

data/lib/inttegro/product/service.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
+    # Service 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 Service < T::Struct
+      # This object intentionally has no fields.
+    end
+  end
+end

data/lib/inttegro/product/set_default_unit_price_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Inttegro
+  class Product
+    # Request body for selecting a product's default unit price.
+    #
+    # Both fields are required and serialize with their snake-case API names.
+    #
+    # @api public
+    # @!attribute [r] price_id
+    #   Identifier of the catalog price to make the default.
+    #   @return [String]
+    # @!attribute [r] product_id
+    #   Identifier of the product whose default price is changing.
+    #   @return [String]
+    class SetDefaultUnitPriceRequest < T::Struct
+      const :product_id, String
+      const :price_id, String
+    end
+  end
+end

data/lib/inttegro/product/shipment.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "delivery"
+require_relative "download"
+require_relative "render"
+require_relative "service"
+require_relative "shipment_type"
+require_relative "stream"
+
+module Inttegro
+  class Product
+    # Typed representation of the shipment object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::ShipmentType]
+    #
+    # @!attribute [r] delivery
+    #   Delivery fulfillment marker.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `delivery`.
+    #   @return [Inttegro::Product::Delivery, nil]
+    #
+    # @!attribute [r] download
+    #   Download fulfillment marker.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `download`.
+    #   @return [Inttegro::Product::Download, nil]
+    #
+    # @!attribute [r] render
+    #   Rendered fulfillment marker.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `render`.
+    #   @return [Inttegro::Product::Render, nil]
+    #
+    # @!attribute [r] service
+    #   Service fulfillment marker.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `service`.
+    #   @return [Inttegro::Product::Service, nil]
+    #
+    # @!attribute [r] stream
+    #   Streaming fulfillment marker.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `stream`.
+    #   @return [Inttegro::Product::Stream, nil]
+    class Shipment < T::Struct
+      const :type, Inttegro::Product::ShipmentType
+      const :delivery, T.nilable(Inttegro::Product::Delivery), default: nil
+      const :download, T.nilable(Inttegro::Product::Download), default: nil
+      const :render, T.nilable(Inttegro::Product::Render), default: nil
+      const :service, T.nilable(Inttegro::Product::Service), default: nil
+      const :stream, T.nilable(Inttegro::Product::Stream), default: nil
+    end
+  end
+end

data/lib/inttegro/product/shipment_input.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 "shipment_input_type"
+
+module Inttegro
+  class Product
+    # Typed representation of the shipment input object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Product::ShipmentInputType]
+    class ShipmentInput < T::Struct
+      const :type, Inttegro::Product::ShipmentInputType
+    end
+  end
+end

data/lib/inttegro/product/shipment_input_type.rb

@@ -0,0 +1,33 @@
+# 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
+    # String-backed values accepted by the Inttegro API for Inttegro::Product::ShipmentInputType.
+    #
+    # 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 ShipmentInputType < T::Enum
+      enums do
+        # Serialized wire value: `delivery`.
+        # @return [Inttegro::Product::ShipmentInputType]
+        DELIVERY = new("delivery")
+        # Serialized wire value: `download`.
+        # @return [Inttegro::Product::ShipmentInputType]
+        DOWNLOAD = new("download")
+        # Serialized wire value: `render`.
+        # @return [Inttegro::Product::ShipmentInputType]
+        RENDER = new("render")
+        # Serialized wire value: `stream`.
+        # @return [Inttegro::Product::ShipmentInputType]
+        STREAM = new("stream")
+      end
+    end
+  end
+end