purecloud-platform-client-v2 218.1.0 → 220.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 (91) hide show
  1. package/README.md +4 -4
  2. package/dist/node/purecloud-platform-client-v2.js +1195 -118
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1195 -118
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +390 -130
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +390 -130
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1494 -763
  9. package/package.json +2 -2
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +37 -1
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +399 -5
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +366 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +54 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +60 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +3 -3
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +33 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +66 -10
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +3 -3
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -5
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -687,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
687
687
 
688
688
  /**
689
689
  * @module purecloud-platform-client-v2/ApiClient
690
- * @version 218.1.0
690
+ * @version 220.0.0
691
691
  */
692
692
  class ApiClient {
693
693
  /**
@@ -782,7 +782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
782
782
  /**
783
783
  * The default HTTP timeout for all API calls.
784
784
  * @type {Number}
785
- * @default 60000
785
+ * @default 16000
786
786
  */
787
787
  this.timeout = 16000;
788
788
 
@@ -2231,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2231
2231
  /**
2232
2232
  * AgentAssistants service.
2233
2233
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2234
- * @version 218.1.0
2234
+ * @version 220.0.0
2235
2235
  */
2236
2236
 
2237
2237
  /**
@@ -2607,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2607
2607
  /**
2608
2608
  * AgentCopilot service.
2609
2609
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
2610
- * @version 218.1.0
2610
+ * @version 220.0.0
2611
2611
  */
2612
2612
 
2613
2613
  /**
@@ -2683,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2683
2683
  /**
2684
2684
  * AgentUI service.
2685
2685
  * @module purecloud-platform-client-v2/api/AgentUIApi
2686
- * @version 218.1.0
2686
+ * @version 220.0.0
2687
2687
  */
2688
2688
 
2689
2689
  /**
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2814
2814
  /**
2815
2815
  * Alerting service.
2816
2816
  * @module purecloud-platform-client-v2/api/AlertingApi
2817
- * @version 218.1.0
2817
+ * @version 220.0.0
2818
2818
  */
2819
2819
 
2820
2820
  /**
@@ -3215,7 +3215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3215
3215
  /**
3216
3216
  * Analytics service.
3217
3217
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3218
- * @version 218.1.0
3218
+ * @version 220.0.0
3219
3219
  */
3220
3220
 
3221
3221
  /**
@@ -6036,7 +6036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6036
6036
  /**
6037
6037
  * Architect service.
6038
6038
  * @module purecloud-platform-client-v2/api/ArchitectApi
6039
- * @version 218.1.0
6039
+ * @version 220.0.0
6040
6040
  */
6041
6041
 
6042
6042
  /**
@@ -7431,7 +7431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7431
7431
  * @param {Number} opts.pageNumber Page number (default to 1)
7432
7432
  * @param {Number} opts.pageSize Page size (default to 25)
7433
7433
  * @param {String} opts.sortBy Sort by (default to name)
7434
- * @param {String} opts.sortOrder Sort order (default to ASC)
7434
+ * @param {String} opts.sortOrder Sort order (default to asc)
7435
7435
  * @param {String} opts.name Name of the Schedule to filter by.
7436
7436
  * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
7437
7437
  */
@@ -10329,7 +10329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10329
10329
  /**
10330
10330
  * Audit service.
10331
10331
  * @module purecloud-platform-client-v2/api/AuditApi
10332
- * @version 218.1.0
10332
+ * @version 220.0.0
10333
10333
  */
10334
10334
 
10335
10335
  /**
@@ -10530,7 +10530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10530
10530
  /**
10531
10531
  * Authorization service.
10532
10532
  * @module purecloud-platform-client-v2/api/AuthorizationApi
10533
- * @version 218.1.0
10533
+ * @version 220.0.0
10534
10534
  */
10535
10535
 
10536
10536
  /**
@@ -10756,6 +10756,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10756
10756
  );
10757
10757
  }
10758
10758
 
10759
+ /**
10760
+ * Get a list of soft deleted divisions for the org
10761
+ *
10762
+ * @param {Object} opts Optional parameters
10763
+ * @param {Number} opts.pageNumber Page number (default to 1)
10764
+ * @param {Number} opts.pageSize Page size (default to 25)
10765
+ */
10766
+ getAuthorizationDivisionsDeleted(opts) {
10767
+ opts = opts || {};
10768
+
10769
+
10770
+ return this.apiClient.callApi(
10771
+ '/api/v2/authorization/divisions/deleted',
10772
+ 'GET',
10773
+ { },
10774
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
10775
+ { },
10776
+ { },
10777
+ null,
10778
+ ['PureCloud OAuth'],
10779
+ ['application/json'],
10780
+ ['application/json']
10781
+ );
10782
+ }
10783
+
10759
10784
  /**
10760
10785
  * Retrieve the home division for the organization.
10761
10786
  * Will not include object counts.
@@ -10796,6 +10821,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10796
10821
  );
10797
10822
  }
10798
10823
 
10824
+ /**
10825
+ * Retrieve a list of all divisions defined for the organization with cursor
10826
+ * Use "after" and "before" param to fetch next/previous page}
10827
+ * @param {Object} opts Optional parameters
10828
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
10829
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
10830
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
10831
+ * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
10832
+ * @param {String} opts.name Optionally request specific divisions by division name
10833
+ */
10834
+ getAuthorizationDivisionsQuery(opts) {
10835
+ opts = opts || {};
10836
+
10837
+
10838
+ return this.apiClient.callApi(
10839
+ '/api/v2/authorization/divisions/query',
10840
+ 'GET',
10841
+ { },
10842
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
10843
+ { },
10844
+ { },
10845
+ null,
10846
+ ['PureCloud OAuth'],
10847
+ ['application/json'],
10848
+ ['application/json']
10849
+ );
10850
+ }
10851
+
10799
10852
  /**
10800
10853
  * Returns which divisions the current user has the given permission in.
10801
10854
  * This route is deprecated, use authorization/divisionspermitted/paged/me instead.
@@ -12192,7 +12245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12192
12245
  /**
12193
12246
  * Billing service.
12194
12247
  * @module purecloud-platform-client-v2/api/BillingApi
12195
- * @version 218.1.0
12248
+ * @version 220.0.0
12196
12249
  */
12197
12250
 
12198
12251
  /**
@@ -12272,7 +12325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12272
12325
  /**
12273
12326
  * CarrierServices service.
12274
12327
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
12275
- * @version 218.1.0
12328
+ * @version 220.0.0
12276
12329
  */
12277
12330
 
12278
12331
  /**
@@ -12342,7 +12395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12342
12395
  /**
12343
12396
  * Chat service.
12344
12397
  * @module purecloud-platform-client-v2/api/ChatApi
12345
- * @version 218.1.0
12398
+ * @version 220.0.0
12346
12399
  */
12347
12400
 
12348
12401
  /**
@@ -13271,7 +13324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13271
13324
  /**
13272
13325
  * Coaching service.
13273
13326
  * @module purecloud-platform-client-v2/api/CoachingApi
13274
- * @version 218.1.0
13327
+ * @version 220.0.0
13275
13328
  */
13276
13329
 
13277
13330
  /**
@@ -13848,7 +13901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13848
13901
  /**
13849
13902
  * ContentManagement service.
13850
13903
  * @module purecloud-platform-client-v2/api/ContentManagementApi
13851
- * @version 218.1.0
13904
+ * @version 220.0.0
13852
13905
  */
13853
13906
 
13854
13907
  /**
@@ -14929,7 +14982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14929
14982
  /**
14930
14983
  * Conversations service.
14931
14984
  * @module purecloud-platform-client-v2/api/ConversationsApi
14932
- * @version 218.1.0
14985
+ * @version 220.0.0
14933
14986
  */
14934
14987
 
14935
14988
  /**
@@ -21105,6 +21158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21105
21158
  * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
21106
21159
  * @param {String} conversationId conversationId
21107
21160
  * @param {String} communicationId communicationId
21161
+ * @deprecated
21108
21162
  */
21109
21163
  postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId) {
21110
21164
  // verify the required parameter 'conversationId' is set
@@ -21130,6 +21184,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21130
21184
  );
21131
21185
  }
21132
21186
 
21187
+ /**
21188
+ * Create a URL to upload a message media file
21189
+ * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
21190
+ * @param {String} conversationId conversationId
21191
+ * @param {String} communicationId communicationId
21192
+ * @param {Object} body request
21193
+ */
21194
+ postConversationsMessageCommunicationMessagesMediaUploads(conversationId, communicationId, body) {
21195
+ // verify the required parameter 'conversationId' is set
21196
+ if (conversationId === undefined || conversationId === null) {
21197
+ throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
21198
+ }
21199
+ // verify the required parameter 'communicationId' is set
21200
+ if (communicationId === undefined || communicationId === null) {
21201
+ throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMediaUploads';
21202
+ }
21203
+ // verify the required parameter 'body' is set
21204
+ if (body === undefined || body === null) {
21205
+ throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessagesMediaUploads';
21206
+ }
21207
+
21208
+ return this.apiClient.callApi(
21209
+ '/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads',
21210
+ 'POST',
21211
+ { 'conversationId': conversationId,'communicationId': communicationId },
21212
+ { },
21213
+ { },
21214
+ { },
21215
+ body,
21216
+ ['PureCloud OAuth'],
21217
+ ['application/json'],
21218
+ ['application/json']
21219
+ );
21220
+ }
21221
+
21133
21222
  /**
21134
21223
  * Send message typing event
21135
21224
  * Send message typing event for existing conversation/communication.
@@ -22511,7 +22600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22511
22600
  /**
22512
22601
  * DataExtensions service.
22513
22602
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
22514
- * @version 218.1.0
22603
+ * @version 220.0.0
22515
22604
  */
