@rc-ex/debug 1.3.11 → 1.4.0

package/dist/core/src/definitions/MobilePickupData.d.ts

@@ -0,0 +1,23 @@
+interface MobilePickupData {
+    /**
+     * List of extension IDs, configured to pick up a call from Desktop/Mobile applications
+     */
+    ccMailboxes?: string[];
+    /**
+     * SIP proxy registration name
+     */
+    to?: string;
+    /**
+     * User data
+     */
+    sid?: string;
+    /**
+     * User data
+     */
+    srvlvl?: string;
+    /**
+     * User data
+     */
+    srvLvlExt?: string;
+}
+export default MobilePickupData;

package/dist/core/src/definitions/ModelInfo.d.ts

@@ -0,0 +1,31 @@
+import type AddonInfo from "./AddonInfo.js";
+/**
+ * HardPhone model information
+ */
+interface ModelInfo {
+    /**
+     * Internal identifier of a HardPhone device model
+     */
+    id?: string;
+    /**
+     * Device name
+     */
+    name?: string;
+    /**
+     * Add-ons description
+     */
+    addons?: AddonInfo[];
+    /**
+     */
+    deviceClass?: string;
+    /**
+     * Device feature or multiple features supported
+     */
+    features?: ("BLA" | "CommonPhone" | "Intercom" | "Paging" | "HELD")[];
+    /**
+     * Max supported count of phone lines
+     * Format: int32
+     */
+    lineCount?: number;
+}
+export default ModelInfo;

package/dist/core/src/definitions/ModifyAccountBusinessAddressRequest.d.ts

@@ -0,0 +1,20 @@
+import type BusinessAddressInfo from "./BusinessAddressInfo.js";
+interface ModifyAccountBusinessAddressRequest {
+    /**
+     * Company business name
+     */
+    company?: string;
+    /**
+     * Company business email address
+     * Format: email
+     */
+    email?: string;
+    /**
+     */
+    businessAddress?: BusinessAddressInfo;
+    /**
+     * Custom site name
+     */
+    mainSiteName?: string;
+}
+export default ModifyAccountBusinessAddressRequest;

package/dist/core/src/definitions/MsTeamsUserEntry.d.ts

@@ -0,0 +1,14 @@
+interface MsTeamsUserEntry {
+    /**
+     * RingCentral extension ID of the user to connect
+     * Required
+     */
+    extensionId?: string;
+    /**
+     * Phone number in e.164 format (with '+' prefix)
+     * Required
+     * Example: +16501234567
+     */
+    phoneNumber?: string;
+}
+export default MsTeamsUserEntry;

package/dist/core/src/definitions/MsTeamsUserListResponse.d.ts

@@ -0,0 +1,8 @@
+import type MsTeamsUserListResponseMappings from "./MsTeamsUserListResponseMappings.js";
+interface MsTeamsUserListResponse {
+    /**
+     * Required
+     */
+    mappings?: MsTeamsUserListResponseMappings[];
+}
+export default MsTeamsUserListResponse;

package/dist/core/src/definitions/MsTeamsUserListResponseMappings.d.ts

@@ -0,0 +1,16 @@
+interface MsTeamsUserListResponseMappings {
+    /**
+     * RingCentral extension ID of the user to connect
+     */
+    extensionId?: string;
+    /**
+     * Phone number in e.164 format (with '+' prefix)
+     * Example: +16501234567
+     */
+    phoneNumber?: string;
+    /**
+     * Connection status of the Microsoft Teams Direct Routing user
+     */
+    status?: "Connected" | "Initial" | "RemoteNotFound" | "OutOfSync" | "Connecting" | "Disconnecting" | "DisconnectFailed" | "RemoteUserRemoved";
+}
+export default MsTeamsUserListResponseMappings;

package/dist/core/src/definitions/NetworkInfo.d.ts

@@ -0,0 +1,27 @@
+import type AutomaticLocationUpdatesSiteInfo from "./AutomaticLocationUpdatesSiteInfo.js";
+import type PrivateIpRangeInfo from "./PrivateIpRangeInfo.js";
+import type PublicIpRangeInfo from "./PublicIpRangeInfo.js";
+interface NetworkInfo {
+    /**
+     * Internal identifier of a network
+     */
+    id?: string;
+    /**
+     * Link to a network resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     */
+    name?: string;
+    /**
+     */
+    site?: AutomaticLocationUpdatesSiteInfo;
+    /**
+     */
+    publicIpRanges?: PublicIpRangeInfo[];
+    /**
+     */
+    privateIpRanges?: PrivateIpRangeInfo[];
+}
+export default NetworkInfo;

