purecloudplatformclientv2 49.0.0 → 49.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -8
- data/docs/AlertingApi.md +33 -33
- data/docs/AnalyticsApi.md +81 -81
- data/docs/ArchitectApi.md +243 -243
- data/docs/AuthorizationApi.md +102 -102
- data/docs/BillingApi.md +6 -6
- data/docs/ContentManagementApi.md +114 -114
- data/docs/ConversationsApi.md +300 -300
- data/docs/DialerRulesetConfigChangeCondition.md +1 -0
- data/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +2 -0
- data/docs/ExternalContactsApi.md +90 -90
- data/docs/FaxApi.md +18 -18
- data/docs/FlowsApi.md +3 -3
- data/docs/GeneralDataProtectionRegulationApi.md +12 -12
- data/docs/GeolocationApi.md +12 -12
- data/docs/GreetingsApi.md +48 -48
- data/docs/GroupsApi.md +42 -42
- data/docs/IdentityProviderApi.md +84 -84
- data/docs/IntegrationsApi.md +123 -123
- data/docs/LanguagesApi.md +30 -30
- data/docs/LicenseApi.md +24 -24
- data/docs/LocationsApi.md +21 -21
- data/docs/MessagingApi.md +42 -42
- data/docs/MobileDevicesApi.md +15 -15
- data/docs/NotificationsApi.md +21 -21
- data/docs/OAuthApi.md +18 -18
- data/docs/ObjectsApi.md +24 -24
- data/docs/OrganizationApi.md +18 -18
- data/docs/OrganizationAuthorizationApi.md +69 -69
- data/docs/OutboundApi.md +288 -288
- data/docs/PresenceApi.md +27 -27
- data/docs/QualityApi.md +174 -174
- data/docs/QueueUserEventTopicQueueMember.md +4 -3
- data/docs/RecordingApi.md +111 -111
- data/docs/ResponseManagementApi.md +33 -33
- data/docs/RoutingApi.md +189 -189
- data/docs/ScriptsApi.md +33 -33
- data/docs/SearchApi.md +48 -48
- data/docs/StationsApi.md +15 -15
- data/docs/SuggestApi.md +12 -12
- data/docs/TelephonyProvidersEdgeApi.md +375 -375
- data/docs/TokensApi.md +6 -6
- data/docs/UserRecordingsApi.md +18 -18
- data/docs/UsersApi.md +183 -183
- data/docs/UtilitiesApi.md +12 -12
- data/docs/VoicemailApi.md +72 -72
- data/docs/WebChatApi.md +24 -24
- data/docs/WorkforceManagementApi.md +192 -192
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +50 -25
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -2
data/docs/FaxApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | Description
|
|
18
18
|
|
19
19
|
<a name="delete_fax_document"></a>
|
20
20
|
|
21
|
-
##
|
21
|
+
## delete_fax_document(document_id)
|
22
22
|
|
23
23
|
|
24
24
|
|
@@ -33,7 +33,7 @@ Requires NO permissions:
|
|
33
33
|
|
34
34
|
|
35
35
|
### Example
|
36
|
-
|
36
|
+
```{"language":"ruby"}
|
37
37
|
# load the gem
|
38
38
|
require 'purecloudplatformclientv2'
|
39
39
|
# setup authorization
|
@@ -58,7 +58,7 @@ begin
|
|
58
58
|
rescue PureCloud::ApiError => e
|
59
59
|
puts "Exception when calling FaxApi->delete_fax_document: #{e}"
|
60
60
|
end
|
61
|
-
|
61
|
+
```
|
62
62
|
|
63
63
|
### Parameters
|
64
64
|
|
@@ -81,7 +81,7 @@ nil (empty response body)
|
|
81
81
|
|
82
82
|
<a name="get_fax_document"></a>
|
83
83
|
|
84
|
-
##
|
84
|
+
## [**FaxDocument**](FaxDocument.html) get_fax_document(document_id)
|
85
85
|
|
86
86
|
|
87
87
|
|
@@ -96,7 +96,7 @@ Requires NO permissions:
|
|
96
96
|
|
97
97
|
|
98
98
|
### Example
|
99
|
-
|
99
|
+
```{"language":"ruby"}
|
100
100
|
# load the gem
|
101
101
|
require 'purecloudplatformclientv2'
|
102
102
|
# setup authorization
|
@@ -122,7 +122,7 @@ begin
|
|
122
122
|
rescue PureCloud::ApiError => e
|
123
123
|
puts "Exception when calling FaxApi->get_fax_document: #{e}"
|
124
124
|
end
|
125
|
-
|
125
|
+
```
|
126
126
|
|
127
127
|
### Parameters
|
128
128
|
|
@@ -145,7 +145,7 @@ Name | Type | Description | Notes
|
|
145
145
|
|
146
146
|
<a name="get_fax_document_content"></a>
|
147
147
|
|
148
|
-
##
|
148
|
+
## [**DownloadResponse**](DownloadResponse.html) get_fax_document_content(document_id)
|
149
149
|
|
150
150
|
|
151
151
|
|
@@ -160,7 +160,7 @@ Requires NO permissions:
|
|
160
160
|
|
161
161
|
|
162
162
|
### Example
|
163
|
-
|
163
|
+
```{"language":"ruby"}
|
164
164
|
# load the gem
|
165
165
|
require 'purecloudplatformclientv2'
|
166
166
|
# setup authorization
|
@@ -186,7 +186,7 @@ begin
|
|
186
186
|
rescue PureCloud::ApiError => e
|
187
187
|
puts "Exception when calling FaxApi->get_fax_document_content: #{e}"
|
188
188
|
end
|
189
|
-
|
189
|
+
```
|
190
190
|
|
191
191
|
### Parameters
|
192
192
|
|
@@ -209,7 +209,7 @@ Name | Type | Description | Notes
|
|
209
209
|
|
210
210
|
<a name="get_fax_documents"></a>
|
211
211
|
|
212
|
-
##
|
212
|
+
## [**FaxDocumentEntityListing**](FaxDocumentEntityListing.html) get_fax_documents(opts)
|
213
213
|
|
214
214
|
|
215
215
|
|
@@ -224,7 +224,7 @@ Requires NO permissions:
|
|
224
224
|
|
225
225
|
|
226
226
|
### Example
|
227
|
-
|
227
|
+
```{"language":"ruby"}
|
228
228
|
# load the gem
|
229
229
|
require 'purecloudplatformclientv2'
|
230
230
|
# setup authorization
|
@@ -252,7 +252,7 @@ begin
|
|
252
252
|
rescue PureCloud::ApiError => e
|
253
253
|
puts "Exception when calling FaxApi->get_fax_documents: #{e}"
|
254
254
|
end
|
255
|
-
|
255
|
+
```
|
256
256
|
|
257
257
|
### Parameters
|
258
258
|
|
@@ -276,7 +276,7 @@ Name | Type | Description | Notes
|
|
276
276
|
|
277
277
|
<a name="get_fax_summary"></a>
|
278
278
|
|
279
|
-
##
|
279
|
+
## [**FaxSummary**](FaxSummary.html) get_fax_summary
|
280
280
|
|
281
281
|
|
282
282
|
|
@@ -291,7 +291,7 @@ Requires NO permissions:
|
|
291
291
|
|
292
292
|
|
293
293
|
### Example
|
294
|
-
|
294
|
+
```{"language":"ruby"}
|
295
295
|
# load the gem
|
296
296
|
require 'purecloudplatformclientv2'
|
297
297
|
# setup authorization
|
@@ -314,7 +314,7 @@ begin
|
|
314
314
|
rescue PureCloud::ApiError => e
|
315
315
|
puts "Exception when calling FaxApi->get_fax_summary: #{e}"
|
316
316
|
end
|
317
|
-
|
317
|
+
```
|
318
318
|
|
319
319
|
### Parameters
|
320
320
|
This endpoint does not need any parameter.
|
@@ -334,7 +334,7 @@ This endpoint does not need any parameter.
|
|
334
334
|
|
335
335
|
<a name="put_fax_document"></a>
|
336
336
|
|
337
|
-
##
|
337
|
+
## [**FaxDocument**](FaxDocument.html) put_fax_document(document_id, body)
|
338
338
|
|
339
339
|
|
340
340
|
|
@@ -349,7 +349,7 @@ Requires NO permissions:
|
|
349
349
|
|
350
350
|
|
351
351
|
### Example
|
352
|
-
|
352
|
+
```{"language":"ruby"}
|
353
353
|
# load the gem
|
354
354
|
require 'purecloudplatformclientv2'
|
355
355
|
# setup authorization
|
@@ -377,7 +377,7 @@ begin
|
|
377
377
|
rescue PureCloud::ApiError => e
|
378
378
|
puts "Exception when calling FaxApi->put_fax_document: #{e}"
|
379
379
|
end
|
380
|
-
|
380
|
+
```
|
381
381
|
|
382
382
|
### Parameters
|
383
383
|
|
data/docs/FlowsApi.md
CHANGED
@@ -13,7 +13,7 @@ Method | Description
|
|
13
13
|
|
14
14
|
<a name="post_analytics_flows_aggregates_query"></a>
|
15
15
|
|
16
|
-
##
|
16
|
+
## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_flows_aggregates_query(body)
|
17
17
|
|
18
18
|
|
19
19
|
|
@@ -29,7 +29,7 @@ Requires ANY permissions:
|
|
29
29
|
|
30
30
|
|
31
31
|
### Example
|
32
|
-
|
32
|
+
```{"language":"ruby"}
|
33
33
|
# load the gem
|
34
34
|
require 'purecloudplatformclientv2'
|
35
35
|
# setup authorization
|
@@ -55,7 +55,7 @@ begin
|
|
55
55
|
rescue PureCloud::ApiError => e
|
56
56
|
puts "Exception when calling FlowsApi->post_analytics_flows_aggregates_query: #{e}"
|
57
57
|
end
|
58
|
-
|
58
|
+
```
|
59
59
|
|
60
60
|
### Parameters
|
61
61
|
|
@@ -16,7 +16,7 @@ Method | Description
|
|
16
16
|
|
17
17
|
<a name="get_gdpr_request"></a>
|
18
18
|
|
19
|
-
##
|
19
|
+
## [**GDPRRequest**](GDPRRequest.html) get_gdpr_request(request_id)
|
20
20
|
|
21
21
|
|
22
22
|
|
@@ -32,7 +32,7 @@ Requires ANY permissions:
|
|
32
32
|
|
33
33
|
|
34
34
|
### Example
|
35
|
-
|
35
|
+
```{"language":"ruby"}
|
36
36
|
# load the gem
|
37
37
|
require 'purecloudplatformclientv2'
|
38
38
|
# setup authorization
|
@@ -58,7 +58,7 @@ begin
|
|
58
58
|
rescue PureCloud::ApiError => e
|
59
59
|
puts "Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_request: #{e}"
|
60
60
|
end
|
61
|
-
|
61
|
+
```
|
62
62
|
|
63
63
|
### Parameters
|
64
64
|
|
@@ -81,7 +81,7 @@ Name | Type | Description | Notes
|
|
81
81
|
|
82
82
|
<a name="get_gdpr_requests"></a>
|
83
83
|
|
84
|
-
##
|
84
|
+
## [**GDPRRequestEntityListing**](GDPRRequestEntityListing.html) get_gdpr_requests(opts)
|
85
85
|
|
86
86
|
|
87
87
|
|
@@ -97,7 +97,7 @@ Requires ANY permissions:
|
|
97
97
|
|
98
98
|
|
99
99
|
### Example
|
100
|
-
|
100
|
+
```{"language":"ruby"}
|
101
101
|
# load the gem
|
102
102
|
require 'purecloudplatformclientv2'
|
103
103
|
# setup authorization
|
@@ -125,7 +125,7 @@ begin
|
|
125
125
|
rescue PureCloud::ApiError => e
|
126
126
|
puts "Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_requests: #{e}"
|
127
127
|
end
|
128
|
-
|
128
|
+
```
|
129
129
|
|
130
130
|
### Parameters
|
131
131
|
|
@@ -149,7 +149,7 @@ Name | Type | Description | Notes
|
|
149
149
|
|
150
150
|
<a name="get_gdpr_subjects"></a>
|
151
151
|
|
152
|
-
##
|
152
|
+
## [**GDPRSubjectEntityListing**](GDPRSubjectEntityListing.html) get_gdpr_subjects(search_type, search_value)
|
153
153
|
|
154
154
|
|
155
155
|
|
@@ -165,7 +165,7 @@ Requires ANY permissions:
|
|
165
165
|
|
166
166
|
|
167
167
|
### Example
|
168
|
-
|
168
|
+
```{"language":"ruby"}
|
169
169
|
# load the gem
|
170
170
|
require 'purecloudplatformclientv2'
|
171
171
|
# setup authorization
|
@@ -193,7 +193,7 @@ begin
|
|
193
193
|
rescue PureCloud::ApiError => e
|
194
194
|
puts "Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_subjects: #{e}"
|
195
195
|
end
|
196
|
-
|
196
|
+
```
|
197
197
|
|
198
198
|
### Parameters
|
199
199
|
|
@@ -217,7 +217,7 @@ Name | Type | Description | Notes
|
|
217
217
|
|
218
218
|
<a name="post_gdpr_requests"></a>
|
219
219
|
|
220
|
-
##
|
220
|
+
## [**GDPRRequest**](GDPRRequest.html) post_gdpr_requests(body, opts)
|
221
221
|
|
222
222
|
|
223
223
|
|
@@ -233,7 +233,7 @@ Requires ANY permissions:
|
|
233
233
|
|
234
234
|
|
235
235
|
### Example
|
236
|
-
|
236
|
+
```{"language":"ruby"}
|
237
237
|
# load the gem
|
238
238
|
require 'purecloudplatformclientv2'
|
239
239
|
# setup authorization
|
@@ -262,7 +262,7 @@ begin
|
|
262
262
|
rescue PureCloud::ApiError => e
|
263
263
|
puts "Exception when calling GeneralDataProtectionRegulationApi->post_gdpr_requests: #{e}"
|
264
264
|
end
|
265
|
-
|
265
|
+
```
|
266
266
|
|
267
267
|
### Parameters
|
268
268
|
|
data/docs/GeolocationApi.md
CHANGED
@@ -16,7 +16,7 @@ Method | Description
|
|
16
16
|
|
17
17
|
<a name="get_geolocations_settings"></a>
|
18
18
|
|
19
|
-
##
|
19
|
+
## [**GeolocationSettings**](GeolocationSettings.html) get_geolocations_settings
|
20
20
|
|
21
21
|
|
22
22
|
|
@@ -31,7 +31,7 @@ Requires NO permissions:
|
|
31
31
|
|
32
32
|
|
33
33
|
### Example
|
34
|
-
|
34
|
+
```{"language":"ruby"}
|
35
35
|
# load the gem
|
36
36
|
require 'purecloudplatformclientv2'
|
37
37
|
# setup authorization
|
@@ -54,7 +54,7 @@ begin
|
|
54
54
|
rescue PureCloud::ApiError => e
|
55
55
|
puts "Exception when calling GeolocationApi->get_geolocations_settings: #{e}"
|
56
56
|
end
|
57
|
-
|
57
|
+
```
|
58
58
|
|
59
59
|
### Parameters
|
60
60
|
This endpoint does not need any parameter.
|
@@ -74,7 +74,7 @@ This endpoint does not need any parameter.
|
|
74
74
|
|
75
75
|
<a name="get_user_geolocation"></a>
|
76
76
|
|
77
|
-
##
|
77
|
+
## [**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
|
78
78
|
|
79
79
|
|
80
80
|
|
@@ -89,7 +89,7 @@ Requires NO permissions:
|
|
89
89
|
|
90
90
|
|
91
91
|
### Example
|
92
|
-
|
92
|
+
```{"language":"ruby"}
|
93
93
|
# load the gem
|
94
94
|
require 'purecloudplatformclientv2'
|
95
95
|
# setup authorization
|
@@ -117,7 +117,7 @@ begin
|
|
117
117
|
rescue PureCloud::ApiError => e
|
118
118
|
puts "Exception when calling GeolocationApi->get_user_geolocation: #{e}"
|
119
119
|
end
|
120
|
-
|
120
|
+
```
|
121
121
|
|
122
122
|
### Parameters
|
123
123
|
|
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
|
|
141
141
|
|
142
142
|
<a name="patch_geolocations_settings"></a>
|
143
143
|
|
144
|
-
##
|
144
|
+
## [**GeolocationSettings**](GeolocationSettings.html) patch_geolocations_settings(body)
|
145
145
|
|
146
146
|
|
147
147
|
|
@@ -157,7 +157,7 @@ Requires ANY permissions:
|
|
157
157
|
|
158
158
|
|
159
159
|
### Example
|
160
|
-
|
160
|
+
```{"language":"ruby"}
|
161
161
|
# load the gem
|
162
162
|
require 'purecloudplatformclientv2'
|
163
163
|
# setup authorization
|
@@ -183,7 +183,7 @@ begin
|
|
183
183
|
rescue PureCloud::ApiError => e
|
184
184
|
puts "Exception when calling GeolocationApi->patch_geolocations_settings: #{e}"
|
185
185
|
end
|
186
|
-
|
186
|
+
```
|
187
187
|
|
188
188
|
### Parameters
|
189
189
|
|
@@ -206,7 +206,7 @@ Name | Type | Description | Notes
|
|
206
206
|
|
207
207
|
<a name="patch_user_geolocation"></a>
|
208
208
|
|
209
|
-
##
|
209
|
+
## [**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
|
210
210
|
|
211
211
|
|
212
212
|
|
@@ -221,7 +221,7 @@ Requires NO permissions:
|
|
221
221
|
|
222
222
|
|
223
223
|
### Example
|
224
|
-
|
224
|
+
```{"language":"ruby"}
|
225
225
|
# load the gem
|
226
226
|
require 'purecloudplatformclientv2'
|
227
227
|
# setup authorization
|
@@ -251,7 +251,7 @@ begin
|
|
251
251
|
rescue PureCloud::ApiError => e
|
252
252
|
puts "Exception when calling GeolocationApi->patch_user_geolocation: #{e}"
|
253
253
|
end
|
254
|
-
|
254
|
+
```
|
255
255
|
|
256
256
|
### Parameters
|
257
257
|
|
data/docs/GreetingsApi.md
CHANGED
@@ -28,7 +28,7 @@ Method | Description
|
|
28
28
|
|
29
29
|
<a name="delete_greeting"></a>
|
30
30
|
|
31
|
-
##
|
31
|
+
## delete_greeting(greeting_id)
|
32
32
|
|
33
33
|
|
34
34
|
|
@@ -43,7 +43,7 @@ Requires NO permissions:
|
|
43
43
|
|
44
44
|
|
45
45
|
### Example
|
46
|
-
|
46
|
+
```{"language":"ruby"}
|
47
47
|
# load the gem
|
48
48
|
require 'purecloudplatformclientv2'
|
49
49
|
# setup authorization
|
@@ -68,7 +68,7 @@ begin
|
|
68
68
|
rescue PureCloud::ApiError => e
|
69
69
|
puts "Exception when calling GreetingsApi->delete_greeting: #{e}"
|
70
70
|
end
|
71
|
-
|
71
|
+
```
|
72
72
|
|
73
73
|
### Parameters
|
74
74
|
|
@@ -91,7 +91,7 @@ nil (empty response body)
|
|
91
91
|
|
92
92
|
<a name="get_greeting"></a>
|
93
93
|
|
94
|
-
##
|
94
|
+
## [**Greeting**](Greeting.html) get_greeting(greeting_id)
|
95
95
|
|
96
96
|
|
97
97
|
|
@@ -106,7 +106,7 @@ Requires NO permissions:
|
|
106
106
|
|
107
107
|
|
108
108
|
### Example
|
109
|
-
|
109
|
+
```{"language":"ruby"}
|
110
110
|
# load the gem
|
111
111
|
require 'purecloudplatformclientv2'
|
112
112
|
# setup authorization
|
@@ -132,7 +132,7 @@ begin
|
|
132
132
|
rescue PureCloud::ApiError => e
|
133
133
|
puts "Exception when calling GreetingsApi->get_greeting: #{e}"
|
134
134
|
end
|
135
|
-
|
135
|
+
```
|
136
136
|
|
137
137
|
### Parameters
|
138
138
|
|
@@ -155,7 +155,7 @@ Name | Type | Description | Notes
|
|
155
155
|
|
156
156
|
<a name="get_greeting_media"></a>
|
157
157
|
|
158
|
-
##
|
158
|
+
## [**GreetingMediaInfo**](GreetingMediaInfo.html) get_greeting_media(greeting_id, opts)
|
159
159
|
|
160
160
|
|
161
161
|
|
@@ -170,7 +170,7 @@ Requires NO permissions:
|
|
170
170
|
|
171
171
|
|
172
172
|
### Example
|
173
|
-
|
173
|
+
```{"language":"ruby"}
|
174
174
|
# load the gem
|
175
175
|
require 'purecloudplatformclientv2'
|
176
176
|
# setup authorization
|
@@ -199,7 +199,7 @@ begin
|
|
199
199
|
rescue PureCloud::ApiError => e
|
200
200
|
puts "Exception when calling GreetingsApi->get_greeting_media: #{e}"
|
201
201
|
end
|
202
|
-
|
202
|
+
```
|
203
203
|
|
204
204
|
### Parameters
|
205
205
|
|
@@ -223,7 +223,7 @@ Name | Type | Description | Notes
|
|
223
223
|
|
224
224
|
<a name="get_greetings"></a>
|
225
225
|
|
226
|
-
##
|
226
|
+
## [**DomainEntityListing**](DomainEntityListing.html) get_greetings(opts)
|
227
227
|
|
228
228
|
|
229
229
|
|
@@ -238,7 +238,7 @@ Requires NO permissions:
|
|
238
238
|
|
239
239
|
|
240
240
|
### Example
|
241
|
-
|
241
|
+
```{"language":"ruby"}
|
242
242
|
# load the gem
|
243
243
|
require 'purecloudplatformclientv2'
|
244
244
|
# setup authorization
|
@@ -266,7 +266,7 @@ begin
|
|
266
266
|
rescue PureCloud::ApiError => e
|
267
267
|
puts "Exception when calling GreetingsApi->get_greetings: #{e}"
|
268
268
|
end
|
269
|
-
|
269
|
+
```
|
270
270
|
|
271
271
|
### Parameters
|
272
272
|
|
@@ -290,7 +290,7 @@ Name | Type | Description | Notes
|
|
290
290
|
|
291
291
|
<a name="get_greetings_defaults"></a>
|
292
292
|
|
293
|
-
##
|
293
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) get_greetings_defaults
|
294
294
|
|
295
295
|
|
296
296
|
|
@@ -305,7 +305,7 @@ Requires NO permissions:
|
|
305
305
|
|
306
306
|
|
307
307
|
### Example
|
308
|
-
|
308
|
+
```{"language":"ruby"}
|
309
309
|
# load the gem
|
310
310
|
require 'purecloudplatformclientv2'
|
311
311
|
# setup authorization
|
@@ -328,7 +328,7 @@ begin
|
|
328
328
|
rescue PureCloud::ApiError => e
|
329
329
|
puts "Exception when calling GreetingsApi->get_greetings_defaults: #{e}"
|
330
330
|
end
|
331
|
-
|
331
|
+
```
|
332
332
|
|
333
333
|
### Parameters
|
334
334
|
This endpoint does not need any parameter.
|
@@ -348,7 +348,7 @@ This endpoint does not need any parameter.
|
|
348
348
|
|
349
349
|
<a name="get_group_greetings"></a>
|
350
350
|
|
351
|
-
##
|
351
|
+
## [**GreetingListing**](GreetingListing.html) get_group_greetings(group_id, opts)
|
352
352
|
|
353
353
|
|
354
354
|
|
@@ -363,7 +363,7 @@ Requires NO permissions:
|
|
363
363
|
|
364
364
|
|
365
365
|
### Example
|
366
|
-
|
366
|
+
```{"language":"ruby"}
|
367
367
|
# load the gem
|
368
368
|
require 'purecloudplatformclientv2'
|
369
369
|
# setup authorization
|
@@ -393,7 +393,7 @@ begin
|
|
393
393
|
rescue PureCloud::ApiError => e
|
394
394
|
puts "Exception when calling GreetingsApi->get_group_greetings: #{e}"
|
395
395
|
end
|
396
|
-
|
396
|
+
```
|
397
397
|
|
398
398
|
### Parameters
|
399
399
|
|
@@ -418,7 +418,7 @@ Name | Type | Description | Notes
|
|
418
418
|
|
419
419
|
<a name="get_group_greetings_defaults"></a>
|
420
420
|
|
421
|
-
##
|
421
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) get_group_greetings_defaults(group_id)
|
422
422
|
|
423
423
|
|
424
424
|
|
@@ -433,7 +433,7 @@ Requires NO permissions:
|
|
433
433
|
|
434
434
|
|
435
435
|
### Example
|
436
|
-
|
436
|
+
```{"language":"ruby"}
|
437
437
|
# load the gem
|
438
438
|
require 'purecloudplatformclientv2'
|
439
439
|
# setup authorization
|
@@ -459,7 +459,7 @@ begin
|
|
459
459
|
rescue PureCloud::ApiError => e
|
460
460
|
puts "Exception when calling GreetingsApi->get_group_greetings_defaults: #{e}"
|
461
461
|
end
|
462
|
-
|
462
|
+
```
|
463
463
|
|
464
464
|
### Parameters
|
465
465
|
|
@@ -482,7 +482,7 @@ Name | Type | Description | Notes
|
|
482
482
|
|
483
483
|
<a name="get_user_greetings"></a>
|
484
484
|
|
485
|
-
##
|
485
|
+
## [**DomainEntityListing**](DomainEntityListing.html) get_user_greetings(user_id, opts)
|
486
486
|
|
487
487
|
|
488
488
|
|
@@ -497,7 +497,7 @@ Requires NO permissions:
|
|
497
497
|
|
498
498
|
|
499
499
|
### Example
|
500
|
-
|
500
|
+
```{"language":"ruby"}
|
501
501
|
# load the gem
|
502
502
|
require 'purecloudplatformclientv2'
|
503
503
|
# setup authorization
|
@@ -527,7 +527,7 @@ begin
|
|
527
527
|
rescue PureCloud::ApiError => e
|
528
528
|
puts "Exception when calling GreetingsApi->get_user_greetings: #{e}"
|
529
529
|
end
|
530
|
-
|
530
|
+
```
|
531
531
|
|
532
532
|
### Parameters
|
533
533
|
|
@@ -552,7 +552,7 @@ Name | Type | Description | Notes
|
|
552
552
|
|
553
553
|
<a name="get_user_greetings_defaults"></a>
|
554
554
|
|
555
|
-
##
|
555
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) get_user_greetings_defaults(user_id)
|
556
556
|
|
557
557
|
|
558
558
|
|
@@ -567,7 +567,7 @@ Requires NO permissions:
|
|
567
567
|
|
568
568
|
|
569
569
|
### Example
|
570
|
-
|
570
|
+
```{"language":"ruby"}
|
571
571
|
# load the gem
|
572
572
|
require 'purecloudplatformclientv2'
|
573
573
|
# setup authorization
|
@@ -593,7 +593,7 @@ begin
|
|
593
593
|
rescue PureCloud::ApiError => e
|
594
594
|
puts "Exception when calling GreetingsApi->get_user_greetings_defaults: #{e}"
|
595
595
|
end
|
596
|
-
|
596
|
+
```
|
597
597
|
|
598
598
|
### Parameters
|
599
599
|
|
@@ -616,7 +616,7 @@ Name | Type | Description | Notes
|
|
616
616
|
|
617
617
|
<a name="post_greetings"></a>
|
618
618
|
|
619
|
-
##
|
619
|
+
## [**Greeting**](Greeting.html) post_greetings(body)
|
620
620
|
|
621
621
|
|
622
622
|
|
@@ -631,7 +631,7 @@ Requires NO permissions:
|
|
631
631
|
|
632
632
|
|
633
633
|
### Example
|
634
|
-
|
634
|
+
```{"language":"ruby"}
|
635
635
|
# load the gem
|
636
636
|
require 'purecloudplatformclientv2'
|
637
637
|
# setup authorization
|
@@ -657,7 +657,7 @@ begin
|
|
657
657
|
rescue PureCloud::ApiError => e
|
658
658
|
puts "Exception when calling GreetingsApi->post_greetings: #{e}"
|
659
659
|
end
|
660
|
-
|
660
|
+
```
|
661
661
|
|
662
662
|
### Parameters
|
663
663
|
|
@@ -680,7 +680,7 @@ Name | Type | Description | Notes
|
|
680
680
|
|
681
681
|
<a name="post_group_greetings"></a>
|
682
682
|
|
683
|
-
##
|
683
|
+
## [**Greeting**](Greeting.html) post_group_greetings(group_id, body)
|
684
684
|
|
685
685
|
|
686
686
|
|
@@ -695,7 +695,7 @@ Requires NO permissions:
|
|
695
695
|
|
696
696
|
|
697
697
|
### Example
|
698
|
-
|
698
|
+
```{"language":"ruby"}
|
699
699
|
# load the gem
|
700
700
|
require 'purecloudplatformclientv2'
|
701
701
|
# setup authorization
|
@@ -723,7 +723,7 @@ begin
|
|
723
723
|
rescue PureCloud::ApiError => e
|
724
724
|
puts "Exception when calling GreetingsApi->post_group_greetings: #{e}"
|
725
725
|
end
|
726
|
-
|
726
|
+
```
|
727
727
|
|
728
728
|
### Parameters
|
729
729
|
|
@@ -747,7 +747,7 @@ Name | Type | Description | Notes
|
|
747
747
|
|
748
748
|
<a name="post_user_greetings"></a>
|
749
749
|
|
750
|
-
##
|
750
|
+
## [**Greeting**](Greeting.html) post_user_greetings(user_id, body)
|
751
751
|
|
752
752
|
|
753
753
|
|
@@ -762,7 +762,7 @@ Requires NO permissions:
|
|
762
762
|
|
763
763
|
|
764
764
|
### Example
|
765
|
-
|
765
|
+
```{"language":"ruby"}
|
766
766
|
# load the gem
|
767
767
|
require 'purecloudplatformclientv2'
|
768
768
|
# setup authorization
|
@@ -790,7 +790,7 @@ begin
|
|
790
790
|
rescue PureCloud::ApiError => e
|
791
791
|
puts "Exception when calling GreetingsApi->post_user_greetings: #{e}"
|
792
792
|
end
|
793
|
-
|
793
|
+
```
|
794
794
|
|
795
795
|
### Parameters
|
796
796
|
|
@@ -814,7 +814,7 @@ Name | Type | Description | Notes
|
|
814
814
|
|
815
815
|
<a name="put_greeting"></a>
|
816
816
|
|
817
|
-
##
|
817
|
+
## [**Greeting**](Greeting.html) put_greeting(greeting_id, body)
|
818
818
|
|
819
819
|
|
820
820
|
|
@@ -829,7 +829,7 @@ Requires NO permissions:
|
|
829
829
|
|
830
830
|
|
831
831
|
### Example
|
832
|
-
|
832
|
+
```{"language":"ruby"}
|
833
833
|
# load the gem
|
834
834
|
require 'purecloudplatformclientv2'
|
835
835
|
# setup authorization
|
@@ -857,7 +857,7 @@ begin
|
|
857
857
|
rescue PureCloud::ApiError => e
|
858
858
|
puts "Exception when calling GreetingsApi->put_greeting: #{e}"
|
859
859
|
end
|
860
|
-
|
860
|
+
```
|
861
861
|
|
862
862
|
### Parameters
|
863
863
|
|
@@ -881,7 +881,7 @@ Name | Type | Description | Notes
|
|
881
881
|
|
882
882
|
<a name="put_greetings_defaults"></a>
|
883
883
|
|
884
|
-
##
|
884
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) put_greetings_defaults(body)
|
885
885
|
|
886
886
|
|
887
887
|
|
@@ -896,7 +896,7 @@ Requires NO permissions:
|
|
896
896
|
|
897
897
|
|
898
898
|
### Example
|
899
|
-
|
899
|
+
```{"language":"ruby"}
|
900
900
|
# load the gem
|
901
901
|
require 'purecloudplatformclientv2'
|
902
902
|
# setup authorization
|
@@ -922,7 +922,7 @@ begin
|
|
922
922
|
rescue PureCloud::ApiError => e
|
923
923
|
puts "Exception when calling GreetingsApi->put_greetings_defaults: #{e}"
|
924
924
|
end
|
925
|
-
|
925
|
+
```
|
926
926
|
|
927
927
|
### Parameters
|
928
928
|
|
@@ -945,7 +945,7 @@ Name | Type | Description | Notes
|
|
945
945
|
|
946
946
|
<a name="put_group_greetings_defaults"></a>
|
947
947
|
|
948
|
-
##
|
948
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) put_group_greetings_defaults(group_id, body)
|
949
949
|
|
950
950
|
|
951
951
|
|
@@ -960,7 +960,7 @@ Requires NO permissions:
|
|
960
960
|
|
961
961
|
|
962
962
|
### Example
|
963
|
-
|
963
|
+
```{"language":"ruby"}
|
964
964
|
# load the gem
|
965
965
|
require 'purecloudplatformclientv2'
|
966
966
|
# setup authorization
|
@@ -988,7 +988,7 @@ begin
|
|
988
988
|
rescue PureCloud::ApiError => e
|
989
989
|
puts "Exception when calling GreetingsApi->put_group_greetings_defaults: #{e}"
|
990
990
|
end
|
991
|
-
|
991
|
+
```
|
992
992
|
|
993
993
|
### Parameters
|
994
994
|
|
@@ -1012,7 +1012,7 @@ Name | Type | Description | Notes
|
|
1012
1012
|
|
1013
1013
|
<a name="put_user_greetings_defaults"></a>
|
1014
1014
|
|
1015
|
-
##
|
1015
|
+
## [**DefaultGreetingList**](DefaultGreetingList.html) put_user_greetings_defaults(user_id, body)
|
1016
1016
|
|
1017
1017
|
|
1018
1018
|
|
@@ -1027,7 +1027,7 @@ Requires NO permissions:
|
|
1027
1027
|
|
1028
1028
|
|
1029
1029
|
### Example
|
1030
|
-
|
1030
|
+
```{"language":"ruby"}
|
1031
1031
|
# load the gem
|
1032
1032
|
require 'purecloudplatformclientv2'
|
1033
1033
|
# setup authorization
|
@@ -1055,7 +1055,7 @@ begin
|
|
1055
1055
|
rescue PureCloud::ApiError => e
|
1056
1056
|
puts "Exception when calling GreetingsApi->put_user_greetings_defaults: #{e}"
|
1057
1057
|
end
|
1058
|
-
|
1058
|
+
```
|
1059
1059
|
|
1060
1060
|
### Parameters
|
1061
1061
|
|