22516
22605
 
22517
22606
  /**
@@ -22597,7 +22686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22597
22686
  /**
22598
22687
  * DataPrivacy service.
22599
22688
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
22600
- * @version 218.1.0
22689
+ * @version 220.0.0
22601
22690
  */
22602
22691
 
22603
22692
  /**
@@ -22767,7 +22856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22767
22856
  /**
22768
22857
  * Downloads service.
22769
22858
  * @module purecloud-platform-client-v2/api/DownloadsApi
22770
- * @version 218.1.0
22859
+ * @version 220.0.0
22771
22860
  */
22772
22861
 
22773
22862
  /**
@@ -22819,7 +22908,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22819
22908
  /**
22820
22909
  * Emails service.
22821
22910
  * @module purecloud-platform-client-v2/api/EmailsApi
22822
- * @version 218.1.0
22911
+ * @version 220.0.0
22823
22912
  */
22824
22913
 
22825
22914
  /**
@@ -22948,7 +23037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22948
23037
  /**
22949
23038
  * EmployeeEngagement service.
22950
23039
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
22951
- * @version 218.1.0
23040
+ * @version 220.0.0
22952
23041
  */
22953
23042
 
22954
23043
  /**
@@ -23099,7 +23188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23099
23188
  /**
23100
23189
  * Events service.
23101
23190
  * @module purecloud-platform-client-v2/api/EventsApi
23102
- * @version 218.1.0
23191
+ * @version 220.0.0
23103
23192
  */
23104
23193
 
23105
23194
  /**
@@ -23195,7 +23284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23195
23284
  /**
23196
23285
  * ExternalContacts service.
23197
23286
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
23198
- * @version 218.1.0
23287
+ * @version 220.0.0
23199
23288
  */
23200
23289
 
23201
23290
  /**
@@ -23830,6 +23919,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23830
23919
  );
23831
23920
  }
23832
23921
 
23922
+ /**
23923
+ * Get the core types from which all schemas are built.
23924
+ *
23925
+ * @param {String} coreTypeName Name of the core type
23926
+ */
23927
+ getExternalcontactsContactsSchemasCoretype(coreTypeName) {
23928
+ // verify the required parameter 'coreTypeName' is set
23929
+ if (coreTypeName === undefined || coreTypeName === null) {
23930
+ throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';
23931
+ }
23932
+
23933
+ return this.apiClient.callApi(
23934
+ '/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}',
23935
+ 'GET',
23936
+ { 'coreTypeName': coreTypeName },
23937
+ { },
23938
+ { },
23939
+ { },
23940
+ null,
23941
+ ['PureCloud OAuth'],
23942
+ ['application/json'],
23943
+ ['application/json']
23944
+ );
23945
+ }
23946
+
23947
+ /**
23948
+ * Get the core types from which all schemas are built.
23949
+ *
23950
+ */
23951
+ getExternalcontactsContactsSchemasCoretypes() {
23952
+
23953
+ return this.apiClient.callApi(
23954
+ '/api/v2/externalcontacts/contacts/schemas/coretypes',
23955
+ 'GET',
23956
+ { },
23957
+ { },
23958
+ { },
23959
+ { },
23960
+ null,
23961
+ ['PureCloud OAuth'],
23962
+ ['application/json'],
23963
+ ['application/json']
23964
+ );
23965
+ }
23966
+
23967
+ /**
23968
+ * Get quantitative limits on schemas
23969
+ *
23970
+ */
23971
+ getExternalcontactsContactsSchemasLimits() {
23972
+
23973
+ return this.apiClient.callApi(
23974
+ '/api/v2/externalcontacts/contacts/schemas/limits',
23975
+ 'GET',
23976
+ { },
23977
+ { },
23978
+ { },
23979
+ { },
23980
+ null,
23981
+ ['PureCloud OAuth'],
23982
+ ['application/json'],
23983
+ ['application/json']
23984
+ );
23985
+ }
23986
+
23833
23987
  /**
23834
23988
  * Fetch an External Source
23835
23989
  *
@@ -24155,6 +24309,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24155
24309
  );
24156
24310
  }
24157
24311
 
24312
+ /**
24313
+ * List the identifiers for an external organization
24314
+ *
24315
+ * @param {String} externalOrganizationId External Organization ID
24316
+ * getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24317
+ */
24318
+ getExternalcontactsOrganizationIdentifiers(externalOrganizationId) {
24319
+ // verify the required parameter 'externalOrganizationId' is set
24320
+ if (externalOrganizationId === undefined || externalOrganizationId === null) {
24321
+ throw 'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';
24322
+ }
24323
+
24324
+ return this.apiClient.callApi(
24325
+ '/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
24326
+ 'GET',
24327
+ { 'externalOrganizationId': externalOrganizationId },
24328
+ { },
24329
+ { },
24330
+ { },
24331
+ null,
24332
+ ['PureCloud OAuth'],
24333
+ ['application/json'],
24334
+ ['application/json']
24335
+ );
24336
+ }
24337
+
24158
24338
  /**
24159
24339
  * Fetch a note for an external organization
24160
24340
  *
@@ -24384,6 +24564,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24384
24564
  );
24385
24565
  }
24386
24566
 
24567
+ /**
24568
+ * Get the core types from which all schemas are built.
24569
+ *
24570
+ * @param {String} coreTypeName Name of the core type
24571
+ */
24572
+ getExternalcontactsOrganizationsSchemasCoretype(coreTypeName) {
24573
+ // verify the required parameter 'coreTypeName' is set
24574
+ if (coreTypeName === undefined || coreTypeName === null) {
24575
+ throw 'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';
24576
+ }
24577
+
24578
+ return this.apiClient.callApi(
24579
+ '/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}',
24580
+ 'GET',
24581
+ { 'coreTypeName': coreTypeName },
24582
+ { },
24583
+ { },
24584
+ { },
24585
+ null,
24586
+ ['PureCloud OAuth'],
24587
+ ['application/json'],
24588
+ ['application/json']
24589
+ );
24590
+ }
24591
+
24592
+ /**
24593
+ * Get the core types from which all schemas are built.
24594
+ *
24595
+ */
24596
+ getExternalcontactsOrganizationsSchemasCoretypes() {
24597
+
24598
+ return this.apiClient.callApi(
24599
+ '/api/v2/externalcontacts/organizations/schemas/coretypes',
24600
+ 'GET',
24601
+ { },
24602
+ { },
24603
+ { },
24604
+ { },
24605
+ null,
24606
+ ['PureCloud OAuth'],
24607
+ ['application/json'],
24608
+ ['application/json']
24609
+ );
24610
+ }
24611
+
24612
+ /**
24613
+ * Get quantitative limits on schemas
24614
+ *
24615
+ */
24616
+ getExternalcontactsOrganizationsSchemasLimits() {
24617
+
24618
+ return this.apiClient.callApi(
24619
+ '/api/v2/externalcontacts/organizations/schemas/limits',
24620
+ 'GET',
24621
+ { },
24622
+ { },
24623
+ { },
24624
+ { },
24625
+ null,
24626
+ ['PureCloud OAuth'],
24627
+ ['application/json'],
24628
+ ['application/json']
24629
+ );
24630
+ }
24631
+
24387
24632
  /**
24388
24633
  * Fetch a relationship
24389
24634
  *
@@ -24414,12 +24659,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24414
24659
  }
24415
24660
 
24416
24661
  /**
24417
- * Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
24662
+ * Look up contacts based on an attribute. Maximum of 25 values returned.
24418
24663
  *
24419
- * @param {String} lookupVal User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
24664
+ * @param {String} lookupVal User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)
24420
24665
  * @param {Object} opts Optional parameters
24421
24666
  * @param {Array.<String>} opts.expand which field, if any, to expand
24422
- * @param {String} opts.divisionId Specifies which division to lookup contacts/externalOrganizations in, for the given lookup value (default to *)
24667
+ * @param {String} opts.divisionId Specifies which division to lookup contacts in, for the given lookup value (default to *)
24423
24668
  */
24424
24669
  getExternalcontactsReversewhitepageslookup(lookupVal, opts) {
24425
24670
  opts = opts || {};
@@ -24681,6 +24926,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24681
24926
  );
24682
24927
  }
24683
24928
 
