Class: VoucherifySdk::ExportsGetResponseBody

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

Overview

Response body schema for GET ‘v1/exports/exportId`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportsGetResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#channel ⇒ Object

The channel through which the export was triggered.



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

def channel
  @channel
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#exported_object ⇒ Object

Returns the value of attribute exported_object.



39
40
41
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 39

def exported_object
  @exported_object
end

#id ⇒ Object

Unique export ID.



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

def id
  @id
end

#object ⇒ Object

The type of object being represented. This object stores information about the export.



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

def object
  @object
end

#parameters ⇒ Object

Returns the value of attribute parameters.



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

def parameters
  @parameters
end

#result ⇒ Object

Returns the value of attribute result.



34
35
36
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 34

def result
  @result
end

#status ⇒ Object

Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.



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

def status
  @status
end

#user_id ⇒ Object

Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.



37
38
39
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 37

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



238
239
240
241
242
243
244
245
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
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 238

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



81
82
83
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'status' => :'status',
    :'channel' => :'channel',
    :'result' => :'result',
    :'user_id' => :'user_id',
    :'exported_object' => :'exported_object',
    :'parameters' => :'parameters'
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 214

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



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 101

def self.openapi_nullable
  Set.new([
    :'id',
    :'object',
    :'created_at',
    :'status',
    :'channel',
    :'result',
    :'user_id',
    :'exported_object',
    :'parameters'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'status' => :'String',
    :'channel' => :'String',
    :'result' => :'ExportsGetResponseBodyResult',
    :'user_id' => :'String',
    :'exported_object' => :'String',
    :'parameters' => :'ExportsGetResponseBodyParameters'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      created_at == o.created_at &&
      status == o.status &&
      channel == o.channel &&
      result == o.result &&
      user_id == o.user_id &&
      exported_object == o.exported_object &&
      parameters == o.parameters
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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 309

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


201
202
203
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 207

def hash
  [id, object, created_at, status, channel, result, user_id, exported_object, parameters].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



164
165
166
167
168
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 164

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



285
286
287
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 291

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



279
280
281
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 279

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



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/VoucherifySdk/models/exports_get_response_body.rb', line 172

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["export"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["SCHEDULED", "IN_PROGRESS", "DONE", "ERROR"])
  return false unless status_validator.valid?(@status)
  exported_object_validator = EnumAttributeValidator.new('String', ["voucher", "redemption", "customer", "publication", "order", "points_expiration", "voucher_transactions"])
  return false unless exported_object_validator.valid?(@exported_object)
  true
end