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
@@ -7,11 +7,11 @@ title: ImportStatus
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **state** | **String** | | [optional] |
11
- | **total_records** | **Integer** | | [optional] |
12
- | **completed_records** | **Integer** | | [optional] |
13
- | **percent_complete** | **Integer** | | [optional] |
14
- | **failure_reason** | **String** | | [optional] |
10
+ | **state** | **String** | current status of the import | |
11
+ | **total_records** | **Integer** | total number of records to be imported | |
12
+ | **completed_records** | **Integer** | number of records finished importing | |
13
+ | **percent_complete** | **Integer** | percentage of records finished importing | |
14
+ | **failure_reason** | **String** | if the import has failed, the reason for the failure | [optional] |
15
15
  {: class="table table-striped"}
16
16
 
17
17
 
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: InitiateScreenRecording
3
+ ---
4
+ ## PureCloud::InitiateScreenRecording
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **record_acw** | **BOOLEAN** | | [optional] [default to false]|
11
+ | **archive_retention** | [**ArchiveRetention**](ArchiveRetention.html) | | [optional] |
12
+ | **delete_retention** | [**DeleteRetention**](DeleteRetention.html) | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -9,15 +9,13 @@ title: JsonNode
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **node_type** | **String** | | [optional] |
11
11
  | **float** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **object** | **BOOLEAN** | | [optional] [default to false]|
12
13
  | **boolean** | **BOOLEAN** | | [optional] [default to false]|
13
14
  | **number** | **BOOLEAN** | | [optional] [default to false]|
14
- | **object** | **BOOLEAN** | | [optional] [default to false]|
15
- | **value_node** | **BOOLEAN** | | [optional] [default to false]|
16
15
  | **container_node** | **BOOLEAN** | | [optional] [default to false]|
17
16
  | **missing_node** | **BOOLEAN** | | [optional] [default to false]|
18
17
  | **pojo** | **BOOLEAN** | | [optional] [default to false]|
19
18
  | **integral_number** | **BOOLEAN** | | [optional] [default to false]|
20
- | **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
21
19
  | **short** | **BOOLEAN** | | [optional] [default to false]|
22
20
  | **int** | **BOOLEAN** | | [optional] [default to false]|
23
21
  | **long** | **BOOLEAN** | | [optional] [default to false]|
@@ -26,6 +24,8 @@ title: JsonNode
26
24
  | **big_integer** | **BOOLEAN** | | [optional] [default to false]|
27
25
  | **textual** | **BOOLEAN** | | [optional] [default to false]|
28
26
  | **binary** | **BOOLEAN** | | [optional] [default to false]|
27
+ | **value_node** | **BOOLEAN** | | [optional] [default to false]|
28
+ | **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
29
29
  | **array** | **BOOLEAN** | | [optional] [default to false]|
30
30
  | **null** | **BOOLEAN** | | [optional] [default to false]|
