Class: PostfinancecheckoutRubySdk::DunningFlowLevel

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DunningFlowLevel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
206
207
208
209
210
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 141

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::DunningFlowLevel` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::DunningFlowLevel`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#document_text ⇒ Object

This text is put in the reminder document of this dunning flow level.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 51

def document_text
  @document_text
end

#flow ⇒ Object

Returns the value of attribute flow.



61
62
63
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 61

def flow
  @flow
end

#id ⇒ Object

A unique identifier for the object.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 57

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 48

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The dunning flow level name is used internally to identify the dunning flow level. For example the name is used within search fields and hence it should be distinct and descriptive.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 54

def name
  @name
end

#period ⇒ Object

The duration of the level before switching to the next one.



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 29

def period
  @period
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



32
33
34
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 32

def planned_purge_date
  @planned_purge_date
end

#priority ⇒ Object

The priority indicates the sort order of the level. A low value indicates that the level is executed before any level with a higher value. Any change to this value affects future level selections. The value has to pe unique per dunning flow.



37
38
39
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 37

def priority
  @priority
end

#processor ⇒ Object

Returns the value of attribute processor.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 42

def processor
  @processor
end

#reminder_template ⇒ Object

Returns the value of attribute reminder_template.



34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 34

def reminder_template
  @reminder_template
end

#state ⇒ Object

Returns the value of attribute state.



59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 59

def state
  @state
end

#title ⇒ Object

The title is used to communicate the dunning level to the customer within the reminder.



40
41
42
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 40

def title
  @title
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 45

def version
  @version
end

Class Method Details

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 305

def self._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 = PostfinancecheckoutRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



105
106
107
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 105

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 110

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 86

def self.attribute_map
  {
    :'period' => :'period',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'reminder_template' => :'reminderTemplate',
    :'priority' => :'priority',
    :'title' => :'title',
    :'processor' => :'processor',
    :'version' => :'version',
    :'linked_space_id' => :'linkedSpaceId',
    :'document_text' => :'documentText',
    :'name' => :'name',
    :'id' => :'id',
    :'state' => :'state',
    :'flow' => :'flow'
  }
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 281

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 115

def self.openapi_types
  {
    :'period' => :'String',
    :'planned_purge_date' => :'Time',
    :'reminder_template' => :'DocumentTemplate',
    :'priority' => :'Integer',
    :'title' => :'Hash<String, String>',
    :'processor' => :'Integer',
    :'version' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'document_text' => :'Hash<String, String>',
    :'name' => :'String',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'flow' => :'DunningFlow'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period == o.period &&
      planned_purge_date == o.planned_purge_date &&
      reminder_template == o.reminder_template &&
      priority == o.priority &&
      title == o.title &&
      processor == o.processor &&
      version == o.version &&
      linked_space_id == o.linked_space_id &&
      document_text == o.document_text &&
      name == o.name &&
      id == o.id &&
      state == o.state &&
      flow == o.flow
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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 376

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 274

def hash
  [period, planned_purge_date, reminder_template, priority, title, processor, version, linked_space_id, document_text, name, id, state, flow].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



214
215
216
217
218
219
220
221
222
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 214

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  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



352
353
354
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 358

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



346
347
348
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 346

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



226
227
228
229
230
 
# File 'lib/postfinancecheckout-ruby-sdk/models/dunning_flow_level.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 100
  true
end