purecloud-platform-client-v2 231.0.0 → 233.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 +378 -111
  3. package/dist/web-amd/purecloud-platform-client-v2.js +378 -111
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +183 -112
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +183 -112
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1090 -522
  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 +3 -3
  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 +11 -5
  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 +3 -2
  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 +3 -3
  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
@@ -748,7 +748,7 @@ class Configuration {
748
748
 
749
749
  /**
750
750
  * @module purecloud-platform-client-v2/ApiClient
751
- * @version 231.0.0
751
+ * @version 233.0.0
752
752
  */
753
753
  class ApiClient {
754
754
  /**
@@ -814,6 +814,8 @@ class ApiClient {
814
814
  MULTI: 'multi'
815
815
  };
816
816
 
817
+ this.useLegacyParameterFilter = true;
818
+
817
819
  /**
818
820
  * @description Value is `true` if local storage exists. Otherwise, false.
819
821
  */
@@ -1932,12 +1934,35 @@ class ApiClient {
1932
1934
  return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
1933
1935
  }
1934
1936
 
1937
+ /**
1938
+ * @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.
1939
+ * @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)
1940
+ */
1941
+ setUseLegacyParameterFilter(useLegacyParameterFilter) {
1942
+ this.useLegacyParameterFilter = useLegacyParameterFilter;
1943
+ }
1944
+
1945
+ getUseLegacyParameterFilter() {
1946
+ return this.useLegacyParameterFilter;
1947
+ }
1948
+
1935
1949
  /**
1936
1950
  * Returns a string representation for an actual parameter.
1937
1951
  * @param param The actual parameter.
1938
1952
  * @returns {String} The string representation of <code>param</code>.
1939
1953
  */
1940
1954
  paramToString(param) {
1955
+ if (this.useLegacyParameterFilter !== true) {
1956
+ if (param !== null && param !== undefined) {
1957
+ if (typeof param === "boolean") {
1958
+ return param.toString().toLowerCase();
1959
+ } else if (param instanceof Boolean) {
1960
+ return param.toString().toLowerCase();
1961
+ } else if (typeof param === "number") {
1962
+ return param.toString();
1963
+ }
1964
+ }
1965
+ }
1941
1966
  if (!param) {
1942
1967
  return '';
1943
1968
  }
@@ -2101,16 +2126,16 @@ class ApiClient {
2101
2126
 
2102
2127
  switch (collectionFormat) {
2103
2128
  case 'csv':
2104
- return param.map(this.paramToString).join(',');
2129
+ return param.map((x) => this.paramToString(x)).join(',');
2105
2130
  case 'ssv':
2106
- return param.map(this.paramToString).join(' ');
2131
+ return param.map((x) => this.paramToString(x)).join(' ');
2107
2132
  case 'tsv':
2108
- return param.map(this.paramToString).join('\t');
2133
+ return param.map((x) => this.paramToString(x)).join('\t');
2109
2134
  case 'pipes':
2110
- return param.map(this.paramToString).join('|');
2135
+ return param.map((x) => this.paramToString(x)).join('|');
2111
2136
  case 'multi':
2112
2137
  // return the array directly as axios will handle it as expected
2113
- return param.map(this.paramToString);
2138
+ return param.map((x) => this.paramToString(x));
2114
2139
  default:
2115
2140
  throw new Error(`Unknown collection format: ${collectionFormat}`);
2116
2141
  }
@@ -2292,7 +2317,7 @@ class AIStudioApi {
2292
2317
  /**
2293
2318
  * AIStudio service.
2294
2319
  * @module purecloud-platform-client-v2/api/AIStudioApi
2295
- * @version 231.0.0
2320
+ * @version 233.0.0
2296
2321
  */
2297
2322
 
2298
2323
  /**
@@ -2864,7 +2889,7 @@ class AgentAssistantsApi {
2864
2889
  /**
2865
2890
  * AgentAssistants service.
2866
2891
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2867
- * @version 231.0.0
2892
+ * @version 233.0.0
2868
2893
  */
2869
2894
 
2870
2895
  /**
@@ -3350,7 +3375,7 @@ class AgentCopilotApi {
3350
3375
  /**
3351
3376
  * AgentCopilot service.
3352
3377
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3353
- * @version 231.0.0
3378
+ * @version 233.0.0
3354
3379
  */
3355
3380
 
3356
3381
  /**
@@ -3390,6 +3415,30 @@ class AgentCopilotApi {
3390
3415
  );
3391
3416
  }
3392
3417
 
3418
+ /**
3419
+ * Get information about the support of features for all the languages or only for a certain language.
3420
+ *
3421
+ * @param {Object} opts Optional parameters
3422
+ * @param {String} opts.language Which language are the features supported for
3423
+ */
3424
+ getAssistantsCopilotFeaturesupport(opts) {
3425
+ opts = opts || {};
3426
+
3427
+
3428
+ return this.apiClient.callApi(
3429
+ '/api/v2/assistants/copilot/featuresupport',
3430
+ 'GET',
3431
+ { },
3432
+ { 'language': opts['language'] },
3433
+ { },
3434
+ { },
3435
+ null,
3436
+ ['PureCloud OAuth'],
3437
+ ['application/json'],
3438
+ ['application/json']
3439
+ );
3440
+ }
3441
+
3393
3442
  /**
3394
3443
  * Update agent copilot configuration
3395
3444
  *
@@ -3426,7 +3475,7 @@ class AgentUIApi {
3426
3475
  /**
3427
3476
  * AgentUI service.
3428
3477
  * @module purecloud-platform-client-v2/api/AgentUIApi
3429
- * @version 231.0.0
3478
+ * @version 233.0.0
3430
3479
  */
3431
3480
 
3432
3481
  /**
@@ -3557,7 +3606,7 @@ class AlertingApi {
3557
3606
  /**
3558
3607
  * Alerting service.
3559
3608
  * @module purecloud-platform-client-v2/api/AlertingApi
3560
- * @version 231.0.0
3609
+ * @version 233.0.0
3561
3610
  */
3562
3611
 
3563
3612
  /**
@@ -3958,7 +4007,7 @@ class AnalyticsApi {
3958
4007
  /**
3959
4008
  * Analytics service.
3960
4009
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3961
- * @version 231.0.0
4010
+ * @version 233.0.0
3962
4011
  */
3963
4012
 
3964
4013
  /**
@@ -7226,7 +7275,7 @@ class ArchitectApi {
7226
7275
  /**
7227
7276
  * Architect service.
7228
7277
  * @module purecloud-platform-client-v2/api/ArchitectApi
7229
- * @version 231.0.0
7278
+ * @version 233.0.0
7230
7279
  */
7231
7280
 
7232
7281
  /**
@@ -11521,7 +11570,7 @@ class AuditApi {
11521
11570
  /**
11522
11571
  * Audit service.
11523
11572
  * @module purecloud-platform-client-v2/api/AuditApi
11524
- * @version 231.0.0
11573
+ * @version 233.0.0
11525
11574
  */
11526
11575
 
11527
11576
  /**
@@ -11722,7 +11771,7 @@ class AuthorizationApi {
11722
11771
  /**
11723
11772
  * Authorization service.
11724
11773
  * @module purecloud-platform-client-v2/api/AuthorizationApi
11725
- * @version 231.0.0
11774
+ * @version 233.0.0
11726
11775
  */
11727
11776
 
11728
11777
  /**
@@ -13437,7 +13486,7 @@ class BillingApi {
13437
13486
  /**
13438
13487
  * Billing service.
13439
13488
  * @module purecloud-platform-client-v2/api/BillingApi
13440
- * @version 231.0.0
13489
+ * @version 233.0.0
13441
13490
  */
13442
13491
 
13443
13492
  /**
@@ -13693,7 +13742,7 @@ class BusinessRulesApi {
13693
13742
  /**
13694
13743
  * BusinessRules service.
13695
13744
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
13696
- * @version 231.0.0
13745
+ * @version 233.0.0
13697
13746
  */
13698
13747
 
13699
13748
  /**
@@ -14477,7 +14526,7 @@ class BusinessRulesApi {
14477
14526
  /**
14478
14527
  * Create a schema
14479
14528
  *
14480
- * @param {Object} body Schema
14529
+ * @param {Object} body Business Rules Schema Create Request
14481
14530
  * postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14482
14531
  */
14483
14532
  postBusinessrulesSchemas(body) {
@@ -14576,7 +14625,7 @@ class BusinessRulesApi {
14576
14625
  * Update a schema
14577
14626
  *
14578
14627
  * @param {String} schemaId Schema ID
14579
- * @param {Object} body Data Schema
14628
+ * @param {Object} body Business Rules Schema Update Request
14580
14629
  * putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14581
14630
  */
14582
14631
  putBusinessrulesSchema(schemaId, body) {
@@ -14609,7 +14658,7 @@ class CarrierServicesApi {
14609
14658
  /**
14610
14659
  * CarrierServices service.
14611
14660
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
14612
- * @version 231.0.0
14661
+ * @version 233.0.0
14613
14662
  */
14614
14663
 
14615
14664
  /**
@@ -14679,7 +14728,7 @@ class ChatApi {
14679
14728
  /**
14680
14729
  * Chat service.
14681
14730
  * @module purecloud-platform-client-v2/api/ChatApi
14682
- * @version 231.0.0
14731
+ * @version 233.0.0
14683
14732
  */
14684
14733
 
14685
14734
  /**
@@ -15660,7 +15709,7 @@ class CoachingApi {
15660
15709
  /**
15661
15710
  * Coaching service.
15662
15711
  * @module purecloud-platform-client-v2/api/CoachingApi
15663
- * @version 231.0.0
15712
+ * @version 233.0.0
15664
15713
  */
15665
15714
 
15666
15715
  /**
@@ -16237,7 +16286,7 @@ class ContentManagementApi {
16237
16286
  /**
16238
16287
  * ContentManagement service.
16239
16288
  * @module purecloud-platform-client-v2/api/ContentManagementApi
16240
- * @version 231.0.0
16289
+ * @version 233.0.0
16241
16290
  */
16242
16291
 
16243
16292
  /**
@@ -17318,7 +17367,7 @@ class ConversationsApi {
17318
17367
  /**
17319
17368
  * Conversations service.
17320
17369
  * @module purecloud-platform-client-v2/api/ConversationsApi
17321
- * @version 231.0.0
17370
+ * @version 233.0.0
17322
17371
  */
17323
17372
 
17324
17373
  /**
@@ -17559,6 +17608,31 @@ class ConversationsApi {
17559
17608
  );
17560
17609
  }
17561
17610
 
17611
+ /**
17612
+ * Delete an Apple messaging integration
17613
+ *
17614
+ * @param {String} integrationId Integration ID
17615
+ */
17616
+ deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId) {
17617
+ // verify the required parameter 'integrationId' is set
17618
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
17619
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';
17620
+ }
17621
+
17622
+ return this.apiClient.callApi(
17623
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
17624
+ 'DELETE',
17625
+ { 'integrationId': integrationId },
17626
+ { },
17627
+ { },
17628
+ { },
17629
+ null,
17630
+ ['PureCloud OAuth'],
17631
+ ['application/json'],
17632
+ ['application/json']
17633
+ );
17634
+ }
17635
+
17562
17636
  /**
17563
17637
  * Delete a Facebook messaging integration
17564
17638
  *
@@ -19694,7 +19768,6 @@ class ConversationsApi {
19694
19768
  * Get Apple messaging integration identity resolution settings
19695
19769
  *
19696
19770
  * @param {String} integrationId Integration ID
19697
- * getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19698
19771
  */
19699
19772
  getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
19700
19773
  // verify the required parameter 'integrationId' is set
@@ -19894,6 +19967,63 @@ class ConversationsApi {
19894
19967
  );
19895
19968
  }
19896
19969
 
19970
+ /**
19971
+ * Get a list of Apple Integrations
19972
+ *
19973
+ * @param {Object} opts Optional parameters
19974
+ * @param {Number} opts.pageSize Page size (default to 25)
19975
+ * @param {Number} opts.pageNumber Page number (default to 1)
19976
+ * @param {Object} opts.expand Expand instructions for the return value.
19977
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
19978
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
19979
+ */
19980
+ getConversationsMessagingIntegrationsApple(opts) {
19981
+ opts = opts || {};
19982
+
19983
+
19984
+ return this.apiClient.callApi(
19985
+ '/api/v2/conversations/messaging/integrations/apple',
19986
+ 'GET',
19987
+ { },
19988
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
19989
+ { },
19990
+ { },
19991
+ null,
19992
+ ['PureCloud OAuth'],
19993
+ ['application/json'],
19994
+ ['application/json']
19995
+ );
19996
+ }
19997
+
19998
+ /**
19999
+ * Get an Apple messaging integration
20000
+ *
20001
+ * @param {String} integrationId Integration ID
20002
+ * @param {Object} opts Optional parameters
20003
+ * @param {Object} opts.expand Expand instructions for the return value.
20004
+ */
20005
+ getConversationsMessagingIntegrationsAppleIntegrationId(integrationId, opts) {
20006
+ opts = opts || {};
20007
+
20008
+ // verify the required parameter 'integrationId' is set
20009
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
20010
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';
20011
+ }
20012
+
20013
+ return this.apiClient.callApi(
20014
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
20015
+ 'GET',
20016
+ { 'integrationId': integrationId },
20017
+ { 'expand': opts['expand'] },
20018
+ { },
20019
+ { },
20020
+ null,
20021
+ ['PureCloud OAuth'],
20022
+ ['application/json'],
20023
+ ['application/json']
20024
+ );
20025
+ }
20026
+
19897
20027
  /**
19898
20028
  * Get a list of Facebook Integrations
19899
20029
  *
@@ -20199,6 +20329,40 @@ class ConversationsApi {
20199
20329
  );
20200
20330
  }
20201
20331
 
20332
+ /**
20333
+ * Call Authentication provider callback to validate state and code
20334
+ *
20335
+ * @param {String} code The authorization code to be sent to the authentication server during the token request.
20336
+ * @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
20337
+ * @param {Object} opts Optional parameters
20338
+ * @param {String} opts.error Error parameter from OAuth provider
20339
+ */
20340
+ getConversationsMessagingOauthAppleCallback(code, state, opts) {
20341
+ opts = opts || {};
20342
+
20343
+ // verify the required parameter 'code' is set
20344
+ if (code === undefined || code === null) {
20345
+ throw 'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';
20346
+ }
20347
+ // verify the required parameter 'state' is set
20348
+ if (state === undefined || state === null) {
20349
+ throw 'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';
20350
+ }
20351
+
20352
+ return this.apiClient.callApi(
20353
+ '/api/v2/conversations/messaging/oauth/apple/callback',
20354
+ 'GET',
20355
+ { },
20356
+ { 'code': code,'state': state,'error': opts['error'] },
20357
+ { },
20358
+ { },
20359
+ null,
20360
+ ['PureCloud OAuth'],
20361
+ ['application/json'],
20362
+ ['application/json']
20363
+ );
20364
+ }
20365
+
20202
20366
  /**
20203
20367
  * Get a messaging setting
20204
20368
  *
@@ -21817,6 +21981,36 @@ class ConversationsApi {
21817
21981
  );
21818
21982
  }
21819
21983
 
21984
+ /**
21985
+ * Update an Apple messaging integration
21986
+ *
21987
+ * @param {String} integrationId Integration ID
21988
+ * @param {Object} body AppleIntegrationUpdateRequest
21989
+ */
21990
+ patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId, body) {
21991
+ // verify the required parameter 'integrationId' is set
21992
+ if (integrationId === undefined || integrationId === null || integrationId === '') {
21993
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
21994
+ }
21995
+ // verify the required parameter 'body' is set
21996
+ if (body === undefined || body === null) {
21997
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
21998
+ }
21999
+
22000
+ return this.apiClient.callApi(
22001
+ '/api/v2/conversations/messaging/integrations/apple/{integrationId}',
22002
+ 'PATCH',
22003
+ { 'integrationId': integrationId },
22004
+ { },
22005
+ { },
22006
+ { },
22007
+ body,
22008
+ ['PureCloud OAuth'],
22009
+ ['application/json'],
22010
+ ['application/json']
22011
+ );
22012
+ }
22013
+
21820
22014
  /**
21821
22015
  * Update Facebook messaging integration
21822
22016
  *
@@ -23271,7 +23465,7 @@ class ConversationsApi {
23271
23465
  }
23272
23466
 
23273
23467
  /**
23274
- * Add participants to a conversation without a user context
23468
+ * Add participants to a conversation on behalf of a user
23275
23469
  *
23276
23470
  * @param {String} conversationId conversationId
23277
23471
  * @param {String} userId userId
@@ -24580,6 +24774,31 @@ class ConversationsApi {
24580
24774
  );
24581
24775
  }
24582
24776
 
24777
+ /**
24778
+ * Create Apple Integration
24779
+ *
24780
+ * @param {Object} body AppleIntegrationRequest
24781
+ */
24782
+ postConversationsMessagingIntegrationsApple(body) {
24783
+ // verify the required parameter 'body' is set
24784
+ if (body === undefined || body === null) {
24785
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';
24786
+ }
24787
+
24788
+ return this.apiClient.callApi(
24789
+ '/api/v2/conversations/messaging/integrations/apple',
24790
+ 'POST',
24791
+ { },
24792
+ { },
24793
+ { },
24794
+ { },
24795
+ body,
24796
+ ['PureCloud OAuth'],
24797
+ ['application/json'],
24798
+ ['application/json']
24799
+ );
24800
+ }
24801
+
24583
24802
  /**
24584
24803
  * Create a Facebook Integration
24585
24804
  *
@@ -25358,7 +25577,6 @@ class ConversationsApi {
25358
25577
  *
25359
25578
  * @param {String} integrationId Integration ID
25360
25579
  * @param {Object} body IdentityResolutionConfig
25361
- * putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25362
25580
  */
25363
25581
  putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
25364
25582
  // verify the required parameter 'integrationId' is set
@@ -25706,7 +25924,7 @@ class DataExtensionsApi {
25706
25924
  /**
25707
25925
  * DataExtensions service.
25708
25926
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
25709
- * @version 231.0.0
25927
+ * @version 233.0.0
25710
25928
  */
25711
25929
 
25712
25930
  /**
@@ -25792,7 +26010,7 @@ class DataPrivacyApi {
25792
26010
  /**
25793
26011
  * DataPrivacy service.
25794
26012
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
25795
- * @version 231.0.0
26013
+ * @version 233.0.0
25796
26014
  */
25797
26015
 
25798
26016
  /**
@@ -25962,7 +26180,7 @@ class DownloadsApi {
25962
26180
  /**
25963
26181
  * Downloads service.
25964
26182
  * @module purecloud-platform-client-v2/api/DownloadsApi
25965
- * @version 231.0.0
26183
+ * @version 233.0.0
25966
26184
  */
25967
26185
 
25968
26186
  /**
@@ -26014,7 +26232,7 @@ class EmailsApi {
26014
26232
  /**
26015
26233
  * Emails service.
26016
26234
  * @module purecloud-platform-client-v2/api/EmailsApi
26017
- * @version 231.0.0
26235
+ * @version 233.0.0
26018
26236
  */
26019
26237
 
26020
26238
  /**
@@ -26143,7 +26361,7 @@ class EmployeeEngagementApi {
26143
26361
  /**
26144
26362
  * EmployeeEngagement service.
26145
26363
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
26146
- * @version 231.0.0
26364
+ * @version 233.0.0
26147
26365
  */
26148
26366
 
26149
26367
  /**
@@ -26294,7 +26512,7 @@ class EventsApi {
26294
26512
  /**
26295
26513
  * Events service.
26296
26514
  * @module purecloud-platform-client-v2/api/EventsApi
26297
- * @version 231.0.0
26515
+ * @version 233.0.0
26298
26516
  */
26299
26517
 
26300
26518
  /**
@@ -26390,7 +26608,7 @@ class ExternalContactsApi {
26390
26608
  /**
26391
26609
  * ExternalContacts service.
26392
26610
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
26393
- * @version 231.0.0
26611
+ * @version 233.0.0
26394
26612
  */
26395
26613
 
26396
26614
  /**
@@ -29637,7 +29855,7 @@ class FaxApi {
29637
29855
  /**
29638
29856
  * Fax service.
29639
29857
  * @module purecloud-platform-client-v2/api/FaxApi
29640
- * @version 231.0.0
29858
+ * @version 233.0.0
29641
29859
  */
29642
29860
 
29643
29861
  /**
@@ -29852,7 +30070,7 @@ class FlowsApi {
29852
30070
  /**
29853
30071
  * Flows service.
29854
30072
  * @module purecloud-platform-client-v2/api/FlowsApi
29855
- * @version 231.0.0
30073
+ * @version 233.0.0
29856
30074
  */
29857
30075
 
29858
30076
  /**
@@ -30061,7 +30279,7 @@ class GamificationApi {
30061
30279
  /**
30062
30280
  * Gamification service.
30063
30281
  * @module purecloud-platform-client-v2/api/GamificationApi
30064
- * @version 231.0.0
30282
+ * @version 233.0.0
30065
30283
  */
30066
30284
 
30067
30285
  /**
@@ -30421,6 +30639,7 @@ class GamificationApi {
30421
30639
  * @param {String} opts.sortMetricId Sort Metric Id
30422
30640
  * @param {Object} opts.sortOrder Sort order (default to asc)
30423
30641
  * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
30642
+ * @param {String} opts.reportsTo The reportsTo used by ABAC policies.
30424
30643
  */
30425
30644
  getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
30426
30645
  opts = opts || {};
@@ -30450,7 +30669,7 @@ class GamificationApi {
30450
30669
  '/api/v2/gamification/insights',
30451
30670
  'GET',
30452
30671
  { },
30453
- { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'] },
30672
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'],'reportsTo': opts['reportsTo'] },
30454
30673
  { },
30455
30674
  { },
30456
30675
  null,
@@ -30622,8 +30841,12 @@ class GamificationApi {
30622
30841
  * @param {String} filterId ID for the filter type.
30623
30842
  * @param {Object} granularity Granularity
30624
30843
  * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
30844
+ * @param {Object} opts Optional parameters
30845
+ * @param {String} opts.reportsTo The reportsTo used by ABAC policies.
30625
30846
  */
30626
- getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
30847
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday, opts) {
30848
+ opts = opts || {};
30849
+
30627
30850
  // verify the required parameter 'filterType' is set
30628
30851
  if (filterType === undefined || filterType === null) {
30629
30852
  throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
@@ -30645,7 +30868,7 @@ class GamificationApi {
30645
30868
  '/api/v2/gamification/insights/members',
30646
30869
  'GET',
30647
30870
  { },
30648
- { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
30871
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'reportsTo': opts['reportsTo'] },
30649
30872
  { },
30650
30873
  { },
30651
30874
  null,
@@ -30668,6 +30891,7 @@ class GamificationApi {
30668
30891
  * @param {String} opts.sortMetricId Sort Metric Id
30669
30892
  * @param {Number} opts.sectionSize The number of top and bottom users to return before ties
30670
30893
  * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
30894
+ * @param {String} opts.reportsTo The reportsTo used by ABAC policies.
30671
30895
  */
30672
30896
  getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
30673
30897
  opts = opts || {};
@@ -30701,7 +30925,7 @@ class GamificationApi {
30701
30925
  '/api/v2/gamification/insights/rankings',
30702
30926
  'GET',
30703
30927
  { },
30704
- { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
30928
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'],'reportsTo': opts['reportsTo'] },
30705
30929
  { },
30706
30930
  { },
30707
30931
  null,
@@ -32568,7 +32792,7 @@ class GeneralDataProtectionRegulationApi {
32568
32792
  /**
32569
32793
  * GeneralDataProtectionRegulation service.
32570
32794
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
32571
- * @version 231.0.0
32795
+ * @version 233.0.0
32572
32796
  */
32573
32797
 
32574
32798
  /**
@@ -32698,7 +32922,7 @@ class GeolocationApi {
32698
32922
  /**
32699
32923
  * Geolocation service.
32700
32924
  * @module purecloud-platform-client-v2/api/GeolocationApi
32701
- * @version 231.0.0
32925
+ * @version 233.0.0
32702
32926
  */
32703
32927
 
32704
32928
  /**
@@ -32829,7 +33053,7 @@ class GreetingsApi {
32829
33053
  /**
32830
33054
  * Greetings service.
32831
33055
  * @module purecloud-platform-client-v2/api/GreetingsApi
32832
- * @version 231.0.0
33056
+ * @version 233.0.0
32833
33057
  */
32834
33058
 
32835
33059
  /**
@@ -33371,7 +33595,7 @@ class GroupsApi {
33371
33595
  /**
33372
33596
  * Groups service.
33373
33597
  * @module purecloud-platform-client-v2/api/GroupsApi
33374
- * @version 231.0.0
33598
+ * @version 233.0.0
33375
33599
  */
33376
33600
 
33377
33601
  /**
@@ -33890,7 +34114,7 @@ class IdentityProviderApi {
33890
34114
  /**
33891
34115
  * IdentityProvider service.
33892
34116
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
33893
- * @version 231.0.0
34117
+ * @version 233.0.0
33894
34118
  */
33895
34119
 
33896
34120
  /**
@@ -34751,7 +34975,7 @@ class InfrastructureAsCodeApi {
34751
34975
  /**
34752
34976
  * InfrastructureAsCode service.
34753
34977
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
34754
- * @version 231.0.0
34978
+ * @version 233.0.0
34755
34979
  */
34756
34980
 
34757
34981
  /**
@@ -34918,7 +35142,7 @@ class IntegrationsApi {
34918
35142
  /**
34919
35143
  * Integrations service.
34920
35144
  * @module purecloud-platform-client-v2/api/IntegrationsApi
34921
- * @version 231.0.0
35145
+ * @version 233.0.0
34922
35146
  */
34923
35147
 
34924
35148
  /**
@@ -35102,6 +35326,9 @@ class IntegrationsApi {
35102
35326
  * @param {Array.<String>} opts.expand variable name requested by expand list
35103
35327
  * @param {String} opts.nextPage next page token
35104
35328
  * @param {String} opts.previousPage Previous page token
35329
+ * @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
35330
+ * @param {String} opts.integrationType Filter integrations by integration type ID
35331
+ * @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
35105
35332
  */
35106
35333
  getIntegrations(opts) {
35107
35334
  opts = opts || {};
@@ -35111,7 +35338,7 @@ class IntegrationsApi {
35111
35338
  '/api/v2/integrations',
35112
35339
  'GET',
35113
35340
  { },
35114
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
35341
+ { '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'] },
35115
35342
  { },
35116
35343
  { },
35117
35344
  null,
@@ -37563,7 +37790,7 @@ class JourneyApi {
37563
37790
  /**
37564
37791
  * Journey service.
37565
37792
  * @module purecloud-platform-client-v2/api/JourneyApi
37566
- * @version 231.0.0
37793
+ * @version 233.0.0
37567
37794
  */
37568
37795
 
37569
37796
  /**
@@ -39660,7 +39887,7 @@ class KnowledgeApi {
39660
39887
  /**
39661
39888
  * Knowledge service.
39662
39889
  * @module purecloud-platform-client-v2/api/KnowledgeApi
39663
- * @version 231.0.0
39890
+ * @version 233.0.0
39664
39891
  */
39665
39892
 
39666
39893
  /**
@@ -43562,7 +43789,7 @@ class LanguageUnderstandingApi {
43562
43789
  /**
43563
43790
  * LanguageUnderstanding service.
43564
43791
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
43565
- * @version 231.0.0
43792
+ * @version 233.0.0
43566
43793
  */
43567
43794
 
43568
43795
  /**
@@ -44781,7 +45008,7 @@ class LanguagesApi {
44781
45008
  /**
44782
45009
  * Languages service.
44783
45010
  * @module purecloud-platform-client-v2/api/LanguagesApi
44784
- * @version 231.0.0
45011
+ * @version 233.0.0
44785
45012
  */
44786
45013
 
44787
45014
  /**
@@ -45003,7 +45230,7 @@ class LearningApi {
45003
45230
  /**
45004
45231
  * Learning service.
45005
45232
  * @module purecloud-platform-client-v2/api/LearningApi
45006
- * @version 231.0.0
45233
+ * @version 233.0.0
45007
45234
  */
45008
45235
 
45009
45236
  /**
@@ -46001,8 +46228,12 @@ class LearningApi {
46001
46228
  * This will update a learning module rule with the specified fields.
46002
46229
  * @param {String} moduleId The ID of the learning module
46003
46230
  * @param {Object} body The learning module rule to be updated
46231
+ * @param {Object} opts Optional parameters
46232
+ * @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
46004
46233
  */
46005
- putLearningModuleRule(moduleId, body) {
46234
+ putLearningModuleRule(moduleId, body, opts) {
46235
+ opts = opts || {};
46236
+
46006
46237
  // verify the required parameter 'moduleId' is set
46007
46238
  if (moduleId === undefined || moduleId === null || moduleId === '') {
46008
46239
  throw 'Missing the required parameter "moduleId" when calling putLearningModuleRule';
@@ -46016,7 +46247,7 @@ class LearningApi {
46016
46247
  '/api/v2/learning/modules/{moduleId}/rule',
46017
46248
  'PUT',
46018
46249
  { 'moduleId': moduleId },
46019
- { },
46250
+ { 'assign': opts['assign'] },
46020
46251
  { },
46021
46252
  { },
46022
46253
  body,
@@ -46032,7 +46263,7 @@ class LicenseApi {
46032
46263
  /**
46033
46264
  * License service.
46034
46265
  * @module purecloud-platform-client-v2/api/LicenseApi
46035
- * @version 231.0.0
46266
+ * @version 233.0.0
46036
46267
  */
46037
46268
 
46038
46269
  /**
@@ -46270,7 +46501,7 @@ class LocationsApi {
46270
46501
  /**
46271
46502
  * Locations service.
46272
46503
  * @module purecloud-platform-client-v2/api/LocationsApi
46273
- * @version 231.0.0
46504
+ * @version 233.0.0
46274
46505
  */
46275
46506
 
46276
46507
  /**
@@ -46506,7 +46737,7 @@ class LogCaptureApi {
46506
46737
  /**
46507
46738
  * LogCapture service.
46508
46739
  * @module purecloud-platform-client-v2/api/LogCaptureApi
46509
- * @version 231.0.0
46740
+ * @version 233.0.0
46510
46741
  */
46511
46742
 
46512
46743
  /**
@@ -46705,7 +46936,7 @@ class MessagingApi {
46705
46936
  /**
46706
46937
  * Messaging service.
46707
46938
  * @module purecloud-platform-client-v2/api/MessagingApi
46708
- * @version 231.0.0
46939
+ * @version 233.0.0
46709
46940
  */
46710
46941
 
46711
46942
  /**
@@ -47064,7 +47295,7 @@ class MobileDevicesApi {
47064
47295
  /**
47065
47296
  * MobileDevices service.
47066
47297
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
47067
- * @version 231.0.0
47298
+ * @version 233.0.0
47068
47299
  */
47069
47300
 
47070
47301
  /**
@@ -47215,7 +47446,7 @@ class NotificationsApi {
47215
47446
  /**
47216
47447
  * Notifications service.
47217
47448
  * @module purecloud-platform-client-v2/api/NotificationsApi
47218
- * @version 231.0.0
47449
+ * @version 233.0.0
47219
47450
  */
47220
47451
 
47221
47452
  /**
@@ -47448,7 +47679,7 @@ class OAuthApi {
47448
47679
  /**
47449
47680
  * OAuth service.
47450
47681
  * @module purecloud-platform-client-v2/api/OAuthApi
47451
- * @version 231.0.0
47682
+ * @version 233.0.0
47452
47683
  */
47453
47684
 
47454
47685
  /**
@@ -47814,7 +48045,7 @@ class ObjectsApi {
47814
48045
  /**
47815
48046
  * Objects service.
47816
48047
  * @module purecloud-platform-client-v2/api/ObjectsApi
47817
- * @version 231.0.0
48048
+ * @version 233.0.0
47818
48049
  */
47819
48050
 
47820
48051
  /**
@@ -48138,7 +48369,7 @@ class OperationalEventsApi {
48138
48369
  /**
48139
48370
  * OperationalEvents service.
48140
48371
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
48141
- * @version 231.0.0
48372
+ * @version 233.0.0
48142
48373
  */
48143
48374
 
48144
48375
  /**
@@ -48255,7 +48486,7 @@ class OrganizationApi {
48255
48486
  /**
48256
48487
  * Organization service.
48257
48488
  * @module purecloud-platform-client-v2/api/OrganizationApi
48258
- * @version 231.0.0
48489
+ * @version 233.0.0
48259
48490
  */
48260
48491
 
48261
48492
  /**
@@ -48730,7 +48961,7 @@ class OrganizationAuthorizationApi {
48730
48961
  /**
48731
48962
  * OrganizationAuthorization service.
48732
48963
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
48733
- * @version 231.0.0
48964
+ * @version 233.0.0
48734
48965
  */
48735
48966
 
48736
48967
  /**
@@ -50124,7 +50355,7 @@ class OutboundApi {
50124
50355
  /**
50125
50356
  * Outbound service.
50126
50357
  * @module purecloud-platform-client-v2/api/OutboundApi
50127
- * @version 231.0.0
50358
+ * @version 233.0.0
50128
50359
  */
50129
50360
 
50130
50361
  /**
@@ -54846,7 +55077,7 @@ class PresenceApi {
54846
55077
  /**
54847
55078
  * Presence service.
54848
55079
  * @module purecloud-platform-client-v2/api/PresenceApi
54849
- * @version 231.0.0
55080
+ * @version 233.0.0
54850
55081
  */
54851
55082
 
54852
55083
  /**
@@ -55590,7 +55821,7 @@ class ProcessAutomationApi {
55590
55821
  /**
55591
55822
  * ProcessAutomation service.
55592
55823
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
55593
- * @version 231.0.0
55824
+ * @version 233.0.0
55594
55825
  */
55595
55826
 
55596
55827
  /**
@@ -55829,7 +56060,7 @@ class QualityApi {
55829
56060
  /**
55830
56061
  * Quality service.
55831
56062
  * @module purecloud-platform-client-v2/api/QualityApi
55832
- * @version 231.0.0
56063
+ * @version 233.0.0
55833
56064
  */
55834
56065
 
55835
56066
  /**
@@ -56412,7 +56643,7 @@ class QualityApi {
56412
56643
  }
56413
56644
 
56414
56645
  /**
56415
- * Get an evaluator activity
56646
+ * 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.
56416
56647
  *
56417
56648
  * @param {Object} opts Optional parameters
56418
56649
  * @param {Number} opts.pageSize The total page size requested (default to 25)
@@ -57774,7 +58005,7 @@ class RecordingApi {
57774
58005
  /**
57775
58006
  * Recording service.
57776
58007
  * @module purecloud-platform-client-v2/api/RecordingApi
57777
- * @version 231.0.0
58008
+ * @version 233.0.0
57778
58009
  */
57779
58010
 
57780
58011
  /**
@@ -59379,7 +59610,7 @@ class ResponseManagementApi {
59379
59610
  /**
59380
59611
  * ResponseManagement service.
59381
59612
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
59382
- * @version 231.0.0
59613
+ * @version 233.0.0
59383
59614
  */
59384
59615
 
59385
59616
  /**
@@ -59889,7 +60120,7 @@ class RoutingApi {
59889
60120
  /**
59890
60121
  * Routing service.
59891
60122
  * @module purecloud-platform-client-v2/api/RoutingApi
59892
- * @version 231.0.0
60123
+ * @version 233.0.0
59893
60124
  */
59894
60125
 
59895
60126
  /**
@@ -61123,6 +61354,8 @@ class RoutingApi {
61123
61354
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
61124
61355
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
61125
61356
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
61357
+ * @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
61358
+ * @param {Object} opts.state The state used to filter predictors.
61126
61359
  */
61127
61360
  getRoutingPredictors(opts) {
61128
61361
  opts = opts || {};
@@ -61132,7 +61365,7 @@ class RoutingApi {
61132
61365
  '/api/v2/routing/predictors',
61133
61366
  'GET',
61134
61367
  { },
61135
- { 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
61368
+ { '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'] },
61136
61369
  { },
61137
61370
  { },
61138
61371
  null,
@@ -61201,7 +61434,7 @@ class RoutingApi {
61201
61434
  *
61202
61435
  * @param {String} queueId Queue ID
61203
61436
  * @param {Object} opts Optional parameters
61204
- * @param {Object} opts.expand Which fields, if any, to expand.
61437
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand.
61205
61438
  */
61206
61439
  getRoutingQueueAssistant(queueId, opts) {
61207
61440
  opts = opts || {};
@@ -61215,7 +61448,7 @@ class RoutingApi {
61215
61448
  '/api/v2/routing/queues/{queueId}/assistant',
61216
61449
  'GET',
61217
61450
  { 'queueId': queueId },
61218
- { 'expand': opts['expand'] },
61451
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
61219
61452
  { },
61220
61453
  { },
61221
61454
  null,
@@ -64215,7 +64448,7 @@ class SCIMApi {
64215
64448
  /**
64216
64449
  * SCIM service.
64217
64450
  * @module purecloud-platform-client-v2/api/SCIMApi
64218
- * @version 231.0.0
64451
+ * @version 233.0.0
64219
64452
  */
64220
64453
 
64221
64454
  /**
@@ -65092,7 +65325,7 @@ class ScreenRecordingApi {
65092
65325
  /**
65093
65326
  * ScreenRecording service.
65094
65327
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
65095
- * @version 231.0.0
65328
+ * @version 233.0.0
65096
65329
  */
65097
65330
 
65098
65331
  /**
@@ -65137,7 +65370,7 @@ class ScriptsApi {
65137
65370
  /**
65138
65371
  * Scripts service.
65139
65372
  * @module purecloud-platform-client-v2/api/ScriptsApi
65140
- * @version 231.0.0
65373
+ * @version 233.0.0
65141
65374
  */
65142
65375
 
65143
65376
  /**
@@ -65613,7 +65846,7 @@ class SearchApi {
65613
65846
  /**
65614
65847
  * Search service.
65615
65848
  * @module purecloud-platform-client-v2/api/SearchApi
65616
- * @version 231.0.0
65849
+ * @version 233.0.0
65617
65850
  */
65618
65851
 
65619
65852
  /**
@@ -66331,7 +66564,7 @@ class SettingsApi {
66331
66564
  /**
66332
66565
  * Settings service.
66333
66566
  * @module purecloud-platform-client-v2/api/SettingsApi
66334
- * @version 231.0.0
66567
+ * @version 233.0.0
66335
66568
  */
66336
66569
 
66337
66570
  /**
@@ -66679,7 +66912,7 @@ class SocialMediaApi {
66679
66912
  /**
66680
66913
  * SocialMedia service.
66681
66914
  * @module purecloud-platform-client-v2/api/SocialMediaApi
66682
- * @version 231.0.0
66915
+ * @version 233.0.0
66683
66916
  */
66684
66917
 
66685
66918
  /**
@@ -68270,7 +68503,7 @@ class SpeechTextAnalyticsApi {
68270
68503
  /**
68271
68504
  * SpeechTextAnalytics service.
68272
68505
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
68273
- * @version 231.0.0
68506
+ * @version 233.0.0
68274
68507
  */
68275
68508
 
68276
68509
  /**
@@ -69177,6 +69410,7 @@ class SpeechTextAnalyticsApi {
69177
69410
  * @param {Object} opts Optional parameters
69178
69411
  * @param {String} opts.nextPage The key for listing the next page
69179
69412
  * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
69413
+ * @param {Number} opts.pageNumber The page number for the listing
69180
69414
  * @param {Object} opts.state Topic state. Defaults to latest
69181
69415
  * @param {String} opts.name Case insensitive partial name to filter by
69182
69416
  * @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
@@ -69192,7 +69426,7 @@ class SpeechTextAnalyticsApi {
69192
69426
  '/api/v2/speechandtextanalytics/topics',
69193
69427
  'GET',
69194
69428
  { },
69195
- { 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
69429
+ { 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
69196
69430
  { },
69197
69431
  { },
69198
69432
  null,
@@ -69916,7 +70150,7 @@ class StationsApi {
69916
70150
  /**
69917
70151
  * Stations service.
69918
70152
  * @module purecloud-platform-client-v2/api/StationsApi
69919
- * @version 231.0.0
70153
+ * @version 233.0.0
69920
70154
  */
69921
70155
 
69922
70156
  /**
@@ -70018,7 +70252,7 @@ class SuggestApi {
70018
70252
  /**
70019
70253
  * Suggest service.
70020
70254
  * @module purecloud-platform-client-v2/api/SuggestApi
70021
- * @version 231.0.0
70255
+ * @version 233.0.0
70022
70256
  */
70023
70257
 
70024
70258
  /**
@@ -70157,7 +70391,7 @@ class TaskManagementApi {
70157
70391
  /**
70158
70392
  * TaskManagement service.
70159
70393
  * @module purecloud-platform-client-v2/api/TaskManagementApi
70160
- * @version 231.0.0
70394
+ * @version 233.0.0
70161
70395
  */
70162
70396
 
70163
70397
  /**
@@ -70564,7 +70798,7 @@ class TaskManagementApi {
70564
70798
  *
70565
70799
  * @param {String} workitemId Workitem ID
70566
70800
  * @param {Object} opts Optional parameters
70567
- * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
70801
+ * @param {Array.<String>} opts.expands Which fields to expand. Comma separated if more than one.
70568
70802
  */
70569
70803
  getTaskmanagementWorkitem(workitemId, opts) {
70570
70804
  opts = opts || {};
@@ -70578,7 +70812,7 @@ class TaskManagementApi {
70578
70812
  '/api/v2/taskmanagement/workitems/{workitemId}',
70579
70813
  'GET',
70580
70814
  { 'workitemId': workitemId },
70581
- { 'expands': opts['expands'] },
70815
+ { 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
70582
70816
  { },
70583
70817
  { },
70584
70818
  null,
@@ -72319,7 +72553,7 @@ class TeamsApi {
72319
72553
  /**
72320
72554
  * Teams service.
72321
72555
  * @module purecloud-platform-client-v2/api/TeamsApi
72322
- * @version 231.0.0
72556
+ * @version 233.0.0
72323
72557
  */
72324
72558
 
72325
72559
  /**
@@ -72624,7 +72858,7 @@ class TelephonyApi {
72624
72858
  /**
72625
72859
  * Telephony service.
72626
72860
  * @module purecloud-platform-client-v2/api/TelephonyApi
72627
- * @version 231.0.0
72861
+ * @version 233.0.0
72628
72862
  */
72629
72863
 
72630
72864
  /**
@@ -72910,7 +73144,7 @@ class TelephonyProvidersEdgeApi {
72910
73144
  /**
72911
73145
  * TelephonyProvidersEdge service.
72912
73146
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
72913
- * @version 231.0.0
73147
+ * @version 233.0.0
72914
73148
  */
72915
73149
 
72916
73150
  /**
@@ -76403,7 +76637,7 @@ class TextbotsApi {
76403
76637
  /**
76404
76638
  * Textbots service.
76405
76639
  * @module purecloud-platform-client-v2/api/TextbotsApi
76406
- * @version 231.0.0
76640
+ * @version 233.0.0
76407
76641
  */
76408
76642
 
76409
76643
  /**
@@ -76532,7 +76766,7 @@ class TokensApi {
76532
76766
  /**
76533
76767
  * Tokens service.
76534
76768
  * @module purecloud-platform-client-v2/api/TokensApi
76535
- * @version 231.0.0
76769
+ * @version 233.0.0
76536
76770
  */
76537
76771
 
76538
76772
  /**
@@ -76686,7 +76920,7 @@ class UploadsApi {
76686
76920
  /**
76687
76921
  * Uploads service.
76688
76922
  * @module purecloud-platform-client-v2/api/UploadsApi
76689
- * @version 231.0.0
76923
+ * @version 233.0.0
76690
76924
  */
76691
76925
 
76692
76926
  /**
@@ -76977,7 +77211,7 @@ class UsageApi {
76977
77211
  /**
76978
77212
  * Usage service.
76979
77213
  * @module purecloud-platform-client-v2/api/UsageApi
76980
- * @version 231.0.0
77214
+ * @version 233.0.0
76981
77215
  */
76982
77216
 
76983
77217
  /**
@@ -77312,7 +77546,7 @@ class UserRecordingsApi {
77312
77546
  /**
77313
77547
  * UserRecordings service.
77314
77548
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
77315
- * @version 231.0.0
77549
+ * @version 233.0.0
77316
77550
  */
77317
77551
 
77318
77552
  /**
@@ -77496,7 +77730,7 @@ class UsersApi {
77496
77730
  /**
77497
77731
  * Users service.
77498
77732
  * @module purecloud-platform-client-v2/api/UsersApi
77499
- * @version 231.0.0
77733
+ * @version 233.0.0
77500
77734
  */
77501
77735
 
77502
77736
  /**
@@ -80505,7 +80739,7 @@ class UtilitiesApi {
80505
80739
  /**
80506
80740
  * Utilities service.
80507
80741
  * @module purecloud-platform-client-v2/api/UtilitiesApi
80508
- * @version 231.0.0
80742
+ * @version 233.0.0
80509
80743
  */
80510
80744
 
80511
80745
  /**
@@ -80616,7 +80850,7 @@ class VoicemailApi {
80616
80850
  /**
80617
80851
  * Voicemail service.
80618
80852
  * @module purecloud-platform-client-v2/api/VoicemailApi
80619
- * @version 231.0.0
80853
+ * @version 233.0.0
80620
80854
  */
80621
80855
 
80622
80856
  /**
@@ -81338,7 +81572,7 @@ class WebChatApi {
81338
81572
  /**
81339
81573
  * WebChat service.
81340
81574
  * @module purecloud-platform-client-v2/api/WebChatApi
81341
- * @version 231.0.0
81575
+ * @version 233.0.0
81342
81576
  */
81343
81577
 
81344
81578
  /**
@@ -81412,7 +81646,8 @@ class WebChatApi {
81412
81646
 
81413
81647
  /**
81414
81648
  * Remove WebChat deployment settings
81415
- *
81649
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81650
+ * @deprecated
81416
81651
  */
81417
81652
  deleteWebchatSettings() {
81418
81653
 
@@ -81663,7 +81898,8 @@ class WebChatApi {
81663
81898
 
81664
81899
  /**
81665
81900
  * Get WebChat deployment settings
81666
- *
81901
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81902
+ * @deprecated
81667
81903
  */
81668
81904
  getWebchatSettings() {
81669
81905
 
@@ -81869,8 +82105,9 @@ class WebChatApi {
81869
82105
 
81870
82106
  /**
81871
82107
  * Update WebChat deployment settings
81872
- *
82108
+ * This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
81873
82109
  * @param {Object} body webChatSettings
82110
+ * @deprecated
81874
82111
  */
81875
82112
  putWebchatSettings(body) {
81876
82113
  // verify the required parameter 'body' is set
@@ -81898,7 +82135,7 @@ class WebDeploymentsApi {
81898
82135
  /**
81899
82136
  * WebDeployments service.
81900
82137
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
81901
- * @version 231.0.0
82138
+ * @version 233.0.0
81902
82139
  */
81903
82140
 
81904
82141
  /**
@@ -82480,7 +82717,7 @@ class WebMessagingApi {
82480
82717
  /**
82481
82718
  * WebMessaging service.
82482
82719
  * @module purecloud-platform-client-v2/api/WebMessagingApi
82483
- * @version 231.0.0
82720
+ * @version 233.0.0
82484
82721
  */
82485
82722
 
82486
82723
  /**
@@ -82626,7 +82863,7 @@ class WidgetsApi {
82626
82863
  /**
82627
82864
  * Widgets service.
82628
82865
  * @module purecloud-platform-client-v2/api/WidgetsApi
82629
- * @version 231.0.0
82866
+ * @version 233.0.0
82630
82867
  */
82631
82868
 
82632
82869
  /**
@@ -82777,7 +83014,7 @@ class WorkforceManagementApi {
82777
83014
  /**
82778
83015
  * WorkforceManagement service.
82779
83016
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
82780
- * @version 231.0.0
83017
+ * @version 233.0.0
82781
83018
  */
82782
83019
 
82783
83020
  /**
@@ -87913,6 +88150,36 @@ class WorkforceManagementApi {
87913
88150
  );
87914
88151
  }
87915
88152
 
88153
+ /**
88154
+ * Fetch agent schedules for the logged in user's management unit
88155
+ *
88156
+ * @param {Object} body body
88157
+ * @param {Object} opts Optional parameters
88158
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
88159
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
88160
+ */
88161
+ postWorkforcemanagementAgentschedulesManagementunitsMine(body, opts) {
88162
+ opts = opts || {};
88163
+
88164
+ // verify the required parameter 'body' is set
88165
+ if (body === undefined || body === null) {
88166
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesManagementunitsMine';
88167
+ }
88168
+
88169
+ return this.apiClient.callApi(
88170
+ '/api/v2/workforcemanagement/agentschedules/managementunits/mine',
88171
+ 'POST',
88172
+ { },
88173
+ { 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
88174
+ { },
88175
+ { },
88176
+ body,
88177
+ ['PureCloud OAuth'],
88178
+ ['application/json'],
88179
+ ['application/json']
88180
+ );
88181
+ }
88182
+
87916
88183
  /**
87917
88184
  * Get published schedule for the current user
87918
88185
  *
@@ -90747,7 +91014,7 @@ class WorkforceManagementApi {
90747
91014
  * </pre>
90748
91015
  * </p>
90749
91016
  * @module purecloud-platform-client-v2/index
90750
- * @version 231.0.0
91017
+ * @version 233.0.0
90751
91018
  */
90752
91019
  class platformClient {
90753
91020
  constructor() {