package/dist/core/src/definitions/NetworksList.d.ts

@@ -0,0 +1,20 @@
+import type EnumeratedPagingModel from "./EnumeratedPagingModel.js";
+import type NetworkInfo from "./NetworkInfo.js";
+import type PageNavigationModel from "./PageNavigationModel.js";
+interface NetworksList {
+    /**
+     * Link to a networks resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     */
+    records?: NetworkInfo[];
+    /**
+     */
+    navigation?: PageNavigationModel;
+    /**
+     */
+    paging?: EnumeratedPagingModel;
+}
+export default NetworksList;

package/dist/core/src/definitions/NextStepsInsightUnit.d.ts

@@ -0,0 +1,29 @@
+interface NextStepsInsightUnit {
+    /**
+     * Participant ID
+     * Required
+     * Example: p-32423
+     */
+    speakerId?: string;
+    /**
+     * Value of the insight
+     * Required
+     * Example: conversational insights text
+     */
+    value?: string;
+    /**
+     * Start time of the insight (in sec)
+     * Required
+     * Format: float
+     * Example: 1.2
+     */
+    start?: number;
+    /**
+     * End time of the insight (in sec)
+     * Required
+     * Format: float
+     * Example: 4.2
+     */
+    end?: number;
+}
+export default NextStepsInsightUnit;

package/dist/core/src/definitions/NonEnumeratedPagingModel.d.ts

@@ -0,0 +1,31 @@
+interface NonEnumeratedPagingModel {
+    /**
+     * Current page size, describes how many items are in each page.
+     *  Matches "perPage" parameter from the request.
+     * Required
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 50
+     */
+    perPage?: number;
+    /**
+     * Current page token. May be omitted if result is empty (because non-existent page
+     *  was specified or perPage=0 was requested)
+     */
+    pageToken?: string;
+    /**
+     * A page token to be used to fetch the next page of the result set. May be omitted if the current page is the last one.
+     */
+    nextPageToken?: string;
+    /**
+     * A page token to be used to fetch the previous page of the result set.
+     *  May be omitted if the current page is the first one or if the result set does not support backward navigation.
+     */
+    previousPageToken?: string;
+    /**
+     * A page token to be used to fetch the first page of the result set.
+     */
+    firstPageToken?: string;
+}
+export default NonEnumeratedPagingModel;

package/dist/core/src/definitions/NotificationDeliveryMode.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Notification delivery transport information
+ */
+interface NotificationDeliveryMode {
+    /**
+     * The transport type for this subscription
+     * Required
+     */
+    transportType?: "WebHook" | "WebSocket";
+    /**
+     * The URL to which notifications should be delivered. This is only applicable for the `WebHook` transport type, for which it is a required field.
+     * Required
+     * Format: uri
+     * Example: https://acme.com/myservice/webhook
+     */
+    address?: string;
+    /**
+     * Specifies if notification messages will be encrypted or not.
+     * Required
+     */
+    encryption?: boolean;
+}
+export default NotificationDeliveryMode;

package/dist/core/src/definitions/NotificationDeliveryModeRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Notification delivery transport information
+ */
+interface NotificationDeliveryModeRequest {
+    /**
+     * The transport type for this subscription, or the channel by which an app should be notified of an event
+     * Required
+     */
+    transportType?: "WebHook";
+    /**
+     * The URL to which notifications should be delivered. This is only applicable for the `WebHook` transport type, for which it is a required field.
+     * Required
+     * Format: uri
+     * Example: https://acme.com/myservice/webhook
+     */
+    address?: string;
+    /**
+     * An optional validation token used to verify the authenticity of the incoming webhook. Applicable only for the `WebHook` transport type.
+     */
+    verificationToken?: string;
+}
+export default NotificationDeliveryModeRequest;

package/dist/core/src/definitions/NotificationSettings.d.ts

