@rc-ex/core 1.3.13 → 1.3.14

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 (143) hide show
  1. package/lib/definitions/ContactBusinessAddressInfo.d.ts +6 -6
  2. package/lib/definitions/ContactInfo.d.ts +12 -13
  3. package/lib/definitions/CreateFaxMessageRequest.d.ts +2 -1
  4. package/lib/definitions/CreateUserEmergencyLocationRequest.d.ts +4 -0
  5. package/lib/definitions/DepartmentInfo.d.ts +2 -2
  6. package/lib/definitions/DeviceResource.d.ts +5 -5
  7. package/lib/definitions/EmergencyLocationRequestResource.d.ts +42 -0
  8. package/lib/definitions/{ImportIdentityRequest.js → EmergencyLocationRequestResource.js} +1 -1
  9. package/lib/definitions/EmergencyLocationRequestResource.js.map +1 -0
  10. package/lib/definitions/EmergencyLocationResponseResource.d.ts +58 -0
  11. package/lib/definitions/EmergencyLocationResponseResource.js +3 -0
  12. package/lib/definitions/EmergencyLocationResponseResource.js.map +1 -0
  13. package/lib/definitions/ExtensionBulkUpdateInfo.d.ts +2 -0
  14. package/lib/definitions/ExtensionCreationRequest.d.ts +1 -2
  15. package/lib/definitions/ExtensionCreationResponse.d.ts +2 -2
  16. package/lib/definitions/ExtensionUpdateRequest.d.ts +2 -0
  17. package/lib/definitions/GetAccountInfoResponse.d.ts +2 -3
  18. package/lib/definitions/GetExtensionInfoResponse.d.ts +1 -1
  19. package/lib/definitions/GrantInfo.d.ts +4 -0
  20. package/lib/definitions/MessageStoreConfiguration.d.ts +1 -1
  21. package/lib/definitions/PauseResumeCallRecordingParameters.d.ts +1 -1
  22. package/lib/definitions/PronouncedNameInfo.d.ts +5 -6
  23. package/lib/definitions/ReadA2PSMSOptOutsParameters.d.ts +2 -1
  24. package/lib/definitions/ReadCallSessionStatusParameters.d.ts +2 -1
  25. package/lib/definitions/SipRegistrationDeviceInfo.d.ts +4 -7
  26. package/lib/definitions/SyncAccountCallLogParameters.d.ts +4 -1
  27. package/lib/definitions/SyncMessagesParameters.d.ts +1 -1
  28. package/lib/definitions/SyncUserCallLogParameters.d.ts +8 -3
  29. package/lib/definitions/TokenInfo.d.ts +3 -3
  30. package/lib/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.d.ts +1 -1
  31. package/lib/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.js +1 -1
  32. package/lib/paths/Ai/Audio/V1/Async/SpeechToText/index.d.ts +1 -1
  33. package/lib/paths/Ai/Audio/V1/Async/SpeechToText/index.js +1 -1
  34. package/lib/paths/Ai/Text/V1/Async/Punctuate/index.d.ts +1 -1
  35. package/lib/paths/Ai/Text/V1/Async/Punctuate/index.js +1 -1
  36. package/lib/paths/Ai/Text/V1/Async/Summarize/index.d.ts +3 -1
  37. package/lib/paths/Ai/Text/V1/Async/Summarize/index.js +3 -1
  38. package/lib/paths/Ai/Text/V1/Async/Summarize/index.js.map +1 -1
  39. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.d.ts +0 -6
  40. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.js +0 -15
  41. package/lib/paths/Cx/SocialMessaging/V1/Identities/index.js.map +1 -1
  42. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.d.ts +4 -1
  43. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.js +4 -1
  44. package/lib/paths/Restapi/Account/A2pSms/OptOuts/index.js.map +1 -1
  45. package/lib/paths/Restapi/Account/EmergencyLocations/index.d.ts +5 -4
  46. package/lib/paths/Restapi/Account/EmergencyLocations/index.js +4 -4
  47. package/lib/paths/Restapi/Account/EmergencyLocations/index.js.map +1 -1
  48. package/lib/paths/Restapi/Account/Extension/AssignedRole/index.d.ts +1 -1
  49. package/lib/paths/Restapi/Account/Extension/AssignedRole/index.js +1 -1
  50. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.d.ts +4 -3
  51. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.js +2 -2
  52. package/lib/paths/Restapi/Account/Extension/EmergencyLocations/index.js.map +1 -1
  53. package/lib/paths/Restapi/Account/Extension/Features/index.d.ts +6 -6
  54. package/lib/paths/Restapi/Account/Extension/Features/index.js +6 -6
  55. package/lib/paths/Restapi/Account/Extension/MessageStore/index.d.ts +3 -3
  56. package/lib/paths/Restapi/Account/Extension/MessageStore/index.js +3 -3
  57. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.d.ts +0 -1
  58. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.js +0 -1
  59. package/lib/paths/Restapi/Account/Extension/OverflowSettings/index.js.map +1 -1
  60. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.d.ts +6 -1
  61. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.js +6 -1
  62. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.js.map +1 -1
  63. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.d.ts +5 -1
  64. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.js +5 -1
  65. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.js.map +1 -1
  66. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.d.ts +1 -1
  67. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.js +1 -1
  68. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.d.ts +1 -1
  69. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.js +1 -1
  70. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.d.ts +11 -1
  71. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.js +11 -1
  72. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.js.map +1 -1
  73. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.d.ts +1 -1
  74. package/lib/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.js +1 -1
  75. package/lib/paths/Restapi/Account/Telephony/Sessions/Supervise/index.d.ts +1 -1
  76. package/lib/paths/Restapi/Account/Telephony/Sessions/Supervise/index.js +1 -1
  77. package/lib/paths/Webinar/Configuration/V1/Webinars/index.d.ts +1 -1
  78. package/lib/paths/Webinar/Configuration/V1/Webinars/index.js +1 -1
  79. package/lib/paths/Webinar/Notifications/V1/Subscriptions/index.d.ts +1 -1
  80. package/lib/paths/Webinar/Notifications/V1/Subscriptions/index.js +1 -1
  81. package/package.json +2 -2
  82. package/src/definitions/ContactBusinessAddressInfo.ts +6 -6
  83. package/src/definitions/ContactInfo.ts +12 -13
  84. package/src/definitions/CreateFaxMessageRequest.ts +2 -1
  85. package/src/definitions/CreateUserEmergencyLocationRequest.ts +5 -0
  86. package/src/definitions/DepartmentInfo.ts +2 -2
  87. package/src/definitions/DeviceResource.ts +5 -5
  88. package/src/definitions/EmergencyLocationRequestResource.ts +52 -0
  89. package/src/definitions/EmergencyLocationResponseResource.ts +71 -0
  90. package/src/definitions/ExtensionBulkUpdateInfo.ts +2 -0
  91. package/src/definitions/ExtensionCreationRequest.ts +1 -2
  92. package/src/definitions/ExtensionCreationResponse.ts +2 -2
  93. package/src/definitions/ExtensionUpdateRequest.ts +2 -0
  94. package/src/definitions/GetAccountInfoResponse.ts +2 -3
  95. package/src/definitions/GetExtensionInfoResponse.ts +1 -1
  96. package/src/definitions/GrantInfo.ts +5 -0
  97. package/src/definitions/MessageStoreConfiguration.ts +1 -1
  98. package/src/definitions/PauseResumeCallRecordingParameters.ts +1 -1
  99. package/src/definitions/PronouncedNameInfo.ts +5 -6
  100. package/src/definitions/ReadA2PSMSOptOutsParameters.ts +2 -1
  101. package/src/definitions/ReadCallSessionStatusParameters.ts +2 -1
  102. package/src/definitions/SipRegistrationDeviceInfo.ts +4 -7
  103. package/src/definitions/SyncAccountCallLogParameters.ts +4 -1
  104. package/src/definitions/SyncMessagesParameters.ts +1 -1
  105. package/src/definitions/SyncUserCallLogParameters.ts +8 -3
  106. package/src/definitions/TokenInfo.ts +3 -3
  107. package/src/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.ts +1 -1
  108. package/src/paths/Ai/Audio/V1/Async/SpeechToText/index.ts +1 -1
  109. package/src/paths/Ai/Text/V1/Async/Punctuate/index.ts +1 -1
  110. package/src/paths/Ai/Text/V1/Async/Summarize/index.ts +3 -1
  111. package/src/paths/Cx/SocialMessaging/V1/Identities/index.ts +0 -15
  112. package/src/paths/Restapi/Account/A2pSms/OptOuts/index.ts +4 -1
  113. package/src/paths/Restapi/Account/EmergencyLocations/index.ts +11 -10
  114. package/src/paths/Restapi/Account/Extension/AssignedRole/index.ts +1 -1
  115. package/src/paths/Restapi/Account/Extension/EmergencyLocations/index.ts +8 -7
  116. package/src/paths/Restapi/Account/Extension/Features/index.ts +6 -6
  117. package/src/paths/Restapi/Account/Extension/MessageStore/index.ts +3 -3
  118. package/src/paths/Restapi/Account/Extension/OverflowSettings/index.ts +0 -1
  119. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.ts +6 -1
  120. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.ts +5 -1
  121. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.ts +1 -1
  122. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.ts +1 -1
  123. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.ts +11 -1
  124. package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.ts +1 -1
  125. package/src/paths/Restapi/Account/Telephony/Sessions/Supervise/index.ts +1 -1
  126. package/src/paths/Webinar/Configuration/V1/Webinars/index.ts +1 -1
  127. package/src/paths/Webinar/Notifications/V1/Subscriptions/index.ts +1 -1
  128. package/src/samples.md +201 -267
  129. package/lib/definitions/ImportIdentityRequest.d.ts +0 -61
  130. package/lib/definitions/ImportIdentityRequest.js.map +0 -1
  131. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.d.ts +0 -17
  132. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.js +0 -25
  133. package/lib/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.js.map +0 -1
  134. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.d.ts +0 -19
  135. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.js +0 -27
  136. package/lib/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.js.map +0 -1
  137. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.d.ts +0 -20
  138. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.js +0 -27
  139. package/lib/paths/Cx/SocialMessaging/V1/Identities/Import/index.js.map +0 -1
  140. package/src/definitions/ImportIdentityRequest.ts +0 -73
  141. package/src/paths/Cx/SocialMessaging/V1/Identities/Anonymize/index.ts +0 -27
  142. package/src/paths/Cx/SocialMessaging/V1/Identities/Deanonymize/index.ts +0 -29
  143. package/src/paths/Cx/SocialMessaging/V1/Identities/Import/index.ts +0 -33
