purecloud 0.38.1 → 0.39.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AuthorizationApi.html.md +0 -57
  5. data/doc_out/AvailableLanguageList.html.md +13 -0
  6. data/doc_out/BillingContact.html.md +20 -0
  7. data/doc_out/{FlowHistoryResultItemEntityListing.html.md → BillingContactListing.html.md} +3 -3
  8. data/doc_out/CallRecord.html.md +2 -2
  9. data/doc_out/CallableContactsDiagnostic.html.md +3 -3
  10. data/doc_out/CallableTimeSet.html.md +3 -3
  11. data/doc_out/Campaign.html.md +3 -3
  12. data/doc_out/CampaignDiagnostics.html.md +3 -3
  13. data/doc_out/CampaignSchedule.html.md +6 -6
  14. data/doc_out/CampaignSequence.html.md +8 -8
  15. data/doc_out/CampaignStats.html.md +4 -4
  16. data/doc_out/Condition.html.md +7 -7
  17. data/doc_out/ConnectRate.html.md +3 -3
  18. data/doc_out/ContactCallbackRequest.html.md +5 -5
  19. data/doc_out/ContactList.html.md +9 -9
  20. data/doc_out/ContactPhoneNumberColumn.html.md +3 -3
  21. data/doc_out/CreateCallbackCommand.html.md +1 -0
  22. data/doc_out/CreateUser.html.md +1 -1
  23. data/doc_out/CustomerInteractionCenter.html.md +18 -0
  24. data/doc_out/DialerAction.html.md +4 -4
  25. data/doc_out/DialerContact.html.md +5 -5
  26. data/doc_out/DialerRule.html.md +6 -6
  27. data/doc_out/DncList.html.md +6 -7
  28. data/doc_out/ExternalContact.html.md +1 -0
  29. data/doc_out/ExternalDataSource.html.md +14 -0
  30. data/doc_out/ExternalOrganization.html.md +1 -0
  31. data/doc_out/IdentityProviderApi.html.md +1011 -0
  32. data/doc_out/ImportStatus.html.md +5 -5
  33. data/doc_out/InitiateScreenRecording.html.md +15 -0
  34. data/doc_out/JsonNode.html.md +3 -3
  35. data/doc_out/Keyword.html.md +19 -0
  36. data/doc_out/KeywordSet.html.md +21 -0
  37. data/doc_out/KeywordSetEntityListing.html.md +22 -0
  38. data/doc_out/OAuthApi.html.md +45 -886
  39. data/doc_out/OAuthClient.html.md +2 -2
  40. data/doc_out/Okta.html.md +1 -1
  41. data/doc_out/OneLogin.html.md +1 -1
  42. data/doc_out/OrgMediaUtilization.html.md +1 -0
  43. data/doc_out/OutboundApi.html.md +3 -3
  44. data/doc_out/PaymentMethod.html.md +3 -0
  45. data/doc_out/PhoneNumberStatus.html.md +1 -1
  46. data/doc_out/PolicyActions.html.md +1 -0
  47. data/doc_out/PresenceApi.html.md +68 -17
  48. data/doc_out/QualityApi.html.md +361 -0
  49. data/doc_out/QueueUtilizationDiagnostic.html.md +8 -8
  50. data/doc_out/ResponseSet.html.md +3 -3
  51. data/doc_out/RoutingApi.html.md +15 -12
  52. data/doc_out/RoutingSkill.html.md +1 -2
  53. data/doc_out/RuleSet.html.md +6 -6
  54. data/doc_out/Salesforce.html.md +1 -1
  55. data/doc_out/ScheduleInterval.html.md +14 -0
  56. data/doc_out/SequenceSchedule.html.md +6 -6
  57. data/doc_out/Station.html.md +1 -0
  58. data/doc_out/StationsApi.html.md +3 -1
  59. data/doc_out/SupportCredit.html.md +16 -0
  60. data/doc_out/SupportCreditListing.html.md +22 -0
  61. data/doc_out/SystemPresence.html.md +15 -0
  62. data/doc_out/TelephonyProvidersEdgeApi.html.md +112 -1
  63. data/doc_out/TrunkRecordingEnabledCount.html.md +14 -0
  64. data/doc_out/UserImage.html.md +1 -1
  65. data/doc_out/UserMe.html.md +5 -1
  66. data/doc_out/UserRoutingSkill.html.md +2 -2
  67. data/doc_out/UsersApi.html.md +182 -0
  68. data/doc_out/WrapUpCodeMapping.html.md +5 -5
  69. data/doc_out/index.html.md +3 -3
  70. data/lib/purecloud.rb +15 -3
  71. data/lib/purecloud/api/authorization_api.rb +0 -60
  72. data/lib/purecloud/api/identity_provider_api.rb +1072 -0
  73. data/lib/purecloud/api/o_auth_api.rb +26 -906
  74. data/lib/purecloud/api/outbound_api.rb +2 -2
  75. data/lib/purecloud/api/presence_api.rb +67 -12
  76. data/lib/purecloud/api/quality_api.rb +378 -0
  77. data/lib/purecloud/api/routing_api.rb +21 -16
  78. data/lib/purecloud/api/stations_api.rb +3 -0
  79. data/lib/purecloud/api/telephony_providers_edge_api.rb +120 -0
  80. data/lib/purecloud/api/users_api.rb +189 -0
  81. data/lib/purecloud/api_client.rb +1 -1
  82. data/lib/purecloud/models/analytics_session.rb +1 -1
  83. data/lib/purecloud/models/available_language_list.rb +167 -0
  84. data/lib/purecloud/models/billing_contact.rb +237 -0
  85. data/lib/purecloud/models/{flow_history_result_item_entity_listing.rb → billing_contact_listing.rb} +2 -2
  86. data/lib/purecloud/models/call_record.rb +2 -1
  87. data/lib/purecloud/models/callable_contacts_diagnostic.rb +3 -0
  88. data/lib/purecloud/models/callable_time_set.rb +3 -3
  89. data/lib/purecloud/models/campaign.rb +3 -3
  90. data/lib/purecloud/models/campaign_diagnostics.rb +3 -0
  91. data/lib/purecloud/models/campaign_schedule.rb +7 -4
  92. data/lib/purecloud/models/campaign_sequence.rb +8 -3
  93. data/lib/purecloud/models/campaign_stats.rb +4 -0
  94. data/lib/purecloud/models/condition.rb +16 -0
  95. data/lib/purecloud/models/connect_rate.rb +3 -0
  96. data/lib/purecloud/models/contact_callback_request.rb +5 -0
  97. data/lib/purecloud/models/contact_list.rb +9 -3
  98. data/lib/purecloud/models/contact_phone_number_column.rb +3 -0
  99. data/lib/purecloud/models/create_callback_command.rb +12 -1
  100. data/lib/purecloud/models/create_user.rb +1 -0
  101. data/lib/purecloud/models/customer_interaction_center.rb +217 -0
  102. data/lib/purecloud/models/dialer_action.rb +31 -0
  103. data/lib/purecloud/models/dialer_contact.rb +5 -0
  104. data/lib/purecloud/models/dialer_rule.rb +15 -0
  105. data/lib/purecloud/models/dnc_list.rb +7 -14
  106. data/lib/purecloud/models/external_contact.rb +14 -1
  107. data/lib/purecloud/models/external_data_source.rb +176 -0
  108. data/lib/purecloud/models/external_organization.rb +14 -1
  109. data/lib/purecloud/models/import_status.rb +5 -0
  110. data/lib/purecloud/models/initiate_screen_recording.rb +187 -0
  111. data/lib/purecloud/models/json_node.rb +37 -37
  112. data/lib/purecloud/models/keyword.rb +227 -0
  113. data/lib/purecloud/models/keyword_set.rb +253 -0
  114. data/lib/purecloud/models/keyword_set_entity_listing.rb +257 -0
  115. data/lib/purecloud/models/o_auth_client.rb +3 -3
  116. data/lib/purecloud/models/okta.rb +11 -11
  117. data/lib/purecloud/models/one_login.rb +11 -11
  118. data/lib/purecloud/models/org_media_utilization.rb +17 -4
  119. data/lib/purecloud/models/organization_presence.rb +0 -9
  120. data/lib/purecloud/models/payment_method.rb +42 -1
  121. data/lib/purecloud/models/phone_number_status.rb +1 -0
  122. data/lib/purecloud/models/policy_actions.rb +14 -4
  123. data/lib/purecloud/models/queue_utilization_diagnostic.rb +8 -0
  124. data/lib/purecloud/models/response_set.rb +3 -3
  125. data/lib/purecloud/models/routing_skill.rb +2 -12
  126. data/lib/purecloud/models/routing_status.rb +1 -1
  127. data/lib/purecloud/models/rule_set.rb +6 -3
  128. data/lib/purecloud/models/salesforce.rb +11 -11
  129. data/lib/purecloud/models/{campaign_schedule_intervals.rb → schedule_interval.rb} +5 -5
  130. data/lib/purecloud/models/sequence_schedule.rb +7 -4
  131. data/lib/purecloud/models/station.rb +11 -1
  132. data/lib/purecloud/models/support_credit.rb +197 -0
  133. data/lib/purecloud/models/support_credit_listing.rb +257 -0
  134. data/lib/purecloud/models/system_presence.rb +187 -0
  135. data/lib/purecloud/models/trunk_recording_enabled_count.rb +177 -0
  136. data/lib/purecloud/models/user_image.rb +1 -0
  137. data/lib/purecloud/models/user_me.rb +50 -2
  138. data/lib/purecloud/models/user_routing_skill.rb +18 -11
  139. data/lib/purecloud/models/wrap_up_code_mapping.rb +5 -3
  140. data/lib/purecloud/version.rb +1 -1
  141. data/newVersion.md +1 -1
  142. data/swagger.json +1 -1
  143. data/version.json +1 -1
  144. metadata +32 -8
  145. data/doc_out/CampaignScheduleIntervals.html.md +0 -14
  146. data/doc_out/ObjectsApi.html.md +0 -69
  147. data/lib/purecloud/api/objects_api.rb +0 -87
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 72c401211de589c476c53f5bb0c369174ca89efc
4
- data.tar.gz: 0426cb0b02f21d55f73ab92228bfac965758af0a
3
+ metadata.gz: 130912a99b3374d435de473ea642b4b0ab6e3a4d
4
+ data.tar.gz: 44670776142ff8e4efdcf9936f9a6b1609bee05d
5
5
  SHA512:
