Class: AmzSpApi::VendorInvoicesApiModel::CreditNoteDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-invoices-api-model/models/credit_note_details.rb

Overview

References required in order to process a credit note. This information is required only if InvoiceType is CreditNote.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditNoteDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::VendorInvoicesApiModel::CreditNoteDetails` 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 `AmzSpApi::VendorInvoicesApiModel::CreditNoteDetails`. 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?(:'reference_invoice_number')
    self.reference_invoice_number = attributes[:'reference_invoice_number']
  end

  if attributes.key?(:'debit_note_number')
    self.debit_note_number = attributes[:'debit_note_number']
  end

  if attributes.key?(:'returns_reference_number')
    self.returns_reference_number = attributes[:'returns_reference_number']
  end

  if attributes.key?(:'goods_return_date')
    self.goods_return_date = attributes[:'goods_return_date']
  end

  if attributes.key?(:'rma_id')
    self.rma_id = attributes[:'rma_id']
  end

  if attributes.key?(:'coop_reference_number')
    self.coop_reference_number = attributes[:'coop_reference_number']
  end

  if attributes.key?(:'consignors_reference_number')
    self.consignors_reference_number = attributes[:'consignors_reference_number']
  end
end

Instance Attribute Details

#consignors_reference_number ⇒ Object

Identifies the consignor reference number (VRET number), if generated by Amazon.



35
36
37
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 35

def consignors_reference_number
  @consignors_reference_number
end

#coop_reference_number ⇒ Object

Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note.



32
33
34
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 32

def coop_reference_number
  @coop_reference_number
end

#debit_note_number ⇒ Object

Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes.



21
22
23
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 21

def debit_note_number
  @debit_note_number
end

#goods_return_date ⇒ Object

Returns the value of attribute goods_return_date.



26
27
28
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 26

def goods_return_date
  @goods_return_date
end

#reference_invoice_number ⇒ Object

Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes.



18
19
20
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 18

def reference_invoice_number
  @reference_invoice_number
end

#returns_reference_number ⇒ Object

Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes.



24
25
26
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 24

def returns_reference_number
  @returns_reference_number
end

#rma_id ⇒ Object

Identifies the Returned Merchandise Authorization ID, if generated.



29
30
31
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 29

def rma_id
  @rma_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 38

def self.attribute_map
  {
    :'reference_invoice_number' => :'referenceInvoiceNumber',
    :'debit_note_number' => :'debitNoteNumber',
    :'returns_reference_number' => :'returnsReferenceNumber',
    :'goods_return_date' => :'goodsReturnDate',
    :'rma_id' => :'rmaId',
    :'coop_reference_number' => :'coopReferenceNumber',
    :'consignors_reference_number' => :'consignorsReferenceNumber'
  }
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



155
156
157
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 155

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 51

def self.openapi_types
  {
    :'reference_invoice_number' => :'Object',
    :'debit_note_number' => :'Object',
    :'returns_reference_number' => :'Object',
    :'goods_return_date' => :'Object',
    :'rma_id' => :'Object',
    :'coop_reference_number' => :'Object',
    :'consignors_reference_number' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference_invoice_number == o.reference_invoice_number &&
      debit_note_number == o.debit_note_number &&
      returns_reference_number == o.returns_reference_number &&
      goods_return_date == o.goods_return_date &&
      rma_id == o.rma_id &&
      coop_reference_number == o.coop_reference_number &&
      consignors_reference_number == o.consignors_reference_number
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 185

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
    AmzSpApi::VendorInvoicesApiModel.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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 254

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 162

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 148

def hash
  [reference_invoice_number, debit_note_number, returns_reference_number, goods_return_date, rma_id, coop_reference_number, consignors_reference_number].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



115
116
117
118
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 115

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



230
231
232
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 230

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 236

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



224
225
226
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 224

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



122
123
124
 
# File 'lib/vendor-invoices-api-model/models/credit_note_details.rb', line 122

def valid?
  true
end