@@ -0,0 +1,74 @@
+import type CallNotesInfo from "./CallNotesInfo.js";
+import type EmailRecipientInfo from "./EmailRecipientInfo.js";
+import type InboundFaxesInfo from "./InboundFaxesInfo.js";
+import type InboundTextsInfo from "./InboundTextsInfo.js";
+import type MissedCallsInfo from "./MissedCallsInfo.js";
+import type OutboundFaxesInfo from "./OutboundFaxesInfo.js";
+import type VoicemailsInfo from "./VoicemailsInfo.js";
+interface NotificationSettings {
+    /**
+     * Canonical URI of notifications settings resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending
+     *  (if advanced mode disabled)
+     */
+    smsPhoneNumbers?: string[];
+    /**
+     * Specifies notifications settings mode. If `true` then advanced
+     *  mode is on, it allows using different emails and/or phone numbers for
+     *  each notification type. If `false` then basic mode is on. Advanced mode
+     *  settings are returned in both modes, if specified once, but if basic mode
+     *  is switched on, they are not applied
+     */
+    advancedMode?: boolean;
+    /**
+     */
+    voicemails?: VoicemailsInfo;
+    /**
+     */
+    inboundFaxes?: InboundFaxesInfo;
+    /**
+     */
+    outboundFaxes?: OutboundFaxesInfo;
+    /**
+     */
+    inboundTexts?: InboundTextsInfo;
+    /**
+     */
+    missedCalls?: MissedCallsInfo;
+    /**
+     * List of extensions specified as email notification recipients.
+     *  Returned only for call queues where queue managers are assigned as user
+     *  extensions.
+     */
+    emailRecipients?: EmailRecipientInfo[];
+    /**
+     * List of notification recipient email addresses
+     */
+    emailAddresses?: string[];
+    /**
+     * Specifies if managers' emails are included in the list of emails to which
+     *  notifications are sent
+     */
+    includeManagers?: boolean;
+    /**
+     * Specifies if sms recipients' emails are included in the list of emails to which
+     *  notifications are sent
+     */
+    includeSmsRecipients?: boolean;
+    /**
+     * List of sms recipients specified for call queue. Returned only for call queue extension
+     */
+    smsRecipients?: EmailRecipientInfo[];
+    /**
+     * List of notification recipient email addresses
+     */
+    smsEmailAddresses?: string[];
+    /**
+     */
+    callNotes?: CallNotesInfo;
+}
+export default NotificationSettings;

package/dist/core/src/definitions/NotificationSettingsUpdateRequest.d.ts

@@ -0,0 +1,60 @@
+import type CallNotesInfo from "./CallNotesInfo.js";
+import type InboundFaxesInfo from "./InboundFaxesInfo.js";
+import type InboundTextsInfo from "./InboundTextsInfo.js";
+import type MissedCallsInfo from "./MissedCallsInfo.js";
+import type OutboundFaxesInfo from "./OutboundFaxesInfo.js";
+import type VoicemailsInfo from "./VoicemailsInfo.js";
+interface NotificationSettingsUpdateRequest {
+    /**
+     * Canonical URI of notifications settings resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * The parameter contains the list of phone Numbers which should be used for SMS notifications sending
+     *  (if advanced mode disabled)
+     */
+    smsPhoneNumbers?: string[];
+    /**
+     * Specifies notifications settings mode. If `true` then advanced
+     *  mode is on, it allows using different emails and/or phone numbers for
+     *  each notification type. If `false` then basic mode is on. Advanced mode
+     *  settings are returned in both modes, if specified once, but if basic mode
+     *  is switched on, they are not applied
+     */
+    advancedMode?: boolean;
+    /**
+     */
+    voicemails?: VoicemailsInfo;
+    /**
+     */
+    inboundFaxes?: InboundFaxesInfo;
+    /**
+     */
+    outboundFaxes?: OutboundFaxesInfo;
+    /**
+     */
+    inboundTexts?: InboundTextsInfo;
+    /**
+     */
+    missedCalls?: MissedCallsInfo;
+    /**
+     * List of notification recipient email addresses. Should not be empty
+     *  if 'includeManagers' parameter is set to false
+     */
+    emailAddresses?: string[];
+    /**
+     * List of notification recipient email addresses
+     */
+    smsEmailAddresses?: string[];
+    /**
+     * Specifies if managers' emails are included in the list of emails to
+     *  which notifications are sent. If not specified, then the value is `true`
+     * Default: true
+     */
+    includeManagers?: boolean;
+    /**
+     */
+    callNotes?: CallNotesInfo;
+}
+export default NotificationSettingsUpdateRequest;

package/dist/core/src/definitions/NumberDetails.d.ts