6
- metadata.gz: 8ede94dc8d40338e6ca8487c3b6ed0096f6e8ef2fa0a1f8b5ff80f1f8ae38c0d5f34a3d2421d16d52e1d75b52d8653436d63ecf112515b1ac56568d3460d667a
7
- data.tar.gz: 9eae8a438a99386c1da62e5b6874163ffe5fdd98857a8e9003d2f1edba915fa7cad70034d2d9d35ba107de2fc18fafb897a6e1c3188cd866060ecfb6fc451073
6
+ metadata.gz: a65a0de8d0476da4f8d769e92ae4c71f3c9caf9e52c55b033ac811c22283f18d126c77c0608ce97a3a26330038f18a9397d430baf35e62ee58a7aa8af8f4339f
7
+ data.tar.gz: aec40d9bded099c460355a8501f896cba93bc0ba4b9bc89bbf434bfe2b7497269effc060ff2b5f4426c94f81e162bd5c93c7125366e4aad22ea07977aa5840e9
data/README.md CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.38.1
13
- - Build date: 2016-05-01T03:13:46.334Z
12
+ - Package version: 0.39.1
13
+ - Build date: 2016-05-08T03:13:39.710Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.38.1'
21
+ gem 'purecloud', '~> 0.39.1'
22
22
 
