@rc-ex/debug 1.3.11 → 1.4.0

package/dist/core/src/FormData.d.ts

@@ -0,0 +1,9 @@
+import type { FormFile } from "./types.js";
+export declare const boundary = "ad05fc42-a66d-4a94-b807-f1c91136c17b";
+declare class FormData {
+    files: FormFile[];
+    append(formFile: FormFile): void;
+    prepend(formFile: FormFile): void;
+    getBody(): Promise<Uint8Array<ArrayBufferLike>>;
+}
+export default FormData;

package/dist/core/src/Rest.d.ts

@@ -0,0 +1,16 @@
+import type { AxiosInstance } from "axios";
+import type TokenInfo from "./definitions/TokenInfo.js";
+import type { RestMethod, RestOptions, RestRequestConfig, RestResponse } from "./types.js";
+export default class Rest {
+    static sandboxServer: string;
+    static productionServer: string;
+    server: string;
+    clientId: string;
+    clientSecret?: string;
+    token?: TokenInfo;
+    appName: string;
+    appVersion: string;
+    httpClient: AxiosInstance;
+    constructor(options: RestOptions);
+    request<T>(method: RestMethod, endpoint: string, content?: {}, queryParams?: {}, config?: RestRequestConfig): Promise<RestResponse<T>>;
+}

package/dist/core/src/RestException.d.ts

@@ -0,0 +1,7 @@
+import type { RestResponse } from "./types.js";
+declare class RestException extends Error {
+    response: RestResponse;
+    message: string;
+    constructor(r: RestResponse);
+}
+export default RestException;

package/dist/core/src/SdkExtension.d.ts

@@ -0,0 +1,9 @@
+import type { RingCentralInterface } from "./types.js";
+declare abstract class SdkExtension {
+    enabled: boolean;
+    enable(): void;
+    disable(): void;
+    abstract install(rc: RingCentralInterface): Promise<void>;
+    abstract revoke(): Promise<void>;
+}
+export default SdkExtension;

package/dist/core/src/Utils.d.ts

@@ -0,0 +1,7 @@
+import type { RestResponse } from "./types.js";
+declare class Utils {
+    static formatTraffic(r: RestResponse): string;
+    static isAttachment(obj: {}): boolean;
+    static getFormData(...objects: {}[]): Promise<Uint8Array>;
+}
+export default Utils;

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

@@ -0,0 +1,35 @@
+import type AIScoreInsightUnit from "./AIScoreInsightUnit.js";
+import type BulletedSummaryInsightUnit from "./BulletedSummaryInsightUnit.js";
+import type CallNotesInsightUnit from "./CallNotesInsightUnit.js";
+import type HighlightsInsightUnit from "./HighlightsInsightUnit.js";
+import type NextStepsInsightUnit from "./NextStepsInsightUnit.js";
+import type SentimentInsightUnit from "./SentimentInsightUnit.js";
+import type SummaryInsightUnit from "./SummaryInsightUnit.js";
+import type TranscriptInsightUnit from "./TranscriptInsightUnit.js";
+interface AIInsights {
+    /**
+     */
+    Transcript?: TranscriptInsightUnit[];
+    /**
+     */
+    Summary?: SummaryInsightUnit[];
+    /**
+     */
+    Highlights?: HighlightsInsightUnit[];
+    /**
+     */
+    NextSteps?: NextStepsInsightUnit[];
+    /**
+     */
+    BulletedSummary?: BulletedSummaryInsightUnit[];
+    /**
+     */
+    AIScore?: AIScoreInsightUnit[];
+    /**
+     */
+    CallNotes?: CallNotesInsightUnit[];
+    /**
+     */
+    Sentiment?: SentimentInsightUnit[];
+}
+export default AIInsights;

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

@@ -0,0 +1,9 @@
+interface AIScoreInsightUnit {
+    /**
+     * Value of the score
+     * Required
+     * Example: 7
+     */
+    value?: string;
+}
+export default AIScoreInsightUnit;

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

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

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

