Class: CyberSource::RequestBody

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 101

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?(:'reportFrequency')
    self.report_frequency = attributes[:'reportFrequency']
  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?(:'startTime')
    self.start_time = attributes[:'startTime']
  end

  if attributes.has_key?(:'startDay')
    self.start_day = attributes[:'startDay']
  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?(:'selectedMerchantGroupName')
    self.selected_merchant_group_name = attributes[:'selectedMerchantGroupName']
  end
end

Instance Attribute Details

#organization_id ⇒ Object

Returns the value of attribute organization_id.



17
18
19
 
# File 'lib/cybersource_rest_client/models/request_body.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/request_body.rb', line 19

def report_definition_name
  @report_definition_name
end

#report_fields ⇒ Object

Returns the value of attribute report_fields.



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

def report_fields
  @report_fields
end

#report_filters ⇒ Object

Returns the value of attribute report_filters.



35
36
37
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 35

def report_filters
  @report_filters
end

#report_frequency ⇒ Object

Returns the value of attribute report_frequency.



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

def report_frequency
  @report_frequency
end

#report_mime_type ⇒ Object

Returns the value of attribute report_mime_type.



23
24
25
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 23

def report_mime_type
  @report_mime_type
end

#report_name ⇒ Object

Returns the value of attribute report_name.



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

def report_name
  @report_name
end

#report_preferences ⇒ Object

Returns the value of attribute report_preferences.



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

def report_preferences
  @report_preferences
end

#selected_merchant_group_name ⇒ Object

Returns the value of attribute selected_merchant_group_name.



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

def selected_merchant_group_name
  @selected_merchant_group_name
end

#start_day ⇒ Object

Returns the value of attribute start_day.



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

def start_day
  @start_day
end

#start_time ⇒ Object

Returns the value of attribute start_time.



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

def start_time
  @start_time
end

#timezone ⇒ Object

Returns the value of attribute timezone.



29
30
31
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 29

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'organization_id' => :'organizationId',
    :'report_definition_name' => :'reportDefinitionName',
    :'report_fields' => :'reportFields',
    :'report_mime_type' => :'reportMimeType',
    :'report_frequency' => :'reportFrequency',
    :'report_name' => :'reportName',
    :'timezone' => :'timezone',
    :'start_time' => :'startTime',
    :'start_day' => :'startDay',
    :'report_filters' => :'reportFilters',
    :'report_preferences' => :'reportPreferences',
    :'selected_merchant_group_name' => :'selectedMerchantGroupName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'organization_id' => :'String',
    :'report_definition_name' => :'String',
    :'report_fields' => :'Array<String>',
    :'report_mime_type' => :'String',
    :'report_frequency' => :'String',
    :'report_name' => :'String',
    :'timezone' => :'String',
    :'start_time' => :'DateTime',
    :'start_day' => :'Integer',
    :'report_filters' => :'Hash<String, Array<String>>',
    :'report_preferences' => :'ReportingV3ReportSubscriptionsGet200ResponseReportPreferences',
    :'selected_merchant_group_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 313

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_frequency == o.report_frequency &&
      report_name == o.report_name &&
      timezone == o.timezone &&
      start_time == o.start_time &&
      start_day == o.start_day &&
      report_filters == o.report_filters &&
      report_preferences == o.report_preferences &&
      selected_merchant_group_name == o.selected_merchant_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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 366

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 432

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



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

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


332
333
334
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 338

def hash
  [organization_id, report_definition_name, report_fields, report_mime_type, report_frequency, report_name, timezone, start_time, start_day, report_filters, report_preferences, selected_merchant_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



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 162

def list_invalid_properties
  invalid_properties = Array.new
  if @report_definition_name.nil?
    invalid_properties.push('invalid value for "report_definition_name", report_definition_name cannot be nil.')
  end

  if @report_definition_name.to_s.length > 80
    invalid_properties.push('invalid value for "report_definition_name", the character length must be smaller than or equal to 80.')
  end

  if @report_definition_name.to_s.length < 1
    invalid_properties.push('invalid value for "report_definition_name", the character length must be great than or equal to 1.')
  end

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

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

  if @report_name.to_s.length > 128
    invalid_properties.push('invalid value for "report_name", the character length must be smaller than or equal to 128.')
  end

  if @report_name.to_s.length < 1
    invalid_properties.push('invalid value for "report_name", the character length must be great than or equal to 1.')
  end

  if !@start_day.nil? && @start_day > 7
    invalid_properties.push('invalid value for "start_day", must be smaller than or equal to 7.')
  end

  if !@start_day.nil? && @start_day < 1
    invalid_properties.push('invalid value for "start_day", must be greater than or equal to 1.')
  end

  if !@selected_merchant_group_name.nil? && @selected_merchant_group_name !~ Regexp.new(/[0-9]*/)
    invalid_properties.push('invalid value for "selected_merchant_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



412
413
414
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 412

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



418
419
420
421
422
423
424
425
426
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 418

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



406
407
408
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 406

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/cybersource_rest_client/models/request_body.rb', line 213

def valid?
  # return false if !@organization_id.nil? && @organization_id !~ Regexp.new(/[a-zA-Z0-9-_]+/)
  return false if @report_definition_name.nil?
  return false if @report_definition_name.to_s.length > 80
  return false if @report_definition_name.to_s.length < 1
  return false if @report_definition_name !~ Regexp.new(/[a-zA-Z0-9-]+/)
  return false if @report_fields.nil?
  report_mime_type_validator = EnumAttributeValidator.new('String', ['application/xml', 'text/csv'])
  return false unless report_mime_type_validator.valid?(@report_mime_type)
  return false if @report_name.nil?
  return false if @report_name.to_s.length > 128
  return false if @report_name.to_s.length < 1
  return false if !@start_day.nil? && @start_day > 7
  return false if !@start_day.nil? && @start_day < 1
  return false if !@selected_merchant_group_name.nil? && @selected_merchant_group_name !~ Regexp.new(/[0-9]*/)
  true
end