Class: SyncteraRubySdk::SpendControl

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/spend_control.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpendControl

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action_case ⇒ Object

If set, create a case for transactions that do not conform to the spend control



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 19

def action_case
  @action_case
end

#action_decline ⇒ Object

If set, decline transactions that do not conform to the spend control



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 22

def action_decline
  @action_decline
end

#amount_limit ⇒ Object

Monetary limit for the spend control in the smallest currency unit (eg cents)



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 25

def amount_limit
  @amount_limit
end

#creation_time ⇒ Object

The timestamp representing when the spend control was created



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 28

def creation_time
  @creation_time
end

#direction ⇒ Object

Returns the value of attribute direction.



30
31
32
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 30

def direction
  @direction
end

#id ⇒ Object

Spend Control ID



33
34
35
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 33

def id
  @id
end

#is_active ⇒ Object

Indicates if spend control is active



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 36

def is_active
  @is_active
end

#last_modified_time ⇒ Object

The timestamp representing when the spend control was last modified



39
40
41
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 39

def last_modified_time
  @last_modified_time
end

#merchant_category_codes ⇒ Object

merchant category codes for spend control



42
43
44
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 42

def merchant_category_codes
  @merchant_category_codes
end

#name ⇒ Object

Name assigned to spend control



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 45

def name
  @name
end

#payment_types ⇒ Object

A list of payment types to which a spend control will apply, if set. If not set or the array is empty, then the spend control will apply to all types of payments.



48
49
50
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 48

def payment_types
  @payment_types
end

#time_range ⇒ Object

Returns the value of attribute time_range.



50
51
52
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 50

def time_range
  @time_range
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 75

def self.attribute_map
  {
    :'action_case' => :'action_case',
    :'action_decline' => :'action_decline',
    :'amount_limit' => :'amount_limit',
    :'creation_time' => :'creation_time',
    :'direction' => :'direction',
    :'id' => :'id',
    :'is_active' => :'is_active',
    :'last_modified_time' => :'last_modified_time',
    :'merchant_category_codes' => :'merchant_category_codes',
    :'name' => :'name',
    :'payment_types' => :'payment_types',
    :'time_range' => :'time_range'
  }
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



300
301
302
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 300

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 98

def self.openapi_types
  {
    :'action_case' => :'Boolean',
    :'action_decline' => :'Boolean',
    :'amount_limit' => :'Integer',
    :'creation_time' => :'Time',
    :'direction' => :'SpendControlDirection',
    :'id' => :'String',
    :'is_active' => :'Boolean',
    :'last_modified_time' => :'Time',
    :'merchant_category_codes' => :'Array<String>',
    :'name' => :'String',
    :'payment_types' => :'Array<PaymentType>',
    :'time_range' => :'SpendControlTimeRange'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 268

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action_case == o.action_case &&
      action_decline == o.action_decline &&
      amount_limit == o.amount_limit &&
      creation_time == o.creation_time &&
      direction == o.direction &&
      id == o.id &&
      is_active == o.is_active &&
      last_modified_time == o.last_modified_time &&
      merchant_category_codes == o.merchant_category_codes &&
      name == o.name &&
      payment_types == o.payment_types &&
      time_range == o.time_range
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 331

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 402

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 307

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 293

def hash
  [action_case, action_decline, amount_limit, creation_time, direction, id, is_active, last_modified_time, merchant_category_codes, name, payment_types, time_range].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



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
221
222
223
224
225
226
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 191

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

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

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

  if @amount_limit < 0
    invalid_properties.push('invalid value for "amount_limit", must be greater than or equal to 0.')
  end

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

  if !@merchant_category_codes.nil? && @merchant_category_codes.length > 10
    invalid_properties.push('invalid value for "merchant_category_codes", number of items must be less than or equal to 10.')
  end

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

  if @time_range.nil?
    invalid_properties.push('invalid value for "time_range", time_range cannot be nil.')
  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



378
379
380
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 378

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 384

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



372
373
374
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 372

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



230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/synctera_ruby_sdk/models/spend_control.rb', line 230

def valid?
  return false if @action_case.nil?
  return false if @action_decline.nil?
  return false if @amount_limit.nil?
  return false if @amount_limit < 0
  return false if @is_active.nil?
  return false if !@merchant_category_codes.nil? && @merchant_category_codes.length > 10
  return false if @name.nil?
  return false if @time_range.nil?
  true
end