Class: VoucherifySdk::VoucherTransactionsExport

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

Overview

This is an object representing an export. Using this endpoint, you can export voucher transactions as a CSV file. This functionality works asynchronously and comes down to the following steps: create an export object and return its id so you can track its status, trigger a CSV file generation, change the status to SCHEDULED when the generation is over, store the file in S3 and change the status to DONE. Now you can download it. With parameters you can select which fields will be exported. An export request will almost always result in a single file being generated by the system. However, when your volume of data is large, the system may split the results into multiple chunks.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoucherTransactionsExport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 111

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  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']
  else
    self.created_at = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#channel ⇒ Object

The channel through which the export was triggered.



32
33
34
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.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/voucher_transactions_export.rb', line 26

def created_at
  @created_at
end

#exported_object ⇒ Object

The type of exported object.



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

def exported_object
  @exported_object
end

#id ⇒ Object

Unique export ID.



20
21
22
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.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/voucher_transactions_export.rb', line 23

def object
  @object
end

#parameters ⇒ Object

Returns the value of attribute parameters.



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

def parameters
  @parameters
end

#result ⇒ Object

Returns the value of attribute result.



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

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/voucher_transactions_export.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`.



42
43
44
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 42

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 320

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



82
83
84
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 296

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



102
103
104
105
106
107
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 102

def self.openapi_nullable
  Set.new([
    :'result',
    :'user_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 267

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 &&
      exported_object == o.exported_object &&
      parameters == o.parameters &&
      result == o.result &&
      user_id == o.user_id
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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 391

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


283
284
285
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 289

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



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
211
212
213
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 181

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @channel.nil?
    invalid_properties.push('invalid value for "channel", channel cannot be nil.')
  end

  if @exported_object.nil?
    invalid_properties.push('invalid value for "exported_object", exported_object cannot be nil.')
  end

  if @parameters.nil?
    invalid_properties.push('invalid value for "parameters", parameters cannot be nil.')
  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



367
368
369
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 373

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



361
362
363
 
# File 'lib/VoucherifySdk/models/voucher_transactions_export.rb', line 361

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["export"])
  return false unless object_validator.valid?(@object)
  return false if @created_at.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["SCHEDULED"])
  return false unless status_validator.valid?(@status)
  return false if @channel.nil?
  return false if @exported_object.nil?
  exported_object_validator = EnumAttributeValidator.new('String', ["voucher_transactions"])
  return false unless exported_object_validator.valid?(@exported_object)
  return false if @parameters.nil?
  true
end