Class: CyberSource::ReportingV3ReportsIdGet200Response

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

Overview

Report Log

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportingV3ReportsIdGet200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 120

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

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

  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?(:'reportFields')
    if (value = attributes[:'reportFields']).is_a?(Array)
      self.report_fields = value
    end
  end

  if attributes.has_key?(:'reportStatus')
    self.report_status = attributes[:'reportStatus']
  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?(:'reportFilters')
    if (value = attributes[:'reportFilters']).is_a?(Hash)
      self.report_filters = value
    end
  end

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

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

Instance Attribute Details

#group_idObject

Id for selected group.



56
57
58
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 56

def group_id
  @group_id
end

#organization_idObject

CyberSource merchant id



18
19
20
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 18

def organization_id
  @organization_id
end

#report_definition_idObject

Report definition Id



24
25
26
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 24

def report_definition_id
  @report_definition_id
end

#report_end_timeObject

Report End Time Value



45
46
47
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 45

def report_end_time
  @report_end_time
end

#report_fieldsObject

List of Integer Values



36
37
38
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 36

def report_fields
  @report_fields
end

#report_filtersObject

List of filters to apply



51
52
53
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 51

def report_filters
  @report_filters
end

#report_frequencyObject

Report Frequency Value Valid values: - DAILY - WEEKLY - MONTHLY - ADHOC



33
34
35
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 33

def report_frequency
  @report_frequency
end

#report_idObject

Report ID Value



21
22
23
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 21

def report_id
  @report_id
end

#report_mime_typeObject

Report Format Valid values: - application/xml - text/csv



30
31
32
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 30

def report_mime_type
  @report_mime_type
end

#report_nameObject

Report Name



27
28
29
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 27

def report_name
  @report_name
end

#report_preferencesObject

Returns the value of attribute report_preferences.



53
54
55
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 53

def report_preferences
  @report_preferences
end

#report_start_timeObject

Report Start Time Value



42
43
44
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 42

def report_start_time
  @report_start_time
end

#report_statusObject

Report Status Value Valid values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA - RERUN



39
40
41
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 39

def report_status
  @report_status
end

#timezoneObject

Time Zone Value



48
49
50
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 48

def timezone
  @timezone
end

Class Method Details

.attribute_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 59

def self.attribute_map
  {
    :'organization_id' => :'organizationId',
    :'report_id' => :'reportId',
    :'report_definition_id' => :'reportDefinitionId',
    :'report_name' => :'reportName',
    :'report_mime_type' => :'reportMimeType',
    :'report_frequency' => :'reportFrequency',
    :'report_fields' => :'reportFields',
    :'report_status' => :'reportStatus',
    :'report_start_time' => :'reportStartTime',
    :'report_end_time' => :'reportEndTime',
    :'timezone' => :'timezone',
    :'report_filters' => :'reportFilters',
    :'report_preferences' => :'reportPreferences',
    :'group_id' => :'groupId'
  }
end

.json_mapObject

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 79

def self.json_map
  {
    :'organization_id' => :'organization_id',
    :'report_id' => :'report_id',
    :'report_definition_id' => :'report_definition_id',
    :'report_name' => :'report_name',
    :'report_mime_type' => :'report_mime_type',
    :'report_frequency' => :'report_frequency',
    :'report_fields' => :'report_fields',
    :'report_status' => :'report_status',
    :'report_start_time' => :'report_start_time',
    :'report_end_time' => :'report_end_time',
    :'timezone' => :'timezone',
    :'report_filters' => :'report_filters',
    :'report_preferences' => :'report_preferences',
    :'group_id' => :'group_id'
  }
end

.swagger_typesObject

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 99

def self.swagger_types
  {
    :'organization_id' => :'String',
    :'report_id' => :'String',
    :'report_definition_id' => :'String',
    :'report_name' => :'String',
    :'report_mime_type' => :'String',
    :'report_frequency' => :'String',
    :'report_fields' => :'Array<String>',
    :'report_status' => :'String',
    :'report_start_time' => :'DateTime',
    :'report_end_time' => :'DateTime',
    :'timezone' => :'String',
    :'report_filters' => :'Hash<String, Array<String>>',
    :'report_preferences' => :'Reportingv3reportsReportPreferences',
    :'group_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      organization_id == o.organization_id &&
      report_id == o.report_id &&
      report_definition_id == o.report_definition_id &&
      report_name == o.report_name &&
      report_mime_type == o.report_mime_type &&
      report_frequency == o.report_frequency &&
      report_fields == o.report_fields &&
      report_status == o.report_status &&
      report_start_time == o.report_start_time &&
      report_end_time == o.report_end_time &&
      timezone == o.timezone &&
      report_filters == o.report_filters &&
      report_preferences == o.report_preferences &&
      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



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
284
285
286
287
288
289
290
291
292
293
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 257

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



323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 323

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 236

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


223
224
225
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 223

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



229
230
231
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 229

def hash
  [organization_id, report_id, report_definition_id, report_name, report_mime_type, report_frequency, report_fields, report_status, report_start_time, report_end_time, timezone, report_filters, report_preferences, group_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



189
190
191
192
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



303
304
305
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 303

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 309

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



297
298
299
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 297

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



196
197
198
# File 'lib/cybersource_rest_client/models/reporting_v3_reports_id_get200_response.rb', line 196

def valid?
  true
end