purecloud-platform-client-v2 231.0.0 → 232.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 (93) hide show
  1. package/README.md +22 -3
  2. package/dist/node/purecloud-platform-client-v2.js +362 -102
  3. package/dist/web-amd/purecloud-platform-client-v2.js +362 -102
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +169 -103
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +291 -170
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +753 -261
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +31 -6
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +25 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +173 -4
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -2
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +7 -3
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -4
  89. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +31 -1
  93. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
745
745
 
746
746
  /**
747
747
  * @module purecloud-platform-client-v2/ApiClient
748
- * @version 231.0.0
748
+ * @version 232.0.0
749
749
  */
750
750
  class ApiClient {
751
751
  /**
@@ -811,6 +811,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
811
811
  MULTI: 'multi'
812
812
  };
813
813
 
814
+ this.useLegacyParameterFilter = true;
815
+
814
816
  /**
815
817
  * @description Value is `true` if local storage exists. Otherwise, false.
816
818
  */
@@ -1929,12 +1931,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1929
1931
  return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
1930
1932
  }
1931
1933
 
1934
+ /**
1935
+ * @description If set to `true`, the ApiClient will continue to use its legacy approach for filtering method parameters (mapped to an API Endpoint's query parameter). This is option is meant to facilitate transition from legacy to current and accurate parameters filtering.
1936
+ * @param {boolean} useLegacyParameterFilter - `false` to use modern/accurate approach (default value), `true` to use legacy approach (i.e. parameters of boolean type and equal to false are ignored/filtered, parameters of type integer/number and equal to 0 are ignored/filtered)
1937
+ */
1938
+ setUseLegacyParameterFilter(useLegacyParameterFilter) {
1939
+ this.useLegacyParameterFilter = useLegacyParameterFilter;
1940
+ }
1941
+
1942
+ getUseLegacyParameterFilter() {
1943
+ return this.useLegacyParameterFilter;
1944
+ }
1945
+
1932
1946
  /**
1933
1947
  * Returns a string representation for an actual parameter.
1934
1948
  * @param param The actual parameter.
1935
1949
  * @returns {String} The string representation of <code>param</code>.
1936
1950
  */
