purecloudplatformclientv2 87.0.0 → 92.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AmazonLexRequest.md +14 -0
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/ApiUsageQuery.md +16 -0
  6. data/docs/ApiUsageQueryResult.md +14 -0
  7. data/docs/ApiUsageRow.md +25 -0
  8. data/docs/ArchitectApi.md +132 -0
  9. data/docs/AuditApi.md +130 -0
  10. data/docs/AuditQueryEntity.md +14 -0
  11. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  12. data/docs/AuditQueryRequest.md +1 -0
  13. data/docs/AuditQueryService.md +14 -0
  14. data/docs/AuditQueryServiceMapping.md +13 -0
  15. data/docs/AuditQuerySort.md +14 -0
  16. data/docs/AuditRealtimeQueryRequest.md +18 -0
  17. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  18. data/docs/BuAgentScheduleActivity.md +2 -0
  19. data/docs/BuRescheduleRequest.md +2 -2
  20. data/docs/ButtonComponent.md +16 -0
  21. data/docs/CoachingApi.md +1 -1
  22. data/docs/ContentActions.md +17 -0
  23. data/docs/ContentAttachment.md +19 -0
  24. data/docs/ContentGeneric.md +19 -0
  25. data/docs/ContentList.md +19 -0
  26. data/docs/ContentLocation.md +17 -0
  27. data/docs/ContentNotificationTemplate.md +17 -0
  28. data/docs/ContentQuickReply.md +16 -0
  29. data/docs/ConversationAggregationQuery.md +1 -1
  30. data/docs/CreateQueueRequest.md +1 -0
  31. data/docs/EdgeGroup.md +1 -0
  32. data/docs/EntityListing.md +1 -5
  33. data/docs/EvaluationAggregationQuery.md +1 -1
  34. data/docs/ExternalContact.md +2 -0
  35. data/docs/ExternalOrganization.md +2 -0
  36. data/docs/FlowAggregationQuery.md +1 -1
  37. data/docs/FlowExecutionLaunchRequest.md +16 -0
  38. data/docs/FlowExecutionLaunchResponse.md +16 -0
  39. data/docs/FlowRuntimeExecution.md +23 -0
  40. data/docs/GenericSAML.md +22 -0
  41. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  42. data/docs/GroupsApi.md +4 -4
  43. data/docs/IdentityProviderApi.md +187 -0
  44. data/docs/IpAddressAuthentication.md +13 -0
  45. data/docs/KnowledgeSearchResponse.md +1 -1
  46. data/docs/LanguageUnderstandingApi.md +164 -30
  47. data/docs/ListItemComponent.md +19 -0
  48. data/docs/MessageContent.md +19 -0
  49. data/docs/NluDomainVersion.md +3 -1
  50. data/docs/NotificationTemplateBody.md +14 -0
  51. data/docs/NotificationTemplateFooter.md +13 -0
  52. data/docs/NotificationTemplateHeader.md +16 -0
  53. data/docs/NotificationTemplateParameter.md +14 -0
  54. data/docs/OAuthApi.md +208 -0
  55. data/docs/OrganizationApi.md +126 -0
  56. data/docs/PostTextMessage.md +15 -0
  57. data/docs/PostTextRequest.md +23 -0
  58. data/docs/PostTextResponse.md +20 -0
  59. data/docs/Prompt.md +2 -2
  60. data/docs/Queue.md +1 -0
  61. data/docs/QueueRequest.md +1 -0
  62. data/docs/RecordingApi.md +12 -0
  63. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  64. data/docs/ScimEmail.md +1 -1
  65. data/docs/SurveyAggregationQuery.md +1 -1
  66. data/docs/SurveyForm.md +0 -2
  67. data/docs/TextbotsApi.md +78 -0
  68. data/docs/UploadUrlRequest.md +1 -0
  69. data/docs/UsageApi.md +144 -0
  70. data/docs/UsageExecutionResult.md +14 -0
  71. data/docs/UserAggregationQuery.md +1 -1
  72. data/docs/UserQueue.md +1 -0
  73. data/docs/UsersApi.md +5 -5
  74. data/docs/ViewFilter.md +2 -0
  75. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  76. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  77. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  78. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  79. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  80. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  81. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  82. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  83. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  84. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  85. data/docs/WorkforceManagementApi.md +3 -3
  86. data/lib/purecloudplatformclientv2.rb +45 -0
  87. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  88. data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
  89. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  90. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  91. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
  92. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  93. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  94. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  95. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  96. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  101. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  102. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  103. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  104. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  106. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  107. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
  108. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
  109. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  110. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  111. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  112. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  113. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  114. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  115. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  116. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  117. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +2 -2
  118. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +2 -2
  119. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  120. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  121. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  122. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  123. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  124. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  125. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  126. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  127. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  128. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  129. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  130. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  131. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  132. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  133. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  134. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  135. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  136. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  137. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  138. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  139. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  140. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  141. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  142. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  143. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  144. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  145. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +72 -1
  147. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  148. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  149. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  150. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  151. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  152. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  153. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  154. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  155. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  156. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  157. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  158. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  159. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  160. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  161. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  162. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  163. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  164. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  165. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  166. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  167. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  168. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  169. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  170. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  171. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  172. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  173. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  174. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  175. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  176. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  177. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +92 -2
