purecloud-platform-client-v2 179.3.0 → 180.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 (82) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +136 -79
  3. package/dist/web-amd/purecloud-platform-client-v2.js +136 -79
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +136 -79
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +180 -91
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +39 -16
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +8 -7
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +57 -1
  68. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SearchApi {
5
5
  /**
6
6
  * Search service.
7
7
  * @module purecloud-platform-client-v2/api/SearchApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SettingsApi {
5
5
  /**
6
6
  * Settings service.
7
7
  * @module purecloud-platform-client-v2/api/SettingsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TaskManagementApi {
5
5
  /**
6
6
  * TaskManagement service.
7
7
  * @module purecloud-platform-client-v2/api/TaskManagementApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TeamsApi {
5
5
  /**
6
6
  * Teams service.
7
7
  * @module purecloud-platform-client-v2/api/TeamsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TelephonyApi {
5
5
  /**
6
6
  * Telephony service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -40,6 +40,62 @@ class TelephonyApi {
40
40
  );
41
41
  }
42
42
 
43
+ /**
44
+ * Get a SIP message.
45
+ * Get the raw form of the SIP message
46
+ * @param {String} conversationId Conversation id
47
+ * getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48
+ */
49
+ getTelephonySipmessagesConversation(conversationId) {
50
+ // verify the required parameter 'conversationId' is set
51
+ if (conversationId === undefined || conversationId === null) {
52
+ throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';
53
+ }
54
+
55
+ return this.apiClient.callApi(
56
+ '/api/v2/telephony/sipmessages/conversations/{conversationId}',
57
+ 'GET',
58
+ { 'conversationId': conversationId },
59
+ { },
60
+ { },
61
+ { },
62
+ null,
63
+ ['PureCloud OAuth'],
64
+ ['application/json'],
65
+ ['application/json']
66
+ );
67
+ }
68
+
69
+ /**
70
+ * Get SIP headers.
71
+ * Get parsed SIP headers. Returns specific headers if key query parameters are added.
72
+ * @param {String} conversationId Conversation id
73
+ * @param {Object} opts Optional parameters
74
+ * @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
75
+ * getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76
+ */
77
+ getTelephonySipmessagesConversationHeaders(conversationId, opts) {
78
+ opts = opts || {};
79
+
80
+ // verify the required parameter 'conversationId' is set
81
+ if (conversationId === undefined || conversationId === null) {
82
+ throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';
83
+ }
84
+
85
+ return this.apiClient.callApi(
86
+ '/api/v2/telephony/sipmessages/conversations/{conversationId}/headers',
87
+ 'GET',
88
+ { 'conversationId': conversationId },
89
+ { 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi') },
90
+ { },
91
+ { },
92
+ null,
93
+ ['PureCloud OAuth'],
94
+ ['application/json'],
95
+ ['application/json']
96
+ );
97
+ }
98
+
43
99
  /**
44
100
  * Fetch SIP metadata
45
101
  * Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
5
5
  /**
6
6
  * TelephonyProvidersEdge service.
7
7
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 179.3.0
8
+ * @version 180.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -104,7 +104,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
104
104
  * </pre>
105
105
  * </p>
106
106
  * @module purecloud-platform-client-v2/index
107
- * @version 179.3.0
107
+ * @version 180.0.0
108
108
  */
109
109
  class platformClient {
110
110
  constructor() {