Class: AmznSpApi::EasyShipApiModel::InvoiceData

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

Overview

Invoice number and date.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceData

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 40

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

  return unless attributes.key?(:invoice_date)

  self.invoice_date = attributes[:invoice_date]
end

Instance Attribute Details

#invoice_date ⇒ Object

Returns the value of attribute invoice_date.



15
16
17
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 15

def invoice_date
  @invoice_date
end

#invoice_number ⇒ Object

Returns the value of attribute invoice_number.



15
16
17
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 15

def invoice_number
  @invoice_number
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 18

def self.attribute_map
  {
    'invoice_number': :invoiceNumber,
    'invoice_date': :invoiceDate
  }
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



99
100
101
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 99

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



34
35
36
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 34

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

.openapi_types ⇒ Object

Attribute type mapping.



26
27
28
29
30
31
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 26

def self.openapi_types
  {
    'invoice_number': :Object,
    'invoice_date': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



76
77
78
79
80
81
82
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 76

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

  self.class == other.class &&
    invoice_number == other.invoice_number &&
    invoice_date == other.invoice_date
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



128
129
130
131
132
133
134
135
136
137
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
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 128

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



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 197

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 106

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


86
87
88
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 86

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



92
93
94
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 92

def hash
  [invoice_number, invoice_date].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



59
60
61
62
63
64
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 59

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "invoice_number", invoice_number cannot be nil.') if @invoice_number.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



173
174
175
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 173

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



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 179

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



167
168
169
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 167

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



68
69
70
71
72
 
# File 'lib/easy_ship_api_model/models/invoice_data.rb', line 68

def valid?
  return false if @invoice_number.nil?

  true
end