Class: Bfwd::CreditNote

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/credit_note.rb

Overview

CreditNote

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditNote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 124

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.has_key?(:'changedBy')
    self.changed_by = attributes[:'changedBy']
  end

  if attributes.has_key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'accountID')
    self. = attributes[:'accountID']
  end

  if attributes.has_key?(:'invoiceID')
    self.invoice_id = attributes[:'invoiceID']
  end

  if attributes.has_key?(:'subscriptionID')
    self.subscription_id = attributes[:'subscriptionID']
  end

  if attributes.has_key?(:'organizationID')
    self.organization_id = attributes[:'organizationID']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'value')
    self.value = attributes[:'value']
  end

  if attributes.has_key?(:'remainingValue')
    self.remaining_value = attributes[:'remainingValue']
  end

  if attributes.has_key?(:'createdBy')
    self.created_by = attributes[:'createdBy']
  end

end

Instance Attribute Details

#account_id ⇒ Object

{ "description" : "", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 31

def 
  @account_id
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 19

def created
  @created
end

#created_by ⇒ Object

{ "description" : "", "verbs“: }



58
59
60
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 58

def created_by
  @created_by
end

#currency ⇒ Object

{ "description" : "Currency of the credit-note specified by a three character ISO 4217 currency code.", "verbs“: }



46
47
48
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 46

def currency
  @currency
end

#description ⇒ Object

{ "description" : "", "verbs“: }



49
50
51
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 49

def description
  @description
end

#id ⇒ Object

{ "description" : "", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 28

def id
  @id
end

#invoice_id ⇒ Object

{ "description" : "References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 34

def invoice_id
  @invoice_id
end

#organization_id ⇒ Object

{ "description" : "", "verbs":[] }



40
41
42
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 40

def organization_id
  @organization_id
end

#remaining_value ⇒ Object

{ "description" : "Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.", "verbs“: }



55
56
57
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 55

def remaining_value
  @remaining_value
end

#subscription_id ⇒ Object

{ "description" : "Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 37

def subscription_id
  @subscription_id
end

#type ⇒ Object

{ "description" : "", "verbs":[] }



43
44
45
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 43

def type
  @type
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 25

def updated
  @updated
end

#value ⇒ Object

{ "description" : " Monetary value of the credit-note", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 52

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 83

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'account_id' => :'accountID',
    :'invoice_id' => :'invoiceID',
    :'subscription_id' => :'subscriptionID',
    :'organization_id' => :'organizationID',
    :'type' => :'type',
    :'currency' => :'currency',
    :'description' => :'description',
    :'value' => :'value',
    :'remaining_value' => :'remainingValue',
    :'created_by' => :'createdBy'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 103

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'account_id' => :'String',
    :'invoice_id' => :'String',
    :'subscription_id' => :'String',
    :'organization_id' => :'String',
    :'type' => :'String',
    :'currency' => :'String',
    :'description' => :'String',
    :'value' => :'Float',
    :'remaining_value' => :'Float',
    :'created_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
       == o. &&
      invoice_id == o.invoice_id &&
      subscription_id == o.subscription_id &&
      organization_id == o.organization_id &&
      type == o.type &&
      currency == o.currency &&
      description == o.description &&
      value == o.value &&
      remaining_value == o.remaining_value &&
      created_by == o.created_by
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 295

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
    temp_model = Bfwd.const_get(type).new
    temp_model.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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 361

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


261
262
263
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 267

def hash
  [created, changed_by, updated, id, , invoice_id, subscription_id, organization_id, type, currency, description, value, remaining_value, created_by].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push("invalid value for 'account_id', account_id cannot be nil.")
  end

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

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

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

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

  return 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



341
342
343
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 341

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



347
348
349
350
351
352
353
354
355
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 347

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



335
336
337
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 335

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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/bf_ruby2/models/credit_note.rb', line 217

def valid?
  return false if @account_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["invoice", "manual"])
  return false unless type_validator.valid?(@type)
  return false if @currency.nil?
  return false if @value.nil?
  return false if @remaining_value.nil?
  return true
end