@@ -1,28 +1,28 @@
1
1
  /**
2
- * Extension user business address. The default is
2
+ * User's business address. The default is
3
3
  * Company (Auto-Receptionist) settings
4
4
  *
5
5
  */
6
6
  interface ContactBusinessAddressInfo {
7
7
  /**
8
- * Country name of an extension user company
8
+ * Country name of a user's company
9
9
  */
10
10
  country?: string;
11
11
  /**
12
- * State/province name of an extension user company. Mandatory
12
+ * State/province name of a user's company. Mandatory
13
13
  * for the USA, UK and Canada
14
14
  */
15
15
  state?: string;
16
16
  /**
17
- * City name of an extension user company
17
+ * City name of a user's company
18
18
  */
19
19
  city?: string;
20
20
  /**
21
- * Street address of an extension user company
21
+ * Street address of a user's company
22
22
  */
23
23
  street?: string;
24
24
  /**
25
- * Zip code of an extension user company
25
+ * Zip code of a user's company
26
26
  */
27
27
  zip?: string;
28
28
  }
@@ -1,42 +1,41 @@
1
1
  import type ContactBusinessAddressInfo from './ContactBusinessAddressInfo';
2
2
  import type PronouncedNameInfo from './PronouncedNameInfo';
3
3
  /**
4
- * Contact detailed information
4
+ * Detailed contact information
5
5
  */