31
31
  {: class="table table-striped"}
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: Keyword
3
+ ---
4
+ ## PureCloud::Keyword
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **phrase** | **String** | | [optional] |
13
+ | **confidence** | **Integer** | | [optional] |
14
+ | **agent_score_modifier** | **Integer** | | [optional] |
15
+ | **customer_score_modifier** | **Integer** | | [optional] |
16
+ | **alternate_spellings** | **Array<String>** | | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: KeywordSet
3
+ ---
4
+ ## PureCloud::KeywordSet
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
+ | **description** | **String** | | [optional] |
13
+ | **queue** | [**Queue**](Queue.html) | | [optional] |
14
+ | **language** | **String** | | [optional] |
15
+ | **agents** | [**Array<User>**](User.html) | | [optional] |
16
+ | **keywords** | [**Array<Keyword>**](Keyword.html) | | [optional] |
17
+ | **participant_purposes** | **Array<String>** | | [optional] |
18
+ | **self_uri** | **String** | The URI for this object | [optional] |
19
+ {: class="table table-striped"}
20
+
21
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: KeywordSetEntityListing
3
+ ---
4
+ ## PureCloud::KeywordSetEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **page_size** | **Integer** | | [optional] |
11
+ | **page_number** | **Integer** | | [optional] |
12
+ | **total** | **Integer** | | [optional] |
13
+ | **entities** | [**Array<KeywordSet>**](KeywordSet.html) | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -9,27 +9,11 @@ All URIs are relative to *https://api.mypurecloud.com*
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_clients_client_id**](OAuthApi.html#delete_clients_client_id) | **DELETE** /api/v2/oauth/clients/{clientId} | Delete OAuth Client|
12
- |[**delete_okta**](OAuthApi.html#delete_okta) | **DELETE** /api/v2/identityproviders/okta | Delete Okta Identity Provider|
13
- |[**delete_onelogin**](OAuthApi.html#delete_onelogin) | **DELETE** /api/v2/identityproviders/onelogin | Delete OneLogin Identity Provider|
14
- |[**delete_provider_id**](OAuthApi.html#delete_provider_id) | **DELETE** /api/v2/identityproviders/{providerId} | Delete an identity provider|
15
- |[**delete_purecloud**](OAuthApi.html#delete_purecloud) | **DELETE** /api/v2/identityproviders/purecloud | Delete PureCloud Identity Provider|
16
- |[**delete_salesforce**](OAuthApi.html#delete_salesforce) | **DELETE** /api/v2/identityproviders/salesforce | Delete Salesforce Identity Provider|
17
12
  |[**get_clients**](OAuthApi.html#get_clients) | **GET** /api/v2/oauth/clients | The list of OAuth clients|
18
13
  |[**get_clients_client_id**](OAuthApi.html#get_clients_client_id) | **GET** /api/v2/oauth/clients/{clientId} | Get OAuth Client|
19
- |[**get_identityproviders**](OAuthApi.html#get_identityproviders) | **GET** /api/v2/identityproviders | The list of identity providers|
20
- |[**get_okta**](OAuthApi.html#get_okta) | **GET** /api/v2/identityproviders/okta | Get Okta Identity Provider|
21
- |[**get_onelogin**](OAuthApi.html#get_onelogin) | **GET** /api/v2/identityproviders/onelogin | Get OneLogin Identity Provider|
22
- |[**get_provider_id**](OAuthApi.html#get_provider_id) | **GET** /api/v2/identityproviders/{providerId} | Get an identity provider|
23
- |[**get_purecloud**](OAuthApi.html#get_purecloud) | **GET** /api/v2/identityproviders/purecloud | Get PureCloud Identity Provider|
24
- |[**get_salesforce**](OAuthApi.html#get_salesforce) | **GET** /api/v2/identityproviders/salesforce | Get Salesforce Identity Provider|
25
14
  |[**post_clients**](OAuthApi.html#post_clients) | **POST** /api/v2/oauth/clients | Create OAuth client|
26
15
  |[**post_clients_client_id_secret**](OAuthApi.html#post_clients_client_id_secret) | **POST** /api/v2/oauth/clients/{clientId}/secret | Regenerate Client Secret|
27
16
  |[**put_clients_client_id**](OAuthApi.html#put_clients_client_id) | **PUT** /api/v2/oauth/clients/{clientId} | Update OAuth Client|
28
- |[**put_okta**](OAuthApi.html#put_okta) | **PUT** /api/v2/identityproviders/okta | Update/Create Okta Identity Provider|
29
- |[**put_onelogin**](OAuthApi.html#put_onelogin) | **PUT** /api/v2/identityproviders/onelogin | Update/Create OneLogin Identity Provider|
30
- |[**put_provider_id**](OAuthApi.html#put_provider_id) | **PUT** /api/v2/identityproviders/{providerId} | Update an identity provider|
31
- |[**put_purecloud**](OAuthApi.html#put_purecloud) | **PUT** /api/v2/identityproviders/purecloud | Update/Create PureCloud Identity Provider|
32
- |[**put_salesforce**](OAuthApi.html#put_salesforce) | **PUT** /api/v2/identityproviders/salesforce | Update/Create Salesforce Identity Provider|
33
17
  {: class="table table-striped"}
34
18
 
35
19
  <a name="delete_clients_client_id"></a>
@@ -87,664 +71,13 @@ nil (empty response body)
87
71
 
88
72
 
89
73
 
90
- <a name="delete_okta"></a>
91
-
92
- ## - delete_okta
93
-
94
- Delete Okta Identity Provider
95
-
96
-
97
-
98
- ### Example
99
- ~~~ruby
100
- # load the gem
101
- require 'purecloud'
102
- # setup authorization
103
- @secret = ENV['PURECLOUD_SECRET']
104
- @id = ENV['PURECLOUD_CLIENT_ID']
105
- environment = "mypurecloud.com"
106
-
107
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
108
-
109
- PureCloud.configure do |config|
110
- config.access_token = @authToken
111
- end
112
-
113
- api_instance = PureCloud::OAuthApi.new
114
-
115
- begin
116
- #Delete Okta Identity Provider
117
- api_instance.delete_okta
118
- rescue PureCloud::ApiError => e
119
- puts "Exception when calling OAuthApi->delete_okta: #{e}"
120
- end
121
- ~~~
122
-
123
- ### Parameters
124
- This endpoint does not need any parameter.
125
- {: class="table table-striped"}
126
-
127
-
128
- ### Return type
129
-
130
- nil (empty response body)
131
-
132
- ### HTTP request headers
133
-
134
- - **Content-Type**: application/json
135
- - **Accept**: application/json
136
-
137
-
138
-
139
- <a name="delete_onelogin"></a>
140
-
141
- ## - delete_onelogin
142
-
143
- Delete OneLogin Identity Provider
144
-
145
-
146
-
147
- ### Example
148
- ~~~ruby
149
- # load the gem
150
- require 'purecloud'
151
- # setup authorization
152
- @secret = ENV['PURECLOUD_SECRET']
153
- @id = ENV['PURECLOUD_CLIENT_ID']
154
- environment = "mypurecloud.com"
155
-
156
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
157
-
158
- PureCloud.configure do |config|
159
- config.access_token = @authToken
160
- end
161
-
162
- api_instance = PureCloud::OAuthApi.new
163
-
164
- begin
165
- #Delete OneLogin Identity Provider
166
- api_instance.delete_onelogin
167
- rescue PureCloud::ApiError => e
168
- puts "Exception when calling OAuthApi->delete_onelogin: #{e}"
169
- end
170
- ~~~
171
-
172
- ### Parameters
173
- This endpoint does not need any parameter.
174
- {: class="table table-striped"}
175
-
176
-
177
- ### Return type
178
-
179
- nil (empty response body)
180
-
181
- ### HTTP request headers
182
-
183
- - **Content-Type**: application/json
184
- - **Accept**: application/json
185
-
186
-
187
-
188
- <a name="delete_provider_id"></a>
189
-
190
- ## - delete_provider_id
191
-
192
- Delete an identity provider
193
-
194
-
195
-
196
- ### Example
197
- ~~~ruby
198
- # load the gem
199
- require 'purecloud'
200
- # setup authorization
201
- @secret = ENV['PURECLOUD_SECRET']
202
- @id = ENV['PURECLOUD_CLIENT_ID']
203
- environment = "mypurecloud.com"
204
-
205
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
206
-
207
- PureCloud.configure do |config|
208
- config.access_token = @authToken
209
- end
210
-
211
- api_instance = PureCloud::OAuthApi.new
212
-
213
- begin
214
- #Delete an identity provider
215
- api_instance.delete_provider_id
216
- rescue PureCloud::ApiError => e
217
- puts "Exception when calling OAuthApi->delete_provider_id: #{e}"
218
- end
219
- ~~~
220
-
221
- ### Parameters
222
- This endpoint does not need any parameter.
223
- {: class="table table-striped"}
224
-
225
-
226
- ### Return type
227
-
228
- nil (empty response body)
229
-
230
- ### HTTP request headers
231
-
232
- - **Content-Type**: application/json
233
- - **Accept**: application/json
234
-
235
-
236
-
237
- <a name="delete_purecloud"></a>
238
-
239
- ## - delete_purecloud
240
-
241
- Delete PureCloud Identity Provider
242
-
243
-
244
-
245
- ### Example
246
- ~~~ruby
247
- # load the gem
248
- require 'purecloud'
249
- # setup authorization
250
- @secret = ENV['PURECLOUD_SECRET']
251
- @id = ENV['PURECLOUD_CLIENT_ID']
252
- environment = "mypurecloud.com"
253
-
254
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
255
-
256
- PureCloud.configure do |config|
257
- config.access_token = @authToken
258
- end
259
-
260
- api_instance = PureCloud::OAuthApi.new
261
-
262
- begin
263
- #Delete PureCloud Identity Provider
264
- api_instance.delete_purecloud
265
- rescue PureCloud::ApiError => e
266
- puts "Exception when calling OAuthApi->delete_purecloud: #{e}"
267
- end
268
- ~~~
269
-
270
- ### Parameters
271
- This endpoint does not need any parameter.
272
- {: class="table table-striped"}
273
-
274
-
275
- ### Return type
276
-
277
- nil (empty response body)
278
-
279
- ### HTTP request headers
280
-
281
- - **Content-Type**: application/json
282
- - **Accept**: application/json
283
-
284
-
285
-
286
- <a name="delete_salesforce"></a>
287
-
288
- ## - delete_salesforce
289
-
290
- Delete Salesforce Identity Provider
291
-
292
-
293
-
294
- ### Example
295
- ~~~ruby
296
- # load the gem
297
- require 'purecloud'
298
- # setup authorization
299
- @secret = ENV['PURECLOUD_SECRET']
300
- @id = ENV['PURECLOUD_CLIENT_ID']
301
- environment = "mypurecloud.com"
302
-
303
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
304
-
305
- PureCloud.configure do |config|
306
- config.access_token = @authToken
307
- end
308
-
309
- api_instance = PureCloud::OAuthApi.new
310
-
311
- begin
312
- #Delete Salesforce Identity Provider
313
- api_instance.delete_salesforce
314
- rescue PureCloud::ApiError => e
315
- puts "Exception when calling OAuthApi->delete_salesforce: #{e}"
316
- end
317
- ~~~
318
-
319
- ### Parameters
320
- This endpoint does not need any parameter.
321
- {: class="table table-striped"}
322
-
323
-
324
- ### Return type
325
-
326
- nil (empty response body)
327
-
328
- ### HTTP request headers
329
-
330
- - **Content-Type**: application/json
331
- - **Accept**: application/json
332
-
333
-
334
-
335
- <a name="get_clients"></a>
336
-
337
- ## -[**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_clients
338
-
339
- The list of OAuth clients
340
-
341
-
342
-
343
- ### Example
344
- ~~~ruby
345
- # load the gem
346
- require 'purecloud'
347
- # setup authorization
348
- @secret = ENV['PURECLOUD_SECRET']
349
- @id = ENV['PURECLOUD_CLIENT_ID']
350
- environment = "mypurecloud.com"
351
-
352
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
353
-
354
- PureCloud.configure do |config|
355
- config.access_token = @authToken
356
- end
357
-
358
- api_instance = PureCloud::OAuthApi.new
359
-
360
- begin
361
- #The list of OAuth clients
362
- result = api_instance.get_clients
363
- p result
364
- rescue PureCloud::ApiError => e
365
- puts "Exception when calling OAuthApi->get_clients: #{e}"
366
- end
367
- ~~~
368
-
369
- ### Parameters
370
- This endpoint does not need any parameter.
371
- {: class="table table-striped"}
372
-
373
-
374
- ### Return type
375
-
376
- [**OAuthClientEntityListing**](OAuthClientEntityListing.html)
377
-
378
- ### HTTP request headers
379
-
380
- - **Content-Type**: application/json
381
- - **Accept**: application/json
382
-
383
-
384
-
385
- <a name="get_clients_client_id"></a>
386
-
387
- ## -[**OAuthClient**](OAuthClient.html) get_clients_client_id(client_id)
388
-
389
- Get OAuth Client
390
-
391
-
392
-
393
- ### Example
394
- ~~~ruby
395
- # load the gem
396
- require 'purecloud'
397
- # setup authorization
398
- @secret = ENV['PURECLOUD_SECRET']
399
- @id = ENV['PURECLOUD_CLIENT_ID']
400
- environment = "mypurecloud.com"
401
-
402
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
403
-
404
- PureCloud.configure do |config|
405
- config.access_token = @authToken
406
- end
407
-
408
- api_instance = PureCloud::OAuthApi.new
409
-
410
- client_id = "client_id_example" # String | Client ID
411
-
412
-
413
- begin
414
- #Get OAuth Client
415
- result = api_instance.get_clients_client_id(client_id)
416
- p result
417
- rescue PureCloud::ApiError => e
418
- puts "Exception when calling OAuthApi->get_clients_client_id: #{e}"
419
- end
420
- ~~~
421
-
422
- ### Parameters
423
-
424
- Name | Type | Description | Notes
425
- ------------- | ------------- | ------------- | -------------
426
- **client_id** | **String**| Client ID |
427
- {: class="table table-striped"}
428
-
429
-
430
- ### Return type
431
-
432
- [**OAuthClient**](OAuthClient.html)
433
-
434
- ### HTTP request headers
435
-
436
- - **Content-Type**: application/json
437
- - **Accept**: application/json
438
-
439
-
440
-
441
- <a name="get_identityproviders"></a>
442
-
443
- ## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get_identityproviders
444
-
445
- The list of identity providers
446
-
447
-
448
-
449
- ### Example
450
- ~~~ruby
451
- # load the gem
452
- require 'purecloud'
453
- # setup authorization
454
- @secret = ENV['PURECLOUD_SECRET']
455
- @id = ENV['PURECLOUD_CLIENT_ID']
456
- environment = "mypurecloud.com"
457
-
458
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
459
-
460
- PureCloud.configure do |config|
461
- config.access_token = @authToken
462
- end
463
-
464
- api_instance = PureCloud::OAuthApi.new
465
-
466
- begin
467
- #The list of identity providers
468
- result = api_instance.get_identityproviders
469
- p result
470
- rescue PureCloud::ApiError => e
471
- puts "Exception when calling OAuthApi->get_identityproviders: #{e}"
472
- end
473
- ~~~
474
-
475
- ### Parameters
476
- This endpoint does not need any parameter.
477
- {: class="table table-striped"}
478
-
479
-
480
- ### Return type
481
-
482
- [**OAuthProviderEntityListing**](OAuthProviderEntityListing.html)
483
-
484
- ### HTTP request headers
485
-
486
- - **Content-Type**: application/json
487
- - **Accept**: application/json
488
-
489
-
490
-
491
- <a name="get_okta"></a>
492
-
493
- ## -[**Okta**](Okta.html) get_okta
494
-
495
- Get Okta Identity Provider
496
-
497
-
498
-
499
- ### Example
500
- ~~~ruby
501
- # load the gem
502
- require 'purecloud'
503
- # setup authorization
504
- @secret = ENV['PURECLOUD_SECRET']
505
- @id = ENV['PURECLOUD_CLIENT_ID']
506
- environment = "mypurecloud.com"
507
-
508
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
509
-
510
- PureCloud.configure do |config|
511
- config.access_token = @authToken
512
- end
513
-
514
- api_instance = PureCloud::OAuthApi.new
515
-
516
- begin
517
- #Get Okta Identity Provider
518
- result = api_instance.get_okta
519
- p result
520
- rescue PureCloud::ApiError => e
521
- puts "Exception when calling OAuthApi->get_okta: #{e}"
522
- end
523
- ~~~
524
-
525
- ### Parameters
526
- This endpoint does not need any parameter.
527
- {: class="table table-striped"}
528
-
529
-
530
- ### Return type
531
-
532
- [**Okta**](Okta.html)
533
-
534
- ### HTTP request headers
535
-
536
- - **Content-Type**: application/json
537
- - **Accept**: application/json
538
-
539
-
540
-
541
- <a name="get_onelogin"></a>
542
-
543
- ## -[**OneLogin**](OneLogin.html) get_onelogin
544
-
545
- Get OneLogin Identity Provider
546
-
547
-
548
-
549
- ### Example
550
- ~~~ruby
551
- # load the gem
552
- require 'purecloud'
553
- # setup authorization
554
- @secret = ENV['PURECLOUD_SECRET']
555
- @id = ENV['PURECLOUD_CLIENT_ID']
556
- environment = "mypurecloud.com"
557
-
558
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
559
-
560
- PureCloud.configure do |config|
561
- config.access_token = @authToken
562
- end
563
-
564
- api_instance = PureCloud::OAuthApi.new
565
-
566
- begin
567
- #Get OneLogin Identity Provider
568
- result = api_instance.get_onelogin
569
- p result
570
- rescue PureCloud::ApiError => e
571
- puts "Exception when calling OAuthApi->get_onelogin: #{e}"
572
- end
573
- ~~~
574
-
575
- ### Parameters
576
- This endpoint does not need any parameter.
577
- {: class="table table-striped"}
578
-
579
-
580
- ### Return type
581
-
582
- [**OneLogin**](OneLogin.html)
583
-
584
- ### HTTP request headers
585
-
586
- - **Content-Type**: application/json
587
- - **Accept**: application/json
588
-
589
-
590
-
591
- <a name="get_provider_id"></a>
592
-
593
- ## -[**OAuthProvider**](OAuthProvider.html) get_provider_id
594
-
595
- Get an identity provider
596
-
597
-
598
-
599
- ### Example
600
- ~~~ruby
601
- # load the gem
602
- require 'purecloud'
603
- # setup authorization
604
- @secret = ENV['PURECLOUD_SECRET']
605
- @id = ENV['PURECLOUD_CLIENT_ID']
606
- environment = "mypurecloud.com"
607
-
608
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
609
-
610
- PureCloud.configure do |config|
611
- config.access_token = @authToken
612
- end
613
-
614
- api_instance = PureCloud::OAuthApi.new
615
-
616
- begin
617
- #Get an identity provider
618
- result = api_instance.get_provider_id
619
- p result
620
- rescue PureCloud::ApiError => e
621
- puts "Exception when calling OAuthApi->get_provider_id: #{e}"
622
- end
623
- ~~~
624
-
625
- ### Parameters
626
- This endpoint does not need any parameter.
627
- {: class="table table-striped"}
628
-
629
-
630
- ### Return type
631
-
632
- [**OAuthProvider**](OAuthProvider.html)
633
-
634
- ### HTTP request headers
635
-
636
- - **Content-Type**: application/json
637
- - **Accept**: application/json
638
-
639
-
640
-
641
- <a name="get_purecloud"></a>
642
-
643
- ## -[**PureCloud**](PureCloud.html) get_purecloud
644
-
645
- Get PureCloud Identity Provider
646
-
647
-
648
-
649
- ### Example
650
- ~~~ruby
651
- # load the gem
652
- require 'purecloud'
653
- # setup authorization
654
- @secret = ENV['PURECLOUD_SECRET']
655
- @id = ENV['PURECLOUD_CLIENT_ID']
656
- environment = "mypurecloud.com"
657
-
658
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
659
-
660
- PureCloud.configure do |config|
661
- config.access_token = @authToken
662
- end
663
-
664
- api_instance = PureCloud::OAuthApi.new
665
-
666
- begin
667
- #Get PureCloud Identity Provider
668
- result = api_instance.get_purecloud
669
- p result
670
- rescue PureCloud::ApiError => e
671
- puts "Exception when calling OAuthApi->get_purecloud: #{e}"
672
- end
673
- ~~~
674
-
675
- ### Parameters
676
- This endpoint does not need any parameter.
677
- {: class="table table-striped"}
678
-
679
-
680
- ### Return type
681
-
682
- [**PureCloud**](PureCloud.html)
683
-
684
- ### HTTP request headers
685
-
686
- - **Content-Type**: application/json
687
- - **Accept**: application/json
688
-
689
-
690
-
691
- <a name="get_salesforce"></a>
692
-
693
- ## -[**Salesforce**](Salesforce.html) get_salesforce
694
-
695
- Get Salesforce Identity Provider
696
-
697
-
698
-
699
- ### Example
700
- ~~~ruby
701
- # load the gem
702
- require 'purecloud'
703
- # setup authorization
704
- @secret = ENV['PURECLOUD_SECRET']
705
- @id = ENV['PURECLOUD_CLIENT_ID']
706
- environment = "mypurecloud.com"
707
-
708
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
709
-
710
- PureCloud.configure do |config|
711
- config.access_token = @authToken
712
- end
713
-
714
- api_instance = PureCloud::OAuthApi.new
715
-
716
- begin
717
- #Get Salesforce Identity Provider
718
- result = api_instance.get_salesforce
719
- p result
720
- rescue PureCloud::ApiError => e
721
- puts "Exception when calling OAuthApi->get_salesforce: #{e}"
722
- end
723
- ~~~
724
-
725
- ### Parameters
726
- This endpoint does not need any parameter.
727
- {: class="table table-striped"}
728
-
729
-
730
- ### Return type
731
-
732
- [**Salesforce**](Salesforce.html)
733
-
734
- ### HTTP request headers
735
-
736
- - **Content-Type**: application/json
737
- - **Accept**: application/json
738
-
739
-
74
+ <a name="get_clients"></a>
740
75
 
741
- <a name="post_clients"></a>
76
+ ## -[**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_clients
742
77
 
743
- ## -[**OAuthClient**](OAuthClient.html) post_clients(opts)
78
+ The list of OAuth clients
744
79
 
745
- Create OAuth client
746
80
 
747
- The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.
748
81
 
749
82
  ### Example
750
83
  ~~~ruby
@@ -763,30 +96,23 @@ end
763
96
 
764
97
  api_instance = PureCloud::OAuthApi.new
765
98
 
766
- opts = {
767
- body: PureCloud::OAuthClient.new # OAuthClient | Client
768
- }
769
-
770
99
  begin
771
- #Create OAuth client
772
- result = api_instance.post_clients(opts)
100
+ #The list of OAuth clients
101
+ result = api_instance.get_clients
773
102
  p result
774
103
  rescue PureCloud::ApiError => e
775
- puts "Exception when calling OAuthApi->post_clients: #{e}"
104
+ puts "Exception when calling OAuthApi->get_clients: #{e}"
776
105
  end
777
106
  ~~~
778
107
 
779
108
  ### Parameters
780
-
781
- Name | Type | Description | Notes
782
- ------------- | ------------- | ------------- | -------------
783
- **body** | [**OAuthClient**](OAuthClient.html)| Client | [optional]
109
+ This endpoint does not need any parameter.
784
110
  {: class="table table-striped"}
785
111
 
786
112
 
787
113
  ### Return type
788
114
 
789
- [**OAuthClient**](OAuthClient.html)
115
+ [**OAuthClientEntityListing**](OAuthClientEntityListing.html)
790
116
 
791
117
  ### HTTP request headers
792
118
 
@@ -795,13 +121,13 @@ Name | Type | Description | Notes
795
121
 
796
122
 
797
123
 
798
- <a name="post_clients_client_id_secret"></a>
124
+ <a name="get_clients_client_id"></a>
799
125
 
800
- ## - post_clients_client_id_secret(client_id)
126
+ ## -[**OAuthClient**](OAuthClient.html) get_clients_client_id(client_id)
127
+
128
+ Get OAuth Client
801
129
 
802
- Regenerate Client Secret
803
130
 
804
- This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
805
131
 
806
132
  ### Example
807
133
  ~~~ruby
@@ -824,10 +150,11 @@ client_id = "client_id_example" # String | Client ID
824
150
 
825
151
 
826
152
  begin
827
- #Regenerate Client Secret
828
- api_instance.post_clients_client_id_secret(client_id)
153
+ #Get OAuth Client
154
+ result = api_instance.get_clients_client_id(client_id)
155
+ p result
829
156
  rescue PureCloud::ApiError => e
830
- puts "Exception when calling OAuthApi->post_clients_client_id_secret: #{e}"
157
+ puts "Exception when calling OAuthApi->get_clients_client_id: #{e}"
831
158
  end
832
159
  ~~~
833
160
 
@@ -841,7 +168,7 @@ Name | Type | Description | Notes
841
168
 
842
169
  ### Return type
843
170
 
844
- nil (empty response body)
171
+ [**OAuthClient**](OAuthClient.html)
845
172
 
846
173
  ### HTTP request headers
847
174
 
@@ -850,13 +177,13 @@ nil (empty response body)
850
177
 
851
178
 
852
179
 
853
- <a name="put_clients_client_id"></a>
854
-
855
- ## -[**OAuthClient**](OAuthClient.html) put_clients_client_id(client_id, opts)
180
+ <a name="post_clients"></a>
856
181
 
857
- Update OAuth Client
182
+ ## -[**OAuthClient**](OAuthClient.html) post_clients(opts)
858
183
 
184
+ Create OAuth client
859
185
 
186
+ The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.
860
187
 
861
188
  ### Example
862
189
  ~~~ruby
@@ -875,18 +202,16 @@ end
875
202
 
876
203
  api_instance = PureCloud::OAuthApi.new
877
204
 
878
- client_id = "client_id_example" # String | Client ID
879
-
880
205
  opts = {
881
206
  body: PureCloud::OAuthClient.new # OAuthClient | Client
882
207
  }
883
208
 
884
209
  begin
885
- #Update OAuth Client
886
- result = api_instance.put_clients_client_id(client_id, opts)
210
+ #Create OAuth client
211
+ result = api_instance.post_clients(opts)
887
212
  p result
888
213
  rescue PureCloud::ApiError => e
889
- puts "Exception when calling OAuthApi->put_clients_client_id: #{e}"
214
+ puts "Exception when calling OAuthApi->post_clients: #{e}"
890
215
  end
891
216
  ~~~
892
217
 
@@ -894,7 +219,6 @@ end
894
219
 
895
220
  Name | Type | Description | Notes
896
221
  ------------- | ------------- | ------------- | -------------
897
- **client_id** | **String**| Client ID |
898
222
  **body** | [**OAuthClient**](OAuthClient.html)| Client | [optional]
899
223
  {: class="table table-striped"}
900
224
 
@@ -910,69 +234,13 @@ Name | Type | Description | Notes
910
234
 
911
235
 
912
236
 
913
- <a name="put_okta"></a>
914
-
915
- ## - put_okta(opts)
916
-
917
- Update/Create Okta Identity Provider
918
-
919
-
920
-
921
- ### Example
922
- ~~~ruby
923
- # load the gem
924
- require 'purecloud'
925
- # setup authorization
926
- @secret = ENV['PURECLOUD_SECRET']
927
- @id = ENV['PURECLOUD_CLIENT_ID']
928
- environment = "mypurecloud.com"
929
-
930
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
931
-
932
- PureCloud.configure do |config|
933
- config.access_token = @authToken
934
- end
935
-
936
- api_instance = PureCloud::OAuthApi.new
937
-
938
- opts = {
939
- body: PureCloud::Okta.new # Okta | Provider
940
- }
941
-
942
- begin
943
- #Update/Create Okta Identity Provider
944
- api_instance.put_okta(opts)
945
- rescue PureCloud::ApiError => e
946
- puts "Exception when calling OAuthApi->put_okta: #{e}"
947
- end
948
- ~~~
949
-
950
- ### Parameters
951
-
952
- Name | Type | Description | Notes
953
- ------------- | ------------- | ------------- | -------------
954
- **body** | [**Okta**](Okta.html)| Provider | [optional]
955
- {: class="table table-striped"}
956
-
957
-
958
- ### Return type
959
-
960
- nil (empty response body)
961
-
962
- ### HTTP request headers
963
-
964
- - **Content-Type**: application/json
965
- - **Accept**: application/json
966
-
967
-
968
-
969
- <a name="put_onelogin"></a>
970
-
971
- ## - put_onelogin(opts)
237
+ <a name="post_clients_client_id_secret"></a>
972
238
 
973
- Update/Create OneLogin Identity Provider
239
+ ## - post_clients_client_id_secret(client_id)
974
240
 
241
+ Regenerate Client Secret
975
242
 
243
+ This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.
976
244
 
977
245
  ### Example
978
246
  ~~~ruby
@@ -991,71 +259,14 @@ end
991
259
 
992
260
  api_instance = PureCloud::OAuthApi.new
993
261
 
994
- opts = {
995
- body: PureCloud::OneLogin.new # OneLogin | Provider
996
- }
997
-
998
- begin
999
- #Update/Create OneLogin Identity Provider
1000
- api_instance.put_onelogin(opts)
1001
- rescue PureCloud::ApiError => e
1002
- puts "Exception when calling OAuthApi->put_onelogin: #{e}"
1003
- end
1004
- ~~~
1005
-
1006
- ### Parameters
1007
-
1008
- Name | Type | Description | Notes
1009
- ------------- | ------------- | ------------- | -------------
1010
- **body** | [**OneLogin**](OneLogin.html)| Provider | [optional]
1011
- {: class="table table-striped"}
1012
-
1013
-
1014
- ### Return type
1015
-
1016
- nil (empty response body)
1017
-
1018
- ### HTTP request headers
1019
-
1020
- - **Content-Type**: application/json
1021
- - **Accept**: application/json
1022
-
1023
-
1024
-
1025
- <a name="put_provider_id"></a>
1026
-
1027
- ## - put_provider_id(opts)
1028
-
1029
- Update an identity provider
1030
-
1031
-
1032
-
1033
- ### Example
1034
- ~~~ruby
1035
- # load the gem
1036
- require 'purecloud'
1037
- # setup authorization
1038
- @secret = ENV['PURECLOUD_SECRET']
1039
- @id = ENV['PURECLOUD_CLIENT_ID']
1040
- environment = "mypurecloud.com"
1041
-
1042
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1043
-
1044
- PureCloud.configure do |config|
1045
- config.access_token = @authToken
1046
- end
1047
-
1048
- api_instance = PureCloud::OAuthApi.new
262
+ client_id = "client_id_example" # String | Client ID
1049
263
 
1050
- opts = {
1051
- body: PureCloud::OAuthProvider.new # OAuthProvider | Provider
1052
- }
1053
264
 
1054
265
  begin
1055
- #Update an identity provider
1056
- api_instance.put_provider_id(opts)
266
+ #Regenerate Client Secret
267
+ api_instance.post_clients_client_id_secret(client_id)
1057
268
  rescue PureCloud::ApiError => e
1058
- puts "Exception when calling OAuthApi->put_provider_id: #{e}"
269
+ puts "Exception when calling OAuthApi->post_clients_client_id_secret: #{e}"
1059
270
  end
1060
271
  ~~~
1061
272
 
@@ -1063,7 +274,7 @@ end
1063
274
 
1064
275
  Name | Type | Description | Notes
1065
276
  ------------- | ------------- | ------------- | -------------
1066
- **body** | [**OAuthProvider**](OAuthProvider.html)| Provider | [optional]
277
+ **client_id** | **String**| Client ID |
1067
278
  {: class="table table-striped"}
1068
279
 
1069
280
 
@@ -1078,11 +289,11 @@ nil (empty response body)
1078
289
 
1079
290
 
1080
291
 
1081
- <a name="put_purecloud"></a>
292
+ <a name="put_clients_client_id"></a>
1082
293
 
1083
- ## - put_purecloud(opts)
294
+ ## -[**OAuthClient**](OAuthClient.html) put_clients_client_id(client_id, opts)
1084
295
 
1085
- Update/Create PureCloud Identity Provider
296
+ Update OAuth Client
1086
297
 
1087
298
 
1088
299
 
@@ -1103,71 +314,18 @@ end
1103
314
 
1104
315
  api_instance = PureCloud::OAuthApi.new
1105
316
 
1106
- opts = {
1107
- body: PureCloud::PureCloud.new # PureCloud | Provider
1108
- }
1109
-
1110
- begin
1111
- #Update/Create PureCloud Identity Provider
1112
- api_instance.put_purecloud(opts)
1113
- rescue PureCloud::ApiError => e
1114
- puts "Exception when calling OAuthApi->put_purecloud: #{e}"
1115
- end
1116
- ~~~
1117
-
1118
- ### Parameters
1119
-
1120
- Name | Type | Description | Notes
1121
- ------------- | ------------- | ------------- | -------------
1122
- **body** | [**PureCloud**](PureCloud.html)| Provider | [optional]
1123
- {: class="table table-striped"}
1124
-
1125
-
1126
- ### Return type
1127
-
1128
- nil (empty response body)
1129
-
1130
- ### HTTP request headers
1131
-
1132
- - **Content-Type**: application/json
1133
- - **Accept**: application/json
1134
-
1135
-
1136
-
1137
- <a name="put_salesforce"></a>
1138
-
1139
- ## - put_salesforce(opts)
1140
-
1141
- Update/Create Salesforce Identity Provider
1142
-
1143
-
1144
-
1145
- ### Example
1146
- ~~~ruby
1147
- # load the gem
1148
- require 'purecloud'
1149
- # setup authorization
1150
- @secret = ENV['PURECLOUD_SECRET']
1151
- @id = ENV['PURECLOUD_CLIENT_ID']
1152
- environment = "mypurecloud.com"
1153
-
1154
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1155
-
1156
- PureCloud.configure do |config|
1157
- config.access_token = @authToken
1158
- end
1159
-
1160
- api_instance = PureCloud::OAuthApi.new
317
+ client_id = "client_id_example" # String | Client ID
1161
318
 
1162
319
  opts = {
1163
- body: PureCloud::Salesforce.new # Salesforce | Provider
320
+ body: PureCloud::OAuthClient.new # OAuthClient | Client
1164
321
  }
1165
322
 
1166
323
  begin
1167
- #Update/Create Salesforce Identity Provider
1168
- api_instance.put_salesforce(opts)
324
+ #Update OAuth Client
325
+ result = api_instance.put_clients_client_id(client_id, opts)
326
+ p result
1169
327
  rescue PureCloud::ApiError => e
1170
- puts "Exception when calling OAuthApi->put_salesforce: #{e}"
328
+ puts "Exception when calling OAuthApi->put_clients_client_id: #{e}"
1171
329
  end
1172
330
  ~~~
1173
331
 
@@ -1175,13 +333,14 @@ end
1175
333
 
1176
334
  Name | Type | Description | Notes
1177
335
  ------------- | ------------- | ------------- | -------------
1178
- **body** | [**Salesforce**](Salesforce.html)| Provider | [optional]
336
+ **client_id** | **String**| Client ID |
337
+ **body** | [**OAuthClient**](OAuthClient.html)| Client | [optional]
1179
338
  {: class="table table-striped"}
1180
339
 
1181
340
 
1182
341
  ### Return type
1183
342
 
1184
- nil (empty response body)
343
+ [**OAuthClient**](OAuthClient.html)
1185
344
 
1186
345
  ### HTTP request headers
1187
346