Class: WalleeRubySdk::DunningFlow

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DunningFlow

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
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 123

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#conditions ⇒ Object

If a dunning flow meets all selected conditions, the dunning flow will be used to process the dunning case. If the conditions are not met the next dunning flow in line will be chosen according to the priorities.



43
44
45
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 43

def conditions
  @conditions
end

#id ⇒ Object

A unique identifier for the object.



38
39
40
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 38

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

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



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

def name
  @name
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.



35
36
37
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 35

def planned_purge_date
  @planned_purge_date
end

#priority ⇒ Object

The priority orders the dunning flows. As such the priority determines together with the conditions the dunning flow the selection mechanism for a particular invoice. A change of the priority affects all future selections.



46
47
48
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 46

def priority
  @priority
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#version ⇒ Object

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



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

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



246
247
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
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 246

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



91
92
93
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 96

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 76

def self.attribute_map
  {
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'id' => :'id',
    :'state' => :'state',
    :'conditions' => :'conditions',
    :'priority' => :'priority',
    :'type' => :'type',
    :'version' => :'version'
  }
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 222

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



116
117
118
119
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 101

def self.openapi_types
  {
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'planned_purge_date' => :'Time',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'conditions' => :'Array<Integer>',
    :'priority' => :'Integer',
    :'type' => :'DunningFlowType',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      planned_purge_date == o.planned_purge_date &&
      id == o.id &&
      state == o.state &&
      conditions == o.conditions &&
      priority == o.priority &&
      type == o.type &&
      version == o.version
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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 317

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


209
210
211
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



215
216
217
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 215

def hash
  [linked_space_id, name, planned_purge_date, id, state, conditions, priority, type, version].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



178
179
180
181
182
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 178

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



293
294
295
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 299

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



287
288
289
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 287

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
189
 
# File 'lib/wallee-ruby-sdk/models/dunning_flow.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end