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



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
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 106

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_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.



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

def active
  @active
end

#allow_process_linked_accounts ⇒ Object

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



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

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



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

def cancel_auto_order
  @cancel_auto_order
end

#current_service_plan ⇒ Object

The current service plan that the account is on.



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

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



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

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.



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

def 
  @managed_by_linked_account_merchant_id
end

#merchant_id ⇒ Object

UltraCart merchant ID



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

def merchant_id
  @merchant_id
end

#notify_emails ⇒ Object

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



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

def notify_emails
  @notify_emails
end

#notify_rejections ⇒ Object

If true, email addresses are notified of rejections.



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

def notify_rejections
  @notify_rejections
end

#notify_successes ⇒ Object

If true, email addresses are notified of successful charges.



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

def notify_successes
  @notify_successes
end

#process_linked_accounts ⇒ Object

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



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

def process_linked_accounts
  @process_linked_accounts
end

#processing_percentage ⇒ Object

The percentage rate charged for the service.



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

def processing_percentage
  @processing_percentage
end

#reject_at_end ⇒ Object

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



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

def reject_at_end
  @reject_at_end
end

#trial_mode ⇒ Object

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



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

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.



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

def trial_mode_expiration_dts
  @trial_mode_expiration_dts
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 63

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',
    :'trial_mode' => :'trial_mode',
    :'trial_mode_expiration_dts' => :'trial_mode_expiration_dts'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_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',
    :'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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 192

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 248

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 314

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



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

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


214
215
216
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 220

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



179
180
181
182
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 179

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



294
295
296
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 300

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



288
289
290
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 288

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



186
187
188
 
# File 'lib/ultracart_api/models/accounts_receivable_retry_config.rb', line 186

def valid?
  true
end