Class: AmznSpApi::FulfillmentInboundApiModel::CreateInboundShipmentPlanRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb

Overview

The request schema for the createInboundShipmentPlan operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateInboundShipmentPlanRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 52

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

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

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

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

  return unless attributes.key?(:inbound_shipment_plan_request_items)

  self.inbound_shipment_plan_request_items = attributes[:inbound_shipment_plan_request_items]
end

Instance Attribute Details

#inbound_shipment_plan_request_items ⇒ Object

Returns the value of attribute inbound_shipment_plan_request_items.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 15

def inbound_shipment_plan_request_items
  @inbound_shipment_plan_request_items
end

#label_prep_preference ⇒ Object

Returns the value of attribute label_prep_preference.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 15

def label_prep_preference
  @label_prep_preference
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



15
16
17
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 15

def ship_from_address
  @ship_from_address
end

#ship_to_country_code ⇒ Object

The two-character country code for the country where the inbound shipment is to be sent. Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error. Values: ShipToCountryCode values for North America: * CA – Canada * MX - Mexico * US - United States ShipToCountryCode values for MCI sellers in Europe: * DE – Germany * ES – Spain * FR – France * GB – United Kingdom * IT – Italy Default: The country code for the seller’s home marketplace.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 18

def ship_to_country_code
  @ship_to_country_code
end

#ship_to_country_subdivision_code ⇒ Object

The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, "IN-MH". In full ISO 3166-2 format. Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.



21
22
23
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 21

def ship_to_country_subdivision_code
  @ship_to_country_subdivision_code
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 24

def self.attribute_map
  {
    'ship_from_address': :ShipFromAddress,
    'label_prep_preference': :LabelPrepPreference,
    'ship_to_country_code': :ShipToCountryCode,
    'ship_to_country_subdivision_code': :ShipToCountrySubdivisionCode,
    'inbound_shipment_plan_request_items': :InboundShipmentPlanRequestItems
  }
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



126
127
128
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 126

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



46
47
48
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 46

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

.openapi_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 35

def self.openapi_types
  {
    'ship_from_address': :Object,
    'label_prep_preference': :Object,
    'ship_to_country_code': :Object,
    'ship_to_country_subdivision_code': :Object,
    'inbound_shipment_plan_request_items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 100

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

  self.class == other.class &&
    ship_from_address == other.ship_from_address &&
    label_prep_preference == other.label_prep_preference &&
    ship_to_country_code == other.ship_to_country_code &&
    ship_to_country_subdivision_code == other.ship_to_country_subdivision_code &&
    inbound_shipment_plan_request_items == other.inbound_shipment_plan_request_items
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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 155

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::FulfillmentInboundApiModel.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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 224

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



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

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


113
114
115
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



119
120
121
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 119

def hash
  [ship_from_address, label_prep_preference, ship_to_country_code, ship_to_country_subdivision_code, inbound_shipment_plan_request_items].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



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 77

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

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

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



200
201
202
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 200

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 206

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



194
195
196
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 194

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



90
91
92
93
94
95
96
 
# File 'lib/fulfillment_inbound_api_model/models/create_inbound_shipment_plan_request.rb', line 90

def valid?
  return false if @ship_from_address.nil?
  return false if @label_prep_preference.nil?
  return false if @inbound_shipment_plan_request_items.nil?

  true
end