purecloud 0.56.1 → 0.57.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  5. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  6. data/doc_out/AttributeEntityListing.html.md +2 -2
  7. data/doc_out/CalibrationEntityListing.html.md +2 -2
  8. data/doc_out/CallConversationEntityListing.html.md +2 -2
  9. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  10. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  11. data/doc_out/CampaignEntityListing.html.md +2 -2
  12. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  13. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  14. data/doc_out/ChannelEntityListing.html.md +2 -2
  15. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  16. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  17. data/doc_out/Cobrowsesession.html.md +1 -0
  18. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  19. data/doc_out/ContactListEntityListing.html.md +2 -2
  20. data/doc_out/ConversationEntityListing.html.md +2 -2
  21. data/doc_out/DIDEntityListing.html.md +2 -2
  22. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  23. data/doc_out/DncListEntityListing.html.md +2 -2
  24. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  25. data/doc_out/DocumentEntityListing.html.md +2 -2
  26. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  27. data/doc_out/DomainEntityListing.html.md +2 -2
  28. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  29. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  30. data/doc_out/EdgeEntityListing.html.md +2 -2
  31. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  32. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  33. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  34. data/doc_out/EmailMessageListing.html.md +2 -2
  35. data/doc_out/EncryptionKey.html.md +4 -4
  36. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  37. data/doc_out/EndpointEntityListing.html.md +2 -2
  38. data/doc_out/EvaluationEntityListing.html.md +2 -2
  39. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  40. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  41. data/doc_out/ExtensionEntityListing.html.md +2 -2
  42. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  43. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  44. data/doc_out/ForecastCreation.html.md +1 -0
  45. data/doc_out/ForecastCreationCompletion.html.md +2 -1
  46. data/doc_out/GroupEntityListing.html.md +2 -2
  47. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  48. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  49. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  50. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  51. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  52. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  53. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  54. data/doc_out/LanguageEntityListing.html.md +2 -2
  55. data/doc_out/LibraryEntityListing.html.md +2 -2
  56. data/doc_out/LineBaseEntityListing.html.md +2 -2
  57. data/doc_out/LineEntityListing.html.md +2 -2
  58. data/doc_out/LocalEncryptionConfiguration.html.md +18 -0
  59. data/doc_out/{ForecastMetadataEntityListing.html.md → LocalEncryptionConfigurationListing.html.md} +5 -5
  60. data/doc_out/LocalEncryptionKeyRequest.html.md +15 -0
  61. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  62. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  63. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  64. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  65. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  66. data/doc_out/OrphanRecordingListing.html.md +2 -2
  67. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  68. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  69. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  70. data/doc_out/PhoneEntityListing.html.md +2 -2
  71. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  72. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  73. data/doc_out/PolicyEntityListing.html.md +2 -2
  74. data/doc_out/QualityAuditPage.html.md +2 -2
  75. data/doc_out/QueueEntityListing.html.md +2 -2
  76. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  77. data/doc_out/RecordingApi.html.md +501 -0
  78. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  79. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  80. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  81. data/doc_out/ResponseEntityList.html.md +2 -2
  82. data/doc_out/ResponseEntityListing.html.md +2 -2
  83. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  84. data/doc_out/RuleSetEntityListing.html.md +2 -2
  85. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  86. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  87. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  88. data/doc_out/Screenshare.html.md +1 -0
  89. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  90. data/doc_out/ShareEntityListing.html.md +2 -2
  91. data/doc_out/SiteEntityListing.html.md +2 -2
  92. data/doc_out/SkillEntityListing.html.md +2 -2
  93. data/doc_out/StationEntityListing.html.md +2 -2
  94. data/doc_out/TagValueEntityListing.html.md +2 -2
  95. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  96. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  97. data/doc_out/TrunkEntityListing.html.md +2 -2
  98. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  99. data/doc_out/User.html.md +1 -0
  100. data/doc_out/UserEntityListing.html.md +2 -2
  101. data/doc_out/UserMe.html.md +2 -0
  102. data/doc_out/UserQueueEntityListing.html.md +2 -2
  103. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  104. data/doc_out/UserSkillEntityListing.html.md +2 -2
  105. data/doc_out/UsersEntityListing.html.md +2 -2
  106. data/doc_out/WorkforceManagementApi.html.md +0 -406
  107. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  108. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  109. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  110. data/doc_out/index.html.md +3 -3
  111. data/lib/purecloud.rb +3 -11
  112. data/lib/purecloud/api/recording_api.rb +531 -0
  113. data/lib/purecloud/api/workforce_management_api.rb +0 -433
  114. data/lib/purecloud/api_client.rb +1 -1
  115. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  116. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  117. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  118. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  119. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  120. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  121. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  122. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  123. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  124. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  125. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  126. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  127. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  128. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  129. data/lib/purecloud/models/cobrowsesession.rb +17 -4
  130. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  131. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  132. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  133. data/lib/purecloud/models/dialer_action.rb +1 -1
  134. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  135. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  136. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  137. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  138. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  139. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  140. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  141. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  142. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  143. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  144. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  145. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  146. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  147. data/lib/purecloud/models/email_message_listing.rb +17 -17
  148. data/lib/purecloud/models/encryption_key.rb +4 -1
  149. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  150. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  151. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  152. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  153. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  154. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  155. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  156. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  157. data/lib/purecloud/models/forecast_creation.rb +15 -4
  158. data/lib/purecloud/models/forecast_creation_completion.rb +18 -7
  159. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  160. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  161. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  162. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  163. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  164. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  165. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  166. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  167. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  168. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  169. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  170. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  171. data/lib/purecloud/models/{forecast.rb → local_encryption_configuration.rb} +51 -32
  172. data/lib/purecloud/models/{forecast_metadata_entity_listing.rb → local_encryption_configuration_listing.rb} +19 -19
  173. data/lib/purecloud/models/{forecast_filter_attributes.rb → local_encryption_key_request.rb} +23 -26
  174. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  175. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  176. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  177. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  178. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  179. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  180. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  181. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  182. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  183. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  184. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  185. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  186. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  187. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  188. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  189. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  190. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  191. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  192. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  193. data/lib/purecloud/models/response_entity_list.rb +17 -17
  194. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  195. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  196. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  197. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  198. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  199. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  200. data/lib/purecloud/models/screenshare.rb +17 -4
  201. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  202. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  203. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  204. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  205. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  206. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  207. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  208. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  209. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  210. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  211. data/lib/purecloud/models/user.rb +11 -1
  212. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  213. data/lib/purecloud/models/user_me.rb +24 -1
  214. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  215. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  216. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  217. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  218. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  219. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  220. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  221. data/lib/purecloud/version.rb +1 -1
  222. data/newVersion.md +1 -1
  223. data/swagger.json +1 -1
  224. data/version.json +1 -1
  225. metadata +8 -24
  226. data/doc_out/ConfigurationApi.html.md +0 -231
  227. data/doc_out/Forecast.html.md +0 -16
  228. data/doc_out/ForecastDimensions.html.md +0 -15
  229. data/doc_out/ForecastEntry.html.md +0 -15
  230. data/doc_out/ForecastFilterAttributes.html.md +0 -15
  231. data/doc_out/ForecastMetadata.html.md +0 -22
  232. data/doc_out/ForecastModification.html.md +0 -27
  233. data/doc_out/ForecastModificationCreation.html.md +0 -25
  234. data/doc_out/ForecastSearchCriteria.html.md +0 -20
  235. data/doc_out/ForecastSearchRequest.html.md +0 -20
  236. data/lib/purecloud/api/configuration_api.rb +0 -258
  237. data/lib/purecloud/models/forecast_dimensions.rb +0 -197
  238. data/lib/purecloud/models/forecast_entry.rb +0 -199
  239. data/lib/purecloud/models/forecast_metadata.rb +0 -284
  240. data/lib/purecloud/models/forecast_modification.rb +0 -339
  241. data/lib/purecloud/models/forecast_modification_creation.rb +0 -317
  242. data/lib/purecloud/models/forecast_search_criteria.rb +0 -267
  243. data/lib/purecloud/models/forecast_search_request.rb +0 -259