@@ -0,0 +1,226 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class VoicemailMessagesTopicVoicemailCopyRecord
21
+ attr_accessor :user
22
+
23
+ attr_accessor :group
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+
29
+ :'user' => :'user',
30
+
31
+ :'group' => :'group'
32
+
33
+ }
34
+ end
35
+
36
+ # Attribute type mapping.
37
+ def self.swagger_types
38
+ {
39
+
40
+ :'user' => :'VoicemailMessagesTopicOwner',
41
+
42
+ :'group' => :'VoicemailMessagesTopicOwner'
43
+
44
+ }
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ return unless attributes.is_a?(Hash)
51
+
52
+ # convert string to symbol for hash key
53
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
54
+
55
+
56
+ if attributes.has_key?(:'user')
57
+
58
+
59
+ self.user = attributes[:'user']
60
+
61
+
62
+ end
63
+
64
+
65
+ if attributes.has_key?(:'group')
66
+
67
+
68
+ self.group = attributes[:'group']
69
+
70
+
71
+ end
72
+
73
+
74
+ end
75
+
76
+ # Show invalid properties with the reasons. Usually used together with valid?
77
+ # @return Array for valid properies with the reasons
78
+ def list_invalid_properties
79
+ invalid_properties = Array.new
80
+
81
+
82
+ return invalid_properties
83
+ end
84
+
85
+ # Check to see if the all the properties in the model are valid
86
+ # @return true if the model is valid
87
+ def valid?
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ end
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ # Checks equality by comparing each attribute.
111
+ # @param [Object] Object to be compared
112
+ def ==(o)
113
+ return true if self.equal?(o)
114
+ self.class == o.class &&
115
+ user == o.user &&
116
+ group == o.group
117
+ end
118
+
119
+ # @see the `==` method
120
+ # @param [Object] Object to be compared
121
+ def eql?(o)
122
+ self == o
123
+ end
124
+
125
+ # Calculates hash code according to all attributes.
126
+ # @return [Fixnum] Hash code
127
+ def hash
128
+ [user, group].hash
129
+ end
130
+
131
+ # build the object from hash
132
+ def build_from_hash(attributes)
133
+ return nil unless attributes.is_a?(Hash)
134
+ self.class.swagger_types.each_pair do |key, type|
135
+ if type =~ /^Array<(.*)>/i
136
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
137
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
138
+ else
139
+ #TODO show warning in debug mode
140
+ end
141
+ elsif !attributes[self.class.attribute_map[key]].nil?
142
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
143
+ else
144
+ # data not found in attributes(hash), not an issue as the data can be optional
145
+ end
146
+ end
147
+
148
+ self
149
+ end
150
+
151
+ def _deserialize(type, value)
152
+ case type.to_sym
153
+ when :DateTime
154
+ DateTime.parse(value)
155
+ when :Date
156
+ Date.parse(value)
157
+ when :String
158
+ value.to_s
159
+ when :Integer
160
+ value.to_i
161
+ when :Float
162
+ value.to_f
163
+ when :BOOLEAN
164
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
165
+ true
166
+ else
167
+ false
168
+ end
169
+ when :Object
170
+ # generic object (usually a Hash), return directly
171
+ value
172
+ when /\AArray<(?<inner_type>.+)>\z/
173
+ inner_type = Regexp.last_match[:inner_type]
174
+ value.map { |v| _deserialize(inner_type, v) }
175
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
176
+ k_type = Regexp.last_match[:k_type]
177
+ v_type = Regexp.last_match[:v_type]
178
+ {}.tap do |hash|
179
+ value.each do |k, v|
180
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
181
+ end
182
+ end
183
+ else # model
184
+ _model = Object.const_get("PureCloud").const_get(type).new
185
+ _model.build_from_hash(value)
186
+ end
187
+ end
188
+
189
+ def to_s
190
+ to_hash.to_s
191
+ end
192
+
193
+ # to_body is an alias to to_body (backward compatibility))
194
+ def to_body
195
+ to_hash
196
+ end
197
+
198
+ # return the object in the form of hash
199
+ def to_hash
200
+ hash = {}
201
+ self.class.attribute_map.each_pair do |attr, param|
202
+ value = self.send(attr)
203
+ next if value.nil?
204
+ hash[param] = _to_hash(value)
205
+ end
206
+ hash
207
+ end
208
+
209
+ # Method to output non-array value in the form of hash
210
+ # For object, use to_hash. Otherwise, just return the value
211
+ def _to_hash(value)
212
+ if value.is_a?(Array)
213
+ value.compact.map{ |v| _to_hash(v) }
214
+ elsif value.is_a?(Hash)
215
+ {}.tap do |hash|
216
+ value.each { |k, v| hash[k] = _to_hash(v) }
217
+ end
218
+ elsif value.respond_to? :to_hash
219
+ value.to_hash
220
+ else
221
+ value
222
+ end
223
+ end
224
+
225
+ end
226
+ end
@@ -42,6 +42,10 @@ module PureCloud
42
42
 
