Class: Inttegro::Price::CatalogPrice

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/price/catalog_price.rb

Overview

Typed representation of the catalog price 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)

Longer description of this price

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

Returns:

  • (String, nil) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#active ⇒ Boolean (readonly)

Whether this price is active and usable in new flows

Required in the API payload. Wire name: active.

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), 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) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#created_at ⇒ Time (readonly)

Price creation timestamp

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#customer_selected_amount ⇒ Inttegro::Price::CustomerSelectedAmount? (readonly)

Customer-selected amount configuration. Present only for customer_selected_amount prices.

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

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#fixed_amount ⇒ Inttegro::Money::Amount? (readonly)

Fixed price amount. Present only for fixed_amount prices.

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

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#id ⇒ String (readonly)

Unique price identifier with pr_ prefix

Required in the API payload. Wire name: id.

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#label ⇒ String? (readonly)

Short label for this price

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

Returns:

  • (String, nil) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#nominal ⇒ Inttegro::Money::Amount? (readonly)

Legacy fixed price amount. Present only for fixed_amount prices.

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

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#product ⇒ Inttegro::Price::EmbeddedProduct? (readonly)

Embedded product details, if this price belongs to a product

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

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

#product_id ⇒ String? (readonly)

Product ID when the operation returns the relationship by reference

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

Returns:

  • (String, nil) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end

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

Price definition discriminator

Required in the API payload. Wire name: type.

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), 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) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/inttegro/price/catalog_price.rb', line 99

class CatalogPrice < T::Struct
  const :id, String
  const :label, T.nilable(String), default: nil
  const :about, T.nilable(String), default: nil
  const :active, T::Boolean
  const :type, Inttegro::Price::Type
  const :nominal, T.nilable(Inttegro::Money::Amount), default: nil
  const :fixed_amount, T.nilable(Inttegro::Money::Amount), default: nil
  const :customer_selected_amount, T.nilable(Inttegro::Price::CustomerSelectedAmount), default: nil
  const :product_id, T.nilable(String), default: nil
  const :product, T.nilable(Inttegro::Price::EmbeddedProduct), default: nil
  const :created_at, Time
  const :updated_at, T.nilable(Time), default: nil
  const :archived_at, T.nilable(Time), default: nil
end