@rc-ex/core 1.6.16 → 1.6.17

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 (161) hide show
  1. package/dist/cjs/Rest.js +1 -1
  2. package/dist/cjs/definitions/AIInsights.d.ts +3 -0
  3. package/dist/cjs/definitions/ASGErrorResponse.d.ts +3 -0
  4. package/dist/cjs/definitions/AccountHistorySearchPublicRequest.d.ts +2 -2
  5. package/dist/cjs/definitions/AccountPhoneNumberInfo.d.ts +2 -2
  6. package/dist/cjs/definitions/AggregateA2PSMSStatusesParameters.d.ts +3 -2
  7. package/dist/cjs/definitions/BaseCallLogRecord.d.ts +4 -0
  8. package/dist/cjs/definitions/CallLogRecord.d.ts +4 -0
  9. package/dist/cjs/definitions/CallLogRecordLegInfo.d.ts +4 -0
  10. package/dist/cjs/definitions/CallNotesInsightUnit.d.ts +9 -0
  11. package/dist/cjs/definitions/CallQueueDetails.d.ts +1 -1
  12. package/dist/cjs/definitions/CallQueueDetailsForUpdate.d.ts +1 -1
  13. package/dist/cjs/definitions/CallQueueInfo.d.ts +1 -1
  14. package/dist/cjs/definitions/CompanyPhoneNumberInfo.d.ts +3 -7
  15. package/dist/cjs/definitions/CreateForwardingNumberRequest.d.ts +8 -3
  16. package/dist/cjs/definitions/CreateSiteRequest.d.ts +4 -0
  17. package/dist/cjs/definitions/CreateUserEmergencyLocationRequest.d.ts +3 -0
  18. package/dist/cjs/definitions/EmailRecipientInfo.d.ts +1 -1
  19. package/dist/cjs/definitions/ErrorEntry.d.ts +18 -0
  20. package/dist/cjs/definitions/ErrorEntry.js +2 -0
  21. package/dist/cjs/definitions/GetExtensionInfoResponse.d.ts +5 -0
  22. package/dist/cjs/definitions/GetMessageInfoResponse.d.ts +2 -2
  23. package/dist/cjs/definitions/GetRecordingInsightsParameters.d.ts +1 -1
  24. package/dist/cjs/definitions/GetSessionInsightsParameters.d.ts +10 -0
  25. package/dist/cjs/definitions/GetSessionInsightsParameters.js +2 -0
  26. package/dist/cjs/definitions/GetSessionInsightsResponse.d.ts +13 -0
  27. package/dist/cjs/definitions/GetSessionInsightsResponse.js +2 -0
  28. package/dist/cjs/definitions/HoldCallPartyRequest.d.ts +1 -1
  29. package/dist/cjs/definitions/ListA2PSMSParameters.d.ts +3 -2
  30. package/dist/cjs/definitions/ListAccountPhoneNumbersParameters.d.ts +2 -2
  31. package/dist/cjs/definitions/ListAccountPhoneNumbersV2Parameters.d.ts +1 -1
  32. package/dist/cjs/definitions/ListAccountSwitchesParameters.d.ts +5 -4
  33. package/dist/cjs/definitions/ListAutomaticLocationUpdatesUsersParameters.d.ts +3 -3
  34. package/dist/cjs/definitions/ListDevicesAutomaticLocationUpdatesParameters.d.ts +3 -3
  35. package/dist/cjs/definitions/ListDirectoryEntriesParameters.d.ts +1 -1
  36. package/dist/cjs/definitions/ListExtensionGrantsParameters.d.ts +3 -3
  37. package/dist/cjs/definitions/ListExtensionPhoneNumbersParameters.d.ts +2 -2
  38. package/dist/cjs/definitions/ListMessagesParameters.d.ts +15 -0
  39. package/dist/cjs/definitions/ListNetworksParameters.d.ts +6 -6
  40. package/dist/cjs/definitions/ListWirelessPointsParameters.d.ts +5 -4
  41. package/dist/cjs/definitions/MessageBatchResponse.d.ts +1 -1
  42. package/dist/cjs/definitions/NotificationSettings.d.ts +9 -0
  43. package/dist/cjs/definitions/OwnerResource.d.ts +18 -0
  44. package/dist/cjs/definitions/OwnerResource.js +2 -0
  45. package/dist/cjs/definitions/PhoneNumberResource.d.ts +1 -1
  46. package/dist/cjs/definitions/RSPagingModel.d.ts +58 -0
  47. package/dist/cjs/definitions/RSPagingModel.js +2 -0
  48. package/dist/cjs/definitions/ReadCompanyCallLogParameters.d.ts +5 -0
  49. package/dist/cjs/definitions/ReadUserCallLogParameters.d.ts +5 -0
  50. package/dist/cjs/definitions/ReasonInfo.d.ts +1 -1
  51. package/dist/cjs/definitions/SearchDirectoryEntriesParameters.d.ts +9 -13
  52. package/dist/cjs/definitions/ShortSiteInfo.d.ts +1 -0
  53. package/dist/cjs/definitions/SmsBrandInfo.d.ts +14 -0
  54. package/dist/cjs/definitions/SmsBrandInfo.js +2 -0
  55. package/dist/cjs/definitions/SmsCampaignInfo.d.ts +22 -0
  56. package/dist/cjs/definitions/SmsCampaignInfo.js +2 -0
  57. package/dist/cjs/definitions/SmsConfigurationResource.d.ts +18 -0
  58. package/dist/cjs/definitions/SmsConfigurationResource.js +2 -0
  59. package/dist/cjs/definitions/SyncAccountCallLogParameters.d.ts +5 -0
  60. package/dist/cjs/definitions/SyncMessagesParameters.d.ts +12 -1
  61. package/dist/cjs/definitions/SyncUserCallLogParameters.d.ts +5 -0
  62. package/dist/cjs/definitions/UserPhoneNumberInfo.d.ts +3 -2
  63. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.d.ts +18 -0
  64. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.js +25 -0
  65. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.d.ts +11 -0
  66. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.js +26 -0
  67. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.d.ts +2 -0
  68. package/dist/cjs/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.js +6 -2
  69. package/dist/cjs/paths/Restapi/Account/Extension/Features/index.d.ts +1 -0
  70. package/dist/cjs/paths/Restapi/Account/Extension/Features/index.js +1 -0
  71. package/dist/cjs/paths/Restapi/Account/Extension/Grant/index.d.ts +2 -3
  72. package/dist/cjs/paths/Restapi/Account/Extension/Grant/index.js +2 -3
  73. package/dist/cjs/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.d.ts +18 -0
  74. package/dist/cjs/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.js +26 -0
  75. package/dist/cjs/paths/Restapi/Account/Extension/PhoneNumber/index.d.ts +2 -0
  76. package/dist/cjs/paths/Restapi/Account/Extension/PhoneNumber/index.js +7 -0
  77. package/dist/cjs/paths/Restapi/V2/Accounts/Extensions/index.d.ts +0 -2
  78. package/dist/cjs/paths/Restapi/V2/Accounts/Extensions/index.js +0 -2
  79. package/dist/esm/Rest.js +1 -1
  80. package/dist/esm/definitions/AIInsights.d.ts +3 -0
  81. package/dist/esm/definitions/ASGErrorResponse.d.ts +3 -0
  82. package/dist/esm/definitions/AccountHistorySearchPublicRequest.d.ts +2 -2
  83. package/dist/esm/definitions/AccountPhoneNumberInfo.d.ts +2 -2
  84. package/dist/esm/definitions/AggregateA2PSMSStatusesParameters.d.ts +3 -2
  85. package/dist/esm/definitions/BaseCallLogRecord.d.ts +4 -0
  86. package/dist/esm/definitions/CallLogRecord.d.ts +4 -0
  87. package/dist/esm/definitions/CallLogRecordLegInfo.d.ts +4 -0
  88. package/dist/esm/definitions/CallNotesInsightUnit.d.ts +9 -0
  89. package/dist/esm/definitions/CallQueueDetails.d.ts +1 -1
  90. package/dist/esm/definitions/CallQueueDetailsForUpdate.d.ts +1 -1
  91. package/dist/esm/definitions/CallQueueInfo.d.ts +1 -1
  92. package/dist/esm/definitions/CompanyPhoneNumberInfo.d.ts +3 -7
  93. package/dist/esm/definitions/CreateForwardingNumberRequest.d.ts +8 -3
  94. package/dist/esm/definitions/CreateSiteRequest.d.ts +4 -0
  95. package/dist/esm/definitions/CreateUserEmergencyLocationRequest.d.ts +3 -0
  96. package/dist/esm/definitions/EmailRecipientInfo.d.ts +1 -1
  97. package/dist/esm/definitions/ErrorEntry.d.ts +18 -0
  98. package/dist/esm/definitions/ErrorEntry.js +1 -0
  99. package/dist/esm/definitions/GetExtensionInfoResponse.d.ts +5 -0
  100. package/dist/esm/definitions/GetMessageInfoResponse.d.ts +2 -2
  101. package/dist/esm/definitions/GetRecordingInsightsParameters.d.ts +1 -1
  102. package/dist/esm/definitions/GetSessionInsightsParameters.d.ts +10 -0
  103. package/dist/esm/definitions/GetSessionInsightsParameters.js +1 -0
  104. package/dist/esm/definitions/GetSessionInsightsResponse.d.ts +13 -0
  105. package/dist/esm/definitions/GetSessionInsightsResponse.js +1 -0
  106. package/dist/esm/definitions/HoldCallPartyRequest.d.ts +1 -1
  107. package/dist/esm/definitions/ListA2PSMSParameters.d.ts +3 -2
  108. package/dist/esm/definitions/ListAccountPhoneNumbersParameters.d.ts +2 -2
  109. package/dist/esm/definitions/ListAccountPhoneNumbersV2Parameters.d.ts +1 -1
  110. package/dist/esm/definitions/ListAccountSwitchesParameters.d.ts +5 -4
  111. package/dist/esm/definitions/ListAutomaticLocationUpdatesUsersParameters.d.ts +3 -3
  112. package/dist/esm/definitions/ListDevicesAutomaticLocationUpdatesParameters.d.ts +3 -3
  113. package/dist/esm/definitions/ListDirectoryEntriesParameters.d.ts +1 -1
  114. package/dist/esm/definitions/ListExtensionGrantsParameters.d.ts +3 -3
  115. package/dist/esm/definitions/ListExtensionPhoneNumbersParameters.d.ts +2 -2
  116. package/dist/esm/definitions/ListMessagesParameters.d.ts +15 -0
  117. package/dist/esm/definitions/ListNetworksParameters.d.ts +6 -6
  118. package/dist/esm/definitions/ListWirelessPointsParameters.d.ts +5 -4
  119. package/dist/esm/definitions/MessageBatchResponse.d.ts +1 -1
  120. package/dist/esm/definitions/NotificationSettings.d.ts +9 -0
  121. package/dist/esm/definitions/OwnerResource.d.ts +18 -0
  122. package/dist/esm/definitions/OwnerResource.js +1 -0
  123. package/dist/esm/definitions/PhoneNumberResource.d.ts +1 -1
  124. package/dist/esm/definitions/RSPagingModel.d.ts +58 -0
  125. package/dist/esm/definitions/RSPagingModel.js +1 -0
  126. package/dist/esm/definitions/ReadCompanyCallLogParameters.d.ts +5 -0
  127. package/dist/esm/definitions/ReadUserCallLogParameters.d.ts +5 -0
  128. package/dist/esm/definitions/ReasonInfo.d.ts +1 -1
  129. package/dist/esm/definitions/SearchDirectoryEntriesParameters.d.ts +9 -13
  130. package/dist/esm/definitions/ShortSiteInfo.d.ts +1 -0
  131. package/dist/esm/definitions/SmsBrandInfo.d.ts +14 -0
  132. package/dist/esm/definitions/SmsBrandInfo.js +1 -0
  133. package/dist/esm/definitions/SmsCampaignInfo.d.ts +22 -0
  134. package/dist/esm/definitions/SmsCampaignInfo.js +1 -0
  135. package/dist/esm/definitions/SmsConfigurationResource.d.ts +18 -0
  136. package/dist/esm/definitions/SmsConfigurationResource.js +1 -0
  137. package/dist/esm/definitions/SyncAccountCallLogParameters.d.ts +5 -0
  138. package/dist/esm/definitions/SyncMessagesParameters.d.ts +12 -1
  139. package/dist/esm/definitions/SyncUserCallLogParameters.d.ts +5 -0
  140. package/dist/esm/definitions/UserPhoneNumberInfo.d.ts +3 -2
  141. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.d.ts +18 -0
  142. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.js +23 -0
  143. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.d.ts +11 -0
  144. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.js +21 -0
  145. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.d.ts +2 -0
  146. package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.js +4 -0
  147. package/dist/esm/paths/Restapi/Account/Extension/Features/index.d.ts +1 -0
  148. package/dist/esm/paths/Restapi/Account/Extension/Features/index.js +1 -0
  149. package/dist/esm/paths/Restapi/Account/Extension/Grant/index.d.ts +2 -3
  150. package/dist/esm/paths/Restapi/Account/Extension/Grant/index.js +2 -3
  151. package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.d.ts +18 -0
  152. package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.js +24 -0
  153. package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/index.d.ts +2 -0
  154. package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/index.js +4 -0
  155. package/dist/esm/paths/Restapi/V2/Accounts/Extensions/index.d.ts +0 -2
  156. package/dist/esm/paths/Restapi/V2/Accounts/Extensions/index.js +0 -2
  157. package/package.json +3 -3
  158. package/dist/cjs/definitions/VoicemailOwnerResource.d.ts +0 -14
  159. package/dist/esm/definitions/VoicemailOwnerResource.d.ts +0 -14
  160. /package/dist/cjs/definitions/{VoicemailOwnerResource.js → CallNotesInsightUnit.js} +0 -0
  161. /package/dist/esm/definitions/{VoicemailOwnerResource.js → CallNotesInsightUnit.js} +0 -0