@@ -0,0 +1,13 @@
+interface AccountCountryInfoRequest {
+    /**
+     * Internal identifier of a country
+     * Required
+     */
+    id?: string;
+    /**
+     * Two-letter country code in ISO 3166-1 alpha-2 format
+     * Required
+     */
+    isoCode?: string;
+}
+export default AccountCountryInfoRequest;

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

@@ -0,0 +1,28 @@
+import type DeviceEmergencyInfo from "./DeviceEmergencyInfo.js";
+import type DeviceUpdateExtensionInfo from "./DeviceUpdateExtensionInfo.js";
+import type DeviceUpdatePhoneLinesInfo from "./DeviceUpdatePhoneLinesInfo.js";
+import type EmergencyServiceAddressResourceRequest from "./EmergencyServiceAddressResourceRequest.js";
+interface AccountDeviceUpdate {
+    /**
+     */
+    emergencyServiceAddress?: EmergencyServiceAddressResourceRequest;
+    /**
+     */
+    emergency?: DeviceEmergencyInfo;
+    /**
+     */
+    extension?: DeviceUpdateExtensionInfo;
+    /**
+     */
+    phoneLines?: DeviceUpdatePhoneLinesInfo;
+    /**
+     * Supported only for devices assigned to Limited extensions.
+     *  If true, enables users to log in to this phone as a common phone
+     */
+    useAsCommonPhone?: boolean;
+    /**
+     * Device label, maximum number of symbols is 64
+     */
+    name?: string;
+}
+export default AccountDeviceUpdate;

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

@@ -0,0 +1,11 @@
+interface AccountDirectoryProfileImageResource {
+    /**
+     * Example: tag
+     */
+    etag?: string;
+    /**
+     * Format: uri
+     */
+    uri?: string;
+}
+export default AccountDirectoryProfileImageResource;

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

@@ -0,0 +1,13 @@
+interface AccountFormattingLocaleInfoRequest {
+    /**
+     * Internal identifier of a formatting language
+     * Required
+     */
+    id?: string;
+    /**
+     * Localization code of a formatting language
+     * Required
+     */
+    localeCode?: string;
+}
+export default AccountFormattingLocaleInfoRequest;

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

@@ -0,0 +1,13 @@
+interface AccountGreetingLanguageInfoRequest {
+    /**
+     * Internal identifier of a greeting language
+     * Required
+     */
+    id?: string;
+    /**
+     * Localization code of a greeting language
+     * Required
+     */
+    localeCode?: string;
+}
+export default AccountGreetingLanguageInfoRequest;

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

@@ -0,0 +1,31 @@
+interface AccountHistoryPaging {
+    /**
+     * The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty
+     *  (because non-existent page was specified or perPage=0 was requested)
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     */
+    page?: number;
+    /**
+     * Current page size, describes how many items are in each page. Matches "perPage" parameter from the request
+     * Maximum: 1000
+     * Minimum: 1
+     * Format: int32
+     * Example: 50
+     */
+    perPage?: number;
+    /**
+     * Total number of pages in a dataset. May be omitted for some resources due to performance reasons
+     * Format: int32
+     * Example: 25
+     */
+    total?: number;
+    /**
+     * Total number of elements in a dataset. May be omitted for some resources due to performance reasons
+     * Format: int32
+     * Example: 25
+     */
+    totalFound?: number;
+}
+export default AccountHistoryPaging;

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

