Class: CyberSourceMergedSpec::ReportDefinitionDefaultSettings

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

Overview

ReportDefinitionDefaultSettings Model.

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(report_mime_type: SKIP, report_frequency: SKIP, report_name: SKIP, timezone: SKIP, start_time: SKIP, start_day: SKIP, report_filters: SKIP, report_preferences: SKIP, additional_properties: nil) ⇒ ReportDefinitionDefaultSettings

Returns a new instance of ReportDefinitionDefaultSettings.



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

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

  @report_mime_type = report_mime_type unless report_mime_type == SKIP
  @report_frequency = report_frequency unless report_frequency == 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_filters = report_filters unless report_filters == SKIP
  @report_preferences = report_preferences unless report_preferences == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#report_filters ⇒ Hash[String, Object]

List of filters to apply

Returns:

  • (Hash[String, Object]) 


46
47
48
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 46

def report_filters
  @report_filters
end

#report_frequency ⇒ String

Report Frequency Value Valid Values:

- DAILY
- WEEKLY
- MONTHLY
- ADHOC

Returns:

  • (String) 


26
27
28
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 26

def report_frequency
  @report_frequency
end

#report_mime_type ⇒ String

Report Format Valid values:

- application/xml
- text/csv

Returns:

  • (String) 


17
18
19
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 17

def report_mime_type
  @report_mime_type
end

#report_name ⇒ String

Report Name

Returns:

  • (String) 


30
31
32
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 30

def report_name
  @report_name
end

#report_preferences ⇒ ReportPreferences

Report Preferences

Returns:



50
51
52
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 50

def report_preferences
  @report_preferences
end

#start_day ⇒ Integer

Start Day

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 42

def start_day
  @start_day
end

#start_time ⇒ String

Start Time

Returns:

  • (String) 


38
39
40
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 38

def start_time
  @start_time
end

#timezone ⇒ String

Time Zone

Returns:

  • (String) 


34
35
36
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 34

def timezone
  @timezone
end

Class Method Details

.from_element(root) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 139

def self.from_element(root)
  report_mime_type = XmlUtilities.from_element(root, 'reportMimeType',
                                               String)
  report_frequency = XmlUtilities.from_element(root, 'reportFrequency',
                                               String)
  report_name = XmlUtilities.from_element(root, 'reportName', String)
  timezone = XmlUtilities.from_element(root, 'timezone', String)
  start_time = XmlUtilities.from_element(root, 'startTime', String)
  start_day = XmlUtilities.from_element(root, 'startDay', Integer)
  report_filters = XmlUtilities.from_element_to_hash(root, 'reportFilters',
                                                     Hash)
  report_preferences = XmlUtilities.from_element(root, 'ReportPreferences',
                                                 ReportPreferences)

  new(report_mime_type: report_mime_type,
      report_frequency: report_frequency,
      report_name: report_name,
      timezone: timezone,
      start_time: start_time,
      start_day: start_day,
      report_filters: report_filters,
      report_preferences: report_preferences,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  report_mime_type =
    hash.key?('reportMimeType') ? hash['reportMimeType'] : SKIP
  report_frequency =
    hash.key?('reportFrequency') ? hash['reportFrequency'] : SKIP
  report_name = hash.key?('reportName') ? hash['reportName'] : SKIP
  timezone = hash.key?('timezone') ? hash['timezone'] : SKIP
  start_time = hash.key?('startTime') ? hash['startTime'] : SKIP
  start_day = hash.key?('startDay') ? hash['startDay'] : SKIP
  report_filters = hash.key?('reportFilters') ? hash['reportFilters'] : SKIP
  report_preferences = ReportPreferences.from_hash(hash['reportPreferences']) if
    hash['reportPreferences']

  # 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.
  ReportDefinitionDefaultSettings.new(report_mime_type: report_mime_type,
                                      report_frequency: report_frequency,
                                      report_name: report_name,
                                      timezone: timezone,
                                      start_time: start_time,
                                      start_day: start_day,
                                      report_filters: report_filters,
                                      report_preferences: report_preferences,
                                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 53

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['report_mime_type'] = 'reportMimeType'
  @_hash['report_frequency'] = 'reportFrequency'
  @_hash['report_name'] = 'reportName'
  @_hash['timezone'] = 'timezone'
  @_hash['start_time'] = 'startTime'
  @_hash['start_day'] = 'startDay'
  @_hash['report_filters'] = 'reportFilters'
  @_hash['report_preferences'] = 'reportPreferences'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



81
82
83
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 81

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 67

def self.optionals
  %w[
    report_mime_type
    report_frequency
    report_name
    timezone
    start_time
    start_day
    report_filters
    report_preferences
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



196
197
198
199
200
201
202
203
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 196

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



186
187
188
189
190
191
192
193
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 186

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

#to_xml_element(doc, root_name) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cyber_source_merged_spec/models/report_definition_default_settings.rb', line 164

def to_xml_element(doc, root_name)
  root = doc.create_element(root_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, 'reportName', report_name)
  XmlUtilities.add_as_subelement(doc, root, 'timezone', timezone)
  XmlUtilities.add_as_subelement(doc, root, 'startTime', start_time)
  XmlUtilities.add_as_subelement(doc, root, 'startDay', start_day)
  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, 'additional_properties',
                                 additional_properties)

  root
end