Class: ProtonApi::BusinessInvoiceAnalysisRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/business_invoice_analysis_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessInvoiceAnalysisRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 109

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

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

  if attributes.has_key?(:'show_history')
    self.show_history = attributes[:'show_history']
  else
    self.show_history = false
  end

  if attributes.has_key?(:'show_outstanding_invoices')
    self.show_outstanding_invoices = attributes[:'show_outstanding_invoices']
  else
    self.show_outstanding_invoices = false
  end

  if attributes.has_key?(:'response_limit')
    self.response_limit = attributes[:'response_limit']
  else
    self.response_limit = 10
  end

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

  if attributes.has_key?(:'history_frequency_interval')
    self.history_frequency_interval = attributes[:'history_frequency_interval']
  else
    self.history_frequency_interval = 'month'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#business_id ⇒ Object

Returns the value of attribute business_id.



39
40
41
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 39

def business_id
  @business_id
end

#client_id ⇒ Object

Returns the value of attribute client_id.



19
20
21
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 19

def client_id
  @client_id
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



17
18
19
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 17

def currency_code
  @currency_code
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



31
32
33
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 31

def currency_conversion
  @currency_conversion
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



43
44
45
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 43

def customer_id
  @customer_id
end

#end_date ⇒ Object

Returns the value of attribute end_date.



27
28
29
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 27

def end_date
  @end_date
end

#future_due_periods ⇒ Object

Returns the value of attribute future_due_periods.



35
36
37
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 35

def future_due_periods
  @future_due_periods
end

#history_frequency_interval ⇒ Object

Returns the value of attribute history_frequency_interval.



29
30
31
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 29

def history_frequency_interval
  @history_frequency_interval
end

#invoice_ids ⇒ Object

Returns the value of attribute invoice_ids.



41
42
43
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 41

def invoice_ids
  @invoice_ids
end

#overdue_periods ⇒ Object

Returns the value of attribute overdue_periods.



37
38
39
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 37

def overdue_periods
  @overdue_periods
end

#response_limit ⇒ Object

Returns the value of attribute response_limit.



25
26
27
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 25

def response_limit
  @response_limit
end

#show_history ⇒ Object

Returns the value of attribute show_history.



21
22
23
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 21

def show_history
  @show_history
end

#show_outstanding_invoices ⇒ Object

Returns the value of attribute show_outstanding_invoices.



23
24
25
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 23

def show_outstanding_invoices
  @show_outstanding_invoices
end

#start_date ⇒ Object

Returns the value of attribute start_date.



33
34
35
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 33

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 68

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'show_history' => :'show_history',
    :'show_outstanding_invoices' => :'show_outstanding_invoices',
    :'response_limit' => :'response_limit',
    :'end_date' => :'end_date',
    :'history_frequency_interval' => :'history_frequency_interval',
    :'currency_conversion' => :'currency_conversion',
    :'start_date' => :'start_date',
    :'future_due_periods' => :'future_due_periods',
    :'overdue_periods' => :'overdue_periods',
    :'business_id' => :'business_id',
    :'invoice_ids' => :'invoice_ids',
    :'customer_id' => :'customer_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 88

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'show_history' => :'BOOLEAN',
    :'show_outstanding_invoices' => :'BOOLEAN',
    :'response_limit' => :'Integer',
    :'end_date' => :'Date',
    :'history_frequency_interval' => :'String',
    :'currency_conversion' => :'String',
    :'start_date' => :'Date',
    :'future_due_periods' => :'Array<Periods>',
    :'overdue_periods' => :'Array<Periods>',
    :'business_id' => :'String',
    :'invoice_ids' => :'Array<String>',
    :'customer_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      show_history == o.show_history &&
      show_outstanding_invoices == o.show_outstanding_invoices &&
      response_limit == o.response_limit &&
      end_date == o.end_date &&
      history_frequency_interval == o.history_frequency_interval &&
      currency_conversion == o.currency_conversion &&
      start_date == o.start_date &&
      future_due_periods == o.future_due_periods &&
      overdue_periods == o.overdue_periods &&
      business_id == o.business_id &&
      invoice_ids == o.invoice_ids &&
      customer_id == o.customer_id
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 282

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 346

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 262

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


249
250
251
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 255

def hash
  [currency_code, client_id, show_history, show_outstanding_invoices, response_limit, end_date, history_frequency_interval, currency_conversion, start_date, future_due_periods, overdue_periods, business_id, invoice_ids, customer_id].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



188
189
190
191
192
193
194
195
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 188

def list_invalid_properties
  invalid_properties = Array.new
  if !@response_limit.nil? && @response_limit < 1
    invalid_properties.push('invalid value for "response_limit", must be greater than or equal to 1.')
  end

  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



327
328
329
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 327

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



333
334
335
336
337
338
339
340
341
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 333

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 String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



321
322
323
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 321

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



199
200
201
202
203
204
 
# File 'lib/proton_api/models/business_invoice_analysis_request.rb', line 199

def valid?
  return false if !@response_limit.nil? && @response_limit < 1
  history_frequency_interval_validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year'])
  return false unless history_frequency_interval_validator.valid?(@history_frequency_interval)
  true
end