@@ -0,0 +1,54 @@
+import type AccountHistoryRecordPublicDetails from "./AccountHistoryRecordPublicDetails.js";
+import type AccountHistoryRecordPublicInitiator from "./AccountHistoryRecordPublicInitiator.js";
+import type AccountHistoryRecordTarget from "./AccountHistoryRecordTarget.js";
+interface AccountHistoryPublicRecord {
+    /**
+     * Internal record identifier
+     * Example: 9835bead-397b-4ba8-b457-73f07ab79997
+     */
+    id?: string;
+    /**
+     * Timestamp of an event (provided by a client), RFC3339 date-time format, UTC time zone.
+     * Format: date-time
+     */
+    eventTime?: string;
+    /**
+     */
+    initiator?: AccountHistoryRecordPublicInitiator;
+    /**
+     * Action type
+     * Example: CHANGE_SECRET_INFO
+     */
+    actionId?: string;
+    /**
+     * Operation: "CREATE", "UPDATE", "DELETE" or custom
+     * Example: UPDATE
+     */
+    eventType?: string;
+    /**
+     * Account identifier which is related with the particular record.
+     * Example: 403858014008
+     */
+    accountId?: string;
+    /**
+     * Account (company) name
+     * Example: Some Company
+     */
+    accountName?: string;
+    /**
+     */
+    target?: AccountHistoryRecordTarget;
+    /**
+     * IP-address of a client.
+     * Example: 192.168.42.6
+     */
+    clientIp?: string;
+    /**
+     * Custom top-level comment
+     */
+    comment?: string;
+    /**
+     */
+    details?: AccountHistoryRecordPublicDetails;
+}
+export default AccountHistoryPublicRecord;

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

@@ -0,0 +1,13 @@
+interface AccountHistoryRecordDetailsParameters {
+    /**
+     * Required
+     * Example: settingName
+     */
+    key?: string;
+    /**
+     * Required
+     * Example: Password
+     */
+    value?: string;
+}
+export default AccountHistoryRecordDetailsParameters;

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

@@ -0,0 +1,8 @@
+import type AccountHistoryRecordDetailsParameters from "./AccountHistoryRecordDetailsParameters.js";
+interface AccountHistoryRecordPublicDetails {
+    /**
+     * Event details (additional parameters)
+     */
+    parameters?: AccountHistoryRecordDetailsParameters[];
+}
+export default AccountHistoryRecordPublicDetails;

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

@@ -0,0 +1,26 @@
+/**
+ * Event initiator info
+ */
+interface AccountHistoryRecordPublicInitiator {
+    /**
+     * Current user extension identifier
+     * Example: 402539300008
+     */
+    extensionId?: string;
+    /**
+     * Current user extension (short) number
+     * Example: 101
+     */
+    extensionNumber?: string;
+    /**
+     * Current user full name
+     * Example: Alice Smith
+     */
+    name?: string;
+    /**
+     * Current user role
+     * Example: Super Admin
+     */
+    role?: string;
+}
+export default AccountHistoryRecordPublicInitiator;

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

@@ -0,0 +1,31 @@
+/**
+ * Action target object (company/extension)
+ */
+interface AccountHistoryRecordTarget {
+    /**
+     * Extension identifier of the affected entity or "0" for Company level
+     * Example: 404611540004
+     */
+    objectId?: string;
+    /**
+     * Type of the entity.
+     * Example: Extension
+     */
+    objectType?: "Extension" | "Account" | "Company" | "Template";
+    /**
+     * Target extension name
+     * Example: Charlie Williams
+     */
+    name?: string;
+    /**
+     * Target extension (short) number  of the affected entity (if the objectType is EXTENSION).
+     * Example: 103
+     */
+    extensionNumber?: string;
+    /**
+     * Target extension site identifier (if any)
+     * Example: 871836004
+     */
+    siteId?: string;
+}
+export default AccountHistoryRecordTarget;

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

