Class: CyberSource::ReportingV3ReportsGet200ResponseReports

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb

Overview

Report Search Result Bean

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportingV3ReportsGet200ResponseReports

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 129

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'reportDefinitionId')
    self.report_definition_id = attributes[:'reportDefinitionId']
  end

  if attributes.has_key?(:'reportName')
    self.report_name = attributes[:'reportName']
  end

  if attributes.has_key?(:'reportMimeType')
    self.report_mime_type = attributes[:'reportMimeType']
  end

  if attributes.has_key?(:'reportFrequency')
    self.report_frequency = attributes[:'reportFrequency']
  end

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

  if attributes.has_key?(:'reportStartTime')
    self.report_start_time = attributes[:'reportStartTime']
  end

  if attributes.has_key?(:'reportEndTime')
    self.report_end_time = attributes[:'reportEndTime']
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'reportId')
    self.report_id = attributes[:'reportId']
  end

  if attributes.has_key?(:'organizationId')
    self.organization_id = attributes[:'organizationId']
  end

  if attributes.has_key?(:'queuedTime')
    self.queued_time = attributes[:'queuedTime']
  end

  if attributes.has_key?(:'reportGeneratingTime')
    self.report_generating_time = attributes[:'reportGeneratingTime']
  end

  if attributes.has_key?(:'reportCompletedTime')
    self.report_completed_time = attributes[:'reportCompletedTime']
  end

  if attributes.has_key?(:'subscriptionType')
    self.subscription_type = attributes[:'subscriptionType']
  end

  if attributes.has_key?(:'groupId')
    self.group_id = attributes[:'groupId']
  end
end

Instance Attribute Details

#group_id ⇒ Object

Id for selected group.



61
62
63
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 61

def group_id
  @group_id
end

#organization_id ⇒ Object

CyberSource Merchant Id



46
47
48
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 46

def organization_id
  @organization_id
end

#queued_time ⇒ Object

Specifies the time of the report in queued in ISO 8601 format



49
50
51
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 49

def queued_time
  @queued_time
end

#report_completed_time ⇒ Object

Specifies the time of the report completed the generation in ISO 8601 format



55
56
57
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 55

def report_completed_time
  @report_completed_time
end

#report_definition_id ⇒ Object

Unique Report Identifier of each report type



19
20
21
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 19

def report_definition_id
  @report_definition_id
end

#report_end_time ⇒ Object

Specifies the report end time in ISO 8601 format



37
38
39
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 37

def report_end_time
  @report_end_time
end

#report_frequency ⇒ Object

Frequency of the report to get generated



28
29
30
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 28

def report_frequency
  @report_frequency
end

#report_generating_time ⇒ Object

Specifies the time of the report started to generate in ISO 8601 format



52
53
54
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 52

def report_generating_time
  @report_generating_time
end

#report_id ⇒ Object

Unique identifier generated for every reports



43
44
45
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 43

def report_id
  @report_id
end

#report_mime_type ⇒ Object

Format of the report to get generated



25
26
27
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 25

def report_mime_type
  @report_mime_type
end

#report_name ⇒ Object

Name of the report specified by merchant while creating the report



22
23
24
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 22

def report_name
  @report_name
end

#report_start_time ⇒ Object

Specifies the report start time in ISO 8601 format



34
35
36
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 34

def report_start_time
  @report_start_time
end

#status ⇒ Object

Status of the report



31
32
33
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 31

def status
  @status
end

#subscription_type ⇒ Object

Specifies whether the subscription created is either Custom, Standard or Classic



58
59
60
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 58

def subscription_type
  @subscription_type
end

#timezone ⇒ Object

Time Zone



40
41
42
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 40

def timezone
  @timezone
end

Class Method Details

.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
103
104
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 86

def self.attribute_map
  {
    :'report_definition_id' => :'reportDefinitionId',
    :'report_name' => :'reportName',
    :'report_mime_type' => :'reportMimeType',
    :'report_frequency' => :'reportFrequency',
    :'status' => :'status',
    :'report_start_time' => :'reportStartTime',
    :'report_end_time' => :'reportEndTime',
    :'timezone' => :'timezone',
    :'report_id' => :'reportId',
    :'organization_id' => :'organizationId',
    :'queued_time' => :'queuedTime',
    :'report_generating_time' => :'reportGeneratingTime',
    :'report_completed_time' => :'reportCompletedTime',
    :'subscription_type' => :'subscriptionType',
    :'group_id' => :'groupId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 107

def self.swagger_types
  {
    :'report_definition_id' => :'String',
    :'report_name' => :'String',
    :'report_mime_type' => :'String',
    :'report_frequency' => :'String',
    :'status' => :'String',
    :'report_start_time' => :'DateTime',
    :'report_end_time' => :'DateTime',
    :'timezone' => :'String',
    :'report_id' => :'String',
    :'organization_id' => :'String',
    :'queued_time' => :'DateTime',
    :'report_generating_time' => :'DateTime',
    :'report_completed_time' => :'DateTime',
    :'subscription_type' => :'String',
    :'group_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      report_definition_id == o.report_definition_id &&
      report_name == o.report_name &&
      report_mime_type == o.report_mime_type &&
      report_frequency == o.report_frequency &&
      status == o.status &&
      report_start_time == o.report_start_time &&
      report_end_time == o.report_end_time &&
      timezone == o.timezone &&
      report_id == o.report_id &&
      organization_id == o.organization_id &&
      queued_time == o.queued_time &&
      report_generating_time == o.report_generating_time &&
      report_completed_time == o.report_completed_time &&
      subscription_type == o.subscription_type &&
      group_id == o.group_id
end

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



303
304
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
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 303

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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

    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 369

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

#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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 282

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute

      # is documented as an array but the input is not

      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional

  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 275

def hash
  [report_definition_id, report_name, report_mime_type, report_frequency, status, report_start_time, report_end_time, timezone, report_id, organization_id, queued_time, report_generating_time, report_completed_time, subscription_type, group_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



198
199
200
201
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 198

def list_invalid_properties
  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



349
350
351
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 349

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



355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 355

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



343
344
345
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 343

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



205
206
207
208
209
210
211
212
213
 
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_reports.rb', line 205

def valid?
  report_mime_type_validator = EnumAttributeValidator.new('String', ['application/xml', 'text/csv'])
  return false unless report_mime_type_validator.valid?(@report_mime_type)
  report_frequency_validator = EnumAttributeValidator.new('String', ['DAILY', 'WEEKLY', 'MONTHLY', 'ADHOC'])
  return false unless report_frequency_validator.valid?(@report_frequency)
  status_validator = EnumAttributeValidator.new('String', ['COMPLETED', 'PENDING', 'QUEUED', 'RUNNING', 'ERROR', 'NO_DATA'])
  return false unless status_validator.valid?(@status)
  true
end