purecloud-platform-client-v2 95.0.0 → 98.0.0
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.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +412 -1256
- package/dist/web-cjs/purecloud-platform-client-v2.js +418 -1263
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +319 -128
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +123 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +309 -1148
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
|
@@ -5,7 +5,7 @@ class SCIMApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SCIM service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 98.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -141,8 +141,8 @@ class SCIMApi {
|
|
|
141
141
|
*
|
|
142
142
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
143
143
|
* @param {Object} opts Optional parameters
|
|
144
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
145
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
144
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
145
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
146
146
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
147
147
|
*/
|
|
148
148
|
getScimGroup(groupId, opts) {
|
|
@@ -172,9 +172,9 @@ class SCIMApi {
|
|
|
172
172
|
*
|
|
173
173
|
* @param {Object} opts Optional parameters
|
|
174
174
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
175
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
176
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
177
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
175
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
176
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
177
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
178
178
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
179
179
|
*/
|
|
180
180
|
getScimGroups(opts) {
|
|
@@ -318,9 +318,9 @@ class SCIMApi {
|
|
|
318
318
|
*
|
|
319
319
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
320
320
|
* @param {Object} opts Optional parameters
|
|
321
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
322
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
323
|
-
* @param {String} opts.ifNoneMatch
|
|
321
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
322
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
323
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
324
324
|
*/
|
|
325
325
|
getScimUser(userId, opts) {
|
|
326
326
|
opts = opts || {};
|
|
@@ -349,9 +349,9 @@ class SCIMApi {
|
|
|
349
349
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
350
350
|
* @param {Object} opts Optional parameters
|
|
351
351
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
352
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
353
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
354
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
352
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
353
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
354
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
355
355
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
356
356
|
*/
|
|
357
357
|
getScimUsers(opts) {
|
|
@@ -377,9 +377,9 @@ class SCIMApi {
|
|
|
377
377
|
*
|
|
378
378
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
379
379
|
* @param {Object} opts Optional parameters
|
|
380
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
381
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
382
|
-
* @param {String} opts.ifNoneMatch
|
|
380
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
381
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
382
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
383
383
|
*/
|
|
384
384
|
getScimV2Group(groupId, opts) {
|
|
385
385
|
opts = opts || {};
|
|
@@ -409,9 +409,9 @@ class SCIMApi {
|
|
|
409
409
|
* @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
410
410
|
* @param {Object} opts Optional parameters
|
|
411
411
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
412
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
413
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
414
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
412
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
413
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
414
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
415
415
|
*/
|
|
416
416
|
getScimV2Groups(filter, opts) {
|
|
417
417
|
opts = opts || {};
|
|
@@ -558,8 +558,8 @@ class SCIMApi {
|
|
|
558
558
|
*
|
|
559
559
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
560
560
|
* @param {Object} opts Optional parameters
|
|
561
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
562
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
561
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
562
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
563
563
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
564
564
|
*/
|
|
565
565
|
getScimV2User(userId, opts) {
|
|
@@ -589,9 +589,9 @@ class SCIMApi {
|
|
|
589
589
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
590
590
|
* @param {Object} opts Optional parameters
|
|
591
591
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
592
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
593
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
594
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
592
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
593
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
594
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
595
595
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
596
596
|
*/
|
|
597
597
|
getScimV2Users(opts) {
|
|
@@ -749,8 +749,8 @@ class SCIMApi {
|
|
|
749
749
|
}
|
|
750
750
|
|
|
751
751
|
/**
|
|
752
|
-
*
|
|
753
|
-
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId}
|
|
752
|
+
* Create a group
|
|
753
|
+
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} is allowed.
|
|
754
754
|
* @param {Object} body The information used to create a group.
|
|
755
755
|
*/
|
|
756
756
|
postScimGroups(body) {
|
|
@@ -801,7 +801,7 @@ class SCIMApi {
|
|
|
801
801
|
/**
|
|
802
802
|
* Create a group
|
|
803
803
|
* Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
804
|
-
* @param {Object} body
|
|
804
|
+
* @param {Object} body The information used to create a group.
|
|
805
805
|
*/
|
|
806
806
|
postScimV2Groups(body) {
|
|
807
807
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class TelephonyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Telephony service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 98.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -23,8 +23,8 @@ class TelephonyApi {
|
|
|
23
23
|
/**
|
|
24
24
|
* Fetch SIP metadata
|
|
25
25
|
* Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
|
|
26
|
-
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
27
|
-
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
26
|
+
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
27
|
+
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
28
28
|
* @param {Object} opts Optional parameters
|
|
29
29
|
* @param {String} opts.callId unique identification of the placed call
|
|
30
30
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 98.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1049,6 +1049,103 @@ class UsersApi {
|
|
|
1049
1049
|
);
|
|
1050
1050
|
}
|
|
1051
1051
|
|
|
1052
|
+
/**
|
|
1053
|
+
* Get list of Development Activities
|
|
1054
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
1055
|
+
* @param {Object} opts Optional parameters
|
|
1056
|
+
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
|
|
1057
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
1058
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
1059
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
1060
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
1061
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1062
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1063
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
1064
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
1065
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1066
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
1067
|
+
*/
|
|
1068
|
+
getUsersDevelopmentActivities(opts) {
|
|
1069
|
+
opts = opts || {};
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
return this.apiClient.callApi(
|
|
1073
|
+
'/api/v2/users/development/activities',
|
|
1074
|
+
'GET',
|
|
1075
|
+
{ },
|
|
1076
|
+
{ 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
1077
|
+
{ },
|
|
1078
|
+
{ },
|
|
1079
|
+
null,
|
|
1080
|
+
['PureCloud OAuth'],
|
|
1081
|
+
['application/json'],
|
|
1082
|
+
['application/json']
|
|
1083
|
+
);
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* Get list of Development Activities for current user
|
|
1088
|
+
* Results are filtered based on the applicable permissions.
|
|
1089
|
+
* @param {Object} opts Optional parameters
|
|
1090
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
1091
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
1092
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
1093
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
1094
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1095
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1096
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
1097
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
1098
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1099
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
1100
|
+
*/
|
|
1101
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
1102
|
+
opts = opts || {};
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
return this.apiClient.callApi(
|
|
1106
|
+
'/api/v2/users/development/activities/me',
|
|
1107
|
+
'GET',
|
|
1108
|
+
{ },
|
|
1109
|
+
{ 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
1110
|
+
{ },
|
|
1111
|
+
{ },
|
|
1112
|
+
null,
|
|
1113
|
+
['PureCloud OAuth'],
|
|
1114
|
+
['application/json'],
|
|
1115
|
+
['application/json']
|
|
1116
|
+
);
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* Get a Development Activity
|
|
1121
|
+
*
|
|
1122
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
1123
|
+
* @param {Object} type Specifies the activity type.
|
|
1124
|
+
*/
|
|
1125
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
1126
|
+
// verify the required parameter 'activityId' is set
|
|
1127
|
+
if (activityId === undefined || activityId === null) {
|
|
1128
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
1129
|
+
}
|
|
1130
|
+
// verify the required parameter 'type' is set
|
|
1131
|
+
if (type === undefined || type === null) {
|
|
1132
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
return this.apiClient.callApi(
|
|
1136
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
1137
|
+
'GET',
|
|
1138
|
+
{ 'activityId': activityId },
|
|
1139
|
+
{ 'type': type },
|
|
1140
|
+
{ },
|
|
1141
|
+
{ },
|
|
1142
|
+
null,
|
|
1143
|
+
['PureCloud OAuth'],
|
|
1144
|
+
['application/json'],
|
|
1145
|
+
['application/json']
|
|
1146
|
+
);
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1052
1149
|
/**
|
|
1053
1150
|
* Get current user details.
|
|
1054
1151
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -1735,6 +1832,31 @@ class UsersApi {
|
|
|
1735
1832
|
);
|
|
1736
1833
|
}
|
|
1737
1834
|
|
|
1835
|
+
/**
|
|
1836
|
+
* Retrieve aggregated development activity data
|
|
1837
|
+
* Results are filtered based on the applicable permissions.
|
|
1838
|
+
* @param {Object} body Aggregate Request
|
|
1839
|
+
*/
|
|
1840
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
1841
|
+
// verify the required parameter 'body' is set
|
|
1842
|
+
if (body === undefined || body === null) {
|
|
1843
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
1844
|
+
}
|
|
1845
|
+
|
|
1846
|
+
return this.apiClient.callApi(
|
|
1847
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
1848
|
+
'POST',
|
|
1849
|
+
{ },
|
|
1850
|
+
{ },
|
|
1851
|
+
{ },
|
|
1852
|
+
{ },
|
|
1853
|
+
body,
|
|
1854
|
+
['PureCloud OAuth'],
|
|
1855
|
+
['application/json'],
|
|
1856
|
+
['application/json']
|
|
1857
|
+
);
|
|
1858
|
+
}
|
|
1859
|
+
|
|
1738
1860
|
/**
|
|
1739
1861
|
* Change your password
|
|
1740
1862
|
*
|