Class: Inttegro::PurchaseIntent::Product

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/purchase_intent/product.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#about ⇒ String? (readonly)

Full product description

Optional in the API payload; omitted values default to nil. Wire name: about.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#active ⇒ Boolean (readonly)

Whether product is published and available

Required in the API payload. Wire name: active.

Returns:

  • (Boolean)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#archived_at ⇒ Time? (readonly)

Archive timestamp (if archived)

Optional in the API payload; omitted values default to nil. Wire name: archived_at.

Returns:

  • (Time, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#attributes ⇒ Array<Inttegro::PurchaseIntent::ProductAttributesItem>? (readonly)

Product attributes

Optional in the API payload; omitted values default to nil. Wire name: attributes.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#category ⇒ String? (readonly)

Product category

Optional in the API payload; omitted values default to nil. Wire name: category.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#created_at ⇒ Time (readonly)

Product creation timestamp

Required in the API payload. Wire name: created_at.

Returns:

  • (Time)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#custom_data ⇒ Inttegro::CustomData? (readonly)

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.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#description ⇒ String? (readonly)

Short description

Optional in the API payload; omitted values default to nil. Wire name: description.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#dimensions ⇒ Inttegro::Product::Dimensions? (readonly)

Product dimensions and size metadata

Optional in the API payload; omitted values default to nil. Wire name: dimensions.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#id ⇒ String (readonly)

Unique product identifier with prod_ prefix

Required in the API payload. Wire name: id.

Returns:

  • (String)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#media ⇒ Inttegro::Product::Media? (readonly)

Product media assets

Optional in the API payload; omitted values default to nil. Wire name: media.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#name ⇒ String (readonly)

Product name

Required in the API payload. Wire name: name.

Returns:

  • (String)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#prices ⇒ Array<Inttegro::Product::PriceSummary>? (readonly)

Non-archived catalog prices currently attached to the product

Optional in the API payload; omitted values default to nil. Wire name: prices.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#published_at ⇒ Time? (readonly)

When the product was published

Optional in the API payload; omitted values default to nil. Wire name: published_at.

Returns:

  • (Time, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#reference ⇒ String? (readonly)

External reference or SKU

Optional in the API payload; omitted values default to nil. Wire name: reference.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#shipment ⇒ Inttegro::Product::Shipment? (readonly)

Shipment and fulfillment details

Optional in the API payload; omitted values default to nil. Wire name: shipment.

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#tax_code ⇒ String? (readonly)

Tax classification code

Optional in the API payload; omitted values default to nil. Wire name: tax_code.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#type ⇒ Inttegro::Product::Type (readonly)

Product type

Required in the API payload. Wire name: type.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#unit_dim ⇒ String? (readonly)

Unit dimension label

Optional in the API payload; omitted values default to nil. Wire name: unit_dim.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#updated_at ⇒ Time? (readonly)

Last update timestamp

Optional in the API payload; omitted values default to nil. Wire name: updated_at.

Returns:

  • (Time, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end

#variant_set_id ⇒ String? (readonly)

Variant set configured for this Buy link

Optional in the API payload; omitted values default to nil. Wire name: variant_set_id.

Returns:

  • (String, nil)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/inttegro/purchase_intent/product.rb', line 151

class Product < 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(Inttegro::CustomData), 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
  const :prices, T.nilable(T::Array[Inttegro::Product::PriceSummary]), default: nil
  const :variant_set_id, T.nilable(String), default: nil
end