6
6
  interface ContactInfo {
7
7
  /**
8
- * For User extension type only. Extension user first name
8
+ * User's first name (for extensions of `User` type only)
9
9
  */
10
10
  firstName?: string;
11
11
  /**
12
- * For User extension type only. Extension user last name
12
+ * For User extension type only. User's last name (for extensions of `User` type only)
13
13
  */
14
14
  lastName?: string;
15
15
  /**
16
- * Extension user name (first name and last name)
16
+ * Extension name (for extensions of `User` type - concatenation of first and last name)
17
17
  */
18
18
  name?: string;
19
19
  /**
20
- * Extension user company name
20
+ * User's company name
21
21
  */
22
22
  company?: string;
23
23
  /**
24
+ * User's job title
24
25
  */
25
26
  jobTitle?: string;
26
27
  /**
27
- * Contact email of extension user
28
+ * User's contact email
28
29
  * Format: email
29
30
  */
30
31
  email?: string;
31
32
  /**
32
- * Extension user contact phone number in
33
- * [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
33
+ * User's contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
34
34
  * (with '+' sign) format
35
35
  */
36
36
  businessPhone?: string;
37
37
  /**
38
- * Extension user mobile (**non** Toll Free) phone number in
39
- * [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
38
+ * User's mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
40
39
  * (with '+' sign) format
41
40
  */
42
41
  mobilePhone?: string;
@@ -44,15 +43,15 @@ interface ContactInfo {
44
43
  */
45
44
  businessAddress?: ContactBusinessAddressInfo;
46
45
  /**
47
- * If `true` then contact email is enabled as login name for this
48
- * user. Please note that email should be unique in this case.
46
+ * Indicates that the contact email is enabled as a login name for this
47
+ * user. Please note that the email must be unique in this case.
49
48
  */
50
49
  emailAsLoginName?: boolean;
51
50
  /**
52
51
  */
53
52
  pronouncedName?: PronouncedNameInfo;
54
53
  /**
55
- * Extension user department, if any
54
+ * User's department name
56
55
  */
57
56
  department?: string;
58
57
  }
@@ -22,7 +22,8 @@ interface CreateFaxMessageRequest {
22
22
  */
23
23
  sendTime?: string;
24
24
  /**
25
- * ISO Code. e.g UK
25
+ * Alpha-2 ISO Code of a country
26
+ * Example: US
26
27
  */
27
28
  isoCode?: string;
28
29
  /**
@@ -8,6 +8,10 @@ interface CreateUserEmergencyLocationRequest {
8
8
  * Address format ID
9
9
  */
10
10
  addressFormatId?: string;
11
+ /**
12
+ * If 'true' address validation for non-us addresses is skipped
13
+ */
14
+ trusted?: boolean;
11
15
  /**
12
16
  */
13
17
  address?: CommonEmergencyLocationAddressInfo;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Please note that legacy 'Department' extension type corresponds to
2
+ * Please note that the `Department` extension type corresponds to
3
3
  * 'Call Queue' extensions in modern RingCentral product terminology
4
4
  *
5
5
  */
@@ -15,7 +15,7 @@ interface DepartmentInfo {
15
15
  */
16
16
  uri?: string;
17
17
  /**
18
- * Number of a department extension
18
+ * Short number of a department extension
19
19
  */
20
20
  extensionNumber?: string;
21
21
  }
@@ -68,9 +68,9 @@ interface DeviceResource {
68
68
  */
69
69
  shipping?: ShippingInfo;
70
70
  /**
71
- * Box billing identifier of a device. Applicable only for HardPhones.
71
+ * Box billing identifier of a device. Applicable only for devices of `HardPhone` type.
72
72
  * It is an alternative way to identify the device to be ordered. Either
73
- * model structure, or boxBillingId must be specified for HardPhone
73
+ * `model` structure, or `boxBillingId` must be specified
74
74
  * Format: int64
75
75
  */
76
76
  boxBillingId?: number;
@@ -102,9 +102,9 @@ interface DeviceResource {
102
102
  lastLocationReportTime?: string;
103
103
  /**
104
104
  * Pooling type of device:
105
- * - Host - a device with standalone paid phone line which can be linked to a soft client instance
106
- * - Guest - a device with a linked phone line
107
- * - None - a device without a phone line or with specific line (free, BLA, etc.)
105
+ * - `Host` - device with a standalone paid phone line which can be linked to soft phone client instance;
106
+ * - `Guest` - device with a linked phone line;
107
+ * - `None` - device without a phone line or with a specific line (free, BLA, etc.)
108
108
  */
109
109
  linePooling?: 'Host' | 'Guest' | 'None';
110
110
  /**
@@ -0,0 +1,42 @@
1
+ import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
2
+ import type ShortSiteInfo from './ShortSiteInfo';
3
+ interface EmergencyLocationRequestResource {
4
+ /**
5
+ * Internal identifier of an emergency response location
6
+ */
7
+ id?: string;
8
+ /**
9
+ */
10
+ address?: CommonEmergencyLocationAddressInfo;
11
+ /**
12
+ * Emergency response location name
13
+ */
14
+ name?: string;
15
+ /**
16
+ */
17
+ site?: ShortSiteInfo;
18
+ /**
19
+ * Emergency address status
20
+ */
21
+ addressStatus?: 'Valid' | 'Invalid';
22
+ /**
23
+ * Status of an emergency response location usage.
24
+ */
25
+ usageStatus?: 'Active' | 'Inactive';
26
+ /**
27
+ * Address format ID
28
+ */
29
+ addressFormatId?: string;
30
+ /**
31
+ * Visibility of an emergency response location. If `Private`
32
+ * is set, then a location is visible only for restricted number of users,
33
+ * specified in `owners` array
34
+ * Default: Public
35
+ */
36
+ visibility?: 'Public';
37
+ /**
38
+ * If 'true' address validation for non-us addresses is skipped
39
+ */
40
+ trusted?: boolean;
41
+ }
42
+ export default EmergencyLocationRequestResource;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=ImportIdentityRequest.js.map
3
+ //# sourceMappingURL=EmergencyLocationRequestResource.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"EmergencyLocationRequestResource.js","sourceRoot":"","sources":["../../src/definitions/EmergencyLocationRequestResource.ts"],"names":[],"mappings":""}
@@ -0,0 +1,58 @@
1
+ import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
2
+ import type ShortSiteInfo from './ShortSiteInfo';
3
+ import type LocationOwnerInfo from './LocationOwnerInfo';
4
+ /**
5
+ * Company emergency response location details
6
+ */
7
+ interface EmergencyLocationResponseResource {
8
+ /**
9
+ * Internal identifier of an emergency response location
10
+ */
11
+ id?: string;
12
+ /**
13
+ */
14
+ address?: CommonEmergencyLocationAddressInfo;
15
+ /**
16
+ * Emergency response location name
17
+ */
18
+ name?: string;
19
+ /**
20
+ */
21
+ site?: ShortSiteInfo;
22
+ /**
23
+ * Emergency address status
24
+ */
25
+ addressStatus?: 'Valid' | 'Invalid' | 'Provisioning';
26
+ /**
27
+ * Status of emergency response location usage.
28
+ */
29
+ usageStatus?: 'Active' | 'Inactive';
30
+ /**
31
+ * Resulting status of emergency address synchronization. Returned
32
+ * if `syncEmergencyAddress` parameter is set to `true`
33
+ */
34
+ syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'ActivationProcess' | 'NotRequired' | 'Unsupported' | 'Failed';
35
+ /**
36
+ */
37
+ addressType?: 'LocationWithElins' | 'LocationWithEndpoint';
38
+ /**
39
+ * Visibility of an emergency response location. If `Private`
40
+ * is set, then location is visible only for the restricted number of users,
41
+ * specified in `owners` array
42
+ * Default: Public
43
+ */
44
+ visibility?: 'Private' | 'Public';
45
+ /**
46
+ * List of private location owners
47
+ */
48
+ owners?: LocationOwnerInfo[];
49
+ /**
50
+ * Address format ID
51
+ */
52
+ addressFormatId?: string;
53
+ /**
54
+ * If 'true' address validation for non-us addresses is skipped
55
+ */
56
+ trusted?: boolean;
57
+ }
58
+ export default EmergencyLocationResponseResource;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=EmergencyLocationResponseResource.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"EmergencyLocationResponseResource.js","sourceRoot":"","sources":["../../src/definitions/EmergencyLocationResponseResource.ts"],"names":[],"mappings":""}
@@ -37,6 +37,8 @@ interface ExtensionBulkUpdateInfo {
37
37
  */
38
38
  regionalSettings?: ExtensionRegionalSettingRequest;
39
39
  /**
40
+ * Initial configuration wizard state
41
+ * Default: NotStarted
40
42
  */
41
43
  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
42
44
  /**
@@ -40,8 +40,7 @@ interface ExtensionCreationRequest {
40
40
  */
41
41
  ivrPin?: string;
42
42
  /**
43
- * Specifies extension configuration wizard state (web service
44
- * setup).
43
+ * Initial configuration wizard state
45
44
  * Default: NotStarted
46
45
  */
47
46
  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
@@ -69,8 +69,8 @@ interface ExtensionCreationResponse {
69
69
  */
70
70
  serviceFeatures?: ExtensionServiceFeatureInfo[];
71
71
  /**
72
- * Specifies extension configuration wizard state (web service
73
- * setup). The default value is 'NotStarted'
72
+ * Initial configuration wizard state
73
+ * Default: NotStarted
74
74
  */
75
75
  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
76
76
  /**
@@ -24,6 +24,8 @@ interface ExtensionUpdateRequest {
24
24
  */
25
25
  regionalSettings?: ExtensionRegionalSettingRequest;
26
26
  /**
27
+ * Initial configuration wizard state
28
+ * Default: NotStarted
27
29
  */
28
30
  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
29
31
  /**
@@ -35,10 +35,9 @@ interface GetAccountInfoResponse {
35
35
  */
36
36
  serviceInfo?: ServiceInfo;
37
37
  /**
38
- * Specifies account configuration wizard state (web service setup)
39
- * Default: NotStarted
38
+ * Initial configuration wizard state
40
39
  */
41
- setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
40
+ setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed' | 'Unknown';
42
41
  /**
43
42
  */
44
43
  signupInfo?: SignupInfoResource;
@@ -90,7 +90,7 @@ interface GetExtensionInfoResponse {
90
90
  */
91
91
  serviceFeatures?: ExtensionServiceFeatureInfo[];
92
92
  /**
93
- * Specifies extension configuration wizard state (web service setup)
93
+ * Initial configuration wizard state
94
94
  * Default: NotStarted
95
95
  */
96
96
  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
@@ -50,6 +50,10 @@ interface GrantInfo {
50
50
  * in the queue referenced in extension object
51
51
  */
52
52
  callQueueMessages?: boolean;
53
+ /**
54
+ * Specifies whether the current extension is granted *Forward All Calls (FAC)* permission
55
+ */
56
+ callQueueFacSetup?: boolean;
53
57
  /**
54
58
  * Specifies whether the user referenced in extension object is sharing voicemails
55
59
  * with the current extension
@@ -1,7 +1,7 @@
1
1
  interface MessageStoreConfiguration {
2
2
  /**
3
3
  * Retention policy setting, specifying how long to keep messages;
4
- * the supported value range is 7-90 days. Currently the retention period is supported for Fax and Voicemail messages only.
4
+ * the supported value range is 7-90 days. Currently, the retention period is supported for `Fax` and `Voicemail` messages only.
5
5
  * SMS messages are stored with no time limits
6
6
  * Maximum: 90
7
7
  * Minimum: 7
@@ -3,7 +3,7 @@
3
3
  */
4
4
  interface PauseResumeCallRecordingParameters {
5
5
  /**
6
- * Identifies a brand of a logged in user or a brand of a sign-up session
6
+ * Identifies a brand of a logged-in user or a brand of a sign-up session
7
7
  * Default: ~
8
8
  */
9
9
  brandId?: string;
@@ -1,15 +1,14 @@
1
1
  import type PronouncedNamePromptInfo from './PronouncedNamePromptInfo';
2
2
  interface PronouncedNameInfo {
3
3
  /**
4
- * Voice name type. 'Default' - default extension name; first
5
- * name and last name specified in user profile; 'TextToSpeech' - custom
6
- * text; user name spelled the way it sounds and specified by user; 'Recorded'
7
- * - custom audio, user name recorded in user's own voice (supported only
8
- * for extension retrieval)
4
+ * The method used to pronounce the user's name:
5
+ * - `Default` - default extension name; first and last name specified in user's profile are pronounced using text-to-speech;
6
+ * - `TextToSpeech` - custom text specified by a user pronounced using text-to-speech;
7
+ * - `Recorded` - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval).
9
8
  */
10
9
  type?: 'Default' | 'TextToSpeech' | 'Recorded';
11
10
  /**
12
- * Custom text
11
+ * Custom text (for `TextToSpeech` type only)
13
12
  */
14
13
  text?: string;
15
14
  /**
@@ -3,7 +3,8 @@
3
3
  */
4
4
  interface ReadA2PSMSOptOutsParameters {
5
5
  /**
6
- * The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages. The asterisk value "*" means any number in `from` field
6
+ * The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.
7
+ * The asterisk value "*" means any number in `from` field
7
8
  * Example: 15551234455
8
9
  */
9
10
  from?: string;
@@ -7,7 +7,8 @@ interface ReadCallSessionStatusParameters {
7
7
  */
8
8
  timestamp?: string;
9
9
  /**
10
- * The time frame of awaiting for a status change before sending the resulting one in response
10
+ * The time frame of awaiting for a status change before sending
11
+ * the resulting one in response
11
12
  */
12
13
  timeout?: string;
13
14
  }
@@ -64,9 +64,7 @@ interface SipRegistrationDeviceInfo {
64
64
  */
65
65
  phoneLines?: DevicePhoneLinesInfo[];
66
66
  /**
67
- * Box billing identifier of a device. Applicable only for HardPhones.
68
- * It is an alternative way to identify the device to be ordered. Either
69
- * model structure, or boxBillingId must be specified forT?HardPhone
67
+ * Box billing identifier of a device. Applicable only for devices of `HardPhone` type.
70
68
  * Format: int64
71
69
  */
72
70
  boxBillingId?: number;
@@ -76,10 +74,9 @@ interface SipRegistrationDeviceInfo {
76
74
  useAsCommonPhone?: boolean;
77
75
  /**
78
76
  * Pooling type of device:
79
- * - `Host` - device with standalone paid
80
- * phone line which can be linked to soft phone client instance
81
- * - `Guest` - device with a linked phone line
82
- * - `None` - device without a phone line or with specific line (free, BLA, etc.)
77
+ * - `Host` - device with a standalone paid phone line which can be linked to soft phone client instance;
78
+ * - `Guest` - device with a linked phone line;
79
+ * - `None` - device without a phone line or with a specific line (free, BLA, etc.)
83
80
  */
84
81
  linePooling?: 'Host' | 'Guest' | 'None';
85
82
  /**
@@ -17,7 +17,10 @@ interface SyncAccountCallLogParameters {
17
17
  */
18
18
  dateFrom?: string;
19
19
  /**
20
- * For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync frame to the past, the maximum number of records is 250
20
+ * For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.
21
+ *
22
+ * For `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past
23
+ * (the maximum number of records is 250)
21
24
  * Minimum: 1
22
25
  * Format: int32
23
26
  */
@@ -44,7 +44,7 @@ interface SyncMessagesParameters {
44
44
  */
45
45
  recordCount?: number;
46
46
  /**
47
- * Value of syncToken property of last sync request response
47
+ * A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
48
48
  */
49
49
  syncToken?: string;
50
50
  /**
@@ -8,16 +8,21 @@ interface SyncUserCallLogParameters {
8
8
  */
9
9
  syncType?: 'FSync' | 'ISync';
10
10
  /**
11
- * Value of syncToken property of last sync request response. Mandatory parameter for 'ISync' sync type
11
+ * A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
12
12
  */
13
13
  syncToken?: string;
14
14
  /**
15
- * The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment
15
+ * The start datetime for resulting records in ISO 8601 format including
16
+ * timezone, for example 2016-03-10T18:07:52.534Z. The default value is the
17
+ * current moment
16
18
  * Format: date-time
17
19
  */
18
20
  dateFrom?: string;
19
21
  /**
20
- * For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250
22
+ * For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.
23
+ *
24
+ * For `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past
25
+ * (the maximum number of records is 250)
21
26
  * Format: int32
22
27
  */
23
28
  recordCount?: number;
@@ -46,7 +46,7 @@ interface TokenInfo {
46
46
  */
47
47
  endpoint_id?: string;
48
48
  /**
49
- * OIDC ID token (if OpenId Connect flow was activated during authorization)
49
+ * OIDC ID token (if OpenID Connect flow was activated during authorization)
50
50
  */
51
51
  id_token?: string;
52
52
  /**
@@ -54,12 +54,12 @@ interface TokenInfo {
54
54
  */
55
55
  session_id?: string;
56
56
  /**
57
- * Absolute value of session expiration time as ISO datetime
57
+ * Absolute value of session expiration time as an ISO timestamp
58
58
  * Format: date-time
59
59
  */
60
60
  session_expiration_time?: string;
61
61
  /**
62
- * Remaining time (in seconds) until session expiration due to absolute timeout
62
+ * Remaining time (in seconds) until session expiration due to the absolute timeout
63
63
  * Format: int32
64
64
  */
65
65
  session_expires_in?: number;
@@ -8,7 +8,7 @@ declare class Index {
8
8
  constructor(_parent: ParentInterface);
9
9
  path(): string;
10
10
  /**
11
- * Returns Speaker Identification to the provided webhook uri.
11
+ * Returns Speaker Identification to the provided webhook URI.
12
12
  * HTTP Method: post
13
13
  * Endpoint: /ai/audio/v1/async/speaker-identify
14
14
  * Rate Limit Group: Heavy
@@ -9,7 +9,7 @@ class Index {
9
9
  return `${this._parent.path()}/speaker-identify`;
10
10
  }
11
11
  /**
12
- * Returns Speaker Identification to the provided webhook uri.
12
+ * Returns Speaker Identification to the provided webhook URI.
13
13
  * HTTP Method: post
14
14
  * Endpoint: /ai/audio/v1/async/speaker-identify
15
15
  * Rate Limit Group: Heavy
@@ -8,7 +8,7 @@ declare class Index {
8
8
  constructor(_parent: ParentInterface);
9
9
  path(): string;
10
10
  /**
11
- * Returns Speech to Text Conversion to the provided webhook uri.
11
+ * Returns Speech to Text Conversion to the provided webhook URI.
12
12
  * HTTP Method: post
13
13
  * Endpoint: /ai/audio/v1/async/speech-to-text
14
14
  * Rate Limit Group: Heavy
@@ -9,7 +9,7 @@ class Index {
9
9
  return `${this._parent.path()}/speech-to-text`;
10
10
  }
11
11
  /**
12
- * Returns Speech to Text Conversion to the provided webhook uri.
12
+ * Returns Speech to Text Conversion to the provided webhook URI.
13
13
  * HTTP Method: post
14
14
  * Endpoint: /ai/audio/v1/async/speech-to-text
15
15
  * Rate Limit Group: Heavy
@@ -8,7 +8,7 @@ declare class Index {
8
8
  constructor(_parent: ParentInterface);
9
9
  path(): string;
10
10
  /**
11
- * Returns Smart Punctuation to the provided webhook uri.
11
+ * Returns Smart Punctuation to the provided webhook URI.
12
12
  * HTTP Method: post
13
13
  * Endpoint: /ai/text/v1/async/punctuate
14
14
  * Rate Limit Group: Heavy
@@ -9,7 +9,7 @@ class Index {
9
9
  return `${this._parent.path()}/punctuate`;
10
10
  }
11
11
  /**
12
- * Returns Smart Punctuation to the provided webhook uri.
12
+ * Returns Smart Punctuation to the provided webhook URI.
13
13
  * HTTP Method: post
14
14
  * Endpoint: /ai/text/v1/async/punctuate
15
15
  * Rate Limit Group: Heavy
@@ -8,7 +8,9 @@ declare class Index {
8
8
  constructor(_parent: ParentInterface);
9
9
  path(): string;
10
10
  /**
11
- * Returns Conversational Summarization to webhook uri for segmented transcript of audios with start,end,speakerId, text(alphanumeric and punctuations).
11
+ * Returns Conversational Summarization to the webhook URI for segmented transcript of audios
12
+ * with start, end, speakerId, text(alphanumeric and punctuations).
13
+ *
12
14
  * HTTP Method: post
13
15
  * Endpoint: /ai/text/v1/async/summarize
14
16
  * Rate Limit Group: Heavy
@@ -9,7 +9,9 @@ class Index {
9
9
  return `${this._parent.path()}/summarize`;
10
10
  }
11
11
  /**
12
- * Returns Conversational Summarization to webhook uri for segmented transcript of audios with start,end,speakerId, text(alphanumeric and punctuations).
12
+ * Returns Conversational Summarization to the webhook URI for segmented transcript of audios
13
+ * with start, end, speakerId, text(alphanumeric and punctuations).
14
+ *
13
15
  * HTTP Method: post
14
16
  * Endpoint: /ai/text/v1/async/summarize
15
17
  * Rate Limit Group: Heavy
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/paths/Ai/Text/V1/Async/Summarize/index.ts"],"names":[],"mappings":";;AAKA,MAAM,KAAK;IAIT,YAAmB,OAAwB;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IACvB,CAAC;IACM,IAAI;QACT,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5C,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CACf,YAA0B,EAC1B,WAAoC,EACpC,iBAAqC;QAErC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAsB,IAAI,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC7G,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC;CACF;AACD,kBAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/paths/Ai/Text/V1/Async/Summarize/index.ts"],"names":[],"mappings":";;AAKA,MAAM,KAAK;IAIT,YAAmB,OAAwB;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IACvB,CAAC;IACM,IAAI;QACT,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5C,CAAC;IACD;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,CACf,YAA0B,EAC1B,WAAoC,EACpC,iBAAqC;QAErC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAsB,IAAI,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC7G,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC;CACF;AACD,kBAAe,KAAK,CAAC"}