purecloud-platform-client-v2 164.0.0 → 165.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.
Files changed (78) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +74 -167
  3. package/dist/web-amd/purecloud-platform-client-v2.js +74 -167
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +74 -167
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +74 -167
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +204 -241
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -97
  65. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsersApi.js +5 -3
  71. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -658,66 +658,6 @@ class TelephonyProvidersEdgeApi {
658
658
  );
659
659
  }
660
660
 
661
- /**
662
- * Get line
663
- *
664
- * @param {String} edgeId Edge ID
665
- * @param {String} lineId Line ID
666
- */
667
- getTelephonyProvidersEdgeLine(edgeId, lineId) {
668
- // verify the required parameter 'edgeId' is set
669
- if (edgeId === undefined || edgeId === null) {
670
- throw 'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLine';
671
- }
672
- // verify the required parameter 'lineId' is set
673
- if (lineId === undefined || lineId === null) {
674
- throw 'Missing the required parameter "lineId" when calling getTelephonyProvidersEdgeLine';
675
- }
676
-
677
- return this.apiClient.callApi(
678
- '/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}',
679
- 'GET',
680
- { 'edgeId': edgeId,'lineId': lineId },
681
- { },
682
- { },
683
- { },
684
- null,
685
- ['PureCloud OAuth'],
686
- ['application/json'],
687
- ['application/json']
688
- );
689
- }
690
-
691
- /**
692
- * Get the list of lines.
693
- *
694
- * @param {String} edgeId Edge ID
695
- * @param {Object} opts Optional parameters
696
- * @param {Number} opts.pageSize Page size (default to 25)
697
- * @param {Number} opts.pageNumber Page number (default to 1)
698
- */
699
- getTelephonyProvidersEdgeLines(edgeId, opts) {
700
- opts = opts || {};
701
-
702
- // verify the required parameter 'edgeId' is set
703
- if (edgeId === undefined || edgeId === null) {
704
- throw 'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLines';
705
- }
706
-
707
- return this.apiClient.callApi(
708
- '/api/v2/telephony/providers/edges/{edgeId}/lines',
709
- 'GET',
710
- { 'edgeId': edgeId },
711
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
712
- { },
713
- { },
714
- null,
715
- ['PureCloud OAuth'],
716
- ['application/json'],
717
- ['application/json']
718
- );
719
- }
720
-
721
661
  /**
722
662
  * Get an edge logical interface
723
663
  *
@@ -1555,7 +1495,7 @@ class TelephonyProvidersEdgeApi {
1555
1495
  * @param {Number} opts.pageNumber Page number (default to 1)
1556
1496
  * @param {String} opts.name Name
1557
1497
  * @param {String} opts.sortBy Value by which to sort (default to name)
1558
- * @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
1498
+ * @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated. The edgeGroup value is deprecated.
1559
1499
  */
1560
1500
  getTelephonyProvidersEdgesLines(opts) {
1561
1501
  opts = opts || {};
@@ -3108,41 +3048,6 @@ class TelephonyProvidersEdgeApi {
3108
3048
  );
3109
3049
  }
3110
3050
 
3111
- /**
3112
- * Update a line.
3113
- *
3114
- * @param {String} edgeId Edge ID
3115
- * @param {String} lineId Line ID
3116
- * @param {Object} body Line
3117
- */
3118
- putTelephonyProvidersEdgeLine(edgeId, lineId, body) {
3119
- // verify the required parameter 'edgeId' is set
3120
- if (edgeId === undefined || edgeId === null) {
3121
- throw 'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdgeLine';
3122
- }
3123
- // verify the required parameter 'lineId' is set
3124
- if (lineId === undefined || lineId === null) {
3125
- throw 'Missing the required parameter "lineId" when calling putTelephonyProvidersEdgeLine';
3126
- }
3127
- // verify the required parameter 'body' is set
3128
- if (body === undefined || body === null) {
3129
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgeLine';
3130
- }
3131
-
3132
- return this.apiClient.callApi(
3133
- '/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}',
3134
- 'PUT',
3135
- { 'edgeId': edgeId,'lineId': lineId },
3136
- { },
3137
- { },
3138
- { },
3139
- body,
3140
- ['PureCloud OAuth'],
3141
- ['application/json'],
3142
- ['application/json']
3143
- );
3144
- }
3145
-
3146
3051
  /**
3147
3052
  * Update an edge logical interface.
3148
3053
  *
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1114,6 +1114,7 @@ class UsersApi {
1114
1114
  * @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
1115
1115
  * @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
1116
1116
  * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
1117
+ * @param {Object} opts.pass Specifies if only the failed (pass is False) or passed (pass is True) activities are returned. If pass is Any or if the pass parameter is not supplied, all activities are returned (default to Any)
1117
1118
  * @param {Number} opts.pageSize Page size (default to 25)
1118
1119
  * @param {Number} opts.pageNumber Page number (default to 1)
1119
1120
  * @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)
@@ -1129,7 +1130,7 @@ class UsersApi {
1129
1130
  '/api/v2/users/development/activities',
1130
1131
  'GET',
1131
1132
  { },
1132
- { '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') },
1133
+ { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pass': opts['pass'],'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') },
1133
1134
  { },
1134
1135
  { },
1135
1136
  null,
@@ -1147,6 +1148,7 @@ class UsersApi {
1147
1148
  * @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
1148
1149
  * @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
1149
1150
  * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
1151
+ * @param {Object} opts.pass Specifies if only the failed (pass is False) or passed (pass is True) activities are returned. If pass is Any or if the pass parameter is not supplied, all activities are returned (default to Any)
1150
1152
  * @param {Number} opts.pageSize Page size (default to 25)
1151
1153
  * @param {Number} opts.pageNumber Page number (default to 1)
1152
1154
  * @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)
@@ -1162,7 +1164,7 @@ class UsersApi {
1162
1164
  '/api/v2/users/development/activities/me',
1163
1165
  'GET',
1164
1166
  { },
1165
- { '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') },
1167
+ { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pass': opts['pass'],'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') },
1166
1168
  { },
1167
1169
  { },
1168
1170
  null,
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 164.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -100,7 +100,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
100
100
  * </pre>
101
101
  * </p>
102
102
  * @module purecloud-platform-client-v2/index
103
- * @version 164.0.0
103
+ * @version 165.0.0
104
104
  */
105
105
  class platformClient {
106
106
  constructor() {