@@ -1,16 +0,0 @@
1
- ---
2
- title: Forecast
3
- ---
4
- ## PureCloud::Forecast
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **metadata** | [**ForecastMetadata**](ForecastMetadata.html) | The metadata of the forecast | [optional] |
11
- | **start_date** | **DateTime** | The start date time of the forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
- | **forecast_entries** | [**Array<ForecastEntry>**](ForecastEntry.html) | The entries of forecasted values and their dimensions | [optional] |
13
- | **error_message** | **String** | The error happening when producing the forecasts | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
@@ -1,15 +0,0 @@
1
- ---
2
- title: ForecastDimensions
3
- ---
4
- ## PureCloud::ForecastDimensions
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **language** | [**Language**](Language.html) | The language of the forecast | [optional] |
11
- | **media** | **String** | The media of the forecast | [optional] |
12
- | **queue** | [**Queue**](Queue.html) | The queue of the forecast | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
@@ -1,15 +0,0 @@
1
- ---
2
- title: ForecastEntry
3
- ---
4
- ## PureCloud::ForecastEntry
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **metric** | **String** | The metric of the entry | [optional] |
11
- | **dimensions** | [**ForecastDimensions**](ForecastDimensions.html) | The dimensions of the entry | [optional] |
12
- | **values** | **Array<Float>** | The forecasted values | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
@@ -1,15 +0,0 @@
1
- ---
2
- title: ForecastFilterAttributes
3
- ---
4
- ## PureCloud::ForecastFilterAttributes
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **languages** | **Array<String>** | | [optional] |
11
- | **queue_ids** | **Array<String>** | | [optional] |
12
- | **media_types** | **Array<String>** | | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
@@ -1,22 +0,0 @@
1
- ---
2
- title: ForecastMetadata
3
- ---
4
- ## PureCloud::ForecastMetadata
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **number_of_periods** | **Integer** | The number of periods to be forecasted for | |
13
- | **period_frequency** | **String** | The frequency of the period | |
14
- | **description** | **String** | The description of the forecast to be created | |
15
- | **metrics** | **Array<String>** | The metrics the forecast is for | |
16
- | **last_modified_date** | **DateTime** | The last modified date time of this object. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
- | **last_modified_by** | [**User**](User.html) | The person who last modified this object | [optional] |
18
- | **status** | **String** | The status of the creation of the forecast | [optional] |
19
- | **self_uri** | **String** | The URI for this object | [optional] |
20
- {: class="table table-striped"}
21
-
22
-
@@ -1,27 +0,0 @@
1
- ---
2
- title: ForecastModification
3
- ---
4
- ## PureCloud::ForecastModification
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **forecast_id** | **String** | The id of the associated forecast | |
13
- | **priority** | **Integer** | The priority in which the modification is applied | |
14
- | **metric** | **String** | The metric the modification is appied to | |
15
- | **modification_type** | **String** | The type of modification | |
16
- | **modification_value** | **Float** | The value of the modification | |
17
- | **start_date** | **DateTime** | The start of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
18
- | **end_date** | **DateTime** | The end of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
19
- | **attributes** | [**ForecastFilterAttributes**](ForecastFilterAttributes.html) | The filters for the modification | |
20
- | **enabled** | **BOOLEAN** | Determined if the modification is currently applied | [default to false]|
21
- | **last_modified_date** | **DateTime** | The last time the modification was changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
22
- | **last_modified_by** | [**User**](User.html) | The last user to change the modification | |
23
- | **notes** | **String** | Any notes associated with the modification | |
24
- | **self_uri** | **String** | The URI for this object | [optional] |
25
- {: class="table table-striped"}
26
-
27
-
@@ -1,25 +0,0 @@
1
- ---
2
- title: ForecastModificationCreation
3
- ---
4
- ## PureCloud::ForecastModificationCreation
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **forecast_id** | **String** | The id of the associated forecast | |
13
- | **priority** | **Integer** | The priority in which the modification is applied | |
14
- | **metric** | **String** | The metric the modification is appied to | |
15
- | **modification_type** | **String** | The type of modification | |
16
- | **modification_value** | **Float** | The value of the modification | |
17
- | **start_date** | **DateTime** | The start of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
18
- | **end_date** | **DateTime** | The end of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
19
- | **attributes** | [**ForecastFilterAttributes**](ForecastFilterAttributes.html) | The filters for the modification | |
20
- | **enabled** | **BOOLEAN** | Determined if the modification is currently applied | [default to false]|
21
- | **notes** | **String** | Any notes associated with the modification | |
22
- | **self_uri** | **String** | The URI for this object | [optional] |
23
- {: class="table table-striped"}
24
-
25
-
@@ -1,20 +0,0 @@
1
- ---
2
- title: ForecastSearchCriteria
3
- ---
4
- ## PureCloud::ForecastSearchCriteria
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
11
- | **values** | **Array<String>** | A list of values for the search to match against | [optional] |
12
- | **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
13
- | **fields** | **Array<String>** | Field names to search against | [optional] |
14
- | **value** | **String** | A value for the search to match against | [optional] |
15
- | **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
16
- | **group** | [**Array<ForecastSearchCriteria>**](ForecastSearchCriteria.html) | Groups multiple conditions | [optional] |
17
- | **type** | **String** | Search Type | |
18
- {: class="table table-striped"}
19
-
20
-
@@ -1,20 +0,0 @@
1
- ---
2
- title: ForecastSearchRequest
3
- ---
4
- ## PureCloud::ForecastSearchRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **sort_order** | **String** | The sort order for results | [optional] |
11
- | **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
12
- | **page_size** | **Integer** | The number of results per page | [optional] |
13
- | **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
14
- | **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
15
- | **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
16
- | **types** | **Array<String>** | Resource type | |
17
- | **query** | [**Array<ForecastSearchCriteria>**](ForecastSearchCriteria.html) | | [optional] |
18
- {: class="table table-striped"}
19
-
20
-
@@ -1,258 +0,0 @@
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@inin.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- License: ININ
11
- http://www.inin.com
12
-
13
- Terms of Service: https://developer.mypurecloud.com/tos
14
-
15
- =end
16
-
17
- require "uri"
18
-
19
- module PureCloud
20
- class ConfigurationApi
21
- attr_accessor :api_client
22
-
23
- def initialize(api_client = ApiClient.default)
24
- @api_client = api_client
25
- end
26
-
27
- # Get encryption key list
28
- #
29
- # @param [Hash] opts the optional parameters
30
- # @option opts [Integer] :page_size Page size (default to 25)
31
- # @option opts [Integer] :page_number Page number (default to 1)
32
- # @return [EncryptionKeyEntityListing]
33
- def get_recordingkeys(opts = {})
34
- data, status_code, headers = get_recordingkeys_with_http_info(opts)
35
- return data
36
- end
37
-
38
- # Get encryption key list
39
- #
40
- # @param [Hash] opts the optional parameters
41
- # @option opts [Integer] :page_size Page size
42
- # @option opts [Integer] :page_number Page number
43
- # @return [Array<(EncryptionKeyEntityListing, Fixnum, Hash)>] EncryptionKeyEntityListing data, response status code and response headers
44
- def get_recordingkeys_with_http_info(opts = {})
45
- if @api_client.config.debugging
46
- @api_client.config.logger.debug "Calling API: ConfigurationApi#get_recordingkeys ..."
47
- end
48
-
49
- # resource path
50
- local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json')
51
-
52
- # query parameters
53
- query_params = {}
54
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
55
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
56
-
57
- # header parameters
58
- header_params = {}
59
-
60
- # HTTP header 'Accept' (if needed)
61
- _header_accept = ['application/json']
62
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
63
-
64
- # HTTP header 'Content-Type'
65
- _header_content_type = ['application/json']
66
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
67
-
68
- # form parameters
69
- form_params = {}
70
-
71
- # http body (model)
72
- post_body = nil
73
-
74
- auth_names = ['PureCloud Auth']
75
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
76
- :header_params => header_params,
77
- :query_params => query_params,
78
- :form_params => form_params,
79
- :body => post_body,
80
- :auth_names => auth_names,
81
- :return_type => 'EncryptionKeyEntityListing')
82
- if @api_client.config.debugging
83
- @api_client.config.logger.debug "API called: ConfigurationApi#get_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
- end
85
- return data, status_code, headers
86
- end
87
-
88
- # Get key rotation schedule
89
- #
90
- # @param [Hash] opts the optional parameters
91
- # @return [KeyRotationSchedule]
92
- def get_recordingkeys_rotationschedule(opts = {})
93
- data, status_code, headers = get_recordingkeys_rotationschedule_with_http_info(opts)
94
- return data
95
- end
96
-
97
- # Get key rotation schedule
98
- #
99
- # @param [Hash] opts the optional parameters
100
- # @return [Array<(KeyRotationSchedule, Fixnum, Hash)>] KeyRotationSchedule data, response status code and response headers
101
- def get_recordingkeys_rotationschedule_with_http_info(opts = {})
102
- if @api_client.config.debugging
103
- @api_client.config.logger.debug "Calling API: ConfigurationApi#get_recordingkeys_rotationschedule ..."
104
- end
105
-
106
- # resource path
107
- local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json')
108
-
109
- # query parameters
110
- query_params = {}
111
-
112
- # header parameters
113
- header_params = {}
114
-
115
- # HTTP header 'Accept' (if needed)
116
- _header_accept = ['application/json']
117
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
118
-
119
- # HTTP header 'Content-Type'
120
- _header_content_type = ['application/json']
121
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
122
-
123
- # form parameters
124
- form_params = {}
125
-
126
- # http body (model)
127
- post_body = nil
128
-
129
- auth_names = ['PureCloud Auth']
130
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
131
- :header_params => header_params,
132
- :query_params => query_params,
133
- :form_params => form_params,
134
- :body => post_body,
135
- :auth_names => auth_names,
136
- :return_type => 'KeyRotationSchedule')
137
- if @api_client.config.debugging
138
- @api_client.config.logger.debug "API called: ConfigurationApi#get_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
139
- end
140
- return data, status_code, headers
141
- end
142
-
143
- # Create encryption key
144
- #
145
- # @param [Hash] opts the optional parameters
146
- # @return [EncryptionKey]
147
- def post_recordingkeys(opts = {})
148
- data, status_code, headers = post_recordingkeys_with_http_info(opts)
149
- return data
150
- end
151
-
152
- # Create encryption key
153
- #
154
- # @param [Hash] opts the optional parameters
155
- # @return [Array<(EncryptionKey, Fixnum, Hash)>] EncryptionKey data, response status code and response headers
156
- def post_recordingkeys_with_http_info(opts = {})
157
- if @api_client.config.debugging
158
- @api_client.config.logger.debug "Calling API: ConfigurationApi#post_recordingkeys ..."
159
- end
160
-
161
- # resource path
162
- local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json')
163
-
164
- # query parameters
165
- query_params = {}
166
-
167
- # header parameters
168
- header_params = {}
169
-
170
- # HTTP header 'Accept' (if needed)
171
- _header_accept = ['application/json']
172
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
173
-
174
- # HTTP header 'Content-Type'
175
- _header_content_type = ['application/json']
176
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
177
-
178
- # form parameters
179
- form_params = {}
180
-
181
- # http body (model)
182
- post_body = nil
183
-
184
- auth_names = ['PureCloud Auth']
185
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
186
- :header_params => header_params,
187
- :query_params => query_params,
188
- :form_params => form_params,
189
- :body => post_body,
190
- :auth_names => auth_names,
191
- :return_type => 'EncryptionKey')
192
- if @api_client.config.debugging
193
- @api_client.config.logger.debug "API called: ConfigurationApi#post_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
194
- end
195
- return data, status_code, headers
196
- end
197
-
198
- # Update key rotation schedule
199
- #
200
- # @param body KeyRotationSchedule
201
- # @param [Hash] opts the optional parameters
202
- # @return [KeyRotationSchedule]
203
- def put_recordingkeys_rotationschedule(body, opts = {})
204
- data, status_code, headers = put_recordingkeys_rotationschedule_with_http_info(body, opts)
205
- return data
206
- end
207
-
208
- # Update key rotation schedule
209
- #
210
- # @param body KeyRotationSchedule
211
- # @param [Hash] opts the optional parameters
212
- # @return [Array<(KeyRotationSchedule, Fixnum, Hash)>] KeyRotationSchedule data, response status code and response headers
213
- def put_recordingkeys_rotationschedule_with_http_info(body, opts = {})
214
- if @api_client.config.debugging
215
- @api_client.config.logger.debug "Calling API: ConfigurationApi#put_recordingkeys_rotationschedule ..."
216
- end
217
-
218
- # verify the required parameter 'body' is set
219
- fail "Missing the required parameter 'body' when calling put_recordingkeys_rotationschedule" if body.nil?
220
-
221
- # resource path
222
- local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json')
223
-
224
- # query parameters
225
- query_params = {}
226
-
227
- # header parameters
228
- header_params = {}
229
-
230
- # HTTP header 'Accept' (if needed)
231
- _header_accept = ['application/json']
232
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
233
-
234
- # HTTP header 'Content-Type'
235
- _header_content_type = ['application/json']
236
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
237
-
238
- # form parameters
239
- form_params = {}
240
-
241
- # http body (model)
242
- post_body = @api_client.object_to_http_body(body)
243
-
244
- auth_names = ['PureCloud Auth']
245
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
246
- :header_params => header_params,
247
- :query_params => query_params,
248
- :form_params => form_params,
249
- :body => post_body,
250
- :auth_names => auth_names,
251
- :return_type => 'KeyRotationSchedule')
252
- if @api_client.config.debugging
253
- @api_client.config.logger.debug "API called: ConfigurationApi#put_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
254
- end
255
- return data, status_code, headers
256
- end
257
- end
258
- end