24929
+ /**
24930
+ * Claim or release identifiers for an external organization
24931
+ *
24932
+ * @param {String} externalOrganizationId External Organization ID
24933
+ * @param {Object} body ClaimRequest
24934
+ * patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24935
+ */
24936
+ patchExternalcontactsOrganizationIdentifiers(externalOrganizationId, body) {
24937
+ // verify the required parameter 'externalOrganizationId' is set
24938
+ if (externalOrganizationId === undefined || externalOrganizationId === null) {
24939
+ throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';
24940
+ }
24941
+ // verify the required parameter 'body' is set
24942
+ if (body === undefined || body === null) {
24943
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';
24944
+ }
24945
+
24946
+ return this.apiClient.callApi(
24947
+ '/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers',
24948
+ 'PATCH',
24949
+ { 'externalOrganizationId': externalOrganizationId },
24950
+ { },
24951
+ { },
24952
+ { },
24953
+ body,
24954
+ ['PureCloud OAuth'],
24955
+ ['application/json'],
24956
+ ['application/json']
24957
+ );
24958
+ }
24959
+
24684
24960
  /**
24685
24961
  * Bulk fetch contacts
24686
24962
  *
@@ -24757,6 +25033,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24757
25033
  );
24758
25034
  }
24759
25035
 
25036
+ /**
25037
+ * Bulk Enrich Contacts - Run up to 10 Enrich operations per request
25038
+ * See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
25039
+ * @param {Object} body Contact Enrich Requests
25040
+ * @param {Object} opts Optional parameters
25041
+ * @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
25042
+ * postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25043
+ */
25044
+ postExternalcontactsBulkContactsEnrich(body, opts) {
25045
+ opts = opts || {};
25046
+
25047
+ // verify the required parameter 'body' is set
25048
+ if (body === undefined || body === null) {
25049
+ throw 'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';
25050
+ }
25051
+
25052
+ return this.apiClient.callApi(
25053
+ '/api/v2/externalcontacts/bulk/contacts/enrich',
25054
+ 'POST',
25055
+ { },
25056
+ { 'dryRun': opts['dryRun'] },
25057
+ { },
25058
+ { },
25059
+ body,
25060
+ ['PureCloud OAuth'],
25061
+ ['application/json'],
25062
+ ['application/json']
25063
+ );
25064
+ }
25065
+
24760
25066
  /**
24761
25067
  * Bulk remove contacts
24762
25068
  *
@@ -25008,6 +25314,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25008
25314
  );
25009
25315
  }
25010
25316
 
25317
+ /**
25318
+ * Bulk enrich external organizations - Run up to 10 Enrich operations per request
25319
+ * See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
25320
+ * @param {Object} body External Organization Enrich Requests
25321
+ * @param {Object} opts Optional parameters
25322
+ * @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
25323
+ * postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25324
+ */
25325
+ postExternalcontactsBulkOrganizationsEnrich(body, opts) {
25326
+ opts = opts || {};
25327
+
25328
+ // verify the required parameter 'body' is set
25329
+ if (body === undefined || body === null) {
25330
+ throw 'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';
25331
+ }
25332
+
25333
+ return this.apiClient.callApi(
25334
+ '/api/v2/externalcontacts/bulk/organizations/enrich',
25335
+ 'POST',
25336
+ { },
25337
+ { 'dryRun': opts['dryRun'] },
25338
+ { },
25339
+ { },
25340
+ body,
25341
+ ['PureCloud OAuth'],
25342
+ ['application/json'],
25343
+ ['application/json']
25344
+ );
25345
+ }
25346
+
25011
25347
  /**
25012
25348
  * Bulk remove organizations
25013
25349
  *
@@ -25238,6 +25574,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25238
25574
  );
25239
25575
  }
25240
25576
 
25577
+ /**
25578
+ * Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
25579
+ * You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
25580
+ * @param {Object} body ContactEnrichRequest
25581
+ * @param {Object} opts Optional parameters
25582
+ * @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
25583
+ * postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25584
+ */
25585
+ postExternalcontactsContactsEnrich(body, opts) {
25586
+ opts = opts || {};
25587
+
25588
+ // verify the required parameter 'body' is set
25589
+ if (body === undefined || body === null) {
25590
+ throw 'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';
25591
+ }
25592
+
25593
+ return this.apiClient.callApi(
25594
+ '/api/v2/externalcontacts/contacts/enrich',
25595
+ 'POST',
25596
+ { },
25597
+ { 'dryRun': opts['dryRun'] },
25598
+ { },
25599
+ { },
25600
+ body,
25601
+ ['PureCloud OAuth'],
25602
+ ['application/json'],
25603
+ ['application/json']
25604
+ );
25605
+ }
25606
+
25241
25607
  /**
25242
25608
  * Create bulk export
25243
25609
  *
@@ -25263,6 +25629,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25263
25629
  );
25264
25630
  }
25265
25631
 
25632
+ /**
25633
+ * Merge up to 25 contacts into a new contact record
25634
+ * Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
25635
+ * @param {Object} body MergeRequest
25636
+ * postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25637
+ */
25638
+ postExternalcontactsContactsMerge(body) {
25639
+ // verify the required parameter 'body' is set
25640
+ if (body === undefined || body === null) {
25641
+ throw 'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';
25642
+ }
25643
+
25644
+ return this.apiClient.callApi(
25645
+ '/api/v2/externalcontacts/contacts/merge',
25646
+ 'POST',
25647
+ { },
25648
+ { },
25649
+ { },
25650
+ { },
25651
+ body,
25652
+ ['PureCloud OAuth'],
25653
+ ['application/json'],
25654
+ ['application/json']
25655
+ );
25656
+ }
25657
+
25266
25658
  /**
25267
25659
  * Create a schema
25268
25660
  *
@@ -25343,6 +25735,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25343
25735
  );
25344
25736
  }
25345
25737
 
25738
+ /**
25739
+ * Fetch a contact using an identifier type and value.
25740
+ * Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
25741
+ * @param {Object} identifier
25742
+ * @param {Object} opts Optional parameters
25743
+ * @param {Array.<String>} opts.expand which field, if any, to expand
25744
+ * postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25745
+ */
25746
+ postExternalcontactsIdentifierlookupContacts(identifier, opts) {
25747
+ opts = opts || {};
25748
+
25749
+ // verify the required parameter 'identifier' is set
25750
+ if (identifier === undefined || identifier === null) {
25751
+ throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';
25752
+ }
25753
+
25754
+ return this.apiClient.callApi(
25755
+ '/api/v2/externalcontacts/identifierlookup/contacts',
25756
+ 'POST',
25757
+ { },
25758
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
25759
+ { },
25760
+ { },
25761
+ identifier,
25762
+ ['PureCloud OAuth'],
25763
+ ['application/json'],
25764
+ ['application/json']
25765
+ );
25766
+ }
25767
+
25768
+ /**
25769
+ * Fetch an external organization using an identifier type and value.
25770
+ * This endpoint will only accept ExternalId type identifiers.
25771
+ * @param {Object} identifier
25772
+ * @param {Object} opts Optional parameters
25773
+ * @param {Array.<String>} opts.expand which field, if any, to expand
25774
+ * postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25775
+ */
25776
+ postExternalcontactsIdentifierlookupOrganizations(identifier, opts) {
25777
+ opts = opts || {};
25778
+
25779
+ // verify the required parameter 'identifier' is set
25780
+ if (identifier === undefined || identifier === null) {
25781
+ throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';
25782
+ }
25783
+
25784
+ return this.apiClient.callApi(
25785
+ '/api/v2/externalcontacts/identifierlookup/organizations',
25786
+ 'POST',
25787
+ { },
25788
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
25789
+ { },
25790
+ { },
25791
+ identifier,
25792
+ ['PureCloud OAuth'],
25793
+ ['application/json'],
25794
+ ['application/json']
25795
+ );
25796
+ }
25797
+
25346
25798
  /**
25347
25799
  * Create CSV import job
25348
25800
  *
@@ -25470,8 +25922,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25470
25922
 
25471
25923
  /**
25472
25924
  * Merge two contacts into a new contact record
25473
- * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
25925
+ * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
25474
25926
  * @param {Object} body MergeRequest
25927
+ * @deprecated
25475
25928
  */
25476
25929
  postExternalcontactsMergeContacts(body) {
25477
25930
  // verify the required parameter 'body' is set
@@ -25548,6 +26001,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25548
26001
  );
25549
26002
  }
25550
26003
 
26004
+ /**
26005
+ * Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
26006
+ * You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
26007
+ * @param {Object} body ExternalOrgEnrichRequest
26008
+ * @param {Object} opts Optional parameters
26009
+ * @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
26010
+ * postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26011
+ */
26012
+ postExternalcontactsOrganizationsEnrich(body, opts) {
26013
+ opts = opts || {};
26014
+
26015
+ // verify the required parameter 'body' is set
26016
+ if (body === undefined || body === null) {
26017
+ throw 'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';
26018
+ }
26019
+
26020
+ return this.apiClient.callApi(
26021
+ '/api/v2/externalcontacts/organizations/enrich',
26022
+ 'POST',
26023
+ { },
26024
+ { 'dryRun': opts['dryRun'] },
26025
+ { },
26026
+ { },
26027
+ body,
26028
+ ['PureCloud OAuth'],
26029
+ ['application/json'],
26030
+ ['application/json']
26031
+ );
26032
+ }
26033
+
25551
26034
  /**
25552
26035
  * Create a schema
25553
26036
  *
@@ -26004,7 +26487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26004
26487
  /**
26005
26488
  * Fax service.
26006
26489
  * @module purecloud-platform-client-v2/api/FaxApi
26007
- * @version 218.1.0
26490
+ * @version 220.0.0
26008
26491
  */
26009
26492
 
26010
26493
  /**
@@ -26219,7 +26702,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26219
26702
  /**
26220
26703
  * Flows service.
26221
26704
  * @module purecloud-platform-client-v2/api/FlowsApi
26222
- * @version 218.1.0
26705
+ * @version 220.0.0
26223
26706
  */
26224
26707
 
26225
26708
  /**
@@ -26402,7 +26885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26402
26885
  /**
26403
26886
  * Gamification service.
26404
26887
  * @module purecloud-platform-client-v2/api/GamificationApi
26405
- * @version 218.1.0
26888
+ * @version 220.0.0
26406
26889
  */
26407
26890
 
