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
@@ -12,9 +12,9 @@ title: OAuthClient
12
12
  | **access_token_validity_seconds** | **Integer** | The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied. | [optional] |
13
13
  | **description** | **String** | | [optional] |
14
14
  | **registered_redirect_uri** | **Array<String>** | List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback | |
15
- | **secret** | **String** | System created secret assigned to this client. Secrets are required for code authorization grants. | [optional] |
15
+ | **secret** | **String** | System created secret assigned to this client. Secrets are required for code authorization and client credential grants. | [optional] |
16
16
  | **role_ids** | **Array<String>** | Roles assigned to this client. Roles only apply to clients using the client_credential grant | [optional] |
17
- | **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. | |
17
+ | **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n | [optional] |
18
18
  | **self_uri** | **String** | The URI for this object | [optional] |
19
19
  {: class="table table-striped"}
20
20
 
data/doc_out/Okta.html.md CHANGED
@@ -10,8 +10,8 @@ title: Okta
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **certificate** | **String** | | [optional] |
13
- | **issuer_uri** | **String** | | [optional] |
14
13
  | **sso_target_uri** | **String** | | [optional] |
14
+ | **issuer_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | The URI for this object | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
@@ -10,8 +10,8 @@ title: OneLogin
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **certificate** | **String** | | [optional] |
13
- | **issuer_uri** | **String** | | [optional] |
14
13
  | **sso_target_uri** | **String** | | [optional] |
14
+ | **issuer_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | The URI for this object | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
@@ -9,6 +9,7 @@ title: OrgMediaUtilization
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **maximum_capacity** | **Integer** | Defines the maximum number of conversations of this type that an agent can handle at one time. | [optional] |
11
11
  | **interruptable_media_types** | **Array<String>** | Defines the list of other media types that can interrupt a conversation of this media type. Values can be: call, chat, email, or socialExpression | [optional] |
12
+ | **include_non_acd** | **BOOLEAN** | If true, then track non-ACD conversations against utilization | [optional] [default to false]|
12
13
  {: class="table table-striped"}
13
14
 
14
15
 
