Class: AmznSpApi::EasyShipApiModel::CreateScheduledPackagesResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/easy_ship_api_model/models/create_scheduled_packages_response.rb

Overview

The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn’t schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateScheduledPackagesResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 48

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::EasyShipApiModel::CreateScheduledPackagesResponse` 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::EasyShipApiModel::CreateScheduledPackagesResponse`. 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

  if attributes.key?(:scheduled_packages) && (value = attributes[:scheduled_packages]).is_a?(Array)
    self.scheduled_packages = value
  end

  if attributes.key?(:rejected_orders) && (value = attributes[:rejected_orders]).is_a?(Array)
    self.rejected_orders = value
  end

  return unless attributes.key?(:printable_documents_url)

  self.printable_documents_url = attributes[:printable_documents_url]
end

Instance Attribute Details

#printable_documents_url ⇒ Object

Returns the value of attribute printable_documents_url.



21
22
23
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 21

def printable_documents_url
  @printable_documents_url
end

#rejected_orders ⇒ Object

A list of orders we couldn’t scheduled on your behalf. Each element contains the reason and details on the error.



19
20
21
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 19

def rejected_orders
  @rejected_orders
end

#scheduled_packages ⇒ Object

A list of packages. Refer to the ‘Package` object.



16
17
18
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 16

def scheduled_packages
  @scheduled_packages
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 24

def self.attribute_map
  {
    'scheduled_packages': :scheduledPackages,
    'rejected_orders': :rejectedOrders,
    'printable_documents_url': :printableDocumentsUrl
  }
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



109
110
111
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 109

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



42
43
44
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 42

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 33

def self.openapi_types
  {
    'scheduled_packages': :Object,
    'rejected_orders': :Object,
    'printable_documents_url': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



85
86
87
88
89
90
91
92
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 85

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

  self.class == other.class &&
    scheduled_packages == other.scheduled_packages &&
    rejected_orders == other.rejected_orders &&
    printable_documents_url == other.printable_documents_url
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 138

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



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 207

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 116

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


96
97
98
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



102
103
104
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 102

def hash
  [scheduled_packages, rejected_orders, printable_documents_url].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



73
74
75
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 73

def list_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



183
184
185
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 183

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



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 189

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



177
178
179
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 177

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



79
80
81
 
# File 'lib/easy_ship_api_model/models/create_scheduled_packages_response.rb', line 79

def valid?
  true
end