Class: AmznSpApi::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest

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

Overview

The request body schema for the getFulfillmentPreview operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetFulfillmentPreviewRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 62

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest` 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::GetFulfillmentPreviewRequest`. 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.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

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

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

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

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

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

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

  self.feature_constraints = value
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
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/get_fulfillment_preview_request.rb', line 27

def feature_constraints
  @feature_constraints
end

#include_cod_fulfillment_preview ⇒ Object

When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD.



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

def include_cod_fulfillment_preview
  @include_cod_fulfillment_preview
end

#include_delivery_windows ⇒ Object

When true, returns the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.



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

def include_delivery_windows
  @include_delivery_windows
end

#items ⇒ Object

Returns the value of attribute items.



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

def items
  @items
end

#marketplace_id ⇒ Object

The marketplace the fulfillment order is placed against.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 16

def marketplace_id
  @marketplace_id
end

#shipping_speed_categories ⇒ Object

Returns the value of attribute shipping_speed_categories.



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

def shipping_speed_categories
  @shipping_speed_categories
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
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 30

def self.attribute_map
  {
    'marketplace_id': :marketplaceId,
    'address': :address,
    'items': :items,
    'shipping_speed_categories': :shippingSpeedCategories,
    'include_cod_fulfillment_preview': :includeCODFulfillmentPreview,
    'include_delivery_windows': :includeDeliveryWindows,
    '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



140
141
142
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 140

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 43

def self.openapi_types
  {
    'marketplace_id': :Object,
    'address': :Object,
    'items': :Object,
    'shipping_speed_categories': :Object,
    'include_cod_fulfillment_preview': :Object,
    'include_delivery_windows': :Object,
    'feature_constraints': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 112

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

  self.class == other.class &&
    marketplace_id == other.marketplace_id &&
    address == other.address &&
    items == other.items &&
    shipping_speed_categories == other.shipping_speed_categories &&
    include_cod_fulfillment_preview == other.include_cod_fulfillment_preview &&
    include_delivery_windows == other.include_delivery_windows &&
    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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 169

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 238

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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 147

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


127
128
129
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



133
134
135
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 133

def hash
  [marketplace_id, address, items, shipping_speed_categories, include_cod_fulfillment_preview, include_delivery_windows, 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



92
93
94
95
96
97
98
99
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 92

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

  invalid_properties.push('invalid value for "items", items cannot be nil.') if @items.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



214
215
216
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 214

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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 220

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



208
209
210
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 208

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



103
104
105
106
107
108
 
# File 'lib/fulfillment_outbound_api_model/models/get_fulfillment_preview_request.rb', line 103

def valid?
  return false if @address.nil?
  return false if @items.nil?

  true
end