Class: CyberSource::PredefinedSubscriptionRequestBean

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PredefinedSubscriptionRequestBean

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 80

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

  if attributes.has_key?(:'subscriptionType')
    self.subscription_type = attributes[:'subscriptionType']
  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?(:'reportInterval')
    self.report_interval = attributes[:'reportInterval']
  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?(:'subscriptionStatus')
    self.subscription_status = attributes[:'subscriptionStatus']
  end
end

Instance Attribute Details

#report_definition_name ⇒ Object

Valid Report Definition Name



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

def report_definition_name
  @report_definition_name
end

#report_frequency ⇒ Object

‘The frequency for which subscription is created. For Standard we can have DAILY, WEEKLY and MONTHLY. But for Classic we will have only DAILY.’ **NOTE: Do not document USER_DEFINED Frequency field in developer center** Valid Values: - ‘DAILY’ - ‘WEEKLY’ - ‘MONTHLY’ - ‘USER_DEFINED’



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

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**



32
33
34
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 32

def report_interval
  @report_interval
end

#report_mime_type ⇒ Object

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



26
27
28
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 26

def report_mime_type
  @report_mime_type
end

#report_name ⇒ Object

Returns the value of attribute report_name.



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

def report_name
  @report_name
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/predefined_subscription_request_bean.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. By Default it will be 0000. The format is 24 hours format.



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

def start_time
  @start_time
end

#subscription_status ⇒ Object

The status for subscription which is either created or updated. By default it is ACTIVE. Valid Values: - ACTIVE - INACTIVE



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

def subscription_status
  @subscription_status
end

#subscription_type ⇒ Object

The subscription type for which report definition is required. Valid values are CLASSIC and STANDARD. Valid Values: - CLASSIC - STANDARD



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

def subscription_type
  @subscription_type
end

#timezone ⇒ Object

By Default the timezone for Standard subscription is PST. And for Classic subscription it will be GMT. If user provides any other time zone apart from PST for Standard subscription api should error out.



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

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
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 47

def self.attribute_map
  {
    :'report_definition_name' => :'reportDefinitionName',
    :'subscription_type' => :'subscriptionType',
    :'report_name' => :'reportName',
    :'report_mime_type' => :'reportMimeType',
    :'report_frequency' => :'reportFrequency',
    :'report_interval' => :'reportInterval',
    :'timezone' => :'timezone',
    :'start_time' => :'startTime',
    :'start_day' => :'startDay',
    :'subscription_status' => :'subscriptionStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'report_definition_name' => :'String',
    :'subscription_type' => :'String',
    :'report_name' => :'String',
    :'report_mime_type' => :'String',
    :'report_frequency' => :'String',
    :'report_interval' => :'String',
    :'timezone' => :'String',
    :'start_time' => :'String',
    :'start_day' => :'Integer',
    :'subscription_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      report_definition_name == o.report_definition_name &&
      subscription_type == o.subscription_type &&
      report_name == o.report_name &&
      report_mime_type == o.report_mime_type &&
      report_frequency == o.report_frequency &&
      report_interval == o.report_interval &&
      timezone == o.timezone &&
      start_time == o.start_time &&
      start_day == o.start_day &&
      subscription_status == o.subscription_status
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



276
277
278
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
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 276

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 342

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 255

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


242
243
244
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



248
249
250
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 248

def hash
  [report_definition_name, subscription_type, report_name, report_mime_type, report_frequency, report_interval, timezone, start_time, start_day, subscription_status].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



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
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 129

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 !~ Regexp.new(/[a-zA-Z]+/)
    #invalid_properties.push('invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z]+/.')
  #end

  if @subscription_type.nil?
    invalid_properties.push('invalid value for "subscription_type", subscription_type cannot be nil.')
  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 !@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 !@start_day.nil? && @start_day > 31
    invalid_properties.push('invalid value for "start_day", must be smaller than or equal to 31.')
  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

  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



322
323
324
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 322

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



328
329
330
331
332
333
334
335
336
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 328

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



316
317
318
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 316

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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb', line 164

def valid?
  return false if @report_definition_name.nil?
  #return false if @report_definition_name !~ Regexp.new(/[a-zA-Z]+/)
  return false if @subscription_type.nil?
  #return false if !@report_name.nil? && @report_name !~ Regexp.new(/[a-zA-Z0-9-_ ]+/)
  #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 !@start_day.nil? && @start_day > 31
  return false if !@start_day.nil? && @start_day < 1
  true
end