Class: OpenapiClient::ModifyBatch

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/modify_batch.rb

Overview

A modify batch object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModifyBatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ModifyBatch` initialize method"
  end

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

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

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

Instance Attribute Details

#rate_ids ⇒ Object

Array of Rate IDs to be modifed on the batch



22
23
24
 
# File 'lib/openapi_client/models/modify_batch.rb', line 22

def rate_ids
  @rate_ids
end

#shipment_ids ⇒ Object

The Shipment Ids to be modified on the batch



19
20
21
 
# File 'lib/openapi_client/models/modify_batch.rb', line 19

def shipment_ids
  @shipment_ids
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/openapi_client/models/modify_batch.rb', line 25

def self.attribute_map
  {
    :'shipment_ids' => :'shipment_ids',
    :'rate_ids' => :'rate_ids'
  }
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



111
112
113
 
# File 'lib/openapi_client/models/modify_batch.rb', line 111

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



41
42
43
44
 
# File 'lib/openapi_client/models/modify_batch.rb', line 41

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/openapi_client/models/modify_batch.rb', line 33

def self.openapi_types
  {
    :'shipment_ids' => :'Array<String>',
    :'rate_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
 
# File 'lib/openapi_client/models/modify_batch.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipment_ids == o.shipment_ids &&
      rate_ids == o.rate_ids
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



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
174
 
# File 'lib/openapi_client/models/modify_batch.rb', line 139

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
    OpenapiClient.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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/openapi_client/models/modify_batch.rb', line 208

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/openapi_client/models/modify_batch.rb', line 118

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


98
99
100
 
# File 'lib/openapi_client/models/modify_batch.rb', line 98

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



104
105
106
 
# File 'lib/openapi_client/models/modify_batch.rb', line 104

def hash
  [shipment_ids, rate_ids].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



76
77
78
79
 
# File 'lib/openapi_client/models/modify_batch.rb', line 76

def list_invalid_properties
  invalid_properties = Array.new
  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



184
185
186
 
# File 'lib/openapi_client/models/modify_batch.rb', line 184

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



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/openapi_client/models/modify_batch.rb', line 190

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



178
179
180
 
# File 'lib/openapi_client/models/modify_batch.rb', line 178

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



83
84
85
 
# File 'lib/openapi_client/models/modify_batch.rb', line 83

def valid?
  true
end