Class: VoucherifySdk::AsyncActionBase

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/async_action_base.rb

Overview

This is an object representing an asynchronous action.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AsyncActionBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 126

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'async_action'
  end
end

Instance Attribute Details

#created_at ⇒ Object

Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.



32
33
34
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 32

def created_at
  @created_at
end

#id ⇒ Object

Async action unique ID.



20
21
22
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 20

def id
  @id
end

#object ⇒ Object

The type of the object represented by JSON. This object stores information about the ‘async_action`.



47
48
49
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 47

def object
  @object
end

#operation_status ⇒ Object

Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown.



29
30
31
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 29

def operation_status
  @operation_status
end

#processing_time ⇒ Object

The length of time it took to process the request in milliseconds.



41
42
43
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 41

def processing_time
  @processing_time
end

#progress ⇒ Object

% progress to completion of the asynchronous action.



44
45
46
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 44

def progress
  @progress
end

#request_id ⇒ Object

Unique request ID.



38
39
40
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 38

def request_id
  @request_id
end

#status ⇒ Object

Status of the async action. Informs you whether the async action has already been completed.



26
27
28
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 26

def status
  @status
end

#type ⇒ Object

Type of async action.



23
24
25
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 23

def type
  @type
end

#updated_at ⇒ Object

Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format.



35
36
37
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 35

def updated_at
  @updated_at
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



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
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 260

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 = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'status' => :'status',
    :'operation_status' => :'operation_status',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'request_id' => :'request_id',
    :'processing_time' => :'processing_time',
    :'progress' => :'progress',
    :'object' => :'object'
  }
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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 236

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 109

def self.openapi_nullable
  Set.new([
    :'id',
    :'type',
    :'status',
    :'operation_status',
    :'created_at',
    :'updated_at',
    :'request_id',
    :'processing_time',
    :'progress',
    :'object'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'status' => :'String',
    :'operation_status' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'request_id' => :'String',
    :'processing_time' => :'Integer',
    :'progress' => :'Integer',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      status == o.status &&
      operation_status == o.operation_status &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      request_id == o.request_id &&
      processing_time == o.processing_time &&
      progress == o.progress &&
      object == o.object
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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 331

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


223
224
225
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 229

def hash
  [id, type, status, operation_status, created_at, updated_at, request_id, processing_time, progress, object].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



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@progress.nil? && @progress > 100
    invalid_properties.push('invalid value for "progress", must be smaller than or equal to 100.')
  end

  if !@progress.nil? && @progress < 0
    invalid_properties.push('invalid value for "progress", must be greater than or equal to 0.')
  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



307
308
309
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 313

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



301
302
303
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 301

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



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/VoucherifySdk/models/async_action_base.rb', line 193

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["DONE", "ENQUEUED", "FAILED", "IN_PROGRESS"])
  return false unless status_validator.valid?(@status)
  return false if !@progress.nil? && @progress > 100
  return false if !@progress.nil? && @progress < 0
  object_validator = EnumAttributeValidator.new('String', ["async_action"])
  return false unless object_validator.valid?(@object)
  true
end