26408
26891
  /**
@@ -26442,6 +26925,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26442
26925
  );
26443
26926
  }
26444
26927
 
26928
+ /**
26929
+ * Delete a Contest by Id
26930
+ *
26931
+ * @param {String} contestId The ID of the contest
26932
+ */
26933
+ deleteGamificationContest(contestId) {
26934
+ // verify the required parameter 'contestId' is set
26935
+ if (contestId === undefined || contestId === null) {
26936
+ throw 'Missing the required parameter "contestId" when calling deleteGamificationContest';
26937
+ }
26938
+
26939
+ return this.apiClient.callApi(
26940
+ '/api/v2/gamification/contests/{contestId}',
26941
+ 'DELETE',
26942
+ { 'contestId': contestId },
26943
+ { },
26944
+ { },
26945
+ { },
26946
+ null,
26947
+ ['PureCloud OAuth'],
26948
+ ['application/json'],
26949
+ ['application/json']
26950
+ );
26951
+ }
26952
+
26445
26953
  /**
26446
26954
  * Get an External Metric Definition
26447
26955
  *
@@ -26492,6 +27000,236 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26492
27000
  );
26493
27001
  }
26494
27002
 
27003
+ /**
27004
+ * Get a Contest by Id
27005
+ *
27006
+ * @param {String} contestId The ID of the contest
27007
+ */
27008
+ getGamificationContest(contestId) {
27009
+ // verify the required parameter 'contestId' is set
27010
+ if (contestId === undefined || contestId === null) {
27011
+ throw 'Missing the required parameter "contestId" when calling getGamificationContest';
27012
+ }
27013
+
27014
+ return this.apiClient.callApi(
27015
+ '/api/v2/gamification/contests/{contestId}',
27016
+ 'GET',
27017
+ { 'contestId': contestId },
27018
+ { },
27019
+ { },
27020
+ { },
27021
+ null,
27022
+ ['PureCloud OAuth'],
27023
+ ['application/json'],
27024
+ ['application/json']
27025
+ );
27026
+ }
27027
+
27028
+ /**
27029
+ * Get Contest Scores (Admin)
27030
+ *
27031
+ * @param {String} contestId The ID of the contest
27032
+ * @param {Object} opts Optional parameters
27033
+ * @param {Number} opts.pageNumber (default to 1)
27034
+ * @param {Number} opts.pageSize (default to 25)
27035
+ * @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27036
+ * @param {Object} opts.returnsView Desired response results (default to All)
27037
+ */
27038
+ getGamificationContestAgentsScores(contestId, opts) {
27039
+ opts = opts || {};
27040
+
27041
+ // verify the required parameter 'contestId' is set
27042
+ if (contestId === undefined || contestId === null) {
27043
+ throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';
27044
+ }
27045
+
27046
+ return this.apiClient.callApi(
27047
+ '/api/v2/gamification/contests/{contestId}/agents/scores',
27048
+ 'GET',
27049
+ { 'contestId': contestId },
27050
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
27051
+ { },
27052
+ { },
27053
+ null,
27054
+ ['PureCloud OAuth'],
27055
+ ['application/json'],
27056
+ ['application/json']
27057
+ );
27058
+ }
27059
+
27060
+ /**
27061
+ * Get Contest Scores for the requesting Agent/Supervisor
27062
+ *
27063
+ * @param {String} contestId The ID of the contest
27064
+ * @param {Object} opts Optional parameters
27065
+ * @param {Number} opts.pageNumber (default to 1)
27066
+ * @param {Number} opts.pageSize (default to 25)
27067
+ * @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27068
+ * @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
27069
+ */
27070
+ getGamificationContestAgentsScoresMe(contestId, opts) {
27071
+ opts = opts || {};
27072
+
27073
+ // verify the required parameter 'contestId' is set
27074
+ if (contestId === undefined || contestId === null) {
27075
+ throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';
27076
+ }
27077
+
27078
+ return this.apiClient.callApi(
27079
+ '/api/v2/gamification/contests/{contestId}/agents/scores/me',
27080
+ 'GET',
27081
+ { 'contestId': contestId },
27082
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'workday': opts['workday'],'returnsView': opts['returnsView'] },
27083
+ { },
27084
+ { },
27085
+ null,
27086
+ ['PureCloud OAuth'],
27087
+ ['application/json'],
27088
+ ['application/json']
27089
+ );
27090
+ }
27091
+
27092
+ /**
27093
+ * Get a Contest Score Trend (Average Trend)
27094
+ *
27095
+ * @param {String} contestId The ID of the contest
27096
+ */
27097
+ getGamificationContestAgentsScoresTrends(contestId) {
27098
+ // verify the required parameter 'contestId' is set
27099
+ if (contestId === undefined || contestId === null) {
27100
+ throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';
27101
+ }
27102
+
27103
+ return this.apiClient.callApi(
27104
+ '/api/v2/gamification/contests/{contestId}/agents/scores/trends',
27105
+ 'GET',
27106
+ { 'contestId': contestId },
27107
+ { },
27108
+ { },
27109
+ { },
27110
+ null,
27111
+ ['PureCloud OAuth'],
27112
+ ['application/json'],
27113
+ ['application/json']
27114
+ );
27115
+ }
27116
+
27117
+ /**
27118
+ * Get a Contest Score Trend for the requesting Agent
27119
+ *
27120
+ * @param {String} contestId The ID of the contest
27121
+ */
27122
+ getGamificationContestAgentsScoresTrendsMe(contestId) {
27123
+ // verify the required parameter 'contestId' is set
27124
+ if (contestId === undefined || contestId === null) {
27125
+ throw 'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';
27126
+ }
27127
+
27128
+ return this.apiClient.callApi(
27129
+ '/api/v2/gamification/contests/{contestId}/agents/scores/trends/me',
27130
+ 'GET',
27131
+ { 'contestId': contestId },
27132
+ { },
27133
+ { },
27134
+ { },
27135
+ null,
27136
+ ['PureCloud OAuth'],
27137
+ ['application/json'],
27138
+ ['application/json']
27139
+ );
27140
+ }
27141
+
27142
+ /**
27143
+ * Get a Contest Prize Image by Id
27144
+ *
27145
+ * @param {String} contestId The ID of the contest
27146
+ * @param {String} prizeImageId The ID of the prize image
27147
+ */
27148
+ getGamificationContestPrizeimage(contestId, prizeImageId) {
27149
+ // verify the required parameter 'contestId' is set
27150
+ if (contestId === undefined || contestId === null) {
27151
+ throw 'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';
27152
+ }
27153
+ // verify the required parameter 'prizeImageId' is set
27154
+ if (prizeImageId === undefined || prizeImageId === null) {
27155
+ throw 'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';
27156
+ }
27157
+
27158
+ return this.apiClient.callApi(
27159
+ '/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}',
27160
+ 'GET',
27161
+ { 'contestId': contestId,'prizeImageId': prizeImageId },
27162
+ { },
27163
+ { },
27164
+ { },
27165
+ null,
27166
+ ['PureCloud OAuth'],
27167
+ ['application/json'],
27168
+ ['application/json']
27169
+ );
27170
+ }
27171
+
27172
+ /**
27173
+ * Get a List of Contests (Admin)
27174
+ *
27175
+ * @param {Object} opts Optional parameters
27176
+ * @param {Number} opts.pageNumber (default to 1)
27177
+ * @param {Number} opts.pageSize (default to 25)
27178
+ * @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27179
+ * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27180
+ * @param {Array.<String>} opts.status
27181
+ * @param {Object} opts.sortBy (default to dateStart)
27182
+ * @param {Object} opts.sortOrder (default to desc)
27183
+ */
27184
+ getGamificationContests(opts) {
27185
+ opts = opts || {};
27186
+
27187
+
27188
+ return this.apiClient.callApi(
27189
+ '/api/v2/gamification/contests',
27190
+ 'GET',
27191
+ { },
27192
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
27193
+ { },
27194
+ { },
27195
+ null,
27196
+ ['PureCloud OAuth'],
27197
+ ['application/json'],
27198
+ ['application/json']
27199
+ );
27200
+ }
27201
+
27202
+ /**
27203
+ * Get a List of Contests (Agent/Supervisor)
27204
+ *
27205
+ * @param {Object} opts Optional parameters
27206
+ * @param {Number} opts.pageNumber (default to 1)
27207
+ * @param {Number} opts.pageSize (default to 25)
27208
+ * @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27209
+ * @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27210
+ * @param {Array.<String>} opts.status
27211
+ * @param {Object} opts.sortBy (default to dateStart)
27212
+ * @param {Object} opts.sortOrder (default to desc)
27213
+ * @param {Object} opts.view (default to participant)
27214
+ */
27215
+ getGamificationContestsMe(opts) {
27216
+ opts = opts || {};
27217
+
27218
+
27219
+ return this.apiClient.callApi(
27220
+ '/api/v2/gamification/contests/me',
27221
+ 'GET',
27222
+ { },
27223
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'view': opts['view'] },
27224
+ { },
27225
+ { },
27226
+ null,
27227
+ ['PureCloud OAuth'],
27228
+ ['application/json'],
27229
+ ['application/json']
27230
+ );
27231
+ }
27232
+
26495
27233
  /**
26496
27234
  * Get insights summary
26497
27235
  *
@@ -28142,6 +28880,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28142
28880
  );
28143
28881
  }
28144
28882
 
28883
+ /**
28884
+ * Finalize a Contest by Id
28885
+ *
28886
+ * @param {String} contestId The ID of the contest
28887
+ * @param {Object} body Finalize Contest
28888
+ */
28889
+ patchGamificationContest(contestId, body) {
28890
+ // verify the required parameter 'contestId' is set
28891
+ if (contestId === undefined || contestId === null) {
28892
+ throw 'Missing the required parameter "contestId" when calling patchGamificationContest';
28893
+ }
28894
+ // verify the required parameter 'body' is set
28895
+ if (body === undefined || body === null) {
28896
+ throw 'Missing the required parameter "body" when calling patchGamificationContest';
28897
+ }
28898
+
28899
+ return this.apiClient.callApi(
28900
+ '/api/v2/gamification/contests/{contestId}',
28901
+ 'PATCH',
28902
+ { 'contestId': contestId },
28903
+ { },
28904
+ { },
28905
+ { },
28906
+ body,
28907
+ ['PureCloud OAuth'],
28908
+ ['application/json'],
28909
+ ['application/json']
28910
+ );
28911
+ }
28912
+
28145
28913
  /**
28146
28914
  * Write External Metric Data
28147
28915
  *
@@ -28190,6 +28958,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28190
28958
  );
28191
28959
  }
28192
28960
 
28961
+ /**
28962
+ * Creates a Contest
28963
+ *
28964
+ * @param {Object} body Create Contest
28965
+ */
28966
+ postGamificationContests(body) {
28967
+ // verify the required parameter 'body' is set
28968
+ if (body === undefined || body === null) {
28969
+ throw 'Missing the required parameter "body" when calling postGamificationContests';
28970
+ }
28971
+
28972
+ return this.apiClient.callApi(
28973
+ '/api/v2/gamification/contests',
28974
+ 'POST',
28975
+ { },
28976
+ { },
28977
+ { },
28978
+ { },
28979
+ body,
28980
+ ['PureCloud OAuth'],
28981
+ ['application/json'],
28982
+ ['application/json']
28983
+ );
28984
+ }
28985
+
28986
+ /**
28987
+ * Generates pre-signed URL to upload a prize image for gamification contests
28988
+ *
28989
+ * @param {Object} body query
28990
+ */
28991
+ postGamificationContestsUploadsPrizeimages(body) {
28992
+ // verify the required parameter 'body' is set
28993
+ if (body === undefined || body === null) {
28994
+ throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
28995
+ }
28996
+
28997
+ return this.apiClient.callApi(
28998
+ '/api/v2/gamification/contests/uploads/prizeimages',
28999
+ 'POST',
29000
+ { },
29001
+ { },
29002
+ { },
29003
+ { },
29004
+ body,
29005
+ ['PureCloud OAuth'],
29006
+ ['application/json'],
29007
+ ['application/json']
29008
+ );
29009
+ }
29010
+
28193
29011
  /**
28194
29012
  * Activate a performance profile
28195
29013
  *
@@ -28449,6 +29267,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28449
29267
  );
28450
29268
  }
28451
29269
 
29270
+ /**
29271
+ * Update a Contest by Id
29272
+ *
29273
+ * @param {String} contestId The ID of the contest
29274
+ * @param {Object} body Contest
29275
+ */
29276
+ putGamificationContest(contestId, body) {
29277
+ // verify the required parameter 'contestId' is set
29278
+ if (contestId === undefined || contestId === null) {
29279
+ throw 'Missing the required parameter "contestId" when calling putGamificationContest';
29280
+ }
29281
+ // verify the required parameter 'body' is set
29282
+ if (body === undefined || body === null) {
29283
+ throw 'Missing the required parameter "body" when calling putGamificationContest';
29284
+ }
29285
+
29286
+ return this.apiClient.callApi(
29287
+ '/api/v2/gamification/contests/{contestId}',
29288
+ 'PUT',
29289
+ { 'contestId': contestId },
29290
+ { },
29291
+ { },
29292
+ { },
29293
+ body,
29294
+ ['PureCloud OAuth'],
29295
+ ['application/json'],
29296
+ ['application/json']
29297
+ );
29298
+ }
29299
+
28452
29300
  /**
28453
29301
  * Updates a performance profile
28454
29302
  *
@@ -28544,7 +29392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28544
29392
  /**
28545
29393
  * GeneralDataProtectionRegulation service.
28546
29394
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
28547
- * @version 218.1.0
29395
+ * @version 220.0.0
28548
29396
  */
