Class: CyberSource::CreateReportSubscriptionRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateReportSubscriptionRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 110

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?(:'reportInterval')
    self.report_interval = attributes[:'reportInterval']
  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?(:'groupName')
    self.group_name = attributes[:'groupName']
  end
end

Instance Attribute Details

#group_name ⇒ Object

Valid GroupName



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

def group_name
  @group_name
end

#organization_id ⇒ Object

Valid CyberSource organizationId



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

def organization_id
  @organization_id
end

#report_definition_name ⇒ Object

Valid Report Definition Name



20
21
22
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 20

def report_definition_name
  @report_definition_name
end

#report_fields ⇒ Object

Returns the value of attribute report_fields.



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

def report_fields
  @report_fields
end

#report_filters ⇒ Object

List of filters to apply



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

def report_filters
  @report_filters
end

#report_frequency ⇒ Object

‘The frequency for which subscription is created.’ **NOTE: Do not document USER_DEFINED Frequency field in developer center** Valid Values: - ‘DAILY’ - ‘WEEKLY’ - ‘MONTHLY’ - ‘USER_DEFINED’



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

def report_frequency
  @report_frequency
end

#report_interval ⇒ Object

If the reportFrequency is User-defined, reportInterval should be in **ISO 8601 time format** Please refer the following link to know more about ISO 8601 format.[Rfc Time Format](en.wikipedia.org/wiki/ISO_8601#Durations) **Example time format for 2 hours and 30 Mins:** - PT2H30M **NOTE: Do not document reportInterval field in developer center**



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

def report_interval
  @report_interval
end

#report_mime_type ⇒ Object

Valid values: - application/xml - text/csv



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

def report_mime_type
  @report_mime_type
end

#report_name ⇒ Object

Returns the value of attribute report_name.



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

def report_name
  @report_name
end

#report_preferences ⇒ Object

Returns the value of attribute report_preferences.



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

def report_preferences
  @report_preferences
end

#start_day ⇒ Object

This is the start day if the frequency is WEEKLY or MONTHLY. The value varies from 1-7 for WEEKLY and 1-31 for MONTHLY. For WEEKLY 1 means Sunday and 7 means Saturday. By default the value is 1.



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

def start_day
  @start_day
end

#start_time ⇒ Object

The hour at which the report generation should start. It should be in hhmm format.



38
39
40
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 38

def start_time
  @start_time
end

#timezone ⇒ Object

Returns the value of attribute timezone.



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

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 52

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

.json_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 71

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_frequency' => :'report_frequency',
    :'report_interval' => :'report_interval',
    :'report_name' => :'report_name',
    :'timezone' => :'timezone',
    :'start_time' => :'start_time',
    :'start_day' => :'start_day',
    :'report_filters' => :'report_filters',
    :'report_preferences' => :'report_preferences',
    :'group_name' => :'group_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 90

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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_interval == o.report_interval &&
      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 &&
      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



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/create_report_subscription_request.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/create_report_subscription_request.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/create_report_subscription_request.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("#{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


332
333
334
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.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/create_report_subscription_request.rb', line 338

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



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 175

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?
    invalid_properties.push('invalid value for "report_definition_name", report_definition_name cannot be nil.')
  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_mime_type.nil?
    invalid_properties.push('invalid value for "report_mime_type", report_mime_type cannot be nil.')
  end

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

  #if !@report_interval.nil? && @report_interval !~ Regexp.new(/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/)
    #invalid_properties.push('invalid value for "report_interval", must conform to the pattern /^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/.')
  #end

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

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

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

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cybersource_rest_client/models/create_report_subscription_request.rb', line 230

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 !~ Regexp.new(/[a-zA-Z0-9-]+/)
  return false if @report_fields.nil?
  return false if @report_mime_type.nil?
  return false if @report_frequency.nil?
  #return false if !@report_interval.nil? && @report_interval !~ Regexp.new(/^PT((([1-9]|1[0-9]|2[0-3])H(([1-9]|[1-4][0-9]|5[0-9])M)?)|((([1-9]|1[0-9]|2[0-3])H)?([1-9]|[1-4][0-9]|5[0-9])M))$/)
  return false if @report_name.nil?
  #return false if @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/)
  return false if @timezone.nil?
  return false if @start_time.nil?
  #return false if !@group_name.nil? && @group_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/)
  true
end