@@ -0,0 +1,61 @@
+interface AccountHistorySearchPublicRequest {
+    /**
+     * The beginning of the time range to return records in ISO 8601 format in UTC timezone, default is "eventTimeFrom"-24 hours
+     * Format: date-time
+     */
+    eventTimeFrom?: string;
+    /**
+     * The end of the time range to return records in ISO 8601 format in UTC timezone, default is the current time
+     * Format: date-time
+     */
+    eventTimeTo?: string;
+    /**
+     * List of extension IDs of change initiators.
+     */
+    initiatorIds?: string[];
+    /**
+     * Page number in the result set
+     * Format: int32
+     * Example: 1
+     */
+    page?: number;
+    /**
+     * Number of records to be returned per page.
+     * Format: int32
+     * Example: 25
+     */
+    perPage?: number;
+    /**
+     * List of extension (user) IDs affected by this action.
+     * Example: 404611540004
+     */
+    targetIds?: string[];
+    /**
+     * Site ID to apply as a filter
+     * Example: 871836004
+     */
+    siteId?: string;
+    /**
+     * List of action IDs (exact keys) to search for (alternatively "excludeActionIds" option can be used).
+     * Example: CHANGE_SECRET_INFO,CHANGE_USER_INFO
+     */
+    actionIds?: string[];
+    /**
+     * The (sub)string to search, applied to the following fields:
+     *
+     *  - initiator.name
+     *  - initiator.role
+     *  - initiator.extensionNumber
+     *  - target.name
+     *  - target.extensionNumber
+     *  - details.parameters.value
+     * Example: 542617
+     */
+    searchString?: string;
+    /**
+     * List of action IDs (exact keys) to exclude from your search (alternatively "actionIds" option can be used).
+     * Example: CHANGE_SECRET_INFO,CHANGE_USER_INFO
+     */
+    excludeActionIds?: string[];
+}
+export default AccountHistorySearchPublicRequest;

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

@@ -0,0 +1,12 @@
+import type AccountHistoryPaging from "./AccountHistoryPaging.js";
+import type AccountHistoryPublicRecord from "./AccountHistoryPublicRecord.js";
+interface AccountHistorySearchPublicResponse {
+    /**
+     * List of records
+     */
+    records?: AccountHistoryPublicRecord[];
+    /**
+     */
+    paging?: AccountHistoryPaging;
+}
+export default AccountHistorySearchPublicResponse;

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

@@ -0,0 +1,48 @@
+import type PostalAddress from "./PostalAddress.js";
+import type ServiceInfoV2 from "./ServiceInfoV2.js";
+import type SystemUserContactInfo from "./SystemUserContactInfo.js";
+interface AccountInfo {
+    /**
+     * Internal identifier of RingCentral account
+     * Required
+     * Example: 8000012345
+     */
+    id?: string;
+    /**
+     * External account ID. Used as a primary key to link accounts between
+     *  RingCentral and partner systems.
+     * Example: acme-us-12345
+     */
+    externalAccountId?: string;
+    /**
+     * Phone number in e.164 format (with '+' prefix)
+     * Example: +16501234567
+     */
+    mainNumber?: string;
+    /**
+     * Status of an account
+     * Required
+     */
+    status?: "Initial" | "Unconfirmed" | "Confirmed" | "Disabled";
+    /**
+     * Company name
+     * Example: Acme Inc.
+     */
+    companyName?: string;
+    /**
+     */
+    companyAddress?: PostalAddress;
+    /**
+     * Required
+     */
+    serviceInfo?: ServiceInfoV2;
+    /**
+     */
+    contactInfo?: SystemUserContactInfo;
+    /**
+     * Opportunity identifier (typically created by SalesForce)
+     * Example: 0061800000DwZzJAAV
+     */
+    opportunityId?: string;
+}
+export default AccountInfo;

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

@@ -0,0 +1,13 @@
+interface AccountLanguageInfoRequest {
+    /**
+     * Internal identifier of a language set as regional
+     * Required
+     */
+    id?: string;
+    /**
+     * Localization code of a language set as regional
+     * Required
+     */
+    localeCode?: string;
+}
+export default AccountLanguageInfoRequest;

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

