Class: Inttegro::Order::ProductLineItemProduct

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/product_line_item_product.rb

Overview

Typed representation of the product line item 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)

Value of the about field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#category ⇒ String? (readonly)

Value of the category field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
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:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#id ⇒ String (readonly)

Immutable order-line identifier with the oli_ prefix.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#name ⇒ String (readonly)

Value of the name field in the Inttegro API payload.

Required in the API payload. Wire name: name.

Returns:

  • (String) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#price ⇒ Inttegro::Price (readonly)

An inline price returned by the API.

Required in the API payload. Wire name: price.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#price_id ⇒ String? (readonly)

Source catalog price ID when this line snapshots a saved price.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#product_id ⇒ String? (readonly)

Source catalog product ID when this line snapshots a catalog product.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#quantity ⇒ Integer (readonly)

Value of the quantity field in the Inttegro API payload.

Required in the API payload. Wire name: quantity.

Returns:

  • (Integer) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#reference ⇒ String? (readonly)

Value of the reference field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#tax_code ⇒ String? (readonly)

Value of the tax_code field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end

#type ⇒ String? (readonly)

Value of the type field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/inttegro/order/product_line_item_product.rb', line 92

class ProductLineItemProduct < T::Struct
  const :id, String
  const :product_id, T.nilable(String), default: nil
  const :price_id, T.nilable(String), default: nil
  const :reference, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :name, String
  const :category, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :price, Inttegro::Price
  const :quantity, Integer
end