28549
29397
 
28550
29398
  /**
@@ -28674,7 +29522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28674
29522
  /**
28675
29523
  * Geolocation service.
28676
29524
  * @module purecloud-platform-client-v2/api/GeolocationApi
28677
- * @version 218.1.0
29525
+ * @version 220.0.0
28678
29526
  */
28679
29527
 
28680
29528
  /**
@@ -28805,7 +29653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28805
29653
  /**
28806
29654
  * Greetings service.
28807
29655
  * @module purecloud-platform-client-v2/api/GreetingsApi
28808
- * @version 218.1.0
29656
+ * @version 220.0.0
28809
29657
  */
28810
29658
 
28811
29659
  /**
@@ -29260,7 +30108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29260
30108
  /**
29261
30109
  * Groups service.
29262
30110
  * @module purecloud-platform-client-v2/api/GroupsApi
29263
- * @version 218.1.0
30111
+ * @version 220.0.0
29264
30112
  */
29265
30113
 
29266
30114
  /**
@@ -29779,7 +30627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29779
30627
  /**
29780
30628
  * IdentityProvider service.
29781
30629
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
29782
- * @version 218.1.0
30630
+ * @version 220.0.0
29783
30631
  */
29784
30632
 
29785
30633
  /**
@@ -30640,7 +31488,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30640
31488
  /**
30641
31489
  * InfrastructureAsCode service.
30642
31490
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
30643
- * @version 218.1.0
31491
+ * @version 220.0.0
30644
31492
  */
30645
31493
 
30646
31494
  /**
@@ -30807,7 +31655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30807
31655
  /**
30808
31656
  * Integrations service.
30809
31657
  * @module purecloud-platform-client-v2/api/IntegrationsApi
30810
- * @version 218.1.0
31658
+ * @version 220.0.0
30811
31659
  */
30812
31660
 
30813
31661
  /**
@@ -33276,7 +34124,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33276
34124
  /**
33277
34125
  * Journey service.
33278
34126
  * @module purecloud-platform-client-v2/api/JourneyApi
33279
- * @version 218.1.0
34127
+ * @version 220.0.0
33280
34128
  */
33281
34129
 
33282
34130
  /**
@@ -35261,7 +36109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35261
36109
  /**
35262
36110
  * Knowledge service.
35263
36111
  * @module purecloud-platform-client-v2/api/KnowledgeApi
35264
- * @version 218.1.0
36112
+ * @version 220.0.0
35265
36113
  */
35266
36114
 
35267
36115
  /**
@@ -39134,7 +39982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39134
39982
  /**
39135
39983
  * LanguageUnderstanding service.
39136
39984
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
39137
- * @version 218.1.0
39985
+ * @version 220.0.0
39138
39986
  */
39139
39987
 
39140
39988
  /**
@@ -40167,7 +41015,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40167
41015
  /**
40168
41016
  * Languages service.
40169
41017
  * @module purecloud-platform-client-v2/api/LanguagesApi
40170
- * @version 218.1.0
41018
+ * @version 220.0.0
40171
41019
  */
40172
41020
 
40173
41021
  /**
@@ -40389,7 +41237,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40389
41237
  /**
40390
41238
  * Learning service.
40391
41239
  * @module purecloud-platform-client-v2/api/LearningApi
40392
- * @version 218.1.0
41240
+ * @version 220.0.0
40393
41241
  */
40394
41242
 
40395
41243
  /**
@@ -41418,7 +42266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41418
42266
  /**
41419
42267
  * License service.
41420
42268
  * @module purecloud-platform-client-v2/api/LicenseApi
41421
- * @version 218.1.0
42269
+ * @version 220.0.0
41422
42270
  */
41423
42271
 
41424
42272
  /**
@@ -41656,7 +42504,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41656
42504
  /**
41657
42505
  * Locations service.
41658
42506
  * @module purecloud-platform-client-v2/api/LocationsApi
41659
- * @version 218.1.0
42507
+ * @version 220.0.0
41660
42508
  */
41661
42509
 
41662
42510
  /**
@@ -41892,7 +42740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41892
42740
  /**
41893
42741
  * LogCapture service.
41894
42742
  * @module purecloud-platform-client-v2/api/LogCaptureApi
41895
- * @version 218.1.0
42743
+ * @version 220.0.0
41896
42744
  */
41897
42745
 
41898
42746
  /**
@@ -42092,7 +42940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42092
42940
  /**
42093
42941
  * Messaging service.
42094
42942
  * @module purecloud-platform-client-v2/api/MessagingApi
42095
- * @version 218.1.0
42943
+ * @version 220.0.0
42096
42944
  */
42097
42945
 
42098
42946
  /**
@@ -42451,7 +43299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42451
43299
  /**
42452
43300
  * MobileDevices service.
42453
43301
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
42454
- * @version 218.1.0
43302
+ * @version 220.0.0
42455
43303
  */
42456
43304
 
42457
43305
  /**
@@ -42602,7 +43450,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42602
43450
  /**
42603
43451
  * Notifications service.
42604
43452
  * @module purecloud-platform-client-v2/api/NotificationsApi
42605
- * @version 218.1.0
43453
+ * @version 220.0.0
42606
43454
  */
42607
43455
 
42608
43456
  /**
@@ -42835,7 +43683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42835
43683
  /**
42836
43684
  * OAuth service.
42837
43685
  * @module purecloud-platform-client-v2/api/OAuthApi
42838
- * @version 218.1.0
43686
+ * @version 220.0.0
42839
43687
  */
42840
43688
 
42841
43689
  /**
@@ -43201,7 +44049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43201
44049
  /**
43202
44050
  * Objects service.
43203
44051
  * @module purecloud-platform-client-v2/api/ObjectsApi
43204
- * @version 218.1.0
44052
+ * @version 220.0.0
43205
44053
  */
43206
44054
 
