Class: CyberSource::CreateAdhocReportRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAdhocReportRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 99

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

  if attributes.has_key?(:'reportFields')
    if (value = attributes[:'reportFields']).is_a?(Array)
      self.report_fields = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#group_name ⇒ Object

Specifies the group name



44
45
46
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 44

def group_name
  @group_name
end

#organization_id ⇒ Object

Valid CyberSource Organization Id



17
18
19
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 17

def organization_id
  @organization_id
end

#report_definition_name ⇒ Object

Returns the value of attribute report_definition_name.



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

def report_definition_name
  @report_definition_name
end

#report_end_time ⇒ Object

End time of the report



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

def report_end_time
  @report_end_time
end

#report_fields ⇒ Object

List of fields which needs to get included in a report



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

def report_fields
  @report_fields
end

#report_filters ⇒ Object

Returns the value of attribute report_filters.



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

def report_filters
  @report_filters
end

#report_mime_type ⇒ Object

‘Format of the report’ Valid values: - application/xml - text/csv



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

def report_mime_type
  @report_mime_type
end

#report_name ⇒ Object

Name of the report



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

def report_name
  @report_name
end

#report_preferences ⇒ Object

Returns the value of attribute report_preferences.



41
42
43
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 41

def report_preferences
  @report_preferences
end

#report_start_time ⇒ Object

Start time of the report



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

def report_start_time
  @report_start_time
end

#timezone ⇒ Object

Timezone of the report



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

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 47

def self.attribute_map
  {
    :'organization_id' => :'organizationId',
    :'report_definition_name' => :'reportDefinitionName',
    :'report_fields' => :'reportFields',
    :'report_mime_type' => :'reportMimeType',
    :'report_name' => :'reportName',
    :'timezone' => :'timezone',
    :'report_start_time' => :'reportStartTime',
    :'report_end_time' => :'reportEndTime',
    :'report_filters' => :'reportFilters',
    :'report_preferences' => :'reportPreferences',
    :'group_name' => :'groupName'
  }
end

.json_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 64

def self.json_map
  {
    :'organization_id' => :'organization_id',
    :'report_definition_name' => :'report_definition_name',
    :'report_fields' => :'report_fields',
    :'report_mime_type' => :'report_mime_type',
    :'report_name' => :'report_name',
    :'timezone' => :'timezone',
    :'report_start_time' => :'report_start_time',
    :'report_end_time' => :'report_end_time',
    :'report_filters' => :'report_filters',
    :'report_preferences' => :'report_preferences',
    :'group_name' => :'group_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'organization_id' => :'String',
    :'report_definition_name' => :'String',
    :'report_fields' => :'Array<String>',
    :'report_mime_type' => :'String',
    :'report_name' => :'String',
    :'timezone' => :'String',
    :'report_start_time' => :'DateTime',
    :'report_end_time' => :'DateTime',
    :'report_filters' => :'Reportingv3reportsReportFilters',
    :'report_preferences' => :'Reportingv3reportsReportPreferences',
    :'group_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 227

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 279

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 345

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 258

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


245
246
247
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 251

def hash
  [organization_id, report_definition_name, report_fields, report_mime_type, report_name, timezone, report_start_time, report_end_time, report_filters, report_preferences, group_name].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  #if !@organization_id.nil? && @organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/)
    #invalid_properties.push('invalid value for "organization_id", must conform to the pattern /[a-zA-Z0-9-_]+/.')
  #end

  #if !@report_definition_name.nil? && @report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/)
    #invalid_properties.push('invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z0-9-]+/.')
  #end

  #if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/)
    #invalid_properties.push('invalid value for "report_name", must conform to the pattern /[a-zA-Z0-9-_ ]+/.')
  #end

  #if !@group_name.nil? && @group_name !~ Regexp.new(/[0-9]*/)
    #invalid_properties.push('invalid value for "group_name", must conform to the pattern /[0-9]*/.')
  #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



325
326
327
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 331

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



319
320
321
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 319

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



177
178
179
180
181
182
183
 
# File 'lib/cybersource_rest_client/models/create_adhoc_report_request.rb', line 177

def valid?
  #return false if !@organization_id.nil? && @organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/)
  #return false if !@report_definition_name.nil? && @report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/)
  #return false if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/)
  #return false if !@group_name.nil? && @group_name !~ Regexp.new(/[0-9]*/)
  true
end