43
43
  attr_accessor :modified_by_user_id
44
44
 
45
+ attr_accessor :copied_to
46
+
47
+ attr_accessor :copied_from
48
+
45
49
  # Attribute mapping from ruby-style variable name to JSON key.
46
50
  def self.attribute_map
47
51
  {
@@ -68,7 +72,11 @@ module PureCloud
68
72
 
69
73
  :'deleted' => :'deleted',
70
74
 
71
- :'modified_by_user_id' => :'modifiedByUserId'
75
+ :'modified_by_user_id' => :'modifiedByUserId',
76
+
77
+ :'copied_to' => :'copiedTo',
78
+
79
+ :'copied_from' => :'copiedFrom'
72
80
 
73
81
  }
74
82
  end
@@ -99,7 +107,11 @@ module PureCloud
99
107
 
100
108
  :'deleted' => :'BOOLEAN',
101
109
 
102
- :'modified_by_user_id' => :'String'
110
+ :'modified_by_user_id' => :'String',
111
+
112
+ :'copied_to' => :'Array<VoicemailMessagesTopicVoicemailCopyRecord>',
113
+
114
+ :'copied_from' => :'VoicemailMessagesTopicVoicemailCopyRecord'
103
115
 
104
116
  }
105
117
  end
@@ -221,6 +233,26 @@ module PureCloud
221
233
  end
222
234
 
223
235
 
236
+ if attributes.has_key?(:'copiedTo')
237
+
238
+ if (value = attributes[:'copiedTo']).is_a?(Array)
239
+ self.copied_to = value
240
+ end
241
+
242
+
243
+
244
+ end
245
+
246
+
247
+ if attributes.has_key?(:'copiedFrom')
248
+
249
+
250
+ self.copied_from = attributes[:'copiedFrom']
251
+
252
+
253
+ end
254
+
255
+
224
256
  end
225
257
 
226
258
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -275,6 +307,14 @@ module PureCloud
275
307
 
276
308
 
277
309
 
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
278
318
 
279
319
 
280
320
 
@@ -336,6 +376,16 @@ module PureCloud
336
376
 
337
377
 
338
378
 
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
339
389
 
340
390
 
341
391
 
@@ -363,7 +413,9 @@ module PureCloud
363
413
  action == o.action &&
364
414
  note == o.note &&
365
415
  deleted == o.deleted &&
