Class: CyberSourceMergedSpec::Subscription1

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/subscription1.rb

Overview

Subscription Details

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(organization_id: SKIP, report_definition_id: SKIP, report_definition_name: SKIP, report_mime_type: SKIP, report_frequency: SKIP, report_interval: SKIP, report_name: SKIP, timezone: SKIP, start_time: SKIP, start_day: SKIP, report_fields: SKIP, report_filters: SKIP, report_preferences: SKIP, group_id: SKIP, additional_properties: nil) ⇒ Subscription1

Returns a new instance of Subscription1.



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
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 130

def initialize(organization_id: SKIP, report_definition_id: SKIP,
               report_definition_name: SKIP, report_mime_type: SKIP,
               report_frequency: SKIP, report_interval: SKIP,
               report_name: SKIP, timezone: SKIP, start_time: SKIP,
               start_day: SKIP, report_fields: SKIP, report_filters: SKIP,
               report_preferences: SKIP, group_id: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @organization_id = organization_id unless organization_id == SKIP
  @report_definition_id = report_definition_id unless report_definition_id == SKIP
  @report_definition_name = report_definition_name unless report_definition_name == SKIP
  @report_mime_type = report_mime_type unless report_mime_type == SKIP
  @report_frequency = report_frequency unless report_frequency == SKIP
  @report_interval = report_interval unless report_interval == SKIP
  @report_name = report_name unless report_name == SKIP
  @timezone = timezone unless timezone == SKIP
  @start_time = start_time unless start_time == SKIP
  @start_day = start_day unless start_day == SKIP
  @report_fields = report_fields unless report_fields == SKIP
  @report_filters = report_filters unless report_filters == SKIP
  @report_preferences = report_preferences unless report_preferences == SKIP
  @group_id = group_id unless group_id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#group_id ⇒ String

Id for the selected group.

Returns:

  • (String) 


83
84
85
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 83

def group_id
  @group_id
end

#organization_id ⇒ String

Selected Organization Id

Returns:

  • (String) 


15
16
17
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 15

def organization_id
  @organization_id
end

#report_definition_id ⇒ String

Report Definition Id

Returns:

  • (String) 


19
20
21
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 19

def report_definition_id
  @report_definition_id
end

#report_definition_name ⇒ String

Report Definition Class

Returns:

  • (String) 


23
24
25
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 23

def report_definition_name
  @report_definition_name
end

#report_fields ⇒ Array[String]

List of all fields String values

Returns:

  • (Array[String]) 


71
72
73
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 71

def report_fields
  @report_fields
end

#report_filters ⇒ Hash[String, Object]

List of filters to apply

Returns:

  • (Hash[String, Object]) 


75
76
77
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 75

def report_filters
  @report_filters
end

#report_frequency ⇒ String

'Report Frequency' NOTE: Do not document USER_DEFINED Frequency field in developer center Valid values:

  • DAILY
  • WEEKLY
  • MONTHLY
  • USER_DEFINED

Returns:

  • (String) 


41
42
43
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 41

def report_frequency
  @report_frequency
end

#report_interval ⇒ String

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 Example time format for 2 hours and 30 Mins:

  • PT2H30M NOTE: Do not document reportInterval field in developer center

Returns:

  • (String) 


51
52
53
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 51

def report_interval
  @report_interval
end

#report_mime_type ⇒ String

Report Format

Valid values:

  • application/xml
  • text/csv

Returns:

  • (String) 


31
32
33
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 31

def report_mime_type
  @report_mime_type
end

#report_name ⇒ String

Report Name

Returns:

  • (String) 


55
56
57
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 55

def report_name
  @report_name
end

#report_preferences ⇒ ReportPreferences

Report Preferences

Returns:



79
80
81
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 79

def report_preferences
  @report_preferences
end

#start_day ⇒ Integer

Start Day

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 67

def start_day
  @start_day
end

#start_time ⇒ DateTime

Start Time

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 63

def start_time
  @start_time
end

#timezone ⇒ String

Time Zone

Returns:

  • (String) 


59
60
61
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 59

def timezone
  @timezone
end

Class Method Details

.from_element(root) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 217

def self.from_element(root)
  organization_id = XmlUtilities.from_element(root, 'organizationId',
                                              String)
  report_definition_id = XmlUtilities.from_element(root,
                                                   'reportDefinitionId',
                                                   String)
  report_definition_name = XmlUtilities.from_element(root,
                                                     'reportDefinitionName',
                                                     String)
  report_mime_type = XmlUtilities.from_element(root, 'reportMimeType',
                                               String)
  report_frequency = XmlUtilities.from_element(root, 'reportFrequency',
                                               String)
  report_interval = XmlUtilities.from_element(root, 'reportInterval',
                                              String)
  report_name = XmlUtilities.from_element(root, 'reportName', String)
  timezone = XmlUtilities.from_element(root, 'timezone', String)
  start_time = XmlUtilities.from_element(root, 'startTime', String,
                                         datetime_format: 'rfc3339')
  start_day = XmlUtilities.from_element(root, 'startDay', Integer)
  report_fields = XmlUtilities.from_element_to_array(root, 'reportFields',
                                                     String)
  report_filters = XmlUtilities.from_element_to_hash(root, 'reportFilters',
                                                     Hash)
  report_preferences = XmlUtilities.from_element(root, 'ReportPreferences',
                                                 ReportPreferences)
  group_id = XmlUtilities.from_element(root, 'groupId', String)

  new(organization_id: organization_id,
      report_definition_id: report_definition_id,
      report_definition_name: report_definition_name,
      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_fields: report_fields,
      report_filters: report_filters,
      report_preferences: report_preferences,
      group_id: group_id,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
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
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 158

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  organization_id =
    hash.key?('organizationId') ? hash['organizationId'] : SKIP
  report_definition_id =
    hash.key?('reportDefinitionId') ? hash['reportDefinitionId'] : SKIP
  report_definition_name =
    hash.key?('reportDefinitionName') ? hash['reportDefinitionName'] : SKIP
  report_mime_type =
    hash.key?('reportMimeType') ? hash['reportMimeType'] : SKIP
  report_frequency =
    hash.key?('reportFrequency') ? hash['reportFrequency'] : SKIP
  report_interval =
    hash.key?('reportInterval') ? hash['reportInterval'] : SKIP
  report_name = hash.key?('reportName') ? hash['reportName'] : SKIP
  timezone = hash.key?('timezone') ? hash['timezone'] : SKIP
  start_time = if hash.key?('startTime')
                 (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
               else
                 SKIP
               end
  start_day = hash.key?('startDay') ? hash['startDay'] : SKIP
  report_fields = hash.key?('reportFields') ? hash['reportFields'] : SKIP
  report_filters = hash.key?('reportFilters') ? hash['reportFilters'] : SKIP
  report_preferences = ReportPreferences.from_hash(hash['reportPreferences']) if
    hash['reportPreferences']
  group_id = hash.key?('groupId') ? hash['groupId'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Subscription1.new(organization_id: organization_id,
                    report_definition_id: report_definition_id,
                    report_definition_name: report_definition_name,
                    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_fields: report_fields,
                    report_filters: report_filters,
                    report_preferences: report_preferences,
                    group_id: group_id,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 86

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['organization_id'] = 'organizationId'
  @_hash['report_definition_id'] = 'reportDefinitionId'
  @_hash['report_definition_name'] = 'reportDefinitionName'
  @_hash['report_mime_type'] = 'reportMimeType'
  @_hash['report_frequency'] = 'reportFrequency'
  @_hash['report_interval'] = 'reportInterval'
  @_hash['report_name'] = 'reportName'
  @_hash['timezone'] = 'timezone'
  @_hash['start_time'] = 'startTime'
  @_hash['start_day'] = 'startDay'
  @_hash['report_fields'] = 'reportFields'
  @_hash['report_filters'] = 'reportFilters'
  @_hash['report_preferences'] = 'reportPreferences'
  @_hash['group_id'] = 'groupId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



126
127
128
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 126

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 106

def self.optionals
  %w[
    organization_id
    report_definition_id
    report_definition_name
    report_mime_type
    report_frequency
    report_interval
    report_name
    timezone
    start_time
    start_day
    report_fields
    report_filters
    report_preferences
    group_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 309

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} organization_id: #{@organization_id.inspect}, report_definition_id:"\
  " #{@report_definition_id.inspect}, report_definition_name:"\
  " #{@report_definition_name.inspect}, report_mime_type: #{@report_mime_type.inspect},"\
  " report_frequency: #{@report_frequency.inspect}, report_interval:"\
  " #{@report_interval.inspect}, report_name: #{@report_name.inspect}, timezone:"\
  " #{@timezone.inspect}, start_time: #{@start_time.inspect}, start_day:"\
  " #{@start_day.inspect}, report_fields: #{@report_fields.inspect}, report_filters:"\
  " #{@report_filters.inspect}, report_preferences: #{@report_preferences.inspect}, group_id:"\
  " #{@group_id.inspect}, additional_properties: #{@additional_properties}>"
end

#to_custom_start_time ⇒ Object 



213
214
215
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 213

def to_custom_start_time
  DateTimeHelper.to_rfc3339(start_time)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cyber_source_merged_spec/models/subscription1.rb', line 296

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} organization_id: #{@organization_id}, report_definition_id:"\
  " #{@report_definition_id}, report_definition_name: #{@report_definition_name},"\
  " 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_fields:"\
  " #{@report_fields}, report_filters: #{@report_filters}, report_preferences:"\
  " #{@report_preferences}, group_id: #{@group_id}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



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/cyber_source_merged_spec/models/subscription1.rb', line 262

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'organizationId',
                                 organization_id)
  XmlUtilities.add_as_subelement(doc, root, 'reportDefinitionId',
                                 report_definition_id)
  XmlUtilities.add_as_subelement(doc, root, 'reportDefinitionName',
                                 report_definition_name)
  XmlUtilities.add_as_subelement(doc, root, 'reportMimeType',
                                 report_mime_type)
  XmlUtilities.add_as_subelement(doc, root, 'reportFrequency',
                                 report_frequency)
  XmlUtilities.add_as_subelement(doc, root, 'reportInterval',
                                 report_interval)
  XmlUtilities.add_as_subelement(doc, root, 'reportName', report_name)
  XmlUtilities.add_as_subelement(doc, root, 'timezone', timezone)
  XmlUtilities.add_as_subelement(doc, root, 'startTime', start_time,
                                 datetime_format: 'rfc3339')
  XmlUtilities.add_as_subelement(doc, root, 'startDay', start_day)
  XmlUtilities.add_array_as_subelement(doc, root, 'reportFields',
                                       report_fields)
  XmlUtilities.add_hash_as_subelement(doc, root, 'reportFilters',
                                      report_filters)
  XmlUtilities.add_as_subelement(doc, root, 'ReportPreferences',
                                 report_preferences)
  XmlUtilities.add_as_subelement(doc, root, 'groupId', group_id)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end