@rc-ex/core 1.3.10 → 1.3.11
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.
- package/lib/definitions/AccountPhoneNumberInfo.d.ts +3 -0
- package/lib/definitions/CompanyPhoneNumberInfo.d.ts +1 -1
- package/lib/definitions/ContentModel.d.ts +1 -1
- package/lib/definitions/ConversationalInsightsUnitValues.d.ts +1 -1
- package/lib/definitions/CreateContentRequest.d.ts +1 -1
- package/lib/definitions/IdentityModel.d.ts +1 -1
- package/lib/definitions/ListAccountPhoneNumbersParameters.d.ts +5 -0
- package/lib/definitions/ListAccountPhoneNumbersV2Parameters.d.ts +4 -0
- package/lib/definitions/MessageChanges.d.ts +4 -0
- package/lib/definitions/RegSessionModelSettings.d.ts +5 -0
- package/lib/definitions/SocMsgListIdentitiesParameters.d.ts +2 -2
- package/lib/definitions/SubscriptionInfo.d.ts +1 -1
- package/lib/definitions/TMCreateEventRequest.d.ts +7 -7
- package/lib/definitions/TMCreateTaskRequestRecurrence.d.ts +2 -2
- package/lib/definitions/TMEventInfo.d.ts +7 -6
- package/lib/definitions/TMMessageAttachmentInfo.d.ts +7 -6
- package/lib/definitions/TMTaskInfo.d.ts +1 -1
- package/lib/definitions/TMTaskInfoRecurrence.d.ts +1 -1
- package/lib/definitions/TMUpdateTaskRequestRecurrence.d.ts +2 -2
- package/lib/definitions/UserPhoneNumberInfo.d.ts +1 -1
- package/lib/definitions/VoicemailMessageEventBody.d.ts +5 -7
- package/lib/paths/Restapi/Account/CallRecordings/index.d.ts +3 -1
- package/lib/paths/Restapi/Account/CallRecordings/index.js +3 -1
- package/lib/paths/Restapi/Account/CallRecordings/index.js.map +1 -1
- package/lib/paths/Restapi/Account/EmergencyLocations/index.d.ts +1 -1
- package/lib/paths/Restapi/Account/EmergencyLocations/index.js +1 -1
- package/package.json +2 -2
- package/src/definitions/AccountPhoneNumberInfo.ts +4 -0
- package/src/definitions/CompanyPhoneNumberInfo.ts +7 -1
- package/src/definitions/ContentModel.ts +1 -1
- package/src/definitions/ConversationalInsightsUnitValues.ts +1 -1
- package/src/definitions/CreateContentRequest.ts +1 -1
- package/src/definitions/IdentityModel.ts +1 -1
- package/src/definitions/ListAccountPhoneNumbersParameters.ts +12 -0
- package/src/definitions/ListAccountPhoneNumbersV2Parameters.ts +5 -0
- package/src/definitions/MessageChanges.ts +5 -0
- package/src/definitions/RegSessionModelSettings.ts +6 -0
- package/src/definitions/SocMsgListIdentitiesParameters.ts +2 -2
- package/src/definitions/SubscriptionInfo.ts +1 -1
- package/src/definitions/TMCreateEventRequest.ts +7 -7
- package/src/definitions/TMCreateTaskRequestRecurrence.ts +2 -2
- package/src/definitions/TMEventInfo.ts +7 -6
- package/src/definitions/TMMessageAttachmentInfo.ts +7 -6
- package/src/definitions/TMTaskInfo.ts +1 -1
- package/src/definitions/TMTaskInfoRecurrence.ts +1 -1
- package/src/definitions/TMUpdateTaskRequestRecurrence.ts +2 -2
- package/src/definitions/UserPhoneNumberInfo.ts +7 -1
- package/src/definitions/VoicemailMessageEventBody.ts +12 -8
- package/src/paths/Restapi/Account/CallRecordings/index.ts +3 -1
- package/src/paths/Restapi/Account/EmergencyLocations/index.ts +1 -1
- package/src/samples.md +2 -2
|
@@ -27,6 +27,9 @@ interface AccountPhoneNumberInfo {
|
|
|
27
27
|
* Required
|
|
28
28
|
*/
|
|
29
29
|
usageType?: 'MainCompanyNumber' | 'DirectNumber' | 'Inventory' | 'InventoryPartnerBusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'PhoneLine' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'BusinessMobileNumber' | 'ELIN';
|
|
30
|
+
/**
|
|
31
|
+
*/
|
|
32
|
+
byocNumber?: boolean;
|
|
30
33
|
/**
|
|
31
34
|
* Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
|
|
32
35
|
* Required
|
|
@@ -31,7 +31,7 @@ interface CompanyPhoneNumberInfo {
|
|
|
31
31
|
* Payment type. 'External' is returned for forwarded numbers
|
|
32
32
|
* which are not terminated in the RingCentral phone system
|
|
33
33
|
*/
|
|
34
|
-
paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider';
|
|
34
|
+
paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree';
|
|
35
35
|
/**
|
|
36
36
|
* Phone number
|
|
37
37
|
*/
|
|
@@ -32,7 +32,7 @@ interface ContentModel {
|
|
|
32
32
|
* Channel and max length
|
|
33
33
|
* * Apple Messages For Business (max length 10000)
|
|
34
34
|
* * Email (max length 262144)
|
|
35
|
-
* *
|
|
35
|
+
* * RingCX Digital Messaging (max length 1024)
|
|
36
36
|
* * Facebook (max length 8000)
|
|
37
37
|
* * GoogleBusinessMessages (max length 3000)
|
|
38
38
|
* * Google My Business (max length 4000)
|
|
@@ -16,7 +16,7 @@ interface CreateContentRequest {
|
|
|
16
16
|
* Channel and max length
|
|
17
17
|
* * Apple Messages For Business (max length 10000)
|
|
18
18
|
* * Email (max length 262144)
|
|
19
|
-
* *
|
|
19
|
+
* * RingCX Digital Messaging (max length 1024)
|
|
20
20
|
* * Facebook (max length 8000)
|
|
21
21
|
* * GoogleBusinessMessages (max length 3000)
|
|
22
22
|
* * Google My Business (max length 4000)
|
|
@@ -100,7 +100,7 @@ interface IdentityModel {
|
|
|
100
100
|
/**
|
|
101
101
|
* Device info of the identity.
|
|
102
102
|
*
|
|
103
|
-
* Applicable to
|
|
103
|
+
* Applicable to RingCX Digital Messaging channels only.
|
|
104
104
|
* Example: iPhone (iPhone); iOS 15.0.2
|
|
105
105
|
*/
|
|
106
106
|
mobileDeviceInfo?: string;
|
|
@@ -19,6 +19,11 @@ interface ListAccountPhoneNumbersParameters {
|
|
|
19
19
|
* Usage type of phone number
|
|
20
20
|
*/
|
|
21
21
|
usageType?: ('MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber')[];
|
|
22
|
+
/**
|
|
23
|
+
* Payment type. 'External' is returned for forwarded numbers
|
|
24
|
+
* which are not terminated in the RingCentral phone system
|
|
25
|
+
*/
|
|
26
|
+
paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree';
|
|
22
27
|
/**
|
|
23
28
|
* Status of a phone number
|
|
24
29
|
*/
|
|
@@ -42,6 +42,10 @@ interface ListAccountPhoneNumbersV2Parameters {
|
|
|
42
42
|
* Extension status
|
|
43
43
|
*/
|
|
44
44
|
extensionStatus?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
|
|
45
|
+
/**
|
|
46
|
+
* The parameter reflects whether this number is BYOC or not
|
|
47
|
+
*/
|
|
48
|
+
byocNumber?: boolean;
|
|
45
49
|
/**
|
|
46
50
|
* Phone number in e.164 format to be searched for.
|
|
47
51
|
* Parameter value can include wildcards (e.g. "+165012345**")
|
|
@@ -21,5 +21,10 @@ interface RegSessionModelSettings {
|
|
|
21
21
|
* Indicates that work email address is required for registration.
|
|
22
22
|
*/
|
|
23
23
|
workEmailRequired?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Indicates that recording will be shown after the webinar and in emails.
|
|
26
|
+
* Default: true
|
|
27
|
+
*/
|
|
28
|
+
viewRecording?: boolean;
|
|
24
29
|
}
|
|
25
30
|
export default RegSessionModelSettings;
|
|
@@ -7,9 +7,9 @@ interface SocMsgListIdentitiesParameters {
|
|
|
7
7
|
*/
|
|
8
8
|
sourceId?: string;
|
|
9
9
|
/**
|
|
10
|
-
* Filter based on the specified
|
|
10
|
+
* Filter based on the specified identityGroupIds (separated by commas).
|
|
11
11
|
*/
|
|
12
|
-
|
|
12
|
+
identityGroupIds?: string[];
|
|
13
13
|
/**
|
|
14
14
|
* Filter based on the specified userId.
|
|
15
15
|
*/
|
|
@@ -41,7 +41,7 @@ interface SubscriptionInfo {
|
|
|
41
41
|
* Subscription status
|
|
42
42
|
* Required
|
|
43
43
|
*/
|
|
44
|
-
status?: 'Active' | '
|
|
44
|
+
status?: 'Active' | 'Blacklisted';
|
|
45
45
|
/**
|
|
46
46
|
* Subscription creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
47
47
|
* format including timezone, for example *2016-03-10T18:07:52.534*
|
|
@@ -35,20 +35,20 @@ interface TMCreateEventRequest {
|
|
|
35
35
|
*/
|
|
36
36
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
37
37
|
/**
|
|
38
|
-
* Condition of ending
|
|
38
|
+
* Condition of ending an event
|
|
39
39
|
*/
|
|
40
|
-
endingCondition?:
|
|
40
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
41
41
|
/**
|
|
42
|
-
* Count of iterations. For periodic events only. Value range
|
|
43
|
-
*
|
|
42
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
43
|
+
* Must be specified if `endingCondition` is `Count`
|
|
44
44
|
* Format: int32
|
|
45
45
|
*/
|
|
46
46
|
endingAfter?: number;
|
|
47
47
|
/**
|
|
48
|
-
* Iterations
|
|
49
|
-
*
|
|
48
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
49
|
+
* Format: date-time
|
|
50
50
|
*/
|
|
51
|
-
endingOn?:
|
|
51
|
+
endingOn?: string;
|
|
52
52
|
/**
|
|
53
53
|
* Color of Event title (including its presentation in Calendar)
|
|
54
54
|
* Default: Black
|
|
@@ -10,14 +10,14 @@ interface TMCreateTaskRequestRecurrence {
|
|
|
10
10
|
*/
|
|
11
11
|
endingCondition?: 'None' | 'Count' | 'Date';
|
|
12
12
|
/**
|
|
13
|
-
* Count of iterations of periodic tasks
|
|
13
|
+
* Count of iterations of periodic tasks
|
|
14
14
|
* Maximum: 10
|
|
15
15
|
* Minimum: 1
|
|
16
16
|
* Format: int32
|
|
17
17
|
*/
|
|
18
18
|
endingAfter?: number;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* End date of a periodic task in UTC time zone
|
|
21
21
|
* Format: date-time
|
|
22
22
|
*/
|
|
23
23
|
endingOn?: string;
|
|
@@ -30,19 +30,20 @@ interface TMEventInfo {
|
|
|
30
30
|
*/
|
|
31
31
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
32
32
|
/**
|
|
33
|
-
* Condition of ending
|
|
33
|
+
* Condition of ending an event
|
|
34
34
|
*/
|
|
35
|
-
endingCondition?:
|
|
35
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
36
36
|
/**
|
|
37
|
-
* Count of iterations. For periodic events only
|
|
37
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
38
|
+
* Must be specified if `endingCondition` is `Count`
|
|
38
39
|
* Format: int32
|
|
39
40
|
*/
|
|
40
41
|
endingAfter?: number;
|
|
41
42
|
/**
|
|
42
|
-
* Iterations
|
|
43
|
-
*
|
|
43
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
44
|
+
* Format: date-time
|
|
44
45
|
*/
|
|
45
|
-
endingOn?:
|
|
46
|
+
endingOn?: string;
|
|
46
47
|
/**
|
|
47
48
|
* Color of Event title (including its presentation in Calendar)
|
|
48
49
|
* Default: Black
|
|
@@ -70,19 +70,20 @@ interface TMMessageAttachmentInfo {
|
|
|
70
70
|
*/
|
|
71
71
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
72
72
|
/**
|
|
73
|
-
* Condition of ending
|
|
73
|
+
* Condition of ending an event
|
|
74
74
|
*/
|
|
75
|
-
endingCondition?:
|
|
75
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
76
76
|
/**
|
|
77
|
-
* Count of iterations. For periodic events only
|
|
77
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
78
|
+
* Must be specified if `endingCondition` is `Count`
|
|
78
79
|
* Format: int32
|
|
79
80
|
*/
|
|
80
81
|
endingAfter?: number;
|
|
81
82
|
/**
|
|
82
|
-
* Iterations
|
|
83
|
-
*
|
|
83
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
84
|
+
* Format: date-time
|
|
84
85
|
*/
|
|
85
|
-
endingOn?:
|
|
86
|
+
endingOn?: string;
|
|
86
87
|
/**
|
|
87
88
|
* Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card
|
|
88
89
|
* Default: Black
|
|
@@ -5,7 +5,7 @@ interface TMUpdateTaskRequestRecurrence {
|
|
|
5
5
|
*/
|
|
6
6
|
schedule?: 'None' | 'Daily' | 'Weekdays' | 'Weekly' | 'Monthly' | 'Yearly';
|
|
7
7
|
/**
|
|
8
|
-
* Task ending condition
|
|
8
|
+
* Task ending condition
|
|
9
9
|
*/
|
|
10
10
|
endingCondition?: 'None' | 'Count' | 'Date';
|
|
11
11
|
/**
|
|
@@ -16,7 +16,7 @@ interface TMUpdateTaskRequestRecurrence {
|
|
|
16
16
|
*/
|
|
17
17
|
endingAfter?: number;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* End date of a periodic task in UTC time zone
|
|
20
20
|
* Format: date-time
|
|
21
21
|
*/
|
|
22
22
|
endingOn?: string;
|
|
@@ -33,7 +33,7 @@ interface UserPhoneNumberInfo {
|
|
|
33
33
|
* Payment type. 'External' is returned for forwarded numbers
|
|
34
34
|
* which are not terminated in the RingCentral phone system
|
|
35
35
|
*/
|
|
36
|
-
paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider';
|
|
36
|
+
paymentType?: 'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree';
|
|
37
37
|
/**
|
|
38
38
|
* Phone number
|
|
39
39
|
*/
|
|
@@ -7,8 +7,9 @@ import type MessageAttachmentInfo from './MessageAttachmentInfo';
|
|
|
7
7
|
interface VoicemailMessageEventBody {
|
|
8
8
|
/**
|
|
9
9
|
* Internal identifier of a message
|
|
10
|
+
* Format: int64
|
|
10
11
|
*/
|
|
11
|
-
id?:
|
|
12
|
+
id?: number;
|
|
12
13
|
/**
|
|
13
14
|
* Message receiver(s) information
|
|
14
15
|
*/
|
|
@@ -71,12 +72,9 @@ interface VoicemailMessageEventBody {
|
|
|
71
72
|
*/
|
|
72
73
|
messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
|
|
73
74
|
/**
|
|
74
|
-
*
|
|
75
|
+
* Status of a voicemail to text transcription. Specifies if a voicemail message transcription is already completed or not
|
|
76
|
+
* If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned
|
|
75
77
|
*/
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* Specifies if a voicemail message transcription is already completed or not
|
|
79
|
-
*/
|
|
80
|
-
vmTranscriptionStatus?: string;
|
|
78
|
+
vmTranscriptionStatus?: 'NotAvailable' | 'InProgress' | 'TimedOut' | 'Completed' | 'CompletedPartially' | 'Failed' | 'Unknown';
|
|
81
79
|
}
|
|
82
80
|
export default VoicemailMessageEventBody;
|
|
@@ -6,7 +6,9 @@ declare class Index {
|
|
|
6
6
|
constructor(_parent: ParentInterface);
|
|
7
7
|
path(): string;
|
|
8
8
|
/**
|
|
9
|
-
* Deletes company call recordings by their IDs.
|
|
9
|
+
* Deletes company call recordings by their IDs. *Please note:* This method deletes the recording file itself,
|
|
10
|
+
* not the record of it in the call log.
|
|
11
|
+
*
|
|
10
12
|
* HTTP Method: delete
|
|
11
13
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/call-recordings
|
|
12
14
|
* Rate Limit Group: Heavy
|
|
@@ -9,7 +9,9 @@ class Index {
|
|
|
9
9
|
return `${this._parent.path()}/call-recordings`;
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* Deletes company call recordings by their IDs.
|
|
12
|
+
* Deletes company call recordings by their IDs. *Please note:* This method deletes the recording file itself,
|
|
13
|
+
* not the record of it in the call log.
|
|
14
|
+
*
|
|
13
15
|
* HTTP Method: delete
|
|
14
16
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/call-recordings
|
|
15
17
|
* Rate Limit Group: Heavy
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/paths/Restapi/Account/CallRecordings/index.ts"],"names":[],"mappings":";;AAGA,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,kBAAkB,CAAC;IAClD,CAAC;IACD
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/paths/Restapi/Account/CallRecordings/index.ts"],"names":[],"mappings":";;AAGA,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,kBAAkB,CAAC;IAClD,CAAC;IACD;;;;;;;;;OASG;IACI,KAAK,CAAC,MAAM,CAAC,gBAAkC,EAAE,iBAAqC;QAC3F,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAS,IAAI,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACpG,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC;CACF;AACD,kBAAe,KAAK,CAAC"}
|
|
@@ -30,7 +30,7 @@ declare class Index {
|
|
|
30
30
|
*/
|
|
31
31
|
post(emergencyLocationInfoRequest: EmergencyLocationInfoRequest, restRequestConfig?: RestRequestConfig): Promise<CommonEmergencyLocationResource>;
|
|
32
32
|
/**
|
|
33
|
-
* Returns emergency response location by ID.
|
|
33
|
+
* Returns emergency response location by ID. Available for Admin users only.
|
|
34
34
|
* HTTP Method: get
|
|
35
35
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}
|
|
36
36
|
* Rate Limit Group: Light
|
|
@@ -37,7 +37,7 @@ class Index {
|
|
|
37
37
|
return r.data;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
|
-
* Returns emergency response location by ID.
|
|
40
|
+
* Returns emergency response location by ID. Available for Admin users only.
|
|
41
41
|
* HTTP Method: get
|
|
42
42
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}
|
|
43
43
|
* Rate Limit Group: Light
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rc-ex/core",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.11",
|
|
4
4
|
"description": "Core for ringcentral-extensible project",
|
|
5
5
|
"author": "Tyler Liu <tyler.liu@ringcentral.com>",
|
|
6
6
|
"homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/core",
|
|
@@ -30,5 +30,5 @@
|
|
|
30
30
|
"scripts": {
|
|
31
31
|
"generate": "ts-node -r dotenv-override-true/config code-generator.ts"
|
|
32
32
|
},
|
|
33
|
-
"gitHead": "
|
|
33
|
+
"gitHead": "f9211324d6aba9b4194af5050cea8619cb986e47"
|
|
34
34
|
}
|
|
@@ -49,6 +49,10 @@ interface AccountPhoneNumberInfo {
|
|
|
49
49
|
| 'BusinessMobileNumber'
|
|
50
50
|
| 'ELIN';
|
|
51
51
|
|
|
52
|
+
/**
|
|
53
|
+
*/
|
|
54
|
+
byocNumber?: boolean;
|
|
55
|
+
|
|
52
56
|
/**
|
|
53
57
|
* Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
|
|
54
58
|
* Required
|
|
@@ -38,7 +38,13 @@ interface CompanyPhoneNumberInfo {
|
|
|
38
38
|
* Payment type. 'External' is returned for forwarded numbers
|
|
39
39
|
* which are not terminated in the RingCentral phone system
|
|
40
40
|
*/
|
|
41
|
-
paymentType?:
|
|
41
|
+
paymentType?:
|
|
42
|
+
| 'External'
|
|
43
|
+
| 'TollFree'
|
|
44
|
+
| 'Local'
|
|
45
|
+
| 'BusinessMobileNumberProvider'
|
|
46
|
+
| 'ExternalNumberProvider'
|
|
47
|
+
| 'ExternalNumberProviderTollFree';
|
|
42
48
|
|
|
43
49
|
/**
|
|
44
50
|
* Phone number
|
|
@@ -36,7 +36,7 @@ interface ContentModel {
|
|
|
36
36
|
* Channel and max length
|
|
37
37
|
* * Apple Messages For Business (max length 10000)
|
|
38
38
|
* * Email (max length 262144)
|
|
39
|
-
* *
|
|
39
|
+
* * RingCX Digital Messaging (max length 1024)
|
|
40
40
|
* * Facebook (max length 8000)
|
|
41
41
|
* * GoogleBusinessMessages (max length 3000)
|
|
42
42
|
* * Google My Business (max length 4000)
|
|
@@ -18,7 +18,7 @@ interface CreateContentRequest {
|
|
|
18
18
|
* Channel and max length
|
|
19
19
|
* * Apple Messages For Business (max length 10000)
|
|
20
20
|
* * Email (max length 262144)
|
|
21
|
-
* *
|
|
21
|
+
* * RingCX Digital Messaging (max length 1024)
|
|
22
22
|
* * Facebook (max length 8000)
|
|
23
23
|
* * GoogleBusinessMessages (max length 3000)
|
|
24
24
|
* * Google My Business (max length 4000)
|
|
@@ -131,7 +131,7 @@ interface IdentityModel {
|
|
|
131
131
|
/**
|
|
132
132
|
* Device info of the identity.
|
|
133
133
|
*
|
|
134
|
-
* Applicable to
|
|
134
|
+
* Applicable to RingCX Digital Messaging channels only.
|
|
135
135
|
* Example: iPhone (iPhone); iOS 15.0.2
|
|
136
136
|
*/
|
|
137
137
|
mobileDeviceInfo?: string;
|
|
@@ -36,6 +36,18 @@ interface ListAccountPhoneNumbersParameters {
|
|
|
36
36
|
| 'IntegrationNumber'
|
|
37
37
|
)[];
|
|
38
38
|
|
|
39
|
+
/**
|
|
40
|
+
* Payment type. 'External' is returned for forwarded numbers
|
|
41
|
+
* which are not terminated in the RingCentral phone system
|
|
42
|
+
*/
|
|
43
|
+
paymentType?:
|
|
44
|
+
| 'External'
|
|
45
|
+
| 'TollFree'
|
|
46
|
+
| 'Local'
|
|
47
|
+
| 'BusinessMobileNumberProvider'
|
|
48
|
+
| 'ExternalNumberProvider'
|
|
49
|
+
| 'ExternalNumberProviderTollFree';
|
|
50
|
+
|
|
39
51
|
/**
|
|
40
52
|
* Status of a phone number
|
|
41
53
|
*/
|
|
@@ -66,6 +66,11 @@ interface ListAccountPhoneNumbersV2Parameters {
|
|
|
66
66
|
*/
|
|
67
67
|
extensionStatus?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
|
|
68
68
|
|
|
69
|
+
/**
|
|
70
|
+
* The parameter reflects whether this number is BYOC or not
|
|
71
|
+
*/
|
|
72
|
+
byocNumber?: boolean;
|
|
73
|
+
|
|
69
74
|
/**
|
|
70
75
|
* Phone number in e.164 format to be searched for.
|
|
71
76
|
* Parameter value can include wildcards (e.g. "+165012345**")
|
|
@@ -25,6 +25,12 @@ interface RegSessionModelSettings {
|
|
|
25
25
|
* Indicates that work email address is required for registration.
|
|
26
26
|
*/
|
|
27
27
|
workEmailRequired?: boolean;
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Indicates that recording will be shown after the webinar and in emails.
|
|
31
|
+
* Default: true
|
|
32
|
+
*/
|
|
33
|
+
viewRecording?: boolean;
|
|
28
34
|
}
|
|
29
35
|
|
|
30
36
|
export default RegSessionModelSettings;
|
|
@@ -8,9 +8,9 @@ interface SocMsgListIdentitiesParameters {
|
|
|
8
8
|
sourceId?: string;
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
|
-
* Filter based on the specified
|
|
11
|
+
* Filter based on the specified identityGroupIds (separated by commas).
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
identityGroupIds?: string[];
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
* Filter based on the specified userId.
|
|
@@ -42,22 +42,22 @@ interface TMCreateEventRequest {
|
|
|
42
42
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* Condition of ending
|
|
45
|
+
* Condition of ending an event
|
|
46
46
|
*/
|
|
47
|
-
endingCondition?:
|
|
47
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* Count of iterations. For periodic events only. Value range
|
|
51
|
-
*
|
|
50
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
51
|
+
* Must be specified if `endingCondition` is `Count`
|
|
52
52
|
* Format: int32
|
|
53
53
|
*/
|
|
54
54
|
endingAfter?: number;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* Iterations
|
|
58
|
-
*
|
|
57
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
58
|
+
* Format: date-time
|
|
59
59
|
*/
|
|
60
|
-
endingOn?:
|
|
60
|
+
endingOn?: string;
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
63
|
* Color of Event title (including its presentation in Calendar)
|
|
@@ -12,7 +12,7 @@ interface TMCreateTaskRequestRecurrence {
|
|
|
12
12
|
endingCondition?: 'None' | 'Count' | 'Date';
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
* Count of iterations of periodic tasks
|
|
15
|
+
* Count of iterations of periodic tasks
|
|
16
16
|
* Maximum: 10
|
|
17
17
|
* Minimum: 1
|
|
18
18
|
* Format: int32
|
|
@@ -20,7 +20,7 @@ interface TMCreateTaskRequestRecurrence {
|
|
|
20
20
|
endingAfter?: number;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* End date of a periodic task in UTC time zone
|
|
24
24
|
* Format: date-time
|
|
25
25
|
*/
|
|
26
26
|
endingOn?: string;
|
|
@@ -37,21 +37,22 @@ interface TMEventInfo {
|
|
|
37
37
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Condition of ending
|
|
40
|
+
* Condition of ending an event
|
|
41
41
|
*/
|
|
42
|
-
endingCondition?:
|
|
42
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* Count of iterations. For periodic events only
|
|
45
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
46
|
+
* Must be specified if `endingCondition` is `Count`
|
|
46
47
|
* Format: int32
|
|
47
48
|
*/
|
|
48
49
|
endingAfter?: number;
|
|
49
50
|
|
|
50
51
|
/**
|
|
51
|
-
* Iterations
|
|
52
|
-
*
|
|
52
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
53
|
+
* Format: date-time
|
|
53
54
|
*/
|
|
54
|
-
endingOn?:
|
|
55
|
+
endingOn?: string;
|
|
55
56
|
|
|
56
57
|
/**
|
|
57
58
|
* Color of Event title (including its presentation in Calendar)
|
|
@@ -87,21 +87,22 @@ interface TMMessageAttachmentInfo {
|
|
|
87
87
|
recurrence?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* Condition of ending
|
|
90
|
+
* Condition of ending an event
|
|
91
91
|
*/
|
|
92
|
-
endingCondition?:
|
|
92
|
+
endingCondition?: 'None' | 'Count' | 'Date';
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
|
-
* Count of iterations. For periodic events only
|
|
95
|
+
* Count of event iterations. For periodic events only. Value range is 1 - 10.
|
|
96
|
+
* Must be specified if `endingCondition` is `Count`
|
|
96
97
|
* Format: int32
|
|
97
98
|
*/
|
|
98
99
|
endingAfter?: number;
|
|
99
100
|
|
|
100
101
|
/**
|
|
101
|
-
* Iterations
|
|
102
|
-
*
|
|
102
|
+
* Iterations ending datetime for periodic events in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
|
|
103
|
+
* Format: date-time
|
|
103
104
|
*/
|
|
104
|
-
endingOn?:
|
|
105
|
+
endingOn?: string;
|
|
105
106
|
|
|
106
107
|
/**
|
|
107
108
|
* Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card
|
|
@@ -6,7 +6,7 @@ interface TMUpdateTaskRequestRecurrence {
|
|
|
6
6
|
schedule?: 'None' | 'Daily' | 'Weekdays' | 'Weekly' | 'Monthly' | 'Yearly';
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* Task ending condition
|
|
9
|
+
* Task ending condition
|
|
10
10
|
*/
|
|
11
11
|
endingCondition?: 'None' | 'Count' | 'Date';
|
|
12
12
|
|
|
@@ -19,7 +19,7 @@ interface TMUpdateTaskRequestRecurrence {
|
|
|
19
19
|
endingAfter?: number;
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* End date of a periodic task in UTC time zone
|
|
23
23
|
* Format: date-time
|
|
24
24
|
*/
|
|
25
25
|
endingOn?: string;
|
|
@@ -41,7 +41,13 @@ interface UserPhoneNumberInfo {
|
|
|
41
41
|
* Payment type. 'External' is returned for forwarded numbers
|
|
42
42
|
* which are not terminated in the RingCentral phone system
|
|
43
43
|
*/
|
|
44
|
-
paymentType?:
|
|
44
|
+
paymentType?:
|
|
45
|
+
| 'External'
|
|
46
|
+
| 'TollFree'
|
|
47
|
+
| 'Local'
|
|
48
|
+
| 'BusinessMobileNumberProvider'
|
|
49
|
+
| 'ExternalNumberProvider'
|
|
50
|
+
| 'ExternalNumberProviderTollFree';
|
|
45
51
|
|
|
46
52
|
/**
|
|
47
53
|
* Phone number
|
|
@@ -8,8 +8,9 @@ import type MessageAttachmentInfo from './MessageAttachmentInfo';
|
|
|
8
8
|
interface VoicemailMessageEventBody {
|
|
9
9
|
/**
|
|
10
10
|
* Internal identifier of a message
|
|
11
|
+
* Format: int64
|
|
11
12
|
*/
|
|
12
|
-
id?:
|
|
13
|
+
id?: number;
|
|
13
14
|
|
|
14
15
|
/**
|
|
15
16
|
* Message receiver(s) information
|
|
@@ -85,14 +86,17 @@ interface VoicemailMessageEventBody {
|
|
|
85
86
|
messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
|
|
86
87
|
|
|
87
88
|
/**
|
|
88
|
-
*
|
|
89
|
+
* Status of a voicemail to text transcription. Specifies if a voicemail message transcription is already completed or not
|
|
90
|
+
* If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned
|
|
89
91
|
*/
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
92
|
+
vmTranscriptionStatus?:
|
|
93
|
+
| 'NotAvailable'
|
|
94
|
+
| 'InProgress'
|
|
95
|
+
| 'TimedOut'
|
|
96
|
+
| 'Completed'
|
|
97
|
+
| 'CompletedPartially'
|
|
98
|
+
| 'Failed'
|
|
99
|
+
| 'Unknown';
|
|
96
100
|
}
|
|
97
101
|
|
|
98
102
|
export default VoicemailMessageEventBody;
|
|
@@ -13,7 +13,9 @@ class Index {
|
|
|
13
13
|
return `${this._parent.path()}/call-recordings`;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* Deletes company call recordings by their IDs.
|
|
16
|
+
* Deletes company call recordings by their IDs. *Please note:* This method deletes the recording file itself,
|
|
17
|
+
* not the record of it in the call log.
|
|
18
|
+
*
|
|
17
19
|
* HTTP Method: delete
|
|
18
20
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/call-recordings
|
|
19
21
|
* Rate Limit Group: Heavy
|
|
@@ -60,7 +60,7 @@ class Index {
|
|
|
60
60
|
}
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
|
-
* Returns emergency response location by ID.
|
|
63
|
+
* Returns emergency response location by ID. Available for Admin users only.
|
|
64
64
|
* HTTP Method: get
|
|
65
65
|
* Endpoint: /restapi/{apiVersion}/account/{accountId}/emergency-locations/{locationId}
|
|
66
66
|
* Rate Limit Group: Light
|
package/src/samples.md
CHANGED
|
@@ -8505,7 +8505,7 @@ await rc.revoke();
|
|
|
8505
8505
|
- `analyticsCallsAggregationFetchParameters` is of type [AnalyticsCallsAggregationFetchParameters](./definitions/AnalyticsCallsAggregationFetchParameters.ts)
|
|
8506
8506
|
- `result` is of type [AggregationResponse](./definitions/AggregationResponse.ts)
|
|
8507
8507
|
|
|
8508
|
-
[Try it out](https://developer.ringcentral.com/api-reference#
|
|
8508
|
+
[Try it out](https://developer.ringcentral.com/api-reference#Business-Analytics-analyticsCallsAggregationFetch) in API Explorer.
|
|
8509
8509
|
|
|
8510
8510
|
## analyticsCallsTimelineFetch
|
|
8511
8511
|
|
|
@@ -8537,7 +8537,7 @@ await rc.revoke();
|
|
|
8537
8537
|
- `analyticsCallsTimelineFetchParameters` is of type [AnalyticsCallsTimelineFetchParameters](./definitions/AnalyticsCallsTimelineFetchParameters.ts)
|
|
8538
8538
|
- `result` is of type [TimelineResponse](./definitions/TimelineResponse.ts)
|
|
8539
8539
|
|
|
8540
|
-
[Try it out](https://developer.ringcentral.com/api-reference#
|
|
8540
|
+
[Try it out](https://developer.ringcentral.com/api-reference#Business-Analytics-analyticsCallsTimelineFetch) in API Explorer.
|
|
8541
8541
|
|
|
8542
8542
|
## socMsgAnonymizeIdentity
|
|
8543
8543
|
|