366
- modified_by_user_id == o.modified_by_user_id
416
+ modified_by_user_id == o.modified_by_user_id &&
417
+ copied_to == o.copied_to &&
418
+ copied_from == o.copied_from
367
419
  end
368
420
 
369
421
  # @see the `==` method
@@ -375,7 +427,7 @@ module PureCloud
375
427
  # Calculates hash code according to all attributes.
376
428
  # @return [Fixnum] Hash code
377
429
  def hash
378
- [id, read, audio_recording_duration_seconds, audio_recording_size_bytes, created_date, modified_date, caller_address, caller_name, action, note, deleted, modified_by_user_id].hash
430
+ [id, read, audio_recording_duration_seconds, audio_recording_size_bytes, created_date, modified_date, caller_address, caller_name, action, note, deleted, modified_by_user_id, copied_to, copied_from].hash
379
431
  end
380
432
 
381
433
  # build the object from hash
@@ -0,0 +1,497 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class WfmBuShortTermForecastImportCompleteTopicBuForecastModification
21
+ attr_accessor :type
22
+
23
+ attr_accessor :start_interval_index
24
+
25
+ attr_accessor :end_interval_index
26
+
27
+ attr_accessor :metric
28
+
29
+ attr_accessor :legacy_metric
30
+
31
+ attr_accessor :value
32
+
33
+ attr_accessor :values
34
+
35
+ attr_accessor :enabled
36
+
37
+ attr_accessor :granularity
38
+
39
+ attr_accessor :display_granularity
40
+
41
+ attr_accessor :planning_group_ids
42
+
43
+ # Attribute mapping from ruby-style variable name to JSON key.
44
+ def self.attribute_map
45
+ {
46
+
47
+ :'type' => :'type',
48
+
49
+ :'start_interval_index' => :'startIntervalIndex',
50
+
51
+ :'end_interval_index' => :'endIntervalIndex',
52
+
53
+ :'metric' => :'metric',
54
+
55
+ :'legacy_metric' => :'legacyMetric',
56
+
57
+ :'value' => :'value',
58
+
59
+ :'values' => :'values',
60
+
61
+ :'enabled' => :'enabled',
62
+
63
+ :'granularity' => :'granularity',
64
+
65
+ :'display_granularity' => :'displayGranularity',
66
+
67
+ :'planning_group_ids' => :'planningGroupIds'
68
+
69
+ }
70
+ end
71
+
72
+ # Attribute type mapping.
73
+ def self.swagger_types
74
+ {
75
+
76
+ :'type' => :'String',
77
+
78
+ :'start_interval_index' => :'Integer',
79
+
80
+ :'end_interval_index' => :'Integer',
81
+
82
+ :'metric' => :'String',
83
+
84
+ :'legacy_metric' => :'String',
85
+
86
+ :'value' => :'Float',
87
+
88
+ :'values' => :'Array<WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue>',
89
+
90
+ :'enabled' => :'BOOLEAN',
91
+
92
+ :'granularity' => :'String',
93
+
94
+ :'display_granularity' => :'String',
95
+
96
+ :'planning_group_ids' => :'Array<String>'
97
+
98
+ }
99
+ end
100
+
101
+ # Initializes the object
102
+ # @param [Hash] attributes Model attributes in the form of hash
103
+ def initialize(attributes = {})
104
+ return unless attributes.is_a?(Hash)
105
+
106
+ # convert string to symbol for hash key
107
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
108
+
109
+
110
+ if attributes.has_key?(:'type')
111
+
112
+
113
+ self.type = attributes[:'type']
114
+
115
+
116
+ end
117
+
118
+
119
+ if attributes.has_key?(:'startIntervalIndex')
120
+
121
+
122
+ self.start_interval_index = attributes[:'startIntervalIndex']
123
+
124
+
125
+ end
126
+
127
+
128
+ if attributes.has_key?(:'endIntervalIndex')
129
+
130
+
131
+ self.end_interval_index = attributes[:'endIntervalIndex']
132
+
133
+
134
+ end
135
+
136
+
137
+ if attributes.has_key?(:'metric')
138
+
139
+
140
+ self.metric = attributes[:'metric']
141
+
142
+
143
+ end
144
+
145
+
146
+ if attributes.has_key?(:'legacyMetric')
147
+
148
+
149
+ self.legacy_metric = attributes[:'legacyMetric']
150
+
151
+
152
+ end
153
+
154
+
155
+ if attributes.has_key?(:'value')
156
+
157
+
158
+ self.value = attributes[:'value']
159
+
160
+
161
+ end
162
+
163
+
164
+ if attributes.has_key?(:'values')
165
+
166
+ if (value = attributes[:'values']).is_a?(Array)
167
+ self.values = value
168
+ end
169
+
170
+
171
+
172
+ end
173
+
174
+
175
+ if attributes.has_key?(:'enabled')
176
+
177
+
178
+ self.enabled = attributes[:'enabled']
179
+
180
+
181
+ end
182
+
183
+
184
+ if attributes.has_key?(:'granularity')
185
+
186
+
187
+ self.granularity = attributes[:'granularity']
188
+
189
+
190
+ end
191
+
192
+
193
+ if attributes.has_key?(:'displayGranularity')
194
+
195
+
196
+ self.display_granularity = attributes[:'displayGranularity']
197
+
198
+
199
+ end
200
+
201
+
202
+ if attributes.has_key?(:'planningGroupIds')
203
+
204
+ if (value = attributes[:'planningGroupIds']).is_a?(Array)
205
+ self.planning_group_ids = value
206
+ end
207
+
208
+
209
+
210
+ end
211
+
212
+
213
+ end
214
+
215
+ # Show invalid properties with the reasons. Usually used together with valid?
216
+ # @return Array for valid properies with the reasons
217
+ def list_invalid_properties
218
+ invalid_properties = Array.new
219
+
220
+
221
+ return invalid_properties
222
+ end
223
+
224
+ # Check to see if the all the properties in the model are valid
225
+ # @return true if the model is valid
226
+ def valid?
227
+
228
+
229
+
230
+ allowed_values = ["MinimumPerInterval", "MaximumPerInterval", "SetValuePerInterval", "ChangeValuePerInterval", "ChangePercentPerInterval", "SetValueOverRange", "ChangeValueOverRange", "SetValuesForIntervalSet"]
231
+ if @type && !allowed_values.include?(@type)
232
+ return false
233
+ end
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ allowed_values = ["Offered", "AverageHandleTimeSeconds"]
248
+ if @metric && !allowed_values.include?(@metric)
249
+ return false
250
+ end
251
+
252
+
253
+
254
+
255
+
256
+ allowed_values = ["AverageAfterCallWorkTimeSeconds", "AverageHandleTimeSeconds", "AverageTalkTimeSeconds", "Offered"]
257
+ if @legacy_metric && !allowed_values.include?(@legacy_metric)
258
+ return false
259
+ end
260
+
261
+
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
+ end
288
+
289
+
290
+
291
+ # Custom attribute writer method checking allowed values (enum).
292
+ # @param [Object] type Object to be assigned
293
+ def type=(type)
294
+ allowed_values = ["MinimumPerInterval", "MaximumPerInterval", "SetValuePerInterval", "ChangeValuePerInterval", "ChangePercentPerInterval", "SetValueOverRange", "ChangeValueOverRange", "SetValuesForIntervalSet"]
295
+ if type && !allowed_values.include?(type)
296
+ fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
297
+ end
298
+ @type = type
299
+ end
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+ # Custom attribute writer method checking allowed values (enum).
316
+ # @param [Object] metric Object to be assigned
317
+ def metric=(metric)
318
+ allowed_values = ["Offered", "AverageHandleTimeSeconds"]
319
+ if metric && !allowed_values.include?(metric)
320
+ fail ArgumentError, "invalid value for 'metric', must be one of #{allowed_values}."
321
+ end
322
+ @metric = metric
323
+ end
324
+
325
+
326
+
327
+
328
+
329
+ # Custom attribute writer method checking allowed values (enum).
330
+ # @param [Object] legacy_metric Object to be assigned
331
+ def legacy_metric=(legacy_metric)
332
+ allowed_values = ["AverageAfterCallWorkTimeSeconds", "AverageHandleTimeSeconds", "AverageTalkTimeSeconds", "Offered"]
333
+ if legacy_metric && !allowed_values.include?(legacy_metric)
334
+ fail ArgumentError, "invalid value for 'legacy_metric', must be one of #{allowed_values}."
335
+ end
336
+ @legacy_metric = legacy_metric
337
+ end
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+ # Checks equality by comparing each attribute.
373
+ # @param [Object] Object to be compared
374
+ def ==(o)
375
+ return true if self.equal?(o)
376
+ self.class == o.class &&
377
+ type == o.type &&
378
+ start_interval_index == o.start_interval_index &&
379
+ end_interval_index == o.end_interval_index &&
380
+ metric == o.metric &&
381
+ legacy_metric == o.legacy_metric &&
382
+ value == o.value &&
383
+ values == o.values &&
384
+ enabled == o.enabled &&
385
+ granularity == o.granularity &&
386
+ display_granularity == o.display_granularity &&
387
+ planning_group_ids == o.planning_group_ids
388
+ end
389
+
390
+ # @see the `==` method
391
+ # @param [Object] Object to be compared
392
+ def eql?(o)
393
+ self == o
394
+ end
395
+
396
+ # Calculates hash code according to all attributes.
397
+ # @return [Fixnum] Hash code
398
+ def hash
399
+ [type, start_interval_index, end_interval_index, metric, legacy_metric, value, values, enabled, granularity, display_granularity, planning_group_ids].hash
400
+ end
401
+
402
+ # build the object from hash
403
+ def build_from_hash(attributes)
404
+ return nil unless attributes.is_a?(Hash)
405
+ self.class.swagger_types.each_pair do |key, type|
406
+ if type =~ /^Array<(.*)>/i
407
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
408
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
409
+ else
410
+ #TODO show warning in debug mode
411
+ end
412
+ elsif !attributes[self.class.attribute_map[key]].nil?
413
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
414
+ else
415
+ # data not found in attributes(hash), not an issue as the data can be optional
416
+ end
417
+ end
418
+
419
+ self
420
+ end
421
+
422
+ def _deserialize(type, value)
423
+ case type.to_sym
424
+ when :DateTime
425
+ DateTime.parse(value)
426
+ when :Date
427
+ Date.parse(value)
428
+ when :String
429
+ value.to_s
430
+ when :Integer
431
+ value.to_i
432
+ when :Float
433
+ value.to_f
434
+ when :BOOLEAN
435
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
436
+ true
437
+ else
438
+ false
439
+ end
440
+ when :Object
441
+ # generic object (usually a Hash), return directly
442
+ value
443
+ when /\AArray<(?<inner_type>.+)>\z/
444
+ inner_type = Regexp.last_match[:inner_type]
445
+ value.map { |v| _deserialize(inner_type, v) }
446
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
447
+ k_type = Regexp.last_match[:k_type]
448
+ v_type = Regexp.last_match[:v_type]
449
+ {}.tap do |hash|
450
+ value.each do |k, v|
451
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
452
+ end
453
+ end
454
+ else # model
455
+ _model = Object.const_get("PureCloud").const_get(type).new
456
+ _model.build_from_hash(value)
457
+ end
458
+ end
459
+
460
+ def to_s
461
+ to_hash.to_s
462
+ end
463
+
464
+ # to_body is an alias to to_body (backward compatibility))
465
+ def to_body
466
+ to_hash
467
+ end
468
+
469
+ # return the object in the form of hash
470
+ def to_hash
471
+ hash = {}
472
+ self.class.attribute_map.each_pair do |attr, param|
473
+ value = self.send(attr)
474
+ next if value.nil?
475
+ hash[param] = _to_hash(value)
476
+ end
477
+ hash
478
+ end
479
+
480
+ # Method to output non-array value in the form of hash
481
+ # For object, use to_hash. Otherwise, just return the value
482
+ def _to_hash(value)
483
+ if value.is_a?(Array)
484
+ value.compact.map{ |v| _to_hash(v) }
485
+ elsif value.is_a?(Hash)
486
+ {}.tap do |hash|
487
+ value.each { |k, v| hash[k] = _to_hash(v) }
488
+ end
489
+ elsif value.respond_to? :to_hash
490
+ value.to_hash
491
+ else
492
+ value
493
+ end
494
+ end
495
+
496
+ end
497
+ end