Class: SubskribeSandboxClient::BulkInvoiceRun

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/bulk_invoice_run.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkInvoiceRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 105

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?(:'entityId')
    self.entity_id = attributes[:'entityId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#charge_inclusion_option ⇒ Object

Returns the value of attribute charge_inclusion_option.



27
28
29
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 27

def charge_inclusion_option
  @charge_inclusion_option
end

#created_on ⇒ Object

Returns the value of attribute created_on.



39
40
41
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 39

def created_on
  @created_on
end

#description ⇒ Object

Returns the value of attribute description.



21
22
23
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 21

def description
  @description
end

#entity_id ⇒ Object

Returns the value of attribute entity_id.



17
18
19
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 17

def entity_id
  @entity_id
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



37
38
39
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 37

def failure_reason
  @failure_reason
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 29

def id
  @id
end

#invoice_date ⇒ Object

Returns the value of attribute invoice_date.



25
26
27
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 25

def invoice_date
  @invoice_date
end

#invoice_selector ⇒ Object

Returns the value of attribute invoice_selector.



35
36
37
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 35

def invoice_selector
  @invoice_selector
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 19

def name
  @name
end

#phase ⇒ Object

Returns the value of attribute phase.



33
34
35
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 33

def phase
  @phase
end

#status ⇒ Object

Returns the value of attribute status.



31
32
33
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 31

def status
  @status
end

#target_date ⇒ Object

Returns the value of attribute target_date.



23
24
25
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 23

def target_date
  @target_date
end

#updated_on ⇒ Object

Returns the value of attribute updated_on.



41
42
43
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 41

def updated_on
  @updated_on
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 66

def self.attribute_map
  {
    :'entity_id' => :'entityId',
    :'name' => :'name',
    :'description' => :'description',
    :'target_date' => :'targetDate',
    :'invoice_date' => :'invoiceDate',
    :'charge_inclusion_option' => :'chargeInclusionOption',
    :'id' => :'id',
    :'status' => :'status',
    :'phase' => :'phase',
    :'invoice_selector' => :'invoiceSelector',
    :'failure_reason' => :'failureReason',
    :'created_on' => :'createdOn',
    :'updated_on' => :'updatedOn'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 85

def self.swagger_types
  {
    :'entity_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'target_date' => :'Integer',
    :'invoice_date' => :'Integer',
    :'charge_inclusion_option' => :'String',
    :'id' => :'String',
    :'status' => :'String',
    :'phase' => :'String',
    :'invoice_selector' => :'BulkInvoiceRunSelector',
    :'failure_reason' => :'String',
    :'created_on' => :'Integer',
    :'updated_on' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_id == o.entity_id &&
      name == o.name &&
      description == o.description &&
      target_date == o.target_date &&
      invoice_date == o.invoice_date &&
      charge_inclusion_option == o.charge_inclusion_option &&
      id == o.id &&
      status == o.status &&
      phase == o.phase &&
      invoice_selector == o.invoice_selector &&
      failure_reason == o.failure_reason &&
      created_on == o.created_on &&
      updated_on == o.updated_on
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 269

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 = SubskribeSandboxClient.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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 335

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 248

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


235
236
237
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 241

def hash
  [entity_id, name, description, target_date, invoice_date, charge_inclusion_option, id, status, phase, invoice_selector, failure_reason, created_on, updated_on].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



166
167
168
169
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 166

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



315
316
317
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 321

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



309
310
311
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 309

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



173
174
175
176
177
178
179
180
181
 
# File 'lib/subskribe_sandbox/models/bulk_invoice_run.rb', line 173

def valid?
  charge_inclusion_option_validator = EnumAttributeValidator.new('String', ['INCLUDE_USAGE', 'EXCLUDE_USAGE', 'ONLY_USAGE'])
  return false unless charge_inclusion_option_validator.valid?(@charge_inclusion_option)
  status_validator = EnumAttributeValidator.new('String', ['CREATED', 'PROCESSING', 'FAILED', 'COMPLETED', 'RUNNING'])
  return false unless status_validator.valid?(@status)
  phase_validator = EnumAttributeValidator.new('String', ['INVOICE_GENERATION_NOT_STARTED', 'INVOICES_GENERATING', 'INVOICES_GENERATED', 'INVOICES_POSTING', 'INVOICES_POSTED', 'INVOICES_EMAILING', 'INVOICES_EMAILED'])
  return false unless phase_validator.valid?(@phase)
  true
end