43207
44055
  /**
@@ -43306,6 +44154,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43306
44154
  );
43307
44155
  }
43308
44156
 
44157
+ /**
44158
+ * Get a list of soft deleted divisions for the org
44159
+ *
44160
+ * @param {Object} opts Optional parameters
44161
+ * @param {Number} opts.pageNumber Page number (default to 1)
44162
+ * @param {Number} opts.pageSize Page size (default to 25)
44163
+ */
44164
+ getAuthorizationDivisionsDeleted(opts) {
44165
+ opts = opts || {};
44166
+
44167
+
44168
+ return this.apiClient.callApi(
44169
+ '/api/v2/authorization/divisions/deleted',
44170
+ 'GET',
44171
+ { },
44172
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
44173
+ { },
44174
+ { },
44175
+ null,
44176
+ ['PureCloud OAuth'],
44177
+ ['application/json'],
44178
+ ['application/json']
44179
+ );
44180
+ }
44181
+
43309
44182
  /**
43310
44183
  * Retrieve the home division for the organization.
43311
44184
  * Will not include object counts.
@@ -43346,6 +44219,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43346
44219
  );
43347
44220
  }
43348
44221
 
44222
+ /**
44223
+ * Retrieve a list of all divisions defined for the organization with cursor
44224
+ * Use "after" and "before" param to fetch next/previous page}
44225
+ * @param {Object} opts Optional parameters
44226
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
44227
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
44228
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
44229
+ * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
44230
+ * @param {String} opts.name Optionally request specific divisions by division name
44231
+ */
44232
+ getAuthorizationDivisionsQuery(opts) {
44233
+ opts = opts || {};
44234
+
44235
+
44236
+ return this.apiClient.callApi(
44237
+ '/api/v2/authorization/divisions/query',
44238
+ 'GET',
44239
+ { },
44240
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
44241
+ { },
44242
+ { },
44243
+ null,
44244
+ ['PureCloud OAuth'],
44245
+ ['application/json'],
44246
+ ['application/json']
44247
+ );
44248
+ }
44249
+
43349
44250
  /**
43350
44251
  * Assign a list of objects to a division
43351
44252
  * Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
@@ -43472,7 +44373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43472
44373
  /**
43473
44374
  * OperationalEvents service.
43474
44375
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
43475
- * @version 218.1.0
44376
+ * @version 220.0.0
43476
44377
  */
43477
44378
 
43478
44379
  /**
@@ -43589,7 +44490,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43589
44490
  /**
43590
44491
  * Organization service.
43591
44492
  * @module purecloud-platform-client-v2/api/OrganizationApi
43592
- * @version 218.1.0
44493
+ * @version 220.0.0
43593
44494
  */
43594
44495
 
43595
44496
  /**
@@ -44064,7 +44965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44064
44965
  /**
44065
44966
  * OrganizationAuthorization service.
44066
44967
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
44067
- * @version 218.1.0
44968
+ * @version 220.0.0
44068
44969
  */
44069
44970
 
44070
44971
  /**
@@ -45458,7 +46359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45458
46359
  /**
45459
46360
  * Outbound service.
45460
46361
  * @module purecloud-platform-client-v2/api/OutboundApi
45461
- * @version 218.1.0
46362
+ * @version 220.0.0
45462
46363
  */
45463
46364
 
45464
46365
  /**
@@ -45945,6 +46846,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45945
46846
  );
45946
46847
  }
45947
46848
 
46849
+ /**
46850
+ * Deletes all or expired whatsApp numbers from a DNC list.
46851
+ * This operation is only for Internal DNC lists of whatsApp numbers
46852
+ * @param {String} dncListId DncList ID
46853
+ * @param {Object} opts Optional parameters
46854
+ * @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
46855
+ */
46856
+ deleteOutboundDnclistWhatsappnumbers(dncListId, opts) {
46857
+ opts = opts || {};
46858
+
46859
+ // verify the required parameter 'dncListId' is set
46860
+ if (dncListId === undefined || dncListId === null) {
46861
+ throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';
46862
+ }
46863
+
46864
+ return this.apiClient.callApi(
46865
+ '/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
46866
+ 'DELETE',
46867
+ { 'dncListId': dncListId },
46868
+ { 'expiredOnly': opts['expiredOnly'] },
46869
+ { },
46870
+ { },
46871
+ null,
46872
+ ['PureCloud OAuth'],
46873
+ ['application/json'],
46874
+ ['application/json']
46875
+ );
46876
+ }
46877
+
45948
46878
  /**
45949
46879
  * Delete File Specification Template
45950
46880
  *
@@ -48283,6 +49213,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48283
49213
  );
48284
49214
  }
48285
49215
 
49216
+ /**
49217
+ * Add entries to or delete entries from a DNC list.
49218
+ * Only Internal DNC lists may be deleted from
49219
+ * @param {String} dncListId DncList ID
49220
+ * @param {Object} body DNC whatsApp numbers
49221
+ */
49222
+ patchOutboundDnclistWhatsappnumbers(dncListId, body) {
49223
+ // verify the required parameter 'dncListId' is set
49224
+ if (dncListId === undefined || dncListId === null) {
49225
+ throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';
49226
+ }
49227
+ // verify the required parameter 'body' is set
49228
+ if (body === undefined || body === null) {
49229
+ throw 'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';
49230
+ }
49231
+
49232
+ return this.apiClient.callApi(
49233
+ '/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers',
49234
+ 'PATCH',
49235
+ { 'dncListId': dncListId },
49236
+ { },
49237
+ { },
49238
+ { },
49239
+ body,
49240
+ ['PureCloud OAuth'],
49241
+ ['application/json'],
49242
+ ['application/json']
49243
+ );
49244
+ }
49245
+
48286
49246
  /**
48287
49247
  * Update the outbound settings for this organization
48288
49248
  *
@@ -50021,7 +50981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50021
50981
  /**
50022
50982
  * Presence service.
50023
50983
  * @module purecloud-platform-client-v2/api/PresenceApi
50024
- * @version 218.1.0
50984
+ * @version 220.0.0
50025
50985
  */
50026
50986
 
50027
50987
  /**
@@ -50041,10 +51001,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50041
51001
  *
50042
51002
  * @param {String} definitionId Presence Definition ID
50043
51003
  */
