Class: Inttegro::Product::DimensionsPhysical

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

Overview

Typed representation of the dimensions physical 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

#height ⇒ Integer, ... (readonly)

Value of the height field in the Inttegro API payload.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#length ⇒ Integer, ... (readonly)

Value of the length field in the Inttegro API payload.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#size ⇒ Integer, ... (readonly)

Legacy alias for weight in requests.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#volume ⇒ Integer, ... (readonly)

Value of the volume field in the Inttegro API payload.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#volume_unit ⇒ String? (readonly)

Value of the volume_unit field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#weight ⇒ Integer, ... (readonly)

Value of the weight field in the Inttegro API payload.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#weight_unit ⇒ String? (readonly)

Value of the weight_unit field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end

#width ⇒ Integer, ... (readonly)

Value of the width field in the Inttegro API payload.

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

Returns:

  • (Integer, Float, nil) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inttegro/product/dimensions_physical.rb', line 65

class DimensionsPhysical < T::Struct
  const :weight_unit, T.nilable(String), default: nil
  const :weight, T.nilable(T.any(Integer, Float)), default: nil
  const :size, T.nilable(T.any(Integer, Float)), default: nil
  const :volume_unit, T.nilable(String), default: nil
  const :volume, T.nilable(T.any(Integer, Float)), default: nil
  const :length, T.nilable(T.any(Integer, Float)), default: nil
  const :height, T.nilable(T.any(Integer, Float)), default: nil
  const :width, T.nilable(T.any(Integer, Float)), default: nil
end