Class: UltracartClient::AccountsReceivableRetryConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/accounts_receivable_retry_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountsReceivableRetryConfig

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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

True if the retry should run daily. False puts the retry service into an inactive state for this merchant.



19
20
21
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 19

def active
  @active
end

#allow_process_linked_accounts ⇒ Object

True if this account has linked accounts that it can process.



22
23
24
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 22

def allow_process_linked_accounts
  @allow_process_linked_accounts
end

#cancel_auto_order ⇒ Object

If true also cancel the auto order if the order is rejected at the end



25
26
27
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 25

def cancel_auto_order
  @cancel_auto_order
end

#current_service_plan ⇒ Object

The current service plan that the account is on.



28
29
30
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 28

def current_service_plan
  @current_service_plan
end

#daily_activity_list ⇒ Object

A list of days and what actions should take place on those days after an order reaches accounts receivable



31
32
33
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 31

def daily_activity_list
  @daily_activity_list
end

#managed_by_linked_account_merchant_id ⇒ Object

If not null, this account is managed by the specified parent merchant id.



34
35
36
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 34

def 
  @managed_by_linked_account_merchant_id
end

#merchant_id ⇒ Object

UltraCart merchant ID



37
38
39
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 37

def merchant_id
  @merchant_id
end

#notify_emails ⇒ Object

A list of email addresses to receive summary notifications from the retry service.



40
41
42
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 40

def notify_emails
  @notify_emails
end

#notify_rejections ⇒ Object

If true, email addresses are notified of rejections.



43
44
45
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 43

def notify_rejections
  @notify_rejections
end

#notify_successes ⇒ Object

If true, email addresses are notified of successful charges.



46
47
48
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 46

def notify_successes
  @notify_successes
end

#process_linked_accounts ⇒ Object

If true, all linked accounts are also processed using the same rules.



49
50
51
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 49

def process_linked_accounts
  @process_linked_accounts
end

#processing_percentage ⇒ Object

The percentage rate charged for the service.



52
53
54
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 52

def processing_percentage
  @processing_percentage
end

#reject_at_end ⇒ Object

If true, the order is rejected the day after the last configured activity day



55
56
57
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 55

def reject_at_end
  @reject_at_end
end

#transaction_rejects ⇒ Object

Array of key/value pairs that when found in the response cause the rejection of the transaction.



58
59
60
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 58

def transaction_rejects
  @transaction_rejects
end

#trial_mode ⇒ Object

True if the account is currently in trial mode. Set to false to exit trial mode.



61
62
63
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 61

def trial_mode
  @trial_mode
end

#trial_mode_expiration_dts ⇒ Object

The date when trial mode expires. If this date is reached without exiting trial mode, the service will de-activate.



64
65
66
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 64

def trial_mode_expiration_dts
  @trial_mode_expiration_dts
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'active' => :'active',
    :'allow_process_linked_accounts' => :'allow_process_linked_accounts',
    :'cancel_auto_order' => :'cancel_auto_order',
    :'current_service_plan' => :'current_service_plan',
    :'daily_activity_list' => :'daily_activity_list',
    :'managed_by_linked_account_merchant_id' => :'managed_by_linked_account_merchant_id',
    :'merchant_id' => :'merchant_id',
    :'notify_emails' => :'notify_emails',
    :'notify_rejections' => :'notify_rejections',
    :'notify_successes' => :'notify_successes',
    :'process_linked_accounts' => :'process_linked_accounts',
    :'processing_percentage' => :'processing_percentage',
    :'reject_at_end' => :'reject_at_end',
    :'transaction_rejects' => :'transaction_rejects',
    :'trial_mode' => :'trial_mode',
    :'trial_mode_expiration_dts' => :'trial_mode_expiration_dts'
  }
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



258
259
260
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 258

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/ultracart_api/models/accounts_receivable_retry_config.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 94

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'allow_process_linked_accounts' => :'Boolean',
    :'cancel_auto_order' => :'Boolean',
    :'current_service_plan' => :'String',
    :'daily_activity_list' => :'Array<AccountsReceivableRetryDayActivity>',
    :'managed_by_linked_account_merchant_id' => :'Boolean',
    :'merchant_id' => :'String',
    :'notify_emails' => :'Array<String>',
    :'notify_rejections' => :'Boolean',
    :'notify_successes' => :'Boolean',
    :'process_linked_accounts' => :'Boolean',
    :'processing_percentage' => :'String',
    :'reject_at_end' => :'Boolean',
    :'transaction_rejects' => :'Array<AccountsReceivableRetryTransactionReject>',
    :'trial_mode' => :'Boolean',
    :'trial_mode_expiration_dts' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      allow_process_linked_accounts == o.allow_process_linked_accounts &&
      cancel_auto_order == o.cancel_auto_order &&
      current_service_plan == o.current_service_plan &&
      daily_activity_list == o.daily_activity_list &&
       == o. &&
      merchant_id == o.merchant_id &&
      notify_emails == o.notify_emails &&
      notify_rejections == o.notify_rejections &&
      notify_successes == o.notify_successes &&
      process_linked_accounts == o.process_linked_accounts &&
      processing_percentage == o.processing_percentage &&
      reject_at_end == o.reject_at_end &&
      transaction_rejects == o.transaction_rejects &&
      trial_mode == o.trial_mode &&
      trial_mode_expiration_dts == o.trial_mode_expiration_dts
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



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
319
320
321
322
323
324
325
326
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 289

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 360

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 265

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


245
246
247
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 251

def hash
  [active, allow_process_linked_accounts, cancel_auto_order, current_service_plan, daily_activity_list, , merchant_id, notify_emails, notify_rejections, notify_successes, process_linked_accounts, processing_percentage, reject_at_end, transaction_rejects, trial_mode, trial_mode_expiration_dts].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



209
210
211
212
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 209

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



336
337
338
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 336

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 342

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



330
331
332
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 330

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



216
217
218
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 216

def valid?
  true
end