50044
- deleteDivisionBasedPresenceDefinition(definitionId) {
51004
+ deletePresenceDefinition0(definitionId) {
50045
51005
  // verify the required parameter 'definitionId' is set
50046
51006
  if (definitionId === undefined || definitionId === null) {
50047
- throw 'Missing the required parameter "definitionId" when calling deleteDivisionBasedPresenceDefinition';
51007
+ throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
50048
51008
  }
50049
51009
 
50050
51010
  return this.apiClient.callApi(
@@ -50119,12 +51079,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50119
51079
  * @param {Object} opts Optional parameters
50120
51080
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
50121
51081
  */
50122
- getDivisionBasedPresenceDefinition(definitionId, opts) {
51082
+ getPresenceDefinition0(definitionId, opts) {
50123
51083
  opts = opts || {};
50124
51084
 
50125
51085
  // verify the required parameter 'definitionId' is set
50126
51086
  if (definitionId === undefined || definitionId === null) {
50127
- throw 'Missing the required parameter "definitionId" when calling getDivisionBasedPresenceDefinition';
51087
+ throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
50128
51088
  }
50129
51089
 
50130
51090
  return this.apiClient.callApi(
@@ -50149,7 +51109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50149
51109
  * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
50150
51110
  * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
50151
51111
  */
50152
- getDivisionBasedPresenceDefinitions(opts) {
51112
+ getPresenceDefinitions0(opts) {
50153
51113
  opts = opts || {};
50154
51114
 
50155
51115
 
@@ -50517,10 +51477,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50517
51477
  *
50518
51478
  * @param {Object} body The Presence Definition to create
50519
51479
  */
50520
- postDivisionBasedPresenceDefinitions(body) {
51480
+ postPresenceDefinitions0(body) {
50521
51481
  // verify the required parameter 'body' is set
50522
51482
  if (body === undefined || body === null) {
50523
- throw 'Missing the required parameter "body" when calling postDivisionBasedPresenceDefinitions';
51483
+ throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
50524
51484
  }
50525
51485
 
50526
51486
  return this.apiClient.callApi(
@@ -50594,14 +51554,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50594
51554
  * @param {String} definitionId Presence Definition ID
50595
51555
  * @param {Object} body The updated Presence Definition
50596
51556
  */
50597
- putDivisionBasedPresenceDefinition(definitionId, body) {
51557
+ putPresenceDefinition0(definitionId, body) {
50598
51558
  // verify the required parameter 'definitionId' is set
50599
51559
  if (definitionId === undefined || definitionId === null) {
50600
- throw 'Missing the required parameter "definitionId" when calling putDivisionBasedPresenceDefinition';
51560
+ throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
50601
51561
  }
50602
51562
  // verify the required parameter 'body' is set
50603
51563
  if (body === undefined || body === null) {
50604
- throw 'Missing the required parameter "body" when calling putDivisionBasedPresenceDefinition';
51564
+ throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
50605
51565
  }
50606
51566
 
50607
51567
  return this.apiClient.callApi(
@@ -50765,7 +51725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50765
51725
  /**
50766
51726
  * ProcessAutomation service.
50767
51727
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
50768
- * @version 218.1.0
51728
+ * @version 220.0.0
50769
51729
  */
50770
51730
 
50771
51731
  /**
@@ -51004,7 +51964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51004
51964
  /**
51005
51965
  * Quality service.
51006
51966
  * @module purecloud-platform-client-v2/api/QualityApi
51007
- * @version 218.1.0
51967
+ * @version 220.0.0
51008
51968
  */
51009
51969
 
51010
51970
  /**
@@ -52791,7 +53751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52791
53751
  /**
52792
53752
  * Recording service.
52793
53753
  * @module purecloud-platform-client-v2/api/RecordingApi
52794
- * @version 218.1.0
53754
+ * @version 220.0.0
52795
53755
  */
52796
53756
 
52797
53757
  /**
@@ -53393,7 +54353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53393
54353
  * @param {Object} opts Optional parameters
53394
54354
  * @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
53395
54355
  * @param {Number} opts.pageNumber Page number (default to 1)
53396
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
54356
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
53397
54357
  * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
53398
54358
  */
53399
54359
  getRecordingJobFailedrecordings(jobId, opts) {
@@ -53428,7 +54388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53428
54388
  * @param {Object} opts.state Filter by state
53429
54389
  * @param {Boolean} opts.showOnlyMyJobs Show only my jobs
53430
54390
  * @param {Object} opts.jobType Job Type (Can be left empty for both)
53431
- * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
54391
+ * @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
53432
54392
  * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
53433
54393
  */
53434
54394
  getRecordingJobs(opts) {
@@ -54396,7 +55356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54396
55356
  /**
54397
55357
  * ResponseManagement service.
54398
55358
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
54399
- * @version 218.1.0
55359
+ * @version 220.0.0
54400
55360
  */
54401
55361
 
54402
55362
  /**
@@ -54906,7 +55866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54906
55866
  /**
54907
55867
  * Routing service.
54908
55868
  * @module purecloud-platform-client-v2/api/RoutingApi
54909
- * @version 218.1.0
55869
+ * @version 220.0.0
54910
55870
  */
54911
55871
 
54912
55872
  /**
@@ -55816,7 +56776,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55816
56776
  * @param {Number} opts.pageSize Page size (default to 25)
55817
56777
  * @param {Number} opts.pageNumber Page number (default to 1)
55818
56778
  * @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
55819
- * @param {String} opts.filter Optional search filter
56779
+ * @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
55820
56780
  */
55821
56781
  getRoutingEmailDomains(opts) {
55822
56782
  opts = opts || {};
@@ -55915,7 +56875,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55915
56875
  * Get outbound domains
55916
56876
  *
55917
56877
  * @param {Object} opts Optional parameters
55918
- * @param {String} opts.filter Optional search filter
56878
+ * @param {Number} opts.pageSize Page size (default to 25)
56879
+ * @param {Number} opts.pageNumber Page number (default to 1)
56880
+ * @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
55919
56881
  */
55920
56882
  getRoutingEmailOutboundDomains(opts) {
55921
56883
  opts = opts || {};
@@ -55925,7 +56887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55925
56887
  '/api/v2/routing/email/outbound/domains',
55926
56888
  'GET',
55927
56889
  { },
55928
- { 'filter': opts['filter'] },
56890
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'filter': opts['filter'] },
55929
56891
  { },
55930
56892
  { },
55931
56893
  null,
@@ -59209,7 +60171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59209
60171
  /**
59210
60172
  * SCIM service.
59211
60173
  * @module purecloud-platform-client-v2/api/SCIMApi
59212
- * @version 218.1.0
60174
+ * @version 220.0.0
59213
60175
  */
59214
60176
 
59215
60177
  /**
@@ -60086,7 +61048,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60086
61048
  /**
60087
61049
  * ScreenRecording service.
60088
61050
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
60089
- * @version 218.1.0
61051
+ * @version 220.0.0
60090
61052
  */
60091
61053
 
60092
61054
  /**
@@ -60131,7 +61093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60131
61093
  /**
60132
61094
  * Scripts service.
60133
61095
  * @module purecloud-platform-client-v2/api/ScriptsApi
60134
- * @version 218.1.0
61096
+ * @version 220.0.0
60135
61097
  */
60136
61098
 
60137
61099
  /**
@@ -60331,6 +61293,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60331
61293
  );
60332
61294
  }
60333
61295
 
61296
+ /**
61297
+ * Get the published variables
61298
+ *
61299
+ * @param {String} scriptId Script ID
61300
+ * @param {Object} opts Optional parameters
61301
+ * @param {Object} opts.input input
61302
+ * @param {Object} opts.output output
61303
+ * @param {Object} opts.type type
61304
+ * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
61305
+ */
61306
+ getScriptsPublishedDivisionviewVariables(scriptId, opts) {
61307
+ opts = opts || {};
61308
+
61309
+ // verify the required parameter 'scriptId' is set
61310
+ if (scriptId === undefined || scriptId === null) {
61311
+ throw 'Missing the required parameter "scriptId" when calling getScriptsPublishedDivisionviewVariables';
61312
+ }
61313
+
61314
+ return this.apiClient.callApi(
61315
+ '/api/v2/scripts/published/divisionviews/{scriptId}/variables',
61316
+ 'GET',
61317
+ { 'scriptId': scriptId },
61318
+ { 'input': opts['input'],'output': opts['output'],'type': opts['type'],'scriptDataVersion': opts['scriptDataVersion'] },
61319
+ { },
61320
+ { },
61321
+ null,
61322
+ ['PureCloud OAuth'],
61323
+ ['application/json'],
61324
+ ['application/json']
61325
+ );
61326
+ }
61327
+
60334
61328
  /**
60335
61329
  * Get the published scripts metadata.
60336
61330
  *
@@ -60575,7 +61569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60575
61569
  /**
60576
61570
  * Search service.
60577
61571
  * @module purecloud-platform-client-v2/api/SearchApi
60578
- * @version 218.1.0
61572
+ * @version 220.0.0
60579
61573
  */
60580
61574
 
60581
61575
  /**
@@ -61318,7 +62312,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61318
62312
  /**
61319
62313
  * Settings service.
61320
62314
  * @module purecloud-platform-client-v2/api/SettingsApi
61321
- * @version 218.1.0
62315
+ * @version 220.0.0
61322
62316
  */
61323
62317
 
61324
62318
  /**
@@ -61602,7 +62596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61602
62596
  /**
61603
62597
  * SocialMedia service.
61604
62598
  * @module purecloud-platform-client-v2/api/SocialMediaApi
61605
- * @version 218.1.0
62599
+ * @version 220.0.0
61606
62600
  */
61607
62601
 
61608
62602
  /**
@@ -62890,7 +63884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62890
63884
  /**
62891
63885
  * SpeechTextAnalytics service.
62892
63886
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
62893
- * @version 218.1.0
63887
+ * @version 220.0.0
62894
63888
  */
62895
63889
 
62896
63890
  /**
@@ -64331,7 +65325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64331
65325
  /**
64332
65326
  * Stations service.
64333
65327
  * @module purecloud-platform-client-v2/api/StationsApi
64334
- * @version 218.1.0
65328
+ * @version 220.0.0
64335
65329
  */
64336
65330
 
64337
65331
  /**
@@ -64433,7 +65427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64433
65427
  /**
64434
65428
  * Suggest service.
64435
65429
  * @module purecloud-platform-client-v2/api/SuggestApi
64436
- * @version 218.1.0
65430
+ * @version 220.0.0
64437
65431
  */
64438
65432
 
64439
65433
  /**
@@ -64572,7 +65566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64572
65566
  /**
64573
65567
  * TaskManagement service.
64574
65568
  * @module purecloud-platform-client-v2/api/TaskManagementApi
64575
- * @version 218.1.0
65569
+ * @version 220.0.0
64576
65570
  */
64577
65571
 
64578
65572
  /**
@@ -64890,7 +65884,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64890
65884
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
64891
65885
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
64892
65886
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
64893
- * getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
64894
65887
  */
64895
65888
  getTaskmanagementWorkbinHistory(workbinId, opts) {
64896
65889
  opts = opts || {};
@@ -64919,7 +65912,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64919
65912
  *
64920
65913
  * @param {String} workbinId Workbin ID
64921
65914
  * @param {Number} entityVersion Workbin version
64922
- * getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
64923
65915
  */
64924
65916
  getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
64925
65917
  // verify the required parameter 'workbinId' is set
@@ -64953,7 +65945,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64953
65945
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
64954
65946
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
64955
65947
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
64956
- * getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
64957
65948
  */
64958
65949
  getTaskmanagementWorkbinVersions(workbinId, opts) {
64959
65950
  opts = opts || {};
@@ -65014,7 +66005,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65014
66005
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
65015
66006
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
65016
66007
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
65017
- * getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65018
66008
  */
65019
66009
  getTaskmanagementWorkitemHistory(workitemId, opts) {
65020
66010
  opts = opts || {};
@@ -65080,7 +66070,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65080
66070
  *
65081
66071
  * @param {String} workitemId Workitem ID
65082
66072
  * @param {Number} entityVersion Workitem version
65083
- * getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65084
66073
  */
65085
66074
  getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
65086
66075
  // verify the required parameter 'workitemId' is set
@@ -65114,7 +66103,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65114
66103
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
65115
66104
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
65116
66105
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
65117
- * getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65118
66106
  */
65119
66107
  getTaskmanagementWorkitemVersions(workitemId, opts) {
65120
66108
  opts = opts || {};
@@ -65447,6 +66435,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65447
66435
  );
65448
66436
  }
65449
66437
 
66438
+ /**
66439
+ * Get the core types from which all schemas are built.
66440
+ *
66441
+ * @param {String} coreTypeName Name of the core type
66442
+ */
66443
+ getTaskmanagementWorkitemsSchemasCoretype(coreTypeName) {
66444
+ // verify the required parameter 'coreTypeName' is set
66445
+ if (coreTypeName === undefined || coreTypeName === null) {
66446
+ throw 'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';
66447
+ }
66448
+
66449
+ return this.apiClient.callApi(
66450
+ '/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}',
66451
+ 'GET',
66452
+ { 'coreTypeName': coreTypeName },
66453
+ { },
66454
+ { },
66455
+ { },
66456
+ null,
66457
+ ['PureCloud OAuth'],
66458
+ ['application/json'],
66459
+ ['application/json']
66460
+ );
66461
+ }
66462
+
66463
+ /**
66464
+ * Get the core types from which all schemas are built.
66465
+ *
66466
+ */
66467
+ getTaskmanagementWorkitemsSchemasCoretypes() {
66468
+
66469
+ return this.apiClient.callApi(
66470
+ '/api/v2/taskmanagement/workitems/schemas/coretypes',
66471
+ 'GET',
66472
+ { },
66473
+ { },
66474
+ { },
66475
+ { },
66476
+ null,
66477
+ ['PureCloud OAuth'],
66478
+ ['application/json'],
66479
+ ['application/json']
66480
+ );
66481
+ }
66482
+
66483
+ /**
66484
+ * Get quantitative limits on schemas
66485
+ *
66486
+ */
66487
+ getTaskmanagementWorkitemsSchemasLimits() {
66488
+
66489
+ return this.apiClient.callApi(
66490
+ '/api/v2/taskmanagement/workitems/schemas/limits',
66491
+ 'GET',
66492
+ { },
66493
+ { },
66494
+ { },
66495
+ { },
66496
+ null,
66497
+ ['PureCloud OAuth'],
66498
+ ['application/json'],
66499
+ ['application/json']
66500
+ );
66501
+ }
66502
+
65450
66503
  /**
65451
66504
  * Get a worktype
65452
66505
  *
@@ -65665,7 +66718,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65665
66718
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
65666
66719
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
65667
66720
  * @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
65668
- * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65669
66721
  */
65670
66722
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
65671
66723
  opts = opts || {};
@@ -65749,7 +66801,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65749
66801
  *
65750
66802
  * @param {String} worktypeId Worktype id
65751
66803
  * @param {Number} entityVersion Worktype version
65752
- * getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65753
66804
  */
65754
66805
  getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
65755
66806
  // verify the required parameter 'worktypeId' is set
@@ -65783,7 +66834,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65783
66834
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
65784
66835
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
65785
66836
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
65786
- * getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65787
66837
  */
65788
66838
  getTaskmanagementWorktypeVersions(worktypeId, opts) {
65789
66839
  opts = opts || {};
@@ -66678,7 +67728,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66678
67728
  /**
66679
67729
  * Teams service.
66680
67730
  * @module purecloud-platform-client-v2/api/TeamsApi
66681
- * @version 218.1.0
67731
+ * @version 220.0.0
66682
67732
  */
66683
67733
 
66684
67734
  /**
@@ -66983,7 +68033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66983
68033
  /**
66984
68034
  * Telephony service.
66985
68035
  * @module purecloud-platform-client-v2/api/TelephonyApi
66986
- * @version 218.1.0
68036
+ * @version 220.0.0
66987
68037
  */
66988
68038
 
66989
68039
  /**
@@ -67165,7 +68215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67165
68215
  /**
67166
68216
  * TelephonyProvidersEdge service.
67167
68217
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
67168
- * @version 218.1.0
68218
+ * @version 220.0.0
67169
68219
  */
67170
68220
 
67171
68221
  /**
@@ -70617,7 +71667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70617
71667
  /**
70618
71668
  * Textbots service.
70619
71669
  * @module purecloud-platform-client-v2/api/TextbotsApi
70620
- * @version 218.1.0
71670
+ * @version 220.0.0
70621
71671
  */
70622
71672
 
70623
71673
  /**
@@ -70638,8 +71688,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70638
71688
  * @param {Object} opts Optional parameters
70639
71689
  * @param {Array.<String>} opts.botType Bot types
70640
71690
  * @param {String} opts.botName Bot name
70641
- * @param {Array.<String>} opts.botId Bot IDs
70642
- * @param {Number} opts.pageSize The maximum results to return (default to 25)
71691
+ * @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
71692
+ * @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
70643
71693
  */
70644
71694
  getTextbotsBotsSearch(opts) {
70645
71695
  opts = opts || {};
@@ -70745,7 +71795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70745
71795
  /**
70746
71796
  * Tokens service.
70747
71797
  * @module purecloud-platform-client-v2/api/TokensApi
70748
- * @version 218.1.0
71798
+ * @version 220.0.0
70749
71799
  */
70750
71800
 
70751
71801
  /**
@@ -70899,7 +71949,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70899
71949
  /**
70900
71950
  * Uploads service.
70901
71951
  * @module purecloud-platform-client-v2/api/UploadsApi
70902
- * @version 218.1.0
71952
+ * @version 220.0.0
70903
71953
  */
70904
71954
 
70905
71955
  /**
@@ -70944,6 +71994,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70944
71994
  );
70945
71995
  }
70946
71996
 
71997
+ /**
71998
+ * Generates pre-signed URL to upload a prize image for gamification contests
71999
+ *
72000
+ * @param {Object} body query
72001
+ */
72002
+ postGamificationContestsUploadsPrizeimages(body) {
72003
+ // verify the required parameter 'body' is set
72004
+ if (body === undefined || body === null) {
72005
+ throw 'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';
72006
+ }
72007
+
72008
+ return this.apiClient.callApi(
72009
+ '/api/v2/gamification/contests/uploads/prizeimages',
72010
+ 'POST',
72011
+ { },
72012
+ { },
72013
+ { },
72014
+ { },
72015
+ body,
72016
+ ['PureCloud OAuth'],
72017
+ ['application/json'],
72018
+ ['application/json']
72019
+ );
72020
+ }
72021
+
70947
72022
  /**
70948
72023
  * Create upload presigned URL for draft function package file.
70949
72024
  *
@@ -71165,7 +72240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71165
72240
  /**
71166
72241
  * Usage service.
71167
72242
  * @module purecloud-platform-client-v2/api/UsageApi
71168
- * @version 218.1.0
72243
+ * @version 220.0.0
71169
72244
  */
71170
72245
 
71171
72246
  /**
@@ -71380,7 +72455,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71380
72455
  /**
71381
72456
  * UserRecordings service.
71382
72457
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
71383
- * @version 218.1.0
72458
+ * @version 220.0.0
71384
72459
  */
71385
72460
 
71386
72461
  /**
@@ -71595,7 +72670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71595
72670
  /**
71596
72671
  * Users service.
71597
72672
  * @module purecloud-platform-client-v2/api/UsersApi
71598
- * @version 218.1.0
72673
+ * @version 220.0.0
71599
72674
  */
71600
72675
 
71601
72676
  /**
@@ -74548,7 +75623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74548
75623
  /**
74549
75624
  * Utilities service.
74550
75625
  * @module purecloud-platform-client-v2/api/UtilitiesApi
74551
- * @version 218.1.0
75626
+ * @version 220.0.0
74552
75627
  */
74553
75628
 
74554
75629
  /**
@@ -74659,7 +75734,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74659
75734
  /**
74660
75735
  * Voicemail service.
74661
75736
  * @module purecloud-platform-client-v2/api/VoicemailApi
74662
- * @version 218.1.0
75737
+ * @version 220.0.0
74663
75738
  */
74664
75739
 
74665
75740
  /**
@@ -75381,7 +76456,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75381
76456
  /**
75382
76457
  * WebChat service.
75383
76458
  * @module purecloud-platform-client-v2/api/WebChatApi
75384
- * @version 218.1.0
76459
+ * @version 220.0.0
75385
76460
  */
75386
76461
 
75387
76462
  /**
@@ -75941,7 +77016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75941
77016
  /**
75942
77017
  * WebDeployments service.
75943
77018
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
75944
- * @version 218.1.0
77019
+ * @version 220.0.0
75945
77020
  */
75946
77021
 
75947
77022
  /**
@@ -76525,7 +77600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76525
77600
  /**
76526
77601
  * WebMessaging service.
76527
77602
  * @module purecloud-platform-client-v2/api/WebMessagingApi
76528
- * @version 218.1.0
77603
+ * @version 220.0.0
76529
77604
  */
76530
77605
 
76531
77606
  /**
@@ -76571,7 +77646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76571
77646
  /**
76572
77647
  * Widgets service.
76573
77648
  * @module purecloud-platform-client-v2/api/WidgetsApi
76574
- * @version 218.1.0
77649
+ * @version 220.0.0
76575
77650
  */
76576
77651
 
76577
77652
  /**
@@ -76722,7 +77797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76722
77797
  /**
76723
77798
  * WorkforceManagement service.
76724
77799
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
76725
- * @version 218.1.0
77800
+ * @version 220.0.0
76726
77801
  */
76727
77802
 
76728
77803
  /**
@@ -79292,8 +80367,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
79292
80367
  }
79293
80368
 
79294
80369
  /**
79295
- * Retrieves delete job status for historical data imports of the organization
79296
- *
80370
+ * Retrieves delete job status for historical data imports of the organization.
80371
+ * Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
80372
+ * @deprecated
79297
80373
  */
79298
80374
  getWorkforcemanagementHistoricaldataDeletejob() {
79299
80375
 
@@ -82865,8 +83941,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82865
83941
  }
82866
83942
 
82867
83943
  /**
82868
- * Delete the entries of the historical data imports in the organization
82869
- *
83944
+ * Delete the entries of the historical data imports in the organization.
83945
+ * Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
83946
+ * @deprecated
82870
83947
  */
82871
83948
  postWorkforcemanagementHistoricaldataDeletejob() {
82872
83949
 
@@ -84115,7 +85192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
84115
85192
  * </pre>
84116
85193
  * </p>
84117
85194
  * @module purecloud-platform-client-v2/index
84118
- * @version 218.1.0
85195
+ * @version 220.0.0
84119
85196
  */
84120
85197
  class platformClient {
84121
85198
  constructor() {