1937
1951
  paramToString(param) {
1952
+ if (this.useLegacyParameterFilter !== true) {
1953
+ if (param !== null && param !== undefined) {
1954
+ if (typeof param === "boolean") {
1955
+ return param.toString().toLowerCase();
1956
+ } else if (param instanceof Boolean) {
1957
+ return param.toString().toLowerCase();
1958
+ } else if (typeof param === "number") {
1959
+ return param.toString();
1960
+ }
1961
+ }
1962
+ }
1938
1963
  if (!param) {
1939
1964
  return '';
1940
1965
  }
@@ -2098,16 +2123,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2098
2123
 
2099
2124
  switch (collectionFormat) {
2100
2125
  case 'csv':
2101
- return param.map(this.paramToString).join(',');
2126
+ return param.map((x) => this.paramToString(x)).join(',');
2102
2127
  case 'ssv':
2103
- return param.map(this.paramToString).join(' ');
2128
+ return param.map((x) => this.paramToString(x)).join(' ');
2104
2129
  case 'tsv':
2105
- return param.map(this.paramToString).join('\t');
2130
+ return param.map((x) => this.paramToString(x)).join('\t');
2106
2131
  case 'pipes':
2107
- return param.map(this.paramToString).join('|');
2132
+ return param.map((x) => this.paramToString(x)).join('|');
2108
2133
  case 'multi':
2109
2134
  // return the array directly as axios will handle it as expected
2110
- return param.map(this.paramToString);
2135
+ return param.map((x) => this.paramToString(x));
2111
2136
  default:
2112
2137
  throw new Error(`Unknown collection format: ${collectionFormat}`);
2113
2138
  }
@@ -2289,7 +2314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2289
2314
  /**
2290
2315
  * AIStudio service.
2291
2316
  * @module purecloud-platform-client-v2/api/AIStudioApi
2292
- * @version 231.0.0
2317
+ * @version 232.0.0
2293
2318
  */
2294
2319
 
2295
2320
  /**
@@ -2861,7 +2886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2861
2886
  /**
2862
2887
  * AgentAssistants service.
2863
2888
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2864
- * @version 231.0.0
2889
+ * @version 232.0.0
2865
2890
  */
2866
2891
 
2867
2892
  /**
@@ -3347,7 +3372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3347
3372
  /**
3348
3373
  * AgentCopilot service.
3349
3374
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3350
- * @version 231.0.0
3375
+ * @version 232.0.0
3351
3376
  */
3352
3377
 
3353
3378
  /**
@@ -3387,6 +3412,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3387
3412
  );
3388
3413
  }
3389
3414
 
3415
+ /**
3416
+ * Get information about the support of features for all the languages or only for a certain language.
3417
+ *
3418
+ * @param {Object} opts Optional parameters
3419
+ * @param {String} opts.language Which language are the features supported for
3420
+ */
3421
+ getAssistantsCopilotFeaturesupport(opts) {
3422
+ opts = opts || {};
3423
+
3424
+
3425
+ return this.apiClient.callApi(
3426
+ '/api/v2/assistants/copilot/featuresupport',
3427
+ 'GET',
3428
+ { },
3429
+ { 'language': opts['language'] },
3430
+ { },
3431
+ { },
3432
+ null,
3433
+ ['PureCloud OAuth'],
3434
+ ['application/json'],
3435
+ ['application/json']
3436
+ );
3437
+ }
3438
+
3390
3439
  /**
3391
3440
  * Update agent copilot configuration
3392
3441
  *
@@ -3423,7 +3472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3423
3472
  /**
3424
3473
  * AgentUI service.
3425
3474
  * @module purecloud-platform-client-v2/api/AgentUIApi
3426
- * @version 231.0.0
3475
+ * @version 232.0.0
3427
3476
  */
3428
3477
 
3429
3478
  /**
@@ -3554,7 +3603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3554
3603
  /**
3555
3604
  * Alerting service.
3556
3605
  * @module purecloud-platform-client-v2/api/AlertingApi
3557
- * @version 231.0.0
3606
+ * @version 232.0.0
3558
3607
  */
3559
3608
 
3560
3609
  /**
@@ -3955,7 +4004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3955
4004
  /**
3956
4005
  * Analytics service.
3957
4006
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3958
- * @version 231.0.0
4007
+ * @version 232.0.0
3959
4008
  */
3960
4009
 
3961
4010
  /**
@@ -7223,7 +7272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7223
7272
  /**
7224
7273
  * Architect service.
7225
7274
  * @module purecloud-platform-client-v2/api/ArchitectApi
7226
- * @version 231.0.0
7275
+ * @version 232.0.0
7227
7276
  */
7228
7277
 
7229
7278
  /**
@@ -11518,7 +11567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11518
11567
  /**
11519
11568
  * Audit service.
11520
11569
  * @module purecloud-platform-client-v2/api/AuditApi
11521
- * @version 231.0.0
11570
+ * @version 232.0.0
11522
11571
  */
11523
11572
 
11524
11573
  /**
@@ -11719,7 +11768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11719
11768
  /**
11720
11769
  * Authorization service.
11721
11770
  * @module purecloud-platform-client-v2/api/AuthorizationApi
11722
- * @version 231.0.0
11771
+ * @version 232.0.0
11723
11772
  */
11724
11773
 
11725
11774
  /**
@@ -13434,7 +13483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13434
13483
  /**
13435
13484
  * Billing service.
13436
13485
  * @module purecloud-platform-client-v2/api/BillingApi
13437
- * @version 231.0.0
13486
+ * @version 232.0.0
13438
13487
  */
13439
13488
 
13440
13489
  /**
@@ -13690,7 +13739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13690
13739
  /**
13691
13740
  * BusinessRules service.
13692
13741
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
13693
- * @version 231.0.0
13742
+ * @version 232.0.0
13694
13743
  */
13695
13744
 
13696
13745
  /**
@@ -14606,7 +14655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14606
14655
  /**
14607
14656
  * CarrierServices service.
14608
14657
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
14609
- * @version 231.0.0
14658
+ * @version 232.0.0
14610
14659
  */
14611
14660
 
14612
14661
  /**
@@ -14676,7 +14725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14676
14725
  /**
14677
14726
  * Chat service.
14678
14727
  * @module purecloud-platform-client-v2/api/ChatApi
14679
- * @version 231.0.0
14728
+ * @version 232.0.0
14680
14729
  */
14681
14730
 
14682
14731
  /**
@@ -15657,7 +15706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15657
15706
  /**
15658
15707
  * Coaching service.
15659
15708
  * @module purecloud-platform-client-v2/api/CoachingApi
15660
- * @version 231.0.0
15709
+ * @version 232.0.0
15661
15710
  */
15662
15711
 
15663
15712
  /**
@@ -16234,7 +16283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16234
16283
  /**
16235
16284
  * ContentManagement service.
16236
16285
  * @module purecloud-platform-client-v2/api/ContentManagementApi
16237
- * @version 231.0.0
16286
+ * @version 232.0.0
16238
16287
  */
16239
16288
 
16240
16289
  /**
@@ -17315,7 +17364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17315
17364
  /**
17316
17365
  * Conversations service.
17317
17366
  * @module purecloud-platform-client-v2/api/ConversationsApi
17318
- * @version 231.0.0
17367
+ * @version 232.0.0
17319
17368
  */
17320
17369
 
17321
17370
  /**
@@ -17556,6 +17605,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17556
17605
  );
17557
17606
  }
17558
17607
 
17608
+ /**
17609
+ * Delete an Apple messaging integration
17610
+ *
17611
+ * @param {String} integrationId Integration ID
17612
+ */
17613
+ deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId) {
17614
+ // verify the required parameter 'integrationId' is set
17615
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
17616
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';
17617
+ }
17618
+
17619
+ return this.apiClient.callApi(
17620
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
17621
+ 'DELETE',
17622
+ { 'integrationId': integrationId },
17623
+ { },
17624
+ { },
17625
+ { },
17626
+ null,
17627
+ ['PureCloud OAuth'],
17628
+ ['application/json'],
17629
+ ['application/json']
17630
+ );
17631
+ }
17632
+
17559
17633
  /**
17560
17634
  * Delete a Facebook messaging integration
17561
17635
  *
@@ -19691,7 +19765,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19691
19765
  * Get Apple messaging integration identity resolution settings
19692
19766
  *
19693
19767
  * @param {String} integrationId Integration ID
19694
- * getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19695
19768
  */
19696
19769
  getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