@@ -29,7 +29,7 @@ Method | HTTP request | Description
29
29
  |[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress|
30
30
  |[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign|
31
31
  |[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.|
32
- |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get dialer contactList.|
32
+ |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get a dialer contact list.|
33
33
  |[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get dialer contactList.|
34
34
  |[**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | **GET** /api/v2/outbound/contactlists/{contactListId}/export | Get the URI of a contact list export.|
35
35
  |[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.|
@@ -1316,7 +1316,7 @@ Name | Type | Description | Notes
1316
1316
 
1317
1317
  ## -[**ContactList**](ContactList.html) get_contactlists_contactlist_id(contact_list_id, opts)
1318
1318
 
1319
- Get dialer contactList.
1319
+ Get a dialer contact list.
1320
1320
 
1321
1321
 
1322
1322
 
@@ -1345,7 +1345,7 @@ opts = {
1345
1345
  }
1346
1346
 
1347
1347
  begin
1348
- #Get dialer contactList.
1348
+ #Get a dialer contact list.
1349
1349
  result = api_instance.get_contactlists_contactlist_id(contact_list_id, opts)
1350
1350
  p result
1351
1351
  rescue PureCloud::ApiError => e
@@ -12,6 +12,9 @@ title: PaymentMethod
12
12
  | **type** | **String** | | [optional] |
13
13
  | **provider_name** | **String** | | [optional] |
14
14
  | **token** | **String** | | [optional] |
15
+ | **card_expiration_date** | **String** | for payment methods of type CARD_TOKEN, the card's expiration date in the format YYYY-MM. | [optional] |
16
+ | **card_last_four_digits** | **String** | | [optional] |
17
+ | **card_type** | **String** | for payment methods of type CARD_TOKEN, the type of credit or debit card | [optional] |
15
18
  | **self_uri** | **String** | The URI for this object | [optional] |
16
19
  {: class="table table-striped"}
17
20
 
@@ -7,7 +7,7 @@ title: PhoneNumberStatus
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **callable** | **BOOLEAN** | | [optional] [default to false]|
10
+ | **callable** | **BOOLEAN** | false if the phone number is not callable | [optional] [default to false]|
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -13,6 +13,7 @@ title: PolicyActions
13
13
  | **assign_metered_evaluations** | [**Array<MeteredEvaluationAssignment>**](MeteredEvaluationAssignment.html) | | [optional] |
14
14
  | **assign_calibrations** | [**Array<CalibrationAssignment>**](CalibrationAssignment.html) | | [optional] |
15
15
  | **retention_duration** | [**RetentionDuration**](RetentionDuration.html) | | [optional] |
16
+ | **initiate_screen_recording** | [**InitiateScreenRecording**](InitiateScreenRecording.html) | | [optional] |
16
17
  {: class="table table-striped"}
17
18
 
18
19
 
@@ -8,20 +8,21 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete an OrganizationPresence|
12
- |[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get an OrganizationPresence|
13
- |[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presences|
11
+ |[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete a Presence Definition|
12
+ |[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get a Presence Definition|
13
+ |[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
14
+ |[**get_systempresences**](PresenceApi.html#get_systempresences) | **GET** /api/v2/systempresences | Get the list of SystemPresences|
14
15
  |[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | **GET** /api/v2/users/{userId}/presences/{sourceId} | Get a user's Presence|
15
16
  |[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | **PATCH** /api/v2/users/{userId}/presences/{sourceId} | Patch a user's Presence|
16
- |[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create an OrganizationPresence|
17
- |[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update an OrganizationPresence|
17
+ |[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
18
+ |[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update a Presence Definition|
18
19
  {: class="table table-striped"}
19
20
 
20
21
  <a name="delete_presence_id"></a>
21
22
 
22
23
  ## -[**OrganizationPresence**](OrganizationPresence.html) delete_presence_id(presence_id)
23
24
 
24
- Delete an OrganizationPresence
25
+ Delete a Presence Definition
25
26
 
26
27
 
27
28
 
@@ -46,7 +47,7 @@ presence_id = "presence_id_example" # String | Organization Presence ID
46
47
 
47
48
 
48
49
  begin
49
- #Delete an OrganizationPresence
50
+ #Delete a Presence Definition
50
51
  result = api_instance.delete_presence_id(presence_id)
51
52
  p result
52
53
  rescue PureCloud::ApiError => e
@@ -77,7 +78,7 @@ Name | Type | Description | Notes
77
78
 
78
79
  ## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id)
79
80
 
80
- Get an OrganizationPresence
81
+ Get a Presence Definition
81
82
 
82
83
 
83
84
 
@@ -102,7 +103,7 @@ presence_id = "presence_id_example" # String | Organization Presence ID
102
103
 
103
104
 
104
105
  begin
105
- #Get an OrganizationPresence
106
+ #Get a Presence Definition
106
107
  result = api_instance.get_presence_id(presence_id)
107
108
  p result
108
109
  rescue PureCloud::ApiError => e
@@ -133,7 +134,7 @@ Name | Type | Description | Notes
133
134
 
134
135
  ## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts)
135
136
 
136
- Get an Organization's list of Presences
137
+ Get an Organization's list of Presence Definitions
137
138
 
138
139
 
139
140
 
@@ -160,7 +161,7 @@ opts = {
160
161
  }
161
162
 
162
163
  begin
163
- #Get an Organization's list of Presences
164
+ #Get an Organization's list of Presence Definitions
164
165
  result = api_instance.get_presencedefinitions(opts)
165
166
  p result
166
167
  rescue PureCloud::ApiError => e
@@ -188,6 +189,56 @@ Name | Type | Description | Notes
188
189
 
189
190
 
190
191
 
192
+ <a name="get_systempresences"></a>
193
+
194
+ ## -[**SystemPresence**](SystemPresence.html) get_systempresences
195
+
196
+ Get the list of SystemPresences
197
+
198
+
199
+
200
+ ### Example
201
+ ~~~ruby
202
+ # load the gem
203
+ require 'purecloud'
204
+ # setup authorization
205
+ @secret = ENV['PURECLOUD_SECRET']
206
+ @id = ENV['PURECLOUD_CLIENT_ID']
207
+ environment = "mypurecloud.com"
208
+
209
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
210
+
211
+ PureCloud.configure do |config|
212
+ config.access_token = @authToken
213
+ end
214
+
215
+ api_instance = PureCloud::PresenceApi.new
216
+
217
+ begin
218
+ #Get the list of SystemPresences
219
+ result = api_instance.get_systempresences
220
+ p result
221
+ rescue PureCloud::ApiError => e
222
+ puts "Exception when calling PresenceApi->get_systempresences: #{e}"
223
+ end
224
+ ~~~
225
+
226
+ ### Parameters
227
+ This endpoint does not need any parameter.
228
+ {: class="table table-striped"}
229
+
230
+
231
+ ### Return type
232
+
233
+ [**SystemPresence**](SystemPresence.html)
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: application/json
238
+ - **Accept**: application/json
239
+
240
+
241
+
191
242
  <a name="get_user_id_presences_source_id"></a>
192
243
 
193
244
  ## -[**UserPresence**](UserPresence.html) get_user_id_presences_source_id(user_id, source_id)
@@ -314,7 +365,7 @@ Name | Type | Description | Notes
314
365
 
315
366
  ## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body)
316
367
 
317
- Create an OrganizationPresence
368
+ Create a Presence Definition
318
369
 
319
370
 
320
371
 
@@ -335,11 +386,11 @@ end
335
386
 
336
387
  api_instance = PureCloud::PresenceApi.new
337
388
 
338
- body = PureCloud::OrganizationPresence.new # OrganizationPresence | The OrganizationPresence to create
389
+ body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Presence Definition to create
339
390
 
340
391
 
341
392
  begin
342
- #Create an OrganizationPresence
393
+ #Create a Presence Definition
343
394
  result = api_instance.post_presencedefinitions(body)
344
395
  p result
345
396
  rescue PureCloud::ApiError => e
@@ -351,7 +402,7 @@ end
351
402
 
352
403
  Name | Type | Description | Notes
353
404
  ------------- | ------------- | ------------- | -------------
354
- **body** | [**OrganizationPresence**](OrganizationPresence.html)| The OrganizationPresence to create |
405
+ **body** | [**OrganizationPresence**](OrganizationPresence.html)| The Presence Definition to create |
355
406
  {: class="table table-striped"}
356
407
 
357
408
 
@@ -370,7 +421,7 @@ Name | Type | Description | Notes
370
421
 
371
422
  ## -[**OrganizationPresence**](OrganizationPresence.html) put_presence_id(presence_id, body)
372
423
 
373
- Update an OrganizationPresence
424
+ Update a Presence Definition
374
425
 
375
426
 
376
427
 
@@ -397,7 +448,7 @@ body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Organiza
397
448
 
398
449
 
399
450
  begin
400
- #Update an OrganizationPresence
451
+ #Update a Presence Definition
401
452
  result = api_instance.put_presence_id(presence_id, body)
402
453
  p result
403
454
  rescue PureCloud::ApiError => e
@@ -11,6 +11,8 @@ Method | HTTP request | Description
11
11
  |[**delete_calibrations_calibration_id**](QualityApi.html#delete_calibrations_calibration_id) | **DELETE** /api/v2/quality/calibrations/{calibrationId} | Delete a calibration by id.|
12
12
  |[**delete_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#delete_conversations_conversation_id_evaluations_evaluation_id) | **DELETE** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Delete an evaluation|
13
13
  |[**delete_forms_form_id**](QualityApi.html#delete_forms_form_id) | **DELETE** /api/v2/quality/forms/{formId} | Delete an evaluation form.|
14
+ |[**delete_keywordsets**](QualityApi.html#delete_keywordsets) | **DELETE** /api/v2/quality/keywordsets | Delete keyword sets|
15
+ |[**delete_keywordsets_keywordset_id**](QualityApi.html#delete_keywordsets_keywordset_id) | **DELETE** /api/v2/quality/keywordsets/{keywordSetId} | Delete a keywordSet by id.|
14
16
  |[**get_agents_activity**](QualityApi.html#get_agents_activity) | **GET** /api/v2/quality/agents/activity | Gets a list of Agent Activities|
15
17
  |[**get_calibrations**](QualityApi.html#get_calibrations) | **GET** /api/v2/quality/calibrations | Get the list of calibrations|
16
18
  |[**get_calibrations_calibration_id**](QualityApi.html#get_calibrations_calibration_id) | **GET** /api/v2/quality/calibrations/{calibrationId} | Get a calibration by id.|
@@ -21,6 +23,8 @@ Method | HTTP request | Description
21
23
  |[**get_forms**](QualityApi.html#get_forms) | **GET** /api/v2/quality/forms | Get the list of evaluation forms|
22
24
  |[**get_forms_form_id**](QualityApi.html#get_forms_form_id) | **GET** /api/v2/quality/forms/{formId} | Get an evaluation form|
23
25
  |[**get_forms_form_id_versions**](QualityApi.html#get_forms_form_id_versions) | **GET** /api/v2/quality/forms/{formId}/versions | Gets all the revisions for a specific evaluation.|
26
+ |[**get_keywordsets**](QualityApi.html#get_keywordsets) | **GET** /api/v2/quality/keywordsets | Get the list of keyword sets|
27
+ |[**get_keywordsets_keywordset_id**](QualityApi.html#get_keywordsets_keywordset_id) | **GET** /api/v2/quality/keywordsets/{keywordSetId} | Get a keywordSet by id.|
24
28
  |[**get_publishedforms**](QualityApi.html#get_publishedforms) | **GET** /api/v2/quality/publishedforms | Get the published evaluation forms.|
25
29
  |[**get_publishedforms_form_id**](QualityApi.html#get_publishedforms_form_id) | **GET** /api/v2/quality/publishedforms/{formId} | Get the published evaluation forms.|
26
30
  |[**post_calibrations**](QualityApi.html#post_calibrations) | **POST** /api/v2/quality/calibrations | Create a calibration|
@@ -28,10 +32,12 @@ Method | HTTP request | Description
28
32
  |[**post_evaluations_aggregates_query**](QualityApi.html#post_evaluations_aggregates_query) | **POST** /api/v2/analytics/evaluations/aggregates/query | Query for evaluation aggregates|
29
33
  |[**post_evaluations_scoring**](QualityApi.html#post_evaluations_scoring) | **POST** /api/v2/quality/evaluations/scoring | Score evaluation|
30
34
  |[**post_forms**](QualityApi.html#post_forms) | **POST** /api/v2/quality/forms | Create an evaluation form.|
35
+ |[**post_keywordsets**](QualityApi.html#post_keywordsets) | **POST** /api/v2/quality/keywordsets | Create a Keyword Set|
31
36
  |[**post_publishedforms**](QualityApi.html#post_publishedforms) | **POST** /api/v2/quality/publishedforms | Publish an evaluation form.|
32
37
  |[**put_calibrations_calibration_id**](QualityApi.html#put_calibrations_calibration_id) | **PUT** /api/v2/quality/calibrations/{calibrationId} | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex|
33
38
  |[**put_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#put_conversations_conversation_id_evaluations_evaluation_id) | **PUT** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Update an evaluation|
34
39
  |[**put_forms_form_id**](QualityApi.html#put_forms_form_id) | **PUT** /api/v2/quality/forms/{formId} | Update an evaluation form.|
40
+ |[**put_keywordsets_keywordset_id**](QualityApi.html#put_keywordsets_keywordset_id) | **PUT** /api/v2/quality/keywordsets/{keywordSetId} | Update a keywordSet to the specified keywordSet via PUT.|
35
41
  {: class="table table-striped"}
36
42
 
37
43
  <a name="delete_calibrations_calibration_id"></a>
@@ -212,6 +218,117 @@ Name | Type | Description | Notes
212
218
 
213
219
 
214
220
 
221
+ <a name="delete_keywordsets"></a>
222
+
223
+ ## -String** delete_keywordsets(ids)
224
+
225
+ Delete keyword sets
226
+
227
+ Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
228
+
229
+ ### Example
230
+ ~~~ruby
231
+ # load the gem
232
+ require 'purecloud'
233
+ # setup authorization
234
+ @secret = ENV['PURECLOUD_SECRET']
235
+ @id = ENV['PURECLOUD_CLIENT_ID']
236
+ environment = "mypurecloud.com"
237
+
238
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
239
+
240
+ PureCloud.configure do |config|
241
+ config.access_token = @authToken
242
+ end
243
+
244
+ api_instance = PureCloud::QualityApi.new
245
+
246
+ ids = "ids_example" # String | A comma-delimited list of valid KeywordSet ids
247
+
248
+
249
+ begin
250
+ #Delete keyword sets
251
+ result = api_instance.delete_keywordsets(ids)
252
+ p result
253
+ rescue PureCloud::ApiError => e
254
+ puts "Exception when calling QualityApi->delete_keywordsets: #{e}"
255
+ end
256
+ ~~~
257
+
258
+ ### Parameters
259
+
260
+ Name | Type | Description | Notes
261
+ ------------- | ------------- | ------------- | -------------
262
+ **ids** | **String**| A comma-delimited list of valid KeywordSet ids |
263
+ {: class="table table-striped"}
264
+
265
+
266
+ ### Return type
267
+
268
+ **String**
269
+
270
+ ### HTTP request headers
271
+
272
+ - **Content-Type**: application/json
273
+ - **Accept**: application/json
274
+
275
+
276
+
277
+ <a name="delete_keywordsets_keywordset_id"></a>
278
+
279
+ ## - delete_keywordsets_keywordset_id(keyword_set_id)
280
+
281
+ Delete a keywordSet by id.
282
+
283
+
284
+
285
+ ### Example
286
+ ~~~ruby
287
+ # load the gem
288
+ require 'purecloud'
289
+ # setup authorization
290
+ @secret = ENV['PURECLOUD_SECRET']
291
+ @id = ENV['PURECLOUD_CLIENT_ID']
292
+ environment = "mypurecloud.com"
293
+
294
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
295
+
296
+ PureCloud.configure do |config|
297
+ config.access_token = @authToken
298
+ end
299
+
300
+ api_instance = PureCloud::QualityApi.new
301
+
302
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
303
+
304
+
305
+ begin
306
+ #Delete a keywordSet by id.
307
+ api_instance.delete_keywordsets_keywordset_id(keyword_set_id)
308
+ rescue PureCloud::ApiError => e
309
+ puts "Exception when calling QualityApi->delete_keywordsets_keywordset_id: #{e}"
310
+ end
311
+ ~~~
312
+
313
+ ### Parameters
314
+
315
+ Name | Type | Description | Notes
316
+ ------------- | ------------- | ------------- | -------------
317
+ **keyword_set_id** | **String**| KeywordSet ID |
318
+ {: class="table table-striped"}
319
+
320
+
321
+ ### Return type
322
+
323
+ nil (empty response body)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: application/json
328
+ - **Accept**: application/json
329
+
330
+
331
+
215
332
  <a name="get_agents_activity"></a>
216
333
 
217
334
  ## -[**AgentActivityEntityListing**](AgentActivityEntityListing.html) get_agents_activity(opts)
@@ -916,6 +1033,131 @@ Name | Type | Description | Notes
916
1033
 
917
1034
 
918
1035
 
1036
+ <a name="get_keywordsets"></a>
1037
+
1038
+ ## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_keywordsets(opts)
1039
+
1040
+ Get the list of keyword sets
1041
+
1042
+
1043
+
1044
+ ### Example
1045
+ ~~~ruby
1046
+ # load the gem
1047
+ require 'purecloud'
1048
+ # setup authorization
1049
+ @secret = ENV['PURECLOUD_SECRET']
1050
+ @id = ENV['PURECLOUD_CLIENT_ID']
1051
+ environment = "mypurecloud.com"
1052
+
1053
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1054
+
1055
+ PureCloud.configure do |config|
1056
+ config.access_token = @authToken
1057
+ end
1058
+
1059
+ api_instance = PureCloud::QualityApi.new
1060
+
1061
+ opts = {
1062
+ page_size: 25, # Integer | The total page size requested
1063
+ page_number: 1, # Integer | The page number requested
1064
+ sort_by: "sort_by_example", # String | variable name requested to sort by
1065
+ expand: ["expand_example"], # Array<String> | variable name requested by expand list
1066
+ next_page: "next_page_example", # String | next page token
1067
+ previous_page: "previous_page_example", # String | Previous page token
1068
+ name: "name_example" # String | the keyword set name - used for filtering results in searches.
1069
+ }
1070
+
1071
+ begin
1072
+ #Get the list of keyword sets
1073
+ result = api_instance.get_keywordsets(opts)
1074
+ p result
1075
+ rescue PureCloud::ApiError => e
1076
+ puts "Exception when calling QualityApi->get_keywordsets: #{e}"
1077
+ end
1078
+ ~~~
1079
+
1080
+ ### Parameters
1081
+
1082
+ Name | Type | Description | Notes
1083
+ ------------- | ------------- | ------------- | -------------
1084
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
1085
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
1086
+ **sort_by** | **String**| variable name requested to sort by | [optional]
1087
+ **expand** | [**Array&lt;String&gt;**](String.html)| variable name requested by expand list | [optional]
1088
+ **next_page** | **String**| next page token | [optional]
1089
+ **previous_page** | **String**| Previous page token | [optional]
1090
+ **name** | **String**| the keyword set name - used for filtering results in searches. | [optional]
1091
+ {: class="table table-striped"}
1092
+
1093
+
1094
+ ### Return type
1095
+
1096
+ [**KeywordSetEntityListing**](KeywordSetEntityListing.html)
1097
+
1098
+ ### HTTP request headers
1099
+
1100
+ - **Content-Type**: application/json
1101
+ - **Accept**: application/json
1102
+
1103
+
1104
+
1105
+ <a name="get_keywordsets_keywordset_id"></a>
1106
+
1107
+ ## -[**KeywordSet**](KeywordSet.html) get_keywordsets_keywordset_id(keyword_set_id)
1108
+
1109
+ Get a keywordSet by id.
1110
+
1111
+
1112
+
1113
+ ### Example
1114
+ ~~~ruby
1115
+ # load the gem
1116
+ require 'purecloud'
1117
+ # setup authorization
1118
+ @secret = ENV['PURECLOUD_SECRET']
1119
+ @id = ENV['PURECLOUD_CLIENT_ID']
1120
+ environment = "mypurecloud.com"
1121
+
1122
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1123
+
1124
+ PureCloud.configure do |config|
1125
+ config.access_token = @authToken
1126
+ end
1127
+
1128
+ api_instance = PureCloud::QualityApi.new
1129
+
1130
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
1131
+
1132
+
1133
+ begin
1134
+ #Get a keywordSet by id.
1135
+ result = api_instance.get_keywordsets_keywordset_id(keyword_set_id)
1136
+ p result
1137
+ rescue PureCloud::ApiError => e
1138
+ puts "Exception when calling QualityApi->get_keywordsets_keywordset_id: #{e}"
1139
+ end
1140
+ ~~~
1141
+
1142
+ ### Parameters
1143
+
1144
+ Name | Type | Description | Notes
1145
+ ------------- | ------------- | ------------- | -------------
1146
+ **keyword_set_id** | **String**| KeywordSet ID |
1147
+ {: class="table table-striped"}
1148
+
1149
+
1150
+ ### Return type
1151
+
1152
+ [**KeywordSet**](KeywordSet.html)
1153
+
1154
+ ### HTTP request headers
1155
+
1156
+ - **Content-Type**: application/json
1157
+ - **Accept**: application/json
1158
+
1159
+
1160
+
919
1161
  <a name="get_publishedforms"></a>
920
1162
 
921
1163
  ## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_publishedforms(opts)
@@ -1325,6 +1567,65 @@ Name | Type | Description | Notes
1325
1567
 
1326
1568
 
1327
1569
 
1570
+ <a name="post_keywordsets"></a>
1571
+
1572
+ ## -[**KeywordSet**](KeywordSet.html) post_keywordsets(opts)
1573
+
1574
+ Create a Keyword Set
1575
+
1576
+
1577
+
1578
+ ### Example
1579
+ ~~~ruby
1580
+ # load the gem
1581
+ require 'purecloud'
1582
+ # setup authorization
1583
+ @secret = ENV['PURECLOUD_SECRET']
1584
+ @id = ENV['PURECLOUD_CLIENT_ID']
1585
+ environment = "mypurecloud.com"
1586
+
1587
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1588
+
1589
+ PureCloud.configure do |config|
1590
+ config.access_token = @authToken
1591
+ end
1592
+
1593
+ api_instance = PureCloud::QualityApi.new
1594
+
1595
+ opts = {
1596
+ body: PureCloud::KeywordSet.new, # KeywordSet | keywordSet
1597
+ expand: "expand_example" # String | queueId
1598
+ }
1599
+
1600
+ begin
1601
+ #Create a Keyword Set
1602
+ result = api_instance.post_keywordsets(opts)
1603
+ p result
1604
+ rescue PureCloud::ApiError => e
1605
+ puts "Exception when calling QualityApi->post_keywordsets: #{e}"
1606
+ end
1607
+ ~~~
1608
+
1609
+ ### Parameters
1610
+
1611
+ Name | Type | Description | Notes
1612
+ ------------- | ------------- | ------------- | -------------
1613
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet | [optional]
1614
+ **expand** | **String**| queueId | [optional]
1615
+ {: class="table table-striped"}
1616
+
1617
+
1618
+ ### Return type
1619
+
1620
+ [**KeywordSet**](KeywordSet.html)
1621
+
1622
+ ### HTTP request headers
1623
+
1624
+ - **Content-Type**: application/json
1625
+ - **Accept**: application/json
1626
+
1627
+
1628
+
1328
1629
  <a name="post_publishedforms"></a>
1329
1630
 
1330
1631
  ## -[**EvaluationForm**](EvaluationForm.html) post_publishedforms(opts)
@@ -1567,3 +1868,63 @@ Name | Type | Description | Notes
1567
1868
 
1568
1869
 
1569
1870
 
1871
+ <a name="put_keywordsets_keywordset_id"></a>
1872
+
1873
+ ## -[**KeywordSet**](KeywordSet.html) put_keywordsets_keywordset_id(keyword_set_id, opts)
1874
+
1875
+ Update a keywordSet to the specified keywordSet via PUT.
1876
+
1877
+
1878
+
1879
+ ### Example
1880
+ ~~~ruby
1881
+ # load the gem
1882
+ require 'purecloud'
1883
+ # setup authorization
1884
+ @secret = ENV['PURECLOUD_SECRET']
1885
+ @id = ENV['PURECLOUD_CLIENT_ID']
1886
+ environment = "mypurecloud.com"
1887
+
1888
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1889
+
1890
+ PureCloud.configure do |config|
1891
+ config.access_token = @authToken
1892
+ end
1893
+
1894
+ api_instance = PureCloud::QualityApi.new
1895
+
1896
+ keyword_set_id = "keyword_set_id_example" # String | KeywordSet ID
1897
+
1898
+ opts = {
1899
+ body: PureCloud::KeywordSet.new # KeywordSet | keywordSet
1900
+ }
1901
+
1902
+ begin
1903
+ #Update a keywordSet to the specified keywordSet via PUT.
1904
+ result = api_instance.put_keywordsets_keywordset_id(keyword_set_id, opts)
1905
+ p result
1906
+ rescue PureCloud::ApiError => e
1907
+ puts "Exception when calling QualityApi->put_keywordsets_keywordset_id: #{e}"
1908
+ end
1909
+ ~~~
1910
+
1911
+ ### Parameters
1912
+
1913
+ Name | Type | Description | Notes
1914
+ ------------- | ------------- | ------------- | -------------
1915
+ **keyword_set_id** | **String**| KeywordSet ID |
1916
+ **body** | [**KeywordSet**](KeywordSet.html)| keywordSet | [optional]
1917
+ {: class="table table-striped"}
1918
+
1919
+
1920
+ ### Return type
1921
+
1922
+ [**KeywordSet**](KeywordSet.html)
1923
+
1924
+ ### HTTP request headers
1925
+
1926
+ - **Content-Type**: application/json
1927
+ - **Accept**: application/json
1928
+
1929
+
1930
+