Class: Inttegro::Product::InlineDetails

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

Overview

Typed representation of the inline details 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)

Long-form description or marketing copy

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

Returns:

  • (String, nil) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
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:



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end

#name ⇒ String (readonly)

Product name shown to the customer

Required in the API payload. Wire name: name.

Returns:

  • (String) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end

#price ⇒ Inttegro::Price::PriceParams (readonly)

An inline price supplied in a request.

Required in the API payload. Wire name: price.

Returns:



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end

#quantity ⇒ Integer (readonly)

How many units the customer is purchasing

Required in the API payload. Wire name: quantity.

Returns:

  • (Integer) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end

#reference ⇒ String? (readonly)

Your SKU or internal product reference

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

Returns:

  • (String, nil) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
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) 


69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end

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

Product type—affects shipping requirements

Required in the API payload. Wire name: type.

Returns:



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/inttegro/product/inline_details.rb', line 69

class InlineDetails < T::Struct
  const :about, T.nilable(String), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :name, String
  const :price, Inttegro::Price::PriceParams
  const :quantity, Integer
  const :reference, T.nilable(String), default: nil
  const :tax_code, T.nilable(String), default: nil
  const :type, Inttegro::Product::Type
end