@@ -0,0 +1,79 @@
+import type CountryContext from "./CountryContext.js";
+import type NumberDetailsSpecialService from "./NumberDetailsSpecialService.js";
+/**
+ * Absent if the request's parameter `resultContent.includeNumberDetails` value is set to `false`.
+ */
+interface NumberDetails {
+    /**
+     * Absent if the request's parameter `context.siteCode` value is set to `null`.
+     * Example: 10
+     */
+    siteCode?: string;
+    /**
+     * Absent if the request's parameter `context.siteCode` value is set to `null`.
+     * Example: 303
+     */
+    shortExtensionNumber?: string;
+    /**
+     * Absent for the `results.category` response's attribute values:
+     *  `Unknown`, `ServiceCode`, `SpecialService`, `Regular`, `TollFree` and `ShortCode`.
+     * Example: 10303
+     */
+    extensionNumber?: string;
+    /**
+     * Absent for the `results.category` response's attribute values:
+     *  `Unknown`, `ServiceCode`, `Extension`, `Regular`, `TollFree`, `ShortCode` and `Ambiguous`.
+     */
+    specialService?: NumberDetailsSpecialService;
+    /**
+     */
+    country?: CountryContext;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain a national destination code.
+     */
+    nationalDestinationCode?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain an area code.
+     * Example: 650
+     */
+    areaCode?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain a regional destination code.
+     */
+    regionalDestinationCode?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain an allocation block code.
+     */
+    allocationBlockCode?: string;
+    /**
+     * Absent for the `results.category` response's attribute values: `Unknown`, `ServiceCode` and `Extension`.
+     * Example: 5558275
+     */
+    subscriberNumber?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain a sub-address.
+     * Example: 1019
+     */
+    subAddress?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain a DTMF postfix.
+     * Example: ,,,1,3,1,
+     */
+    dtmfPostfix?: string;
+    /**
+     * Absent if the response's attribute `results.originalString` value doesn't contain a SIP postfix.
+     * Example: @sip.ringcentral.com
+     */
+    sipPostfix?: string;
+    /**
+     * Absent if the request's parameter `context.maskedPhoneNumbersAllowed` value is set to `false`.
+     */
+    probablyMasked?: boolean;
+    /**
+     * Absent for the `results.category` response's attribute values:
+     *  `Unknown`, `SpecialService`, `Extension`, `TollFree`, `ShortCode` and `Ambiguous`.
+     * Example: Valid
+     */
+    status?: "Valid" | "Possible" | "Invalid";
+}
+export default NumberDetails;

package/dist/core/src/definitions/NumberDetailsSpecialService.d.ts

@@ -0,0 +1,12 @@
+interface NumberDetailsSpecialService {
+    /**
+     * The type of special service.
+     * Example: NonEmergencyMedical
+     */
+    type?: "Emergency" | "DirectoryAssistance" | "UpdateEmergencyAddress" | "CustomerSupport" | "NonEmergencyPolice" | "NonEmergencyMedical" | "TelecommunicationRelay" | "Unsupported" | "Supplementary" | "Unknown";
+    /**
+     * Example: 116xxx
+     */
+    pattern?: string;
+}
+export default NumberDetailsSpecialService;

package/dist/core/src/definitions/NumberParserContext.d.ts