23
23
  ### Install from Git
24
24
 
data/config-ruby.json CHANGED
@@ -1 +1 @@
1
- {"gemVersion":"0.38.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.38.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
1
+ {"gemVersion":"0.39.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.39.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
data/doc_out/AuthorizationApi.html.md CHANGED
@@ -10,7 +10,6 @@ Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_roles_role_id**](AuthorizationApi.html#delete_roles_role_id) | **DELETE** /api/v2/authorization/roles/{roleId} | Delete an organization role.|
12
12
  |[**delete_user_id_roles**](AuthorizationApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.|
13
- |[**get_objects_object_id**](AuthorizationApi.html#get_objects_object_id) | **GET** /api/v2/authorization/objects/{objectId} | Returns a permission-protected object, showing the permission contexts it belongs to.|
14
13
  |[**get_permissions**](AuthorizationApi.html#get_permissions) | **GET** /api/v2/authorization/permissions | Get all permissions.|
15
14
  |[**get_products**](AuthorizationApi.html#get_products) | **GET** /api/v2/authorization/products | Get the list of enabled products|
16
15
  |[**get_roles**](AuthorizationApi.html#get_roles) | **GET** /api/v2/authorization/roles | Retrieve a list of all roles defined for the organization|
@@ -138,62 +137,6 @@ nil (empty response body)
138
137
 
139
138
 
140
139
 
141
- <a name="get_objects_object_id"></a>
142
-
143
- ## -[**AuthzObject**](AuthzObject.html) get_objects_object_id(object_id)
144
-
145
- Returns a permission-protected object, showing the permission contexts it belongs to.
146
-
147
-
148
-
149
- ### Example
150
- ~~~ruby
151
- # load the gem
152
- require 'purecloud'
153
- # setup authorization
154
- @secret = ENV['PURECLOUD_SECRET']
155
- @id = ENV['PURECLOUD_CLIENT_ID']
156
- environment = "mypurecloud.com"
157
-
158
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
159
-
160
- PureCloud.configure do |config|
161
- config.access_token = @authToken
162
- end
163
-
164
- api_instance = PureCloud::AuthorizationApi.new
165
-
166
- object_id = "object_id_example" # String | Object ID
167
-
168
-
169
- begin
170
- #Returns a permission-protected object, showing the permission contexts it belongs to.
171
- result = api_instance.get_objects_object_id(object_id)
172
- p result
173
- rescue PureCloud::ApiError => e
174
- puts "Exception when calling AuthorizationApi->get_objects_object_id: #{e}"
175
- end
176
- ~~~
177
-
178
- ### Parameters
179
-
180
- Name | Type | Description | Notes
181
- ------------- | ------------- | ------------- | -------------
182
- **object_id** | **String**| Object ID |
183
- {: class="table table-striped"}
184
-
185
-
186
- ### Return type
187
-
188
- [**AuthzObject**](AuthzObject.html)
189
-
190
- ### HTTP request headers
191
-
192
- - **Content-Type**: application/json
193
- - **Accept**: application/json
194
-
195
-
196
-
197
140
  <a name="get_permissions"></a>
198
141
 
199
142
  ## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_permissions(opts)
data/doc_out/AvailableLanguageList.html.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: AvailableLanguageList
3
+ ---
4
+ ## PureCloud::AvailableLanguageList
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **languages** | **Array&lt;String&gt;** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
data/doc_out/BillingContact.html.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: BillingContact
3
+ ---
4
+ ## PureCloud::BillingContact
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
+ | **first_name** | **String** | | [optional] |
13
+ | **last_name** | **String** | | [optional] |
14
+ | **email** | **String** | | [optional] |
15
+ | **phone** | **String** | | [optional] |
16
+ | **ivr_code** | **String** | | [optional] |
17
+ | **self_uri** | **String** | The URI for this object | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
data/doc_out/{FlowHistoryResultItemEntityListing.html.md → BillingContactListing.html.md} RENAMED
@@ -1,7 +1,7 @@
1
1
  ---
2
- title: FlowHistoryResultItemEntityListing
2
+ title: BillingContactListing
3
3
  ---
4
- ## PureCloud::FlowHistoryResultItemEntityListing
4
+ ## PureCloud::BillingContactListing
5
5
 
6
6
  ## Properties
7
7
 
@@ -10,7 +10,7 @@ title: FlowHistoryResultItemEntityListing
10
10
  | **page_size** | **Integer** | | [optional] |
11
11
  | **page_number** | **Integer** | | [optional] |
12
12
  | **total** | **Integer** | | [optional] |
13
- | **entities** | [**Array&lt;FlowHistoryResultItem&gt;**](FlowHistoryResultItem.html) | | [optional] |
13
+ | **entities** | [**Array&lt;BillingContact&gt;**](BillingContact.html) | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
data/doc_out/CallRecord.html.md CHANGED
@@ -7,8 +7,8 @@ title: CallRecord
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **last_attempt** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
- | **last_result** | **String** | | [optional] |
10
+ | **last_attempt** | **DateTime** | Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
+ | **last_result** | **String** | Result of the last attempt to reach this number | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
data/doc_out/CallableContactsDiagnostic.html.md CHANGED
@@ -7,9 +7,9 @@ title: CallableContactsDiagnostic
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **dnc_lists** | [**Array&lt;UriReference&gt;**](UriReference.html) | | [optional] |
11
- | **callable_time_set** | [**UriReference**](UriReference.html) | | [optional] |
12
- | **rule_sets** | [**Array&lt;UriReference&gt;**](UriReference.html) | | [optional] |
10
+ | **dnc_lists** | [**Array&lt;UriReference&gt;**](UriReference.html) | Do not call lists for the campaign | [optional] |
11
+ | **callable_time_set** | [**UriReference**](UriReference.html) | Callable time sets for the campaign | [optional] |
12
+ | **rule_sets** | [**Array&lt;UriReference&gt;**](UriReference.html) | Rule sets for the campaign | [optional] |
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/CallableTimeSet.html.md CHANGED
@@ -9,9 +9,9 @@ title: CallableTimeSet
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **date_created** | **DateTime** | creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **date_modified** | **DateTime** | last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **version** | **Integer** | required for updates, must match the version number of the most recent update | [optional] |
12
+ | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
15
  | **callable_times** | [**Array&lt;CallableTime&gt;**](CallableTime.html) | list of time/timezone groupings for which it is acceptable to place outbound calls | [optional] |
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
data/doc_out/Campaign.html.md CHANGED
@@ -9,9 +9,9 @@ title: Campaign
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **date_created** | **DateTime** | creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **date_modified** | **DateTime** | last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **version** | **Integer** | required for updates, must match the version number of the most recent update | [optional] |
12
+ | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
15
  | **contact_list** | [**UriReference**](UriReference.html) | identifier of the contact list for the campaign | |
16
16
  | **queue** | [**UriReference**](UriReference.html) | identifier of the agent assignment queue, required for all dialing modes other than agentless | |
17
17
  | **dialing_mode** | **String** | dialing mode of the campaign | |
data/doc_out/CampaignDiagnostics.html.md CHANGED
@@ -7,9 +7,9 @@ title: CampaignDiagnostics
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **callable_contacts** | [**CallableContactsDiagnostic**](CallableContactsDiagnostic.html) | | [optional] |
11
- | **queue_utilization_diagnostic** | [**QueueUtilizationDiagnostic**](QueueUtilizationDiagnostic.html) | | [optional] |
12
- | **outstanding_interactions_count** | **Integer** | | [optional] |
10
+ | **callable_contacts** | [**CallableContactsDiagnostic**](CallableContactsDiagnostic.html) | Campaign properties that can impact which contacts are callable | [optional] |
11
+ | **queue_utilization_diagnostic** | [**QueueUtilizationDiagnostic**](QueueUtilizationDiagnostic.html) | Information regarding the campaign&#39;s queue | [optional] |
12
+ | **outstanding_interactions_count** | **Integer** | Current number of outstanding interactions on the campaign | [optional] |
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/CampaignSchedule.html.md CHANGED
@@ -9,12 +9,12 @@ title: CampaignSchedule
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **date_created** | **DateTime** | creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **date_modified** | **DateTime** | last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **version** | **Integer** | required for updates, must match the version number of the most recent update | [optional] |
15
- | **intervals** | [**Array&lt;CampaignScheduleIntervals&gt;**](CampaignScheduleIntervals.html) | | [optional] |
16
- | **time_zone** | **String** | | [optional] |
17
- | **campaign** | [**UriReference**](UriReference.html) | | [optional] |
12
+ | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
+ | **intervals** | [**Array&lt;ScheduleInterval&gt;**](ScheduleInterval.html) | a list of start and end times | |
16
+ | **time_zone** | **String** | time zone identifier to be applied to the intervals; for example Africa/Abidjan | |
17
+ | **campaign** | [**UriReference**](UriReference.html) | identifier of the campaign to be scheduled | |
18
18
  | **self_uri** | **String** | The URI for this object | [optional] |
19
19
  {: class="table table-striped"}
20
20
 
data/doc_out/CampaignSequence.html.md CHANGED
@@ -9,14 +9,14 @@ title: CampaignSequence
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **date_created** | **DateTime** | creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **date_modified** | **DateTime** | last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **version** | **Integer** | required for updates, must match the version number of the most recent update | [optional] |
15
- | **campaigns** | [**Array&lt;UriReference&gt;**](UriReference.html) | | [optional] |
16
- | **current_campaign** | **Integer** | | [optional] |
17
- | **status** | **String** | | [optional] |
18
- | **stop_message** | **String** | | [optional] |
19
- | **repeat** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
+ | **campaigns** | [**Array&lt;UriReference&gt;**](UriReference.html) | the ordered list of campaign identifiers | |
16
+ | **current_campaign** | **Integer** | the zero-based index of the current campaign in the campaigns list | |
17
+ | **status** | **String** | status of the sequence | |
18
+ | **stop_message** | **String** | if a sequence has unexpectedly stopped, this message provides the reason | [optional] |
19
+ | **repeat** | **BOOLEAN** | indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false | [optional] [default to false]|
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
data/doc_out/CampaignStats.html.md CHANGED
@@ -7,10 +7,10 @@ title: CampaignStats
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **contact_rate** | [**ConnectRate**](ConnectRate.html) | | [optional] |
11
- | **idle_agents** | **Integer** | | [optional] |
12
- | **adjusted_calls_per_agent** | **Float** | | [optional] |
13
- | **outstanding_calls** | **Integer** | | [optional] |
10
+ | **contact_rate** | [**ConnectRate**](ConnectRate.html) | Information regarding the campaign&#39;s connect rate | [optional] |
11
+ | **idle_agents** | **Integer** | Number of available agents not currently being utilized | [optional] |
12
+ | **adjusted_calls_per_agent** | **Float** | Calls per agent adjusted by pace | [optional] |
13
+ | **outstanding_calls** | **Integer** | Number of campaign calls currently ongoing | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
data/doc_out/Condition.html.md CHANGED
@@ -7,13 +7,13 @@ title: Condition
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **type** | **String** | | [optional] |
11
- | **inverted** | **BOOLEAN** | | [optional] [default to false]|
12
- | **attribute_name** | **String** | | [optional] |
13
- | **value** | **String** | | [optional] |
14
- | **value_type** | **String** | | [optional] |
15
- | **operator** | **String** | | [optional] |
16
- | **codes** | **Array&lt;String&gt;** | | [optional] |
10
+ | **type** | **String** | The type of the condition | [optional] |
11
+ | **inverted** | **BOOLEAN** | Indicates whether to evaluate for the opposite of the stated condition; default is false | [optional] [default to false]|
12
+ | **attribute_name** | **String** | An attribute name associated with the condition (applies only to certain rule conditions) | [optional] |
13
+ | **value** | **String** | A value associated with the condition | [optional] |
14
+ | **value_type** | **String** | Determines the type of the value associated with the condition | [optional] |
15
+ | **operator** | **String** | An operation type for condition evaluation | [optional] |
16
+ | **codes** | **Array&lt;String&gt;** | List of wrap-up code identifiers (used only in conditions of type &#39;wrapupCondition&#39;) | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
19
19
 
data/doc_out/ConnectRate.html.md CHANGED
@@ -7,9 +7,9 @@ title: ConnectRate
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **attempts** | **Integer** | | [optional] |
11
- | **connects** | **Integer** | | [optional] |
12
- | **connect_ratio** | **Float** | | [optional] |
10
+ | **attempts** | **Integer** | Number of call attempts made | [optional] |
11
+ | **connects** | **Integer** | Number of calls with a live voice detected | [optional] |
12
+ | **connect_ratio** | **Float** | Ratio of connects to attempts | [optional] |
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/ContactCallbackRequest.html.md CHANGED
@@ -7,11 +7,11 @@ title: ContactCallbackRequest
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **campaign_id** | **String** | | [optional] |
11
- | **contact_list_id** | **String** | | [optional] |
12
- | **contact_id** | **String** | | [optional] |
13
- | **phone_column** | **String** | | [optional] |
14
- | **schedule** | **String** | | [optional] |
10
+ | **campaign_id** | **String** | Campaign identifier | |
11
+ | **contact_list_id** | **String** | Contact list identifier | |
12
+ | **contact_id** | **String** | Contact identifier | |
13
+ | **phone_column** | **String** | Name of the phone column containing the number to be called | |
14
+ | **schedule** | **String** | The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\&quot;, example = \&quot;2016-01-02T16:59:59\&quot; | |
15
15
  {: class="table table-striped"}
16
16
 
17
17
 
data/doc_out/ContactList.html.md CHANGED
@@ -9,15 +9,15 @@ title: ContactList
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **date_created** | **DateTime** | creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
- | **date_modified** | **DateTime** | last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **version** | **Integer** | required for updates, must match the version number of the most recent update | [optional] |
15
- | **column_names** | **Array&lt;String&gt;** | | [optional] |
16
- | **phone_columns** | [**Array&lt;ContactPhoneNumberColumn&gt;**](ContactPhoneNumberColumn.html) | | [optional] |
17
- | **import_status** | [**ImportStatus**](ImportStatus.html) | | [optional] |
18
- | **preview_mode_column_name** | **String** | | [optional] |
19
- | **preview_mode_accepted_values** | **Array&lt;String&gt;** | | [optional] |
20
- | **size** | **Integer** | | [optional] |
12
+ | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
+ | **column_names** | **Array&lt;String&gt;** | the contact column names | |
16
+ | **phone_columns** | [**Array&lt;ContactPhoneNumberColumn&gt;**](ContactPhoneNumberColumn.html) | the columns containing phone numbers | |
17
+ | **import_status** | [**ImportStatus**](ImportStatus.html) | the status of the import process | [optional] |
18
+ | **preview_mode_column_name** | **String** | the name of the column that holds the indicators for contacts that are to be dialed in preview mode only | [optional] |
19
+ | **preview_mode_accepted_values** | **Array&lt;String&gt;** | list of user-defined values indicating the contact is to be dialed in preview mode only | [optional] |
20
+ | **size** | **Integer** | the number of contacts in the contact list | [optional] |
21
21
  | **self_uri** | **String** | The URI for this object | [optional] |
22
22
  {: class="table table-striped"}
23
23
 
data/doc_out/ContactPhoneNumberColumn.html.md CHANGED
@@ -7,9 +7,9 @@ title: ContactPhoneNumberColumn
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **column_name** | **String** | | [optional] |
11
- | **type** | **String** | | [optional] |
12
- | **callable_time_column** | **String** | | [optional] |
10
+ | **column_name** | **String** | name of the phone column | |
11
+ | **type** | **String** | type of the phone column, for example, &#39;cell&#39; or &#39;home&#39; | |
12
+ | **callable_time_column** | **String** | name of the column indicating the timezone to be considered for determining callable times | [optional] |
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/CreateCallbackCommand.html.md CHANGED
@@ -11,6 +11,7 @@ title: CreateCallbackCommand
11
11
  | **queue_id** | **String** | | [optional] |
12
12
  | **callback_user_name** | **String** | | [optional] |
13
13
  | **callback_numbers** | **Array&lt;String&gt;** | | [optional] |
14
+ | **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
15
  | **country_code** | **String** | | [optional] |
15
16
  | **skip_enabled** | **BOOLEAN** | | [optional] [default to false]|
16
17
  {: class="table table-striped"}
data/doc_out/CreateUser.html.md CHANGED
@@ -7,7 +7,7 @@ title: CreateUser
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **name** | **String** | | [optional] |
10
+ | **name** | **String** | User&#39;s full name | |
11
11
  | **department** | **String** | | [optional] |
12
12
  | **email** | **String** | User&#39;s email and username | |
13
13
  | **addresses** | [**Array&lt;Contact&gt;**](Contact.html) | Email addresses and phone numbers for this user | [optional] |
data/doc_out/CustomerInteractionCenter.html.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: CustomerInteractionCenter
3
+ ---
4
+ ## PureCloud::CustomerInteractionCenter
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
+ | **certificate** | **String** | | [optional] |
13
+ | **sso_target_uri** | **String** | | [optional] |
14
+ | **issuer_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | The URI for this object | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
data/doc_out/DialerAction.html.md CHANGED
@@ -7,10 +7,10 @@ title: DialerAction
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **type** | **String** | | [optional] |
11
- | **action_type_name** | **String** | | [optional] |
12
- | **update_option** | **String** | | [optional] |
13
- | **properties** | **Hash&lt;String, String&gt;** | | [optional] |
10
+ | **type** | **String** | Type of the action | |
11
+ | **action_type_name** | **String** | Identifier of the action | |
12
+ | **update_option** | **String** | Indicator of the type of update action (applicable only to certain types of actions) | [optional] |
13
+ | **properties** | **Hash&lt;String, String&gt;** | Map of key-value pairs pertinent to the action (different actions require different properties) | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
data/doc_out/DialerContact.html.md CHANGED
@@ -9,11 +9,11 @@ title: DialerContact
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **contact_list_id** | **String** | | [optional] |
13
- | **data** | **Hash&lt;String, Object&gt;** | | [optional] |
14
- | **call_records** | [**Hash&lt;String, CallRecord&gt;**](CallRecord.html) | | [optional] |
15
- | **callable** | **BOOLEAN** | | [optional] [default to false]|
16
- | **phone_number_status** | [**Hash&lt;String, PhoneNumberStatus&gt;**](PhoneNumberStatus.html) | | [optional] |
12
+ | **contact_list_id** | **String** | Identifier of the contact list containing this contact | |
13
+ | **data** | **Hash&lt;String, Object&gt;** | A map of the contact&#39;s data attributes and values | [optional] |
14
+ | **call_records** | [**Hash&lt;String, CallRecord&gt;**](CallRecord.html) | A map of call records for the contact phone columns | [optional] |
15
+ | **callable** | **BOOLEAN** | false if the contact is not to be called | [optional] [default to false]|
16
+ | **phone_number_status** | [**Hash&lt;String, PhoneNumberStatus&gt;**](PhoneNumberStatus.html) | A map of statuses for the contact phone columns | [optional] |
17
17
  | **self_uri** | **String** | The URI for this object | [optional] |
18
18
  {: class="table table-striped"}
19
19