19697
19770
  // verify the required parameter 'integrationId' is set
@@ -19891,6 +19964,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19891
19964
  );
19892
19965
  }
19893
19966
 
19967
+ /**
19968
+ * Get a list of Apple Integrations
19969
+ *
19970
+ * @param {Object} opts Optional parameters
19971
+ * @param {Number} opts.pageSize Page size (default to 25)
19972
+ * @param {Number} opts.pageNumber Page number (default to 1)
19973
+ * @param {Object} opts.expand Expand instructions for the return value.
19974
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
19975
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
19976
+ */
19977
+ getConversationsMessagingIntegrationsApple(opts) {
19978
+ opts = opts || {};
19979
+
19980
+
19981
+ return this.apiClient.callApi(
19982
+ '/api/v2/conversations/messaging/integrations/apple',
19983
+ 'GET',
19984
+ { },
19985
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
19986
+ { },
19987
+ { },
19988
+ null,
19989
+ ['PureCloud OAuth'],
19990
+ ['application/json'],
19991
+ ['application/json']
19992
+ );
19993
+ }
19994
+
19995
+ /**
19996
+ * Get an Apple messaging integration
19997
+ *
19998
+ * @param {String} integrationId Integration ID
19999
+ * @param {Object} opts Optional parameters
20000
+ * @param {Object} opts.expand Expand instructions for the return value.
20001
+ */
20002
+ getConversationsMessagingIntegrationsAppleIntegrationId(integrationId, opts) {
20003
+ opts = opts || {};
20004
+
20005
+ // verify the required parameter 'integrationId' is set
20006
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
20007
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';
20008
+ }
20009
+
20010
+ return this.apiClient.callApi(
20011
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
20012
+ 'GET',
20013
+ { 'integrationId': integrationId },
20014
+ { 'expand': opts['expand'] },
20015
+ { },
20016
+ { },
20017
+ null,
20018
+ ['PureCloud OAuth'],
20019
+ ['application/json'],
20020
+ ['application/json']
20021
+ );
20022
+ }
20023
+
19894
20024
  /**
19895
20025
  * Get a list of Facebook Integrations
19896
20026
  *
@@ -20196,6 +20326,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20196
20326
  );
20197
20327
  }
20198
20328
 
20329
+ /**
20330
+ * Call Authentication provider callback to validate state and code
20331
+ *
20332
+ * @param {String} code The authorization code to be sent to the authentication server during the token request.
20333
+ * @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
20334
+ * @param {Object} opts Optional parameters
20335
+ * @param {String} opts.error Error parameter from OAuth provider
20336
+ */
20337
+ getConversationsMessagingOauthAppleCallback(code, state, opts) {
20338
+ opts = opts || {};
20339
+
20340
+ // verify the required parameter 'code' is set
20341
+ if (code === undefined || code === null) {
20342
+ throw 'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';
20343
+ }
20344
+ // verify the required parameter 'state' is set
20345
+ if (state === undefined || state === null) {
20346
+ throw 'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';
20347
+ }
20348
+
20349
+ return this.apiClient.callApi(
20350
+ '/api/v2/conversations/messaging/oauth/apple/callback',
20351
+ 'GET',
20352
+ { },
20353
+ { 'code': code,'state': state,'error': opts['error'] },
20354
+ { },
20355
+ { },
20356
+ null,
20357
+ ['PureCloud OAuth'],
20358
+ ['application/json'],
20359
+ ['application/json']
20360
+ );
20361
+ }
20362
+
20199
20363
  /**
20200
20364
  * Get a messaging setting
20201
20365
  *
@@ -21814,6 +21978,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21814
21978
  );
21815
21979
  }
21816
21980
 
21981
+ /**
21982
+ * Update an Apple messaging integration
21983
+ *
21984
+ * @param {String} integrationId Integration ID
21985
+ * @param {Object} body AppleIntegrationUpdateRequest
21986
+ */
21987
+ patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId, body) {
21988
+ // verify the required parameter 'integrationId' is set
21989
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
21990
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
21991
+ }
21992
+ // verify the required parameter 'body' is set
21993
+ if (body === undefined || body === null) {
21994
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
21995
+ }
21996
+
21997
+ return this.apiClient.callApi(
21998
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
21999
+ 'PATCH',
22000
+ { 'integrationId': integrationId },
22001
+ { },
22002
+ { },
22003
+ { },
22004
+ body,
22005
+ ['PureCloud OAuth'],
22006
+ ['application/json'],
22007
+ ['application/json']
22008
+ );
22009
+ }
22010
+
21817
22011
  /**
21818
22012
  * Update Facebook messaging integration
21819
22013
  *
@@ -23268,7 +23462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23268
23462
  }
23269
23463
 
23270
23464
  /**
23271
- * Add participants to a conversation without a user context
23465
+ * Add participants to a conversation on behalf of a user
23272
23466
  *
23273
23467
  * @param {String} conversationId conversationId
23274
23468
  * @param {String} userId userId
@@ -24577,6 +24771,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24577
24771
  );
24578
24772
  }
24579
24773
 
24774
+ /**
24775
+ * Create Apple Integration
24776
+ *
24777
+ * @param {Object} body AppleIntegrationRequest
24778
+ */
24779
+ postConversationsMessagingIntegrationsApple(body) {
24780
+ // verify the required parameter 'body' is set
24781
+ if (body === undefined || body === null) {
24782
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';
24783
+ }
24784
+
24785
+ return this.apiClient.callApi(
24786
+ '/api/v2/conversations/messaging/integrations/apple',
24787
+ 'POST',
24788
+ { },
24789
+ { },
24790
+ { },
24791
+ { },
24792
+ body,
24793
+ ['PureCloud OAuth'],
24794
+ ['application/json'],
24795
+ ['application/json']
24796
+ );
24797
+ }
24798
+
24580
24799
  /**
24581
24800
  * Create a Facebook Integration
24582
24801
  *
@@ -25355,7 +25574,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25355
25574
  *
25356
25575
  * @param {String} integrationId Integration ID
25357
25576
  * @param {Object} body IdentityResolutionConfig
25358
- * putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25359
25577
  */