@@ -0,0 +1,44 @@
+/**
+ * Limits which are effective for the account
+ */
+interface AccountLimitsInfo {
+    /**
+     * Max number of free softphone phone lines per user extension
+     * Format: int32
+     */
+    freeSoftPhoneLinesPerExtension?: number;
+    /**
+     * Max number of participants in RingCentral meeting hosted by
+     *  this account's user
+     * Format: int32
+     */
+    meetingSize?: number;
+    /**
+     * Meetings recording cloud storage limitation in Gb
+     * Format: int32
+     */
+    cloudRecordingStorage?: number;
+    /**
+     * Max number of extensions which can be included in the list
+     *  of users monitored for Presence
+     * Format: int32
+     */
+    maxMonitoredExtensionsPerUser?: number;
+    /**
+     * Max length of extension numbers of an account; the supported
+     *  value is up to 8 symbols, depends on account type
+     * Format: int32
+     */
+    maxExtensionNumberLength?: number;
+    /**
+     * Length of a site code
+     * Format: int32
+     */
+    siteCodeLength?: number;
+    /**
+     * Length of a short extension number
+     * Format: int32
+     */
+    shortExtensionNumberLength?: number;
+}
+export default AccountLimitsInfo;

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

@@ -0,0 +1,32 @@
+/**
+ * Operator extension information. This extension will receive
+ * all calls and messages addressed to an operator.
+ *
+ */
+interface AccountOperatorInfo {
+    /**
+     * Link to an operator extension resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Internal identifier of an operator extension
+     * Format: int64
+     */
+    id?: number;
+    /**
+     * Number of an operator extension
+     */
+    extensionNumber?: string;
+    /**
+     * Internal identifier of an extension created by partner. Supported for Partner Applications.
+     *  The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension
+     *  ID for each partner ID of a client application. In request URIs partner IDs are accepted instead
+     *  of regular RingCentral native IDs as path parameters using `pid=XXX` clause.
+     *  Though in response URIs contain the corresponding account IDs and extension
+     *  IDs. In all request and response bodies these values are reflected via
+     *  partnerId attributes of account and extension
+     */
+    partnerId?: string;
+}
+export default AccountOperatorInfo;

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

@@ -0,0 +1,68 @@
+import type AccountPhoneNumberInfoExtension from "./AccountPhoneNumberInfoExtension.js";
+import type ContactCenterProvider from "./ContactCenterProvider.js";
+interface AccountPhoneNumberInfo {
+    /**
+     * Phone number activation status. Determine whether phone number migration is completed on the partner side.
+     */
+    activationStatus?: "Active" | "Inactive";
+    /**
+     * Internal unique identifier of a phone number
+     * Required
+     * Example: 1162820004
+     */
+    id?: string;
+    /**
+     * Phone number in e.164 format (with '+' prefix)
+     * Required
+     * Example: +16501234567
+     */
+    phoneNumber?: string;
+    /**
+     * Type of a phone number
+     */
+    type?: "VoiceFax" | "VoiceOnly" | "FaxOnly";
+    /**
+     * Indicates if a number is toll or toll-free
+     * Required
+     * Example: Toll
+     */
+    tollType?: "Toll" | "TollFree";
+    /**
+     * Usage type of a phone number
+     * Required
+     */
+    usageType?: "MainCompanyNumber" | "DirectNumber" | "Inventory" | "InventoryPartnerBusinessMobileNumber" | "InventoryFmcBusinessMobileNumber" | "PartnerBusinessMobileNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "PhoneLine" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "MeetingsNumber" | "NumberStorage" | "BusinessMobileNumber" | "FmcBusinessMobileNumber" | "ELIN" | "InventoryMobileNumber";
+    /**
+     */
+    byocNumber?: boolean;
+    /**
+     */
+    mobileNumber?: boolean;
+    /**
+     * Indicates whether the phone number belongs to a Hot Desk device if applicable.
+     */
+    hotDeskNumber?: boolean;
+    /**
+     */
+    contactCenterProvider?: ContactCenterProvider;
+    /**
+     * 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
+     * Required
+     */
+    status?: "Normal" | "Pending" | "PortedIn" | "Temporary" | "Unknown";
+    /**
+     * Caller ID Name
+     */
+    callerIdName?: string;
+    /**
+     * Reference to the extension this number is assigned to. Omitted for company numbers
+     */
+    extension?: AccountPhoneNumberInfoExtension;
+    /**
+     * Internal identifier of a phone provider
+     */
+    providerId?: string;
+}
+export default AccountPhoneNumberInfo;