Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentPreview

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb

Overview

Information about a fulfillment order preview, including delivery and fee information based on shipping method.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentPreview

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 70

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentOutboundApiModel::FulfillmentPreview` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FulfillmentOutboundApiModel::FulfillmentPreview`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.shipping_speed_category = attributes[:shipping_speed_category] if attributes.key?(:shipping_speed_category)

  self.scheduled_delivery_info = attributes[:scheduled_delivery_info] if attributes.key?(:scheduled_delivery_info)

  self.is_fulfillable = attributes[:is_fulfillable] if attributes.key?(:is_fulfillable)

  self.is_cod_capable = attributes[:is_cod_capable] if attributes.key?(:is_cod_capable)

  self.estimated_shipping_weight = attributes[:estimated_shipping_weight] if attributes.key?(:estimated_shipping_weight)

  self.estimated_fees = attributes[:estimated_fees] if attributes.key?(:estimated_fees)

  self.fulfillment_preview_shipments = attributes[:fulfillment_preview_shipments] if attributes.key?(:fulfillment_preview_shipments)

  self.unfulfillable_preview_items = attributes[:unfulfillable_preview_items] if attributes.key?(:unfulfillable_preview_items)

  self.order_unfulfillable_reasons = attributes[:order_unfulfillable_reasons] if attributes.key?(:order_unfulfillable_reasons)

  self.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

  return unless attributes.key?(:feature_constraints)
  return unless (value = attributes[:feature_constraints]).is_a?(Array)

  self.feature_constraints = value
end

Instance Attribute Details

#estimated_fees ⇒ Object

Returns the value of attribute estimated_fees.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def estimated_fees
  @estimated_fees
end

#estimated_shipping_weight ⇒ Object

Returns the value of attribute estimated_shipping_weight.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def estimated_shipping_weight
  @estimated_shipping_weight
end

#feature_constraints ⇒ Object

A list of features and their fulfillment policies to apply to the order.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 27

def feature_constraints
  @feature_constraints
end

#fulfillment_preview_shipments ⇒ Object

Returns the value of attribute fulfillment_preview_shipments.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def fulfillment_preview_shipments
  @fulfillment_preview_shipments
end

#is_cod_capable ⇒ Object

When true, this fulfillment order preview is for COD (Cash On Delivery).



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 21

def is_cod_capable
  @is_cod_capable
end

#is_fulfillable ⇒ Object

When true, this fulfillment order preview is fulfillable.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 18

def is_fulfillable
  @is_fulfillable
end

#marketplace_id ⇒ Object

The marketplace the fulfillment order is placed against.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 24

def marketplace_id
  @marketplace_id
end

#order_unfulfillable_reasons ⇒ Object

Returns the value of attribute order_unfulfillable_reasons.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def order_unfulfillable_reasons
  @order_unfulfillable_reasons
end

#scheduled_delivery_info ⇒ Object

Returns the value of attribute scheduled_delivery_info.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def scheduled_delivery_info
  @scheduled_delivery_info
end

#shipping_speed_category ⇒ Object

Returns the value of attribute shipping_speed_category.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def shipping_speed_category
  @shipping_speed_category
end

#unfulfillable_preview_items ⇒ Object

Returns the value of attribute unfulfillable_preview_items.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 15

def unfulfillable_preview_items
  @unfulfillable_preview_items
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 30

def self.attribute_map
  {
    'shipping_speed_category': :shippingSpeedCategory,
    'scheduled_delivery_info': :scheduledDeliveryInfo,
    'is_fulfillable': :isFulfillable,
    'is_cod_capable': :isCODCapable,
    'estimated_shipping_weight': :estimatedShippingWeight,
    'estimated_fees': :estimatedFees,
    'fulfillment_preview_shipments': :fulfillmentPreviewShipments,
    'unfulfillable_preview_items': :unfulfillablePreviewItems,
    'order_unfulfillable_reasons': :orderUnfulfillableReasons,
    'marketplace_id': :marketplaceId,
    'feature_constraints': :featureConstraints
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



166
167
168
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 166

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 64

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 47

def self.openapi_types
  {
    'shipping_speed_category': :Object,
    'scheduled_delivery_info': :Object,
    'is_fulfillable': :Object,
    'is_cod_capable': :Object,
    'estimated_shipping_weight': :Object,
    'estimated_fees': :Object,
    'fulfillment_preview_shipments': :Object,
    'unfulfillable_preview_items': :Object,
    'order_unfulfillable_reasons': :Object,
    'marketplace_id': :Object,
    'feature_constraints': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 134

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    shipping_speed_category == other.shipping_speed_category &&
    scheduled_delivery_info == other.scheduled_delivery_info &&
    is_fulfillable == other.is_fulfillable &&
    is_cod_capable == other.is_cod_capable &&
    estimated_shipping_weight == other.estimated_shipping_weight &&
    estimated_fees == other.estimated_fees &&
    fulfillment_preview_shipments == other.fulfillment_preview_shipments &&
    unfulfillable_preview_items == other.unfulfillable_preview_items &&
    order_unfulfillable_reasons == other.order_unfulfillable_reasons &&
    marketplace_id == other.marketplace_id &&
    feature_constraints == other.feature_constraints
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 195

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    AmznSpApi::FulfillmentOutboundApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 264

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 173

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 159

def hash
  [shipping_speed_category, scheduled_delivery_info, is_fulfillable, is_cod_capable, estimated_shipping_weight, estimated_fees, fulfillment_preview_shipments, unfulfillable_preview_items, order_unfulfillable_reasons, marketplace_id, feature_constraints].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 108

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "shipping_speed_category", shipping_speed_category cannot be nil.') if @shipping_speed_category.nil?

  invalid_properties.push('invalid value for "is_fulfillable", is_fulfillable cannot be nil.') if @is_fulfillable.nil?

  invalid_properties.push('invalid value for "is_cod_capable", is_cod_capable cannot be nil.') if @is_cod_capable.nil?

  invalid_properties.push('invalid value for "marketplace_id", marketplace_id cannot be nil.') if @marketplace_id.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



240
241
242
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 240

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 246

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



234
235
236
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 234

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



123
124
125
126
127
128
129
130
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_preview.rb', line 123

def valid?
  return false if @shipping_speed_category.nil?
  return false if @is_fulfillable.nil?
  return false if @is_cod_capable.nil?
  return false if @marketplace_id.nil?

  true
end