25360
25578
  putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
25361
25579
  // verify the required parameter 'integrationId' is set
@@ -25703,7 +25921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25703
25921
  /**
25704
25922
  * DataExtensions service.
25705
25923
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
25706
- * @version 231.0.0
25924
+ * @version 232.0.0
25707
25925
  */
25708
25926
 
25709
25927
  /**
@@ -25789,7 +26007,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25789
26007
  /**
25790
26008
  * DataPrivacy service.
25791
26009
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
25792
- * @version 231.0.0
26010
+ * @version 232.0.0
25793
26011
  */
25794
26012
 
25795
26013
  /**
@@ -25959,7 +26177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25959
26177
  /**
25960
26178
  * Downloads service.
25961
26179
  * @module purecloud-platform-client-v2/api/DownloadsApi
25962
- * @version 231.0.0
26180
+ * @version 232.0.0
25963
26181
  */
25964
26182
 
25965
26183
  /**
@@ -26011,7 +26229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26011
26229
  /**
26012
26230
  * Emails service.
26013
26231
  * @module purecloud-platform-client-v2/api/EmailsApi
26014
- * @version 231.0.0
26232
+ * @version 232.0.0
26015
26233
  */
26016
26234
 
26017
26235
  /**
@@ -26140,7 +26358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26140
26358
  /**
26141
26359
  * EmployeeEngagement service.
26142
26360
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
26143
- * @version 231.0.0
26361
+ * @version 232.0.0
26144
26362
  */
26145
26363
 
26146
26364
  /**
@@ -26291,7 +26509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26291
26509
  /**
26292
26510
  * Events service.
26293
26511
  * @module purecloud-platform-client-v2/api/EventsApi
26294
- * @version 231.0.0
26512
+ * @version 232.0.0
26295
26513
  */
26296
26514
 
26297
26515
  /**
@@ -26387,7 +26605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26387
26605
  /**
26388
26606
  * ExternalContacts service.
26389
26607
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
26390
- * @version 231.0.0
26608
+ * @version 232.0.0
26391
26609
  */
26392
26610
 
26393
26611
  /**
@@ -29634,7 +29852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29634
29852
  /**
29635
29853
  * Fax service.
29636
29854
  * @module purecloud-platform-client-v2/api/FaxApi
29637
- * @version 231.0.0
29855
+ * @version 232.0.0
29638
29856
  */
29639
29857
 
29640
29858
  /**
@@ -29849,7 +30067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29849
30067
  /**
29850
30068
  * Flows service.
29851
30069
  * @module purecloud-platform-client-v2/api/FlowsApi
29852
- * @version 231.0.0
30070
+ * @version 232.0.0
29853
30071
  */
29854
30072
 
29855
30073
  /**
@@ -30058,7 +30276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30058
30276
  /**
30059
30277
  * Gamification service.
30060
30278
  * @module purecloud-platform-client-v2/api/GamificationApi
30061
- * @version 231.0.0
30279
+ * @version 232.0.0
30062
30280
  */
30063
30281
 
30064
30282
  /**
@@ -32565,7 +32783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32565
32783
  /**
32566
32784
  * GeneralDataProtectionRegulation service.
32567
32785
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
32568
- * @version 231.0.0
32786
+ * @version 232.0.0
32569
32787
  */
32570
32788
 
32571
32789
  /**
@@ -32695,7 +32913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32695
32913
  /**
32696
32914
  * Geolocation service.
32697
32915
  * @module purecloud-platform-client-v2/api/GeolocationApi
32698
- * @version 231.0.0
32916
+ * @version 232.0.0
32699
32917
  */
32700
32918
 
32701
32919
  /**
@@ -32826,7 +33044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32826
33044
  /**
32827
33045
  * Greetings service.
32828
33046
  * @module purecloud-platform-client-v2/api/GreetingsApi
32829
- * @version 231.0.0
33047
+ * @version 232.0.0
32830
33048
  */
32831
33049
 
32832
33050
  /**
@@ -33368,7 +33586,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33368
33586
  /**
33369
33587
  * Groups service.
33370
33588
  * @module purecloud-platform-client-v2/api/GroupsApi
33371
- * @version 231.0.0
33589
+ * @version 232.0.0
33372
33590
  */
33373
33591
 
33374
33592
  /**
@@ -33887,7 +34105,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33887
34105
  /**
33888
34106
  * IdentityProvider service.
33889
34107
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
33890
- * @version 231.0.0
34108
+ * @version 232.0.0
33891
34109
  */
33892
34110
 