@@ -0,0 +1,137 @@
+import type CountryContext from "./CountryContext.js";
+/**
+ * The manually set parsing context to override the context parameter values taken from the context source.
+ */
+interface NumberParserContext {
+    /**
+     * Internal identifier of the RingCentral brand. Brand context definition.
+     *
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> `null`
+     *    - `Account` -> brand from the request context header
+     *  - Explicitly set value redefines the value taken from the context source.
+     *  - Explicitly set `null` value disables brand context for parsing.
+     * Example: 1210
+     */
+    brandId?: string;
+    /**
+     */
+    country?: CountryContext;
+    /**
+     * Default area code of the caller. Provides support for the dial plan feature
+     *  "[Default Area Code](https://support.ringcentral.com/article/dial-plan-default-area-code-ringcentral-mvp.html)".
+     *
+     *  If the value is not specified or explicitly set to `null`, the feature "Default Area Code" context is disabled for parsing.
+     * Example: 650
+     */
+    defaultAreaCode?: string;
+    /**
+     * Vanity phone numbers are supported in the parsing input. Provides support for the feature
+     *  "[Vanity Numbers dialing](https://support.ringcentral.com/article/Requesting-a-toll-free-vanity-number.html)".
+     *
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> `false`
+     *    - `Account` -> `true`
+     *  - Explicitly set value redefines the value taken from the context source.
+     * Example: true
+     */
+    vanityPhoneNumbersAllowed?: boolean;
+    /**
+     * The maximum allowed length of extension numbers on the account. Provides support for the dial plan feature
+     *  "[Variable-length Extensions](https://support.ringcentral.com/article/11277-Enterprise-Dial-Plan-Max-Extension-Length.html)".
+     *
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> _5_
+     *    - `Account` -> the value from the requester's account settings
+     *  - Explicitly set value redefines the value taken from the context source.
+     *  - Explicitly set `null` value disables extension numbers detection.
+     * Maximum: 9
+     * Minimum: 1
+     * Format: int32
+     */
+    maxExtensionNumberLength?: number;
+    /**
+     * Short codes are supported in the parsing input. Provides support for the feature "Shortcodes dialing".
+     *
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> `false`
+     *    - `Account` -> the value from the requester's account settings
+     *  - Explicitly set value redefines the value taken from the context source.
+     */
+    shortCodesAllowed?: boolean;
+    /**
+     * The site code of caller. Together with parameter `context.shortExtensionNumberLength` provides support for the feature
+     *  "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".
+     *
+     *  - If the value is not specified or explicitly set to `null`, the feature "Site Codes" context is disabled for parsing.
+     * Example: 13
+     */
+    siteCode?: string;
+    /**
+     * The allowed length of short extension numbers on the account.
+     *  Together with parameter `context.siteCode` provides support for the feature
+     *  "[Site Codes](https://support.ringcentral.com/article/11279-Enterprise-Dial-Plan-Site-Codes.html)".
+     *
+     *  - The value is ignored and treated as `null` if parameter `context.siteCode` is not specified or explicitly set to `null`.
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> _3_
+     *    - `Account` -> the value from the requester's account settings
+     *  - Explicitly set value redefines the value taken from the context source.
+     * Maximum: 8
+     * Minimum: 1
+     * Format: int32
+     * Example: 4
+     */
+    shortExtensionNumberLength?: number;
+    /**
+     * Digit of outbound call prefix on the account. Provides support for the dial plan feature
+     *  "[Outbound Call Prefix](https://support.ringcentral.com/article/11278-Enterprise-Dial-Plan-Outbound-Call-Prefix.html)".
+     *
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> `null`
+     *    - `Account` -> the value from the requester's account settings
+     *  - Explicitly set value redefines the value taken from the context source.
+     *  - Explicitly set `null` value disables outbound call prefix detection.
+     * Example: 9
+     */
+    outboundCallPrefix?: string;
+    /**
+     * Masked phone numbers are supported in the the parsing input.
+     *  Provides support for the feature "[Masked Numbers](https://support.ringcentral.com/article/Number-Masking-French-Numbers.html)".
+     *
+     *  - If the value is not specified or explicitly set to `false`, the feature "Masked Numbers" context is disabled for parsing.
+     */
+    maskedPhoneNumbersAllowed?: boolean;
+    /**
+     * A character used for masking phone numbers.
+     *
+     *  Absent if the request's parameter `context.maskedPhoneNumbersAllowed` value is set to `false`.
+     * Example: X
+     */
+    maskSymbol?: string;
+    /**
+     * The number of last digits of the phone number which are masked.
+     *
+     *  Absent if the request's parameter `context.maskedPhoneNumbersAllowed` value is set to `false`.
+     * Format: int32
+     * Example: 4
+     */
+    maskLength?: number;
+    /**
+     * Defines the logic of conflicts resolving when it's impossible to detect whether the inputted string
+     *  corresponds to an extension number or a phone number. Provides support for the feature "Smart Dial Plan Routing".
+     *
+     *  **Possible values**:
+     *
+     *  - `Default` - the ambiguous number will always be classified as an extension number;
+     *  - `Client` - the ambiguous number will get `Ambiguous` category and the final decision whether the number is an extension number or a phone number should be made by the requester.
+     *  - If the value is not specified, it's taken from the context source:
+     *    - `Default` -> _Default_
+     *    - `Client` -> the value from the requester's account settings
+     *  - Explicitly set value redefines the value taken from the context source.
+     * Example: Client
+     * Default: Default
+     */
+    conflictHandling?: "Default" | "Client";
+}
+export default NumberParserContext;

package/dist/core/src/definitions/OnDemandResource.d.ts

@@ -0,0 +1,12 @@
+interface OnDemandResource {
+    /**
+     * Flag for controlling OnDemand Call Recording settings
+     */
+    enabled?: boolean;
+    /**
+     * Retention period of a call recording, the default value is 90 days
+     * Format: int32
+     */
+    retentionPeriod?: number;
+}
+export default OnDemandResource;