@@ -0,0 +1,58 @@
1
+ interface RSPagingModel {
2
+ /**
3
+ * Current page size, describes how many items are in each page.
4
+ * Matches "perPage" parameter from the request.
5
+ * Required
6
+ * Maximum: 1000
7
+ * Minimum: 1
8
+ * Format: int32
9
+ * Example: 50
10
+ */
11
+ perPage?: number;
12
+ /**
13
+ * The current page number. 1-indexed, so the first page is 1
14
+ * by default. May be omitted if result is empty (because non-existent page
15
+ * was specified or perPage=0 was requested)
16
+ * Required
17
+ * Maximum: 1000
18
+ * Minimum: 1
19
+ * Format: int32
20
+ * Example: 5
21
+ */
22
+ page?: number;
23
+ /**
24
+ * The zero-based number of the first element on the current page.
25
+ * Omitted if the page is omitted or result is empty
26
+ * Required
27
+ * Format: int32
28
+ */
29
+ pageStart?: number;
30
+ /**
31
+ * The zero-based index of the last element on the current page.
32
+ * Omitted if the page is omitted or result is empty
33
+ * Required
34
+ * Format: int32
35
+ * Example: 5
36
+ */
37
+ pageEnd?: number;
38
+ /**
39
+ * The total number of pages in a dataset. May be omitted for
40
+ * some resources due to performance reasons
41
+ * Format: int32
42
+ * Example: 25
43
+ */
44
+ totalPages?: number;
45
+ /**
46
+ * The total number of elements in a dataset. May be omitted for
47
+ * some resource due to performance reasons
48
+ * Required
49
+ * Format: int32
50
+ * Example: 25
51
+ */
52
+ totalElements?: number;
53
+ /**
54
+ * Required
55
+ */
56
+ sortableFields?: string[];
57
+ }
58
+ export default RSPagingModel;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -61,6 +61,11 @@ interface ReadCompanyCallLogParameters {
61
61
  * Internal identifier of a telephony session
62
62
  */
63
63
  telephonySessionId?: string;
64
+ /**
65
+ * Category of metadata to be returned. If omitted, all call records are returned.
66
+ * Multiple values are supported
67
+ */
68
+ metadataCategory?: string[];
64
69
  /**
65
70
  * Indicates the page number to retrieve. Only positive number values are accepted
66
71
  * Minimum: 1
@@ -70,6 +70,11 @@ interface ReadUserCallLogParameters {
70
70
  * Internal identifier of a telephony session
71
71
  */
72
72
  telephonySessionId?: string;
73
+ /**
74
+ * Category of metadata to be returned. If omitted, all call records are returned.
75
+ * Multiple values are supported
76
+ */
77
+ metadataCategory?: string[];
73
78
  /**
74
79
  * Indicates the page number to retrieve. Only positive number values are allowed
75
80
  * Minimum: 1
@@ -6,7 +6,7 @@ interface ReasonInfo {
6
6
  /**
7
7
  * Reason code
8
8
  */
9
- code?: "ServicePlanLimitation" | "AccountLimitation" | "ExtensionTypeLimitation" | "ExtensionLimitation" | "InsufficientPermissions" | "ConfigurationLimitation";
9
+ code?: "ServicePlanLimitation" | "AccountLimitation" | "ExtensionTypeLimitation" | "ExtensionLimitation" | "InsufficientPermissions" | "ConfigurationLimitation" | "PermissionLimitation";
10
10
  /**
11
11
  * Reason description
12
12
  */
@@ -8,29 +8,25 @@ interface SearchDirectoryEntriesParameters {
8
8
  */
9
9
  accessibleSitesOnly?: boolean;
10
10
  /**
11
- * A list of Account IDs
12
- * Example: 400131426008
11
+ * A list of Account IDs. Deprecated, use the appropriate body field 'accountIds' instead.
13
12
  */
14
- accountId?: string;
13
+ accountId?: string[];
15
14
  /**
16
- * A list of department names
15
+ * Department name. Deprecated, use the appropriate body field 'department' instead.
17
16
  * Example: North office
18
17
  */
19
18
  department?: string;
20
19
  /**
21
- * A list of Site IDs
22
- * Example: 872781797006
20
+ * A list of Site IDs. Deprecated, use the appropriate body field 'siteIds' instead.
23
21
  */
24
- siteId?: string;
22
+ siteId?: string[];
25
23
  /**
26
- * Extension current state
27
- * Example: Enabled
24
+ * List of extension current statuses. Deprecated, use the appropriate body field 'extensionStatuses' instead.
28
25
  */
29
- extensionStatus?: string;
26
+ extensionStatus?: string[];
30
27
  /**
31
- * Type of extension to filter the contacts
32
- * Example: User
28
+ * Types of extension to filter the contacts
33
29
  */
34
- extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "ProxyAdmin" | "DelegatedLinesGroup" | "FlexibleUser" | "GroupCallPickup" | "RoomConnector";
30
+ extensionType?: ("User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "ProxyAdmin" | "DelegatedLinesGroup" | "FlexibleUser" | "GroupCallPickup" | "RoomConnector")[];
35
31
  }
36
32
  export default SearchDirectoryEntriesParameters;
@@ -1,6 +1,7 @@
1
1
  interface ShortSiteInfo {
2
2
  /**
3
3
  * Internal identifier of a site extension
4
+ * Example: main-site
4
5
  */
5
6
  id?: string;
6
7
  /**
@@ -0,0 +1,14 @@
1
+ import ApiError from "./ApiError.js";
2
+ interface SmsBrandInfo {
3
+ /**
4
+ * Identifier of the associated TCR brand
5
+ */
6
+ id?: string;
7
+ /**
8
+ * Status of the associated TCR campaign
9
+ */
10
+ status?: "Created" | "Submitted" | "Confirmed" | "SubmitFailed" | "UpdateRequested" | "DeleteRequested" | "CampaignSuspended" | "CampaignExpired" | "Draft" | "PreVetFailed" | "Unconfirmed";
11
+ /** */
12
+ errors?: ApiError[];
13
+ }
14
+ export default SmsBrandInfo;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,22 @@
1
+ import ApiError from "./ApiError.js";
2
+ interface SmsCampaignInfo {
3
+ /**
4
+ * Identifier of the associated TCR campaign
5
+ */
6
+ id?: string;
7
+ /**
8
+ * Status of the associated TCR campaign
9
+ */
10
+ status?: "Created" | "Submitted" | "Confirmed" | "SubmitFailed" | "UpdateRequested" | "DeleteRequested" | "CampaignSuspended" | "CampaignExpired" | "Draft" | "PreVetFailed" | "Unconfirmed";
11
+ /**
12
+ * Use case of the associated TCR campaign
13
+ */
14
+ registrationTier?: string;
15
+ /**
16
+ * List of sub use cases of the associated TCR campaign
17
+ */
18
+ useCases?: string[];
19
+ /** */
20
+ errors?: ApiError[];
21
+ }
22
+ export default SmsCampaignInfo;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,18 @@
1
+ import SmsCampaignInfo from "./SmsCampaignInfo.js";
2
+ import SmsBrandInfo from "./SmsBrandInfo.js";
3
+ interface SmsConfigurationResource {
4
+ /**
5
+ * Internal identifier of a phone number
6
+ */
7
+ phoneNumberId?: string;
8
+ /**
9
+ * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format
10
+ * Example: +18661234567
11
+ */
12
+ phoneNumber?: string;
13
+ /** */
14
+ smsCampaignInfo?: SmsCampaignInfo;
15
+ /** */
16
+ smsBrandInfo?: SmsBrandInfo;
17
+ }
18
+ export default SmsConfigurationResource;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -53,5 +53,10 @@ interface SyncAccountCallLogParameters {
53
53
  * If omitted, then calls with and without recordings are returned
54
54
  */
55
55
  recordingType?: "Automatic" | "OnDemand" | "All";
56
+ /**
57
+ * Category of metadata to be returned. If omitted, all call records are returned.
58
+ * Multiple values are supported
59
+ */
60
+ metadataCategory?: string[];
56
61
  }
57
62
  export default SyncAccountCallLogParameters;
@@ -54,10 +54,21 @@ interface SyncMessagesParameters {
54
54
  */
55
55
  syncType?: "FSync" | "ISync";
56
56
  /**
57
- * Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
57
+ * Deprecated. Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
58
58
  * feature is enabled.
59
59
  * Default: Personal
60
60
  */
61
61
  voicemailOwner?: string[];
62
+ /**
63
+ * Filters shared messages based on the owner extension. Supported if the 'SharedVoicemail' or 'CallQueueSmsRecipient'
64
+ * feature is enabled.
65
+ * Default: Personal
66
+ */
67
+ owner?: string[];
68
+ /**
69
+ * Filters shared messages based on the owner extension type. Supported if "SharedVoicemail" or "CallQueueSmsRecipient"
70
+ * feature is enabled.
71
+ */
72
+ ownerExtensionType?: ("User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser")[];
62
73
  }
63
74
  export default SyncMessagesParameters;
@@ -52,5 +52,10 @@ interface SyncUserCallLogParameters {
52
52
  * If omitted, then calls with and without recordings are returned
53
53
  */
54
54
  recordingType?: "Automatic" | "OnDemand" | "All";
55
+ /**
56
+ * Category of metadata to be returned. If omitted, all call records are returned.
57
+ * Multiple values are supported
58
+ */
59
+ metadataCategory?: string[];
55
60
  }
56
61
  export default SyncUserCallLogParameters;
@@ -54,9 +54,10 @@ interface UserPhoneNumberInfo {
54
54
  */
55
55
  subType?: "VideoPro" | "VideoProPlus" | "DigitalSignage" | "Unknown" | "Emergency";
56
56
  /**
57
- * Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests
57
+ * Usage type of a phone number. Numbers of 'NumberPool' and 'NumberStorage' type are not returned in
58
+ * phone number list requests
58
59
  */
59
- usageType?: "MainCompanyNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "DirectNumber" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "NumberPool" | "BusinessMobileNumber" | "PartnerBusinessMobileNumber" | "IntegrationNumber";
60
+ usageType?: "MainCompanyNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "DirectNumber" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "MeetingsNumber" | "NumberPool" | "NumberStorage" | "BusinessMobileNumber" | "PartnerBusinessMobileNumber" | "IntegrationNumber";
60
61
  /**
61
62
  * List of features of a phone number
62
63
  */
@@ -0,0 +1,18 @@
1
+ import GetSessionInsightsResponse from "../../../../../../../../../definitions/GetSessionInsightsResponse.js";
2
+ import GetSessionInsightsParameters from "../../../../../../../../../definitions/GetSessionInsightsParameters.js";
3
+ import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../../../../../types.js";
4
+ declare class Index {
5
+ rc: RingCentralInterface;
6
+ _parent: ParentInterface;
7
+ constructor(_parent: ParentInterface);
8
+ path(): string;
9
+ /**
10
+ * Returns the insights of all call recordings in a session
11
+ * HTTP Method: get
12
+ * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/sessions/{sourceSessionId}/insights
13
+ * Rate Limit Group: Light
14
+ * App Permission: RingSense
15
+ */
16
+ get(queryParams?: GetSessionInsightsParameters, restRequestConfig?: RestRequestConfig): Promise<GetSessionInsightsResponse>;
17
+ }
18
+ export default Index;
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class Index {
4
+ rc;
5
+ _parent;
6
+ constructor(_parent) {
7
+ this._parent = _parent;
8
+ this.rc = _parent.rc;
9
+ }
10
+ path() {
11
+ return `${this._parent.path()}/insights`;
12
+ }
13
+ /**
14
+ * Returns the insights of all call recordings in a session
15
+ * HTTP Method: get
16
+ * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/sessions/{sourceSessionId}/insights
17
+ * Rate Limit Group: Light
18
+ * App Permission: RingSense
19
+ */
20
+ async get(queryParams, restRequestConfig) {
21
+ const r = await this.rc.get(this.path(), queryParams, restRequestConfig);
22
+ return r.data;
23
+ }
24
+ }
25
+ exports.default = Index;
@@ -0,0 +1,11 @@
1
+ import Insights from "./Insights/index.js";
2
+ import { ParentInterface, RingCentralInterface } from "../../../../../../../../types.js";
3
+ declare class Index {
4
+ rc: RingCentralInterface;
5
+ _parent: ParentInterface;
6
+ sourceSessionId: string | null;
7
+ constructor(_parent: ParentInterface, sourceSessionId?: string | null);
8
+ path(withParameter?: boolean): string;
9
+ insights(): Insights;
10
+ }
11
+ export default Index;
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const index_js_1 = __importDefault(require("./Insights/index.js"));
7
+ class Index {
8
+ rc;
9
+ _parent;
10
+ sourceSessionId;
11
+ constructor(_parent, sourceSessionId = null) {
12
+ this._parent = _parent;
13
+ this.rc = _parent.rc;
14
+ this.sourceSessionId = sourceSessionId;
15
+ }
16
+ path(withParameter = true) {
17
+ if (withParameter && this.sourceSessionId !== null) {
18
+ return `${this._parent.path()}/sessions/${this.sourceSessionId}`;
19
+ }
20
+ return `${this._parent.path()}/sessions`;
21
+ }
22
+ insights() {
23
+ return new index_js_1.default(this);
24
+ }
25
+ }
26
+ exports.default = Index;
@@ -1,3 +1,4 @@
1
+ import Sessions from "./Sessions/index.js";
1
2
  import Records from "./Records/index.js";
2
3
  import { ParentInterface, RingCentralInterface } from "../../../../../../../types.js";
3
4
  declare class Index {
@@ -7,5 +8,6 @@ declare class Index {
7
8
  constructor(_parent: ParentInterface, domain?: string | null);
8
9
  path(withParameter?: boolean): string;
9
10
  records(sourceRecordId?: string | null): Records;
11
+ sessions(sourceSessionId?: string | null): Sessions;
10
12
  }
11
13
  export default Index;
@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- const index_js_1 = __importDefault(require("./Records/index.js"));
6
+ const index_js_1 = __importDefault(require("./Sessions/index.js"));
7
+ const index_js_2 = __importDefault(require("./Records/index.js"));
7
8
  class Index {
8
9
  rc;
9
10
  _parent;
@@ -20,7 +21,10 @@ class Index {
20
21
  return `${this._parent.path()}/domains`;
21
22
  }
22
23
  records(sourceRecordId = null) {
23
- return new index_js_1.default(this, sourceRecordId);
24
+ return new index_js_2.default(this, sourceRecordId);
25
+ }
26
+ sessions(sourceSessionId = null) {
27
+ return new index_js_1.default(this, sourceSessionId);
24
28
  }
25
29
  }
26
30
  exports.default = Index;
@@ -22,6 +22,7 @@ declare class Index {
22
22
  * - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required;
23
23
  * - `InsufficientPermissions` - required permission is not granted to the current user (not the one, who is specified in the URL, but the one who is calling this API);
24
24
  * - `ConfigurationLimitation` - a feature is turned off for extension, e.g., by account administrator.
25
+ * - `PermissionLimitation` - a feature is unavailable due to a specific permission this extension has.
25
26
  *
26
27
  * Also, some features may have additional parameters, e.g. limits, which are returned in `params` attribute as a name-value collection:
27
28
  *
@@ -26,6 +26,7 @@ class Index {
26
26
  * - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required;
27
27
  * - `InsufficientPermissions` - required permission is not granted to the current user (not the one, who is specified in the URL, but the one who is calling this API);
28
28
  * - `ConfigurationLimitation` - a feature is turned off for extension, e.g., by account administrator.
29
+ * - `PermissionLimitation` - a feature is unavailable due to a specific permission this extension has.
29
30
  *
30
31
  * Also, some features may have additional parameters, e.g. limits, which are returned in `params` attribute as a name-value collection:
31
32
  *
@@ -7,9 +7,8 @@ declare class Index {
7
7
  constructor(_parent: ParentInterface);
8
8
  path(): string;
9
9
  /**
10
- * Returns the list of extensions with information on grants
11
- * given to the current extension regarding them. Currently the list of grants
12
- * include: picking up a call, monitoring, calling or receiving a call on behalf
10
+ * Returns a list of extensions including information on grants given to the current extension towards them.
11
+ * Currently the list of grants includes: picking up a call, call monitoring, calling or receiving a call on behalf
13
12
  * of somebody, call delegation and calling paging groups.
14
13
  *
15
14
  * HTTP Method: get
@@ -11,9 +11,8 @@ class Index {
11
11
  return `${this._parent.path()}/grant`;
12
12
  }
13
13
  /**
14
- * Returns the list of extensions with information on grants
15
- * given to the current extension regarding them. Currently the list of grants
16
- * include: picking up a call, monitoring, calling or receiving a call on behalf
14
+ * Returns a list of extensions including information on grants given to the current extension towards them.
15
+ * Currently the list of grants includes: picking up a call, call monitoring, calling or receiving a call on behalf
17
16
  * of somebody, call delegation and calling paging groups.
18
17
  *
19
18
  * HTTP Method: get
@@ -0,0 +1,18 @@
1
+ import SmsConfigurationResource from "../../../../../../definitions/SmsConfigurationResource.js";
2
+ import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../../types.js";
3
+ declare class Index {
4
+ rc: RingCentralInterface;
5
+ _parent: ParentInterface;
6
+ constructor(_parent: ParentInterface);
7
+ path(): string;
8
+ /**
9
+ * Returns SMS configuration for the specified phone number of the extension.
10
+ *
11
+ * HTTP Method: get
12
+ * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number/{phoneNumberId}/sms-configuration
13
+ * Rate Limit Group: Light
14
+ * App Permission: ReadAccounts
15
+ */
16
+ get(restRequestConfig?: RestRequestConfig): Promise<SmsConfigurationResource>;
17
+ }
18
+ export default Index;
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class Index {
4
+ rc;
5
+ _parent;
6
+ constructor(_parent) {
7
+ this._parent = _parent;
8
+ this.rc = _parent.rc;
9
+ }
10
+ path() {
11
+ return `${this._parent.path()}/sms-configuration`;
12
+ }
13
+ /**
14
+ * Returns SMS configuration for the specified phone number of the extension.
15
+ *
16
+ * HTTP Method: get
17
+ * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number/{phoneNumberId}/sms-configuration
18
+ * Rate Limit Group: Light
19
+ * App Permission: ReadAccounts
20
+ */
21
+ async get(restRequestConfig) {
22
+ const r = await this.rc.get(this.path(), undefined, restRequestConfig);
23
+ return r.data;
24
+ }
25
+ }
26
+ exports.default = Index;
@@ -1,3 +1,4 @@
1
+ import SmsConfiguration from "./SmsConfiguration/index.js";
1
2
  import GetExtensionPhoneNumbersResponse from "../../../../../definitions/GetExtensionPhoneNumbersResponse.js";
2
3
  import ListExtensionPhoneNumbersParameters from "../../../../../definitions/ListExtensionPhoneNumbersParameters.js";
3
4
  import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../types.js";
@@ -20,5 +21,6 @@ declare class Index {
20
21
  * User Permission: ReadUserPhoneNumbers
21
22
  */
22
23
  get(queryParams?: ListExtensionPhoneNumbersParameters, restRequestConfig?: RestRequestConfig): Promise<GetExtensionPhoneNumbersResponse>;
24
+ smsConfiguration(): SmsConfiguration;
23
25
  }
24
26
  export default Index;
@@ -1,5 +1,9 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ const index_js_1 = __importDefault(require("./SmsConfiguration/index.js"));
3
7
  class Index {
4
8
  rc;
5
9
  _parent;
@@ -27,5 +31,8 @@ class Index {
27
31
  const r = await this.rc.get(this.path(), queryParams, restRequestConfig);
28
32
  return r.data;
29
33
  }
34
+ smsConfiguration() {
35
+ return new index_js_1.default(this);
36
+ }
30
37
  }
31
38
  exports.default = Index;
@@ -12,8 +12,6 @@ declare class Index {
12
12
  * Deletes user extension(s) and either keeps or destroys the assets - numbers and devices.
13
13
  * Multiple extensions can be deleted with a single API call.
14
14
  *
15
- * **Please note:** This API cannot be tested on Sandbox.
16
- *
17
15
  * HTTP Method: delete
18
16
  * Endpoint: /restapi/v2/accounts/{accountId}/extensions
19
17
  * Rate Limit Group: Heavy
@@ -19,8 +19,6 @@ class Index {
19
19
  * Deletes user extension(s) and either keeps or destroys the assets - numbers and devices.
20
20
  * Multiple extensions can be deleted with a single API call.
21
21
  *
22
- * **Please note:** This API cannot be tested on Sandbox.
23
- *
24
22
  * HTTP Method: delete
25
23
  * Endpoint: /restapi/v2/accounts/{accountId}/extensions
26
24
  * Rate Limit Group: Heavy
package/dist/esm/Rest.js CHANGED
@@ -2,7 +2,7 @@ import axios from "axios";
2
2
  import qs from "qs";
3
3
  import { boundary } from "./FormData.js";
4
4
  import RestException from "./RestException.js";
5
- const version = "1.5.0";
5
+ const version = "1.6.x";
6
6
  export default class Rest {
7
7
  static sandboxServer = "https://platform.devtest.ringcentral.com";
8
8
  static productionServer = "https://platform.ringcentral.com";
@@ -4,6 +4,7 @@ import HighlightsInsightUnit from "./HighlightsInsightUnit.js";
4
4
  import NextStepsInsightUnit from "./NextStepsInsightUnit.js";
5
5
  import BulletedSummaryInsightUnit from "./BulletedSummaryInsightUnit.js";
6
6
  import AIScoreInsightUnit from "./AIScoreInsightUnit.js";
7
+ import CallNotesInsightUnit from "./CallNotesInsightUnit.js";
7
8
  interface AIInsights {
8
9
  /** */
9
10
  Transcript?: TranscriptInsightUnit[];
@@ -17,5 +18,7 @@ interface AIInsights {
17
18
  BulletedSummary?: BulletedSummaryInsightUnit[];
18
19
  /** */
19
20
  AIScore?: AIScoreInsightUnit[];
21
+ /** */
22
+ CallNotes?: CallNotesInsightUnit[];
20
23
  }
21
24
  export default AIInsights;
@@ -1,3 +1,4 @@
1
+ import ErrorEntry from "./ErrorEntry.js";
1
2
  /**
2
3
  * Error response
3
4
  */
@@ -14,5 +15,7 @@ interface ASGErrorResponse {
14
15
  * Example: AccountId 1234 is invalid
15
16
  */
16
17
  message?: string;
18
+ /** */
19
+ errors?: ErrorEntry[];
17
20
  }
18
21
  export default ASGErrorResponse;
@@ -39,7 +39,7 @@ interface AccountHistorySearchPublicRequest {
39
39
  * List of action IDs (exact keys) to search for (alternatively "excludeActionIds" option can be used).
40
40
  * Example: CHANGE_SECRET_INFO,CHANGE_USER_INFO
41
41
  */
42
- actionIds?: ("CHANGE_SECRET_INFO" | "CHANGE_USER_INFO")[];
42
+ actionIds?: string[];
43
43
  /**
44
44
  * The (sub)string to search, applied to the following fields:
45
45
  *
@@ -56,6 +56,6 @@ interface AccountHistorySearchPublicRequest {
56
56
  * List of action IDs (exact keys) to exclude from your search (alternatively "actionIds" option can be used).
57
57
  * Example: CHANGE_SECRET_INFO,CHANGE_USER_INFO
58
58
  */
59
- excludeActionIds?: ("CHANGE_SECRET_INFO" | "CHANGE_USER_INFO")[];
59
+ excludeActionIds?: string[];
60
60
  }
61
61
  export default AccountHistorySearchPublicRequest;
@@ -24,10 +24,10 @@ interface AccountPhoneNumberInfo {
24
24
  */
25
25
  tollType?: "Toll" | "TollFree";
26
26
  /**
27
- * Usage type of phone number
27
+ * Usage type of a phone number
28
28
  * Required
29
29
  */
30
- usageType?: "MainCompanyNumber" | "DirectNumber" | "Inventory" | "InventoryPartnerBusinessMobileNumber" | "PartnerBusinessMobileNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "PhoneLine" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "MeetingsNumber" | "BusinessMobileNumber" | "ELIN";
30
+ usageType?: "MainCompanyNumber" | "DirectNumber" | "Inventory" | "InventoryPartnerBusinessMobileNumber" | "PartnerBusinessMobileNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "PhoneLine" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "MeetingsNumber" | "NumberStorage" | "BusinessMobileNumber" | "ELIN";
31
31
  /** */
32
32
  byocNumber?: boolean;
33
33
  /** */
@@ -8,10 +8,11 @@ interface AggregateA2PSMSStatusesParameters {
8
8
  */
9
9
  batchId?: string;
10
10
  /**
11
- * Direction of the SMS message
11
+ * Direction of a message to filter the message list result.
12
+ * By default, there is no filter applied - both Inbound and Outbound messages are returned
12
13
  * Example: Inbound
13
14
  */
14
- direction?: "Inbound" | "Outbound";
15
+ direction?: ("Inbound" | "Outbound")[];
15
16
  /**
16
17
  * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours
17
18
  * Format: date-time