33893
34111
  /**
@@ -34748,7 +34966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34748
34966
  /**
34749
34967
  * InfrastructureAsCode service.
34750
34968
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
34751
- * @version 231.0.0
34969
+ * @version 232.0.0
34752
34970
  */
34753
34971
 
34754
34972
  /**
@@ -34915,7 +35133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34915
35133
  /**
34916
35134
  * Integrations service.
34917
35135
  * @module purecloud-platform-client-v2/api/IntegrationsApi
34918
- * @version 231.0.0
35136
+ * @version 232.0.0
34919
35137
  */
34920
35138
 
34921
35139
  /**
@@ -35099,6 +35317,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35099
35317
  * @param {Array.<String>} opts.expand variable name requested by expand list
35100
35318
  * @param {String} opts.nextPage next page token
35101
35319
  * @param {String} opts.previousPage Previous page token
35320
+ * @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
35321
+ * @param {String} opts.integrationType Filter integrations by integration type ID
35322
+ * @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
35102
35323
  */
35103
35324
  getIntegrations(opts) {
35104
35325
  opts = opts || {};
@@ -35108,7 +35329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35108
35329
  '/api/v2/integrations',
35109
35330
  'GET',
35110
35331
  { },
35111
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
35332
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
35112
35333
  { },
35113
35334
  { },
35114
35335
  null,
@@ -37560,7 +37781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37560
37781
  /**
37561
37782
  * Journey service.
37562
37783
  * @module purecloud-platform-client-v2/api/JourneyApi
37563
- * @version 231.0.0
37784
+ * @version 232.0.0
37564
37785
  */
37565
37786
 
37566
37787
  /**
@@ -39657,7 +39878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39657
39878
  /**
39658
39879
  * Knowledge service.
39659
39880
  * @module purecloud-platform-client-v2/api/KnowledgeApi
39660
- * @version 231.0.0
39881
+ * @version 232.0.0
39661
39882
  */
39662
39883
 
39663
39884
  /**
@@ -43559,7 +43780,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43559
43780
  /**
43560
43781
  * LanguageUnderstanding service.
43561
43782
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
43562
- * @version 231.0.0
43783
+ * @version 232.0.0
43563
43784
  */
43564
43785
 
43565
43786
  /**
@@ -44778,7 +44999,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44778
44999
  /**
44779
45000
  * Languages service.
44780
45001
  * @module purecloud-platform-client-v2/api/LanguagesApi
44781
- * @version 231.0.0
45002
+ * @version 232.0.0
44782
45003
  */
44783
45004
 
44784
45005
  /**
@@ -45000,7 +45221,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45000
45221
  /**
45001
45222
  * Learning service.
45002
45223
  * @module purecloud-platform-client-v2/api/LearningApi
45003
- * @version 231.0.0
45224
+ * @version 232.0.0
45004
45225
  */
45005
45226
 
45006
45227
  /**
@@ -45998,8 +46219,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45998
46219
  * This will update a learning module rule with the specified fields.
45999
46220
  * @param {String} moduleId The ID of the learning module
46000
46221
  * @param {Object} body The learning module rule to be updated
46222
+ * @param {Object} opts Optional parameters
46223
+ * @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
46001
46224
  */
46002
- putLearningModuleRule(moduleId, body) {
46225
+ putLearningModuleRule(moduleId, body, opts) {
46226
+ opts = opts || {};
46227
+
46003
46228
  // verify the required parameter 'moduleId' is set
46004
46229
  if (moduleId === undefined || moduleId === null || moduleId === '') {
46005
46230
  throw 'Missing the required parameter "moduleId" when calling putLearningModuleRule';
@@ -46013,7 +46238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46013
46238
  '/api/v2/learning/modules/{moduleId}/rule',
46014
46239
  'PUT',
46015
46240
  { 'moduleId': moduleId },
46016
- { },
46241
+ { 'assign': opts['assign'] },
46017
46242
  { },
46018
46243
  { },
46019
46244
  body,
@@ -46029,7 +46254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46029
46254
  /**
46030
46255
  * License service.
46031
46256
  * @module purecloud-platform-client-v2/api/LicenseApi
46032
- * @version 231.0.0
46257
+ * @version 232.0.0
46033
46258
  */
46034
46259
 
46035
46260
  /**
@@ -46267,7 +46492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46267
46492
  /**
46268
46493
  * Locations service.
46269
46494
  * @module purecloud-platform-client-v2/api/LocationsApi
46270
- * @version 231.0.0
46495
+ * @version 232.0.0
46271
46496
  */
46272
46497
 
46273
46498
  /**
@@ -46503,7 +46728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46503
46728
  /**
46504
46729
  * LogCapture service.
46505
46730
  * @module purecloud-platform-client-v2/api/LogCaptureApi
46506
- * @version 231.0.0
46731
+ * @version 232.0.0
46507
46732
  */
46508
46733
 
46509
46734
  /**
@@ -46702,7 +46927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46702
46927
  /**
46703
46928
  * Messaging service.
46704
46929
  * @module purecloud-platform-client-v2/api/MessagingApi
46705
- * @version 231.0.0
46930
+ * @version 232.0.0
46706
46931
  */
46707
46932
 
46708
46933
  /**
@@ -47061,7 +47286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47061
47286
  /**
47062
47287
  * MobileDevices service.
47063
47288
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
47064
- * @version 231.0.0
47289
+ * @version 232.0.0
47065
47290
  */
47066
47291
 
47067
47292
  /**
@@ -47212,7 +47437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47212
47437
  /**
47213
47438
  * Notifications service.
47214
47439
  * @module purecloud-platform-client-v2/api/NotificationsApi
47215
- * @version 231.0.0
47440
+ * @version 232.0.0
47216
47441
  */
47217
47442
 
47218
47443
  /**
@@ -47445,7 +47670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47445
47670
  /**
47446
47671
  * OAuth service.
47447
47672
  * @module purecloud-platform-client-v2/api/OAuthApi
47448
- * @version 231.0.0
47673
+ * @version 232.0.0
47449
47674
  */
47450
47675
 
47451
47676
  /**
@@ -47811,7 +48036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47811
48036
  /**
47812
48037
  * Objects service.
47813
48038
  * @module purecloud-platform-client-v2/api/ObjectsApi
47814
- * @version 231.0.0
48039
+ * @version 232.0.0
47815
48040
  */
47816
48041
 
47817
48042
  /**
@@ -48135,7 +48360,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48135
48360
  /**
48136
48361
  * OperationalEvents service.
48137
48362
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
48138
- * @version 231.0.0
48363
+ * @version 232.0.0
48139
48364
  */
48140
48365
 
48141
48366
  /**
@@ -48252,7 +48477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48252
48477
  /**
48253
48478
  * Organization service.
48254
48479
  * @module purecloud-platform-client-v2/api/OrganizationApi
48255
- * @version 231.0.0
48480
+ * @version 232.0.0
48256
48481
  */
48257
48482
 
48258
48483
  /**
@@ -48727,7 +48952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48727
48952
  /**
48728
48953
  * OrganizationAuthorization service.
48729
48954
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
48730
- * @version 231.0.0
48955
+ * @version 232.0.0
48731
48956
  */
48732
48957
 
48733
48958
  /**
@@ -50121,7 +50346,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50121
50346
  /**
50122
50347
  * Outbound service.
50123
50348
  * @module purecloud-platform-client-v2/api/OutboundApi
50124
- * @version 231.0.0
50349
+ * @version 232.0.0
50125
50350
  */
50126
50351
 
50127
50352
  /**
@@ -54843,7 +55068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54843
55068
  /**
54844
55069
  * Presence service.
54845
55070
  * @module purecloud-platform-client-v2/api/PresenceApi
54846
- * @version 231.0.0
55071
+ * @version 232.0.0
54847
55072
  */
54848
55073
 
54849
55074
  /**
@@ -55587,7 +55812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55587
55812
  /**
55588
55813
  * ProcessAutomation service.
55589
55814
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
55590
- * @version 231.0.0
55815
+ * @version 232.0.0
55591
55816
  */
55592
55817
 
55593
55818
  /**
@@ -55826,7 +56051,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55826
56051
  /**
55827
56052
  * Quality service.
55828
56053
  * @module purecloud-platform-client-v2/api/QualityApi
55829
- * @version 231.0.0
56054
+ * @version 232.0.0
55830
56055
  */
55831
56056
 
55832
56057
  /**
@@ -56409,7 +56634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56409
56634
  }
56410
56635
 
56411
56636
  /**
56412
- * Get an evaluator activity
56637
+ * Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
56413
56638
  *
56414
56639
  * @param {Object} opts Optional parameters
56415
56640
  * @param {Number} opts.pageSize The total page size requested (default to 25)
@@ -57771,7 +57996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57771
57996
  /**
57772
57997
  * Recording service.
57773
57998
  * @module purecloud-platform-client-v2/api/RecordingApi
57774
- * @version 231.0.0
57999
+ * @version 232.0.0
57775
58000
  */
57776
58001
 
57777
58002
  /**
@@ -59376,7 +59601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59376
59601
  /**
59377
59602
  * ResponseManagement service.
59378
59603
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
59379
- * @version 231.0.0
59604
+ * @version 232.0.0
59380
59605
  */
59381
59606
 
59382
59607
  /**
@@ -59886,7 +60111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59886
60111
  /**
59887
60112
  * Routing service.
59888
60113
  * @module purecloud-platform-client-v2/api/RoutingApi
59889
- * @version 231.0.0
60114
+ * @version 232.0.0
59890
60115
  */
59891
60116
 
59892
60117
  /**
@@ -61120,6 +61345,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61120
61345
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
61121
61346
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
61122
61347
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
61348
+ * @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
61349
+ * @param {Object} opts.state The state used to filter predictors.
61123
61350
  */
61124
61351
  getRoutingPredictors(opts) {
61125
61352
  opts = opts || {};
@@ -61129,7 +61356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61129
61356
  '/api/v2/routing/predictors',
61130
61357
  'GET',
61131
61358
  { },
61132
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
61359
+ { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi'),'kpiId': opts['kpiId'],'state': opts['state'] },
61133
61360
  { },
61134
61361
  { },
61135
61362
  null,
@@ -61198,7 +61425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61198
61425
  *
61199
61426
  * @param {String} queueId Queue ID
61200
61427
  * @param {Object} opts Optional parameters
61201
- * @param {Object} opts.expand Which fields, if any, to expand.
61428
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand.
61202
61429
  */
61203
61430
  getRoutingQueueAssistant(queueId, opts) {
61204
61431
  opts = opts || {};
@@ -61212,7 +61439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61212
61439
  '/api/v2/routing/queues/{queueId}/assistant',
61213
61440
  'GET',
61214
61441
  { 'queueId': queueId },
61215
- { 'expand': opts['expand'] },
61442
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
61216
61443
  { },
61217
61444
  { },
61218
61445
  null,
@@ -64212,7 +64439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64212
64439
  /**
64213
64440
  * SCIM service.
64214
64441
  * @module purecloud-platform-client-v2/api/SCIMApi
64215
- * @version 231.0.0
64442
+ * @version 232.0.0
64216
64443
  */
64217
64444
 
64218
64445
  /**
@@ -65089,7 +65316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65089
65316
  /**
65090
65317
  * ScreenRecording service.
65091
65318
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
65092
- * @version 231.0.0
65319
+ * @version 232.0.0
65093
65320
  */
65094
65321
 
65095
65322
  /**
@@ -65134,7 +65361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65134
65361
  /**
65135
65362
  * Scripts service.
65136
65363
  * @module purecloud-platform-client-v2/api/ScriptsApi
65137
- * @version 231.0.0
65364
+ * @version 232.0.0
65138
65365
  */
65139
65366
 
65140
65367
  /**
@@ -65610,7 +65837,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65610
65837
  /**
65611
65838
  * Search service.
65612
65839
  * @module purecloud-platform-client-v2/api/SearchApi
65613
- * @version 231.0.0
65840
+ * @version 232.0.0
65614
65841
  */
65615
65842
 
65616
65843
  /**
@@ -66328,7 +66555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66328
66555
  /**
66329
66556
  * Settings service.
66330
66557
  * @module purecloud-platform-client-v2/api/SettingsApi
66331
- * @version 231.0.0
66558
+ * @version 232.0.0
66332
66559
  */
66333
66560
 
66334
66561
  /**
@@ -66676,7 +66903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66676
66903
  /**
66677
66904
  * SocialMedia service.
66678
66905
  * @module purecloud-platform-client-v2/api/SocialMediaApi
66679
- * @version 231.0.0
66906
+ * @version 232.0.0
66680
66907
  */
66681
66908
 
66682
66909
  /**
@@ -68267,7 +68494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68267
68494
  /**
68268
68495
  * SpeechTextAnalytics service.
68269
68496
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
68270
- * @version 231.0.0
68497
+ * @version 232.0.0
68271
68498
  */
68272
68499
 
68273
68500
  /**
@@ -69913,7 +70140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69913
70140
  /**
69914
70141
  * Stations service.
69915
70142
  * @module purecloud-platform-client-v2/api/StationsApi
69916
- * @version 231.0.0
70143
+ * @version 232.0.0
69917
70144
  */
69918
70145
 
69919
70146
  /**
@@ -70015,7 +70242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70015
70242
  /**
70016
70243
  * Suggest service.
70017
70244
  * @module purecloud-platform-client-v2/api/SuggestApi
70018
- * @version 231.0.0
70245
+ * @version 232.0.0
70019
70246
  */
70020
70247
 
70021
70248
  /**
@@ -70154,7 +70381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70154
70381
  /**
70155
70382
  * TaskManagement service.
70156
70383
  * @module purecloud-platform-client-v2/api/TaskManagementApi
70157
- * @version 231.0.0
70384
+ * @version 232.0.0
70158
70385
  */
70159
70386
 
70160
70387
  /**
@@ -72316,7 +72543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72316
72543
  /**
72317
72544
  * Teams service.
72318
72545
  * @module purecloud-platform-client-v2/api/TeamsApi
72319
- * @version 231.0.0
72546
+ * @version 232.0.0
72320
72547
  */
72321
72548
 
72322
72549
  /**
@@ -72621,7 +72848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72621
72848
  /**
72622
72849
  * Telephony service.
72623
72850
  * @module purecloud-platform-client-v2/api/TelephonyApi
72624
- * @version 231.0.0
72851
+ * @version 232.0.0
72625
72852
  */
72626
72853
 
72627
72854
  /**
@@ -72907,7 +73134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72907
73134
  /**
72908
73135
  * TelephonyProvidersEdge service.
72909
73136
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
72910
- * @version 231.0.0
73137
+ * @version 232.0.0
72911
73138
  */
72912
73139
 
72913
73140
  /**
@@ -76400,7 +76627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76400
76627
  /**
76401
76628
  * Textbots service.
76402
76629
  * @module purecloud-platform-client-v2/api/TextbotsApi
76403
- * @version 231.0.0
76630
+ * @version 232.0.0
76404
76631
  */
76405
76632
 
76406
76633
  /**
@@ -76529,7 +76756,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76529
76756
  /**
76530
76757
  * Tokens service.
76531
76758
  * @module purecloud-platform-client-v2/api/TokensApi
76532
- * @version 231.0.0
76759
+ * @version 232.0.0
76533
76760
  */
76534
76761
 
76535
76762
  /**
@@ -76683,7 +76910,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76683
76910
  /**
76684
76911
  * Uploads service.
76685
76912
  * @module purecloud-platform-client-v2/api/UploadsApi
76686
- * @version 231.0.0
76913
+ * @version 232.0.0
76687
76914
  */
76688
76915
 
76689
76916
  /**
@@ -76974,7 +77201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76974
77201
  /**
76975
77202
  * Usage service.
76976
77203
  * @module purecloud-platform-client-v2/api/UsageApi
76977
- * @version 231.0.0
77204
+ * @version 232.0.0
76978
77205
  */
76979
77206
 
76980
77207
  /**
@@ -77309,7 +77536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
77309
77536
  /**
77310
77537
  * UserRecordings service.
77311
77538
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
77312
- * @version 231.0.0
77539
+ * @version 232.0.0
77313
77540
  */
77314
77541
 
77315
77542
  /**
@@ -77493,7 +77720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
77493
77720
  /**
77494
77721
  * Users service.
77495
77722
  * @module purecloud-platform-client-v2/api/UsersApi
77496
- * @version 231.0.0
77723
+ * @version 232.0.0
77497
77724
  */
77498
77725
 
77499
77726
  /**
@@ -80502,7 +80729,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80502
80729
  /**
80503
80730
  * Utilities service.
80504
80731
  * @module purecloud-platform-client-v2/api/UtilitiesApi
80505
- * @version 231.0.0
80732
+ * @version 232.0.0
80506
80733
  */
80507
80734
 
80508
80735
  /**
@@ -80613,7 +80840,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80613
80840
  /**
80614
80841
  * Voicemail service.
80615
80842
  * @module purecloud-platform-client-v2/api/VoicemailApi
80616
- * @version 231.0.0
80843
+ * @version 232.0.0
80617
80844
  */
80618
80845
 
80619
80846
  /**
@@ -81335,7 +81562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81335
81562
  /**
81336
81563
  * WebChat service.
81337
81564
  * @module purecloud-platform-client-v2/api/WebChatApi
81338
- * @version 231.0.0
81565
+ * @version 232.0.0
81339
81566
  */
81340
81567
 
81341
81568
  /**
@@ -81409,7 +81636,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81409
81636
 
81410
81637
  /**
81411
81638
  * Remove WebChat deployment settings
81412
- *
81639
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81640
+ * @deprecated
81413
81641
  */
81414
81642
  deleteWebchatSettings() {
81415
81643
 
@@ -81660,7 +81888,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81660
81888
 
81661
81889
  /**
81662
81890
  * Get WebChat deployment settings
81663
- *
81891
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81892
+ * @deprecated
81664
81893
  */
81665
81894
  getWebchatSettings() {
81666
81895
 
@@ -81866,8 +82095,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81866
82095
 
81867
82096
  /**
81868
82097
  * Update WebChat deployment settings
81869
- *
82098
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81870
82099
  * @param {Object} body webChatSettings
82100
+ * @deprecated
81871
82101
  */
81872
82102
  putWebchatSettings(body) {
81873
82103
  // verify the required parameter 'body' is set
@@ -81895,7 +82125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81895
82125
  /**
81896
82126
  * WebDeployments service.
81897
82127
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
81898
- * @version 231.0.0
82128
+ * @version 232.0.0
81899
82129
  */
81900
82130
 
81901
82131
  /**
@@ -82477,7 +82707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82477
82707
  /**
82478
82708
  * WebMessaging service.
82479
82709
  * @module purecloud-platform-client-v2/api/WebMessagingApi
82480
- * @version 231.0.0
82710
+ * @version 232.0.0
82481
82711
  */
82482
82712
 
82483
82713
  /**
@@ -82623,7 +82853,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82623
82853
  /**
82624
82854
  * Widgets service.
82625
82855
  * @module purecloud-platform-client-v2/api/WidgetsApi
82626
- * @version 231.0.0
82856
+ * @version 232.0.0
82627
82857
  */
82628
82858
 
82629
82859
  /**
@@ -82774,7 +83004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82774
83004
  /**
82775
83005
  * WorkforceManagement service.
82776
83006
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
82777
- * @version 231.0.0
83007
+ * @version 232.0.0
82778
83008
  */
82779
83009
 
82780
83010
  /**
@@ -87910,6 +88140,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
87910
88140
  );
87911
88141
  }
87912
88142
 
88143
+ /**
88144
+ * Fetch agent schedules for the logged in user's management unit
88145
+ *
88146
+ * @param {Object} body body
88147
+ * @param {Object} opts Optional parameters
88148
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
88149
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
88150
+ */
88151
+ postWorkforcemanagementAgentschedulesManagementunitsMine(body, opts) {
88152
+ opts = opts || {};
88153
+
88154
+ // verify the required parameter 'body' is set
88155
+ if (body === undefined || body === null) {
88156
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesManagementunitsMine';
88157
+ }
88158
+
88159
+ return this.apiClient.callApi(
88160
+ '/api/v2/workforcemanagement/agentschedules/managementunits/mine',
88161
+ 'POST',
88162
+ { },
88163
+ { 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
88164
+ { },
88165
+ { },
88166
+ body,
88167
+ ['PureCloud OAuth'],
88168
+ ['application/json'],
88169
+ ['application/json']
88170
+ );
88171
+ }
88172
+
87913
88173
  /**
87914
88174
  * Get published schedule for the current user
87915
88175
  *
@@ -90744,7 +91004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
90744
91004
  * </pre>
90745
91005
  * </p>
90746
91006
  * @module purecloud-platform-client-v2/index
90747
- * @version 231.0.0
91007
+ * @version 232.0.0
90748
91008
  */
90749
91009
  class platformClient {
90750
91010
  constructor() {