@rc-ex/core 1.6.16 → 1.6.17

package/dist/esm/definitions/SearchDirectoryEntriesParameters.d.ts

@@ -8,29 +8,25 @@ interface SearchDirectoryEntriesParameters {
      */
     accessibleSitesOnly?: boolean;
     /**
-     * A list of Account IDs
-     * Example: 400131426008
+     * A list of Account IDs. Deprecated, use the appropriate body field 'accountIds' instead.
      */
-    accountId?: string;
+    accountId?: string[];
     /**
-     * A list of department names
+     * Department name. Deprecated, use the appropriate body field 'department' instead.
      * Example: North office
      */
     department?: string;
     /**
-     * A list of Site IDs
-     * Example: 872781797006
+     * A list of Site IDs. Deprecated, use the appropriate body field 'siteIds' instead.
      */
-    siteId?: string;
+    siteId?: string[];
     /**
-     * Extension current state
-     * Example: Enabled
+     * List of extension current statuses. Deprecated, use the appropriate body field 'extensionStatuses' instead.
      */
-    extensionStatus?: string;
+    extensionStatus?: string[];
     /**
-     * Type of extension to filter the contacts
-     * Example: User
+     * Types of extension to filter the contacts
      */
-    extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "ProxyAdmin" | "DelegatedLinesGroup" | "FlexibleUser" | "GroupCallPickup" | "RoomConnector";
+    extensionType?: ("User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "IvrMenu" | "ApplicationExtension" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "ProxyAdmin" | "DelegatedLinesGroup" | "FlexibleUser" | "GroupCallPickup" | "RoomConnector")[];
 }
 export default SearchDirectoryEntriesParameters;

package/dist/esm/definitions/ShortSiteInfo.d.ts

@@ -1,6 +1,7 @@
 interface ShortSiteInfo {
     /**
      * Internal identifier of a site extension
+     * Example: main-site
      */
     id?: string;
     /**

package/dist/esm/definitions/SmsBrandInfo.d.ts

@@ -0,0 +1,14 @@
+import ApiError from "./ApiError.js";
+interface SmsBrandInfo {
+    /**
+     * Identifier of the associated TCR brand
+     */
+    id?: string;
+    /**
+     * Status of the associated TCR campaign
+     */
+    status?: "Created" | "Submitted" | "Confirmed" | "SubmitFailed" | "UpdateRequested" | "DeleteRequested" | "CampaignSuspended" | "CampaignExpired" | "Draft" | "PreVetFailed" | "Unconfirmed";
+    /** */
+    errors?: ApiError[];
+}
+export default SmsBrandInfo;

package/dist/esm/definitions/SmsBrandInfo.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/SmsCampaignInfo.d.ts

@@ -0,0 +1,22 @@
+import ApiError from "./ApiError.js";
+interface SmsCampaignInfo {
+    /**
+     * Identifier of the associated TCR campaign
+     */
+    id?: string;
+    /**
+     * Status of the associated TCR campaign
+     */
+    status?: "Created" | "Submitted" | "Confirmed" | "SubmitFailed" | "UpdateRequested" | "DeleteRequested" | "CampaignSuspended" | "CampaignExpired" | "Draft" | "PreVetFailed" | "Unconfirmed";
+    /**
+     * Use case of the associated TCR campaign
+     */
+    registrationTier?: string;
+    /**
+     * List of sub use cases of the associated TCR campaign
+     */
+    useCases?: string[];
+    /** */
+    errors?: ApiError[];
+}
+export default SmsCampaignInfo;

package/dist/esm/definitions/SmsCampaignInfo.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/SmsConfigurationResource.d.ts

@@ -0,0 +1,18 @@
+import SmsCampaignInfo from "./SmsCampaignInfo.js";
+import SmsBrandInfo from "./SmsBrandInfo.js";
+interface SmsConfigurationResource {
+    /**
+     * Internal identifier of a phone number
+     */
+    phoneNumberId?: string;
+    /**
+     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format
+     * Example: +18661234567
+     */
+    phoneNumber?: string;
+    /** */
+    smsCampaignInfo?: SmsCampaignInfo;
+    /** */
+    smsBrandInfo?: SmsBrandInfo;
+}
+export default SmsConfigurationResource;

package/dist/esm/definitions/SmsConfigurationResource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/definitions/SyncAccountCallLogParameters.d.ts

@@ -53,5 +53,10 @@ interface SyncAccountCallLogParameters {
      *  If omitted, then calls with and without recordings are returned
      */
     recordingType?: "Automatic" | "OnDemand" | "All";
+    /**
+     * Category of metadata to be returned. If omitted, all call records are returned.
+     *  Multiple values are supported
+     */
+    metadataCategory?: string[];
 }
 export default SyncAccountCallLogParameters;

package/dist/esm/definitions/SyncMessagesParameters.d.ts

@@ -54,10 +54,21 @@ interface SyncMessagesParameters {
      */
     syncType?: "FSync" | "ISync";
     /**
-     * Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
+     * Deprecated. Filters voicemail messages based on the owner extension. Supported if the 'SharedVoicemail'
      *  feature is enabled.
      * Default: Personal
      */
     voicemailOwner?: string[];
+    /**
+     * Filters shared messages based on the owner extension. Supported if the 'SharedVoicemail' or 'CallQueueSmsRecipient'
+     *  feature is enabled.
+     * Default: Personal
+     */
+    owner?: string[];
+    /**
+     * Filters shared messages based on the owner extension type. Supported if "SharedVoicemail" or "CallQueueSmsRecipient"
+     *  feature is enabled.
+     */
+    ownerExtensionType?: ("User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser")[];
 }
 export default SyncMessagesParameters;

package/dist/esm/definitions/SyncUserCallLogParameters.d.ts

@@ -52,5 +52,10 @@ interface SyncUserCallLogParameters {
      *  If omitted, then calls with and without recordings are returned
      */
     recordingType?: "Automatic" | "OnDemand" | "All";
+    /**
+     * Category of metadata to be returned. If omitted, all call records are returned.
+     *  Multiple values are supported
+     */
+    metadataCategory?: string[];
 }
 export default SyncUserCallLogParameters;

package/dist/esm/definitions/UserPhoneNumberInfo.d.ts

@@ -54,9 +54,10 @@ interface UserPhoneNumberInfo {
      */
     subType?: "VideoPro" | "VideoProPlus" | "DigitalSignage" | "Unknown" | "Emergency";
     /**
-     * Usage type of phone number. Numbers of 'NumberPool' type will not be returned for phone number list requests
+     * Usage type of a phone number. Numbers of 'NumberPool' and 'NumberStorage' type are not returned in
+     *  phone number list requests
      */
-    usageType?: "MainCompanyNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "DirectNumber" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "NumberPool" | "BusinessMobileNumber" | "PartnerBusinessMobileNumber" | "IntegrationNumber";
+    usageType?: "MainCompanyNumber" | "AdditionalCompanyNumber" | "CompanyNumber" | "DirectNumber" | "CompanyFaxNumber" | "ForwardedNumber" | "ForwardedCompanyNumber" | "ContactCenterNumber" | "ConferencingNumber" | "MeetingsNumber" | "NumberPool" | "NumberStorage" | "BusinessMobileNumber" | "PartnerBusinessMobileNumber" | "IntegrationNumber";
     /**
      * List of features of a phone number
      */

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.d.ts

@@ -0,0 +1,18 @@
+import GetSessionInsightsResponse from "../../../../../../../../../definitions/GetSessionInsightsResponse.js";
+import GetSessionInsightsParameters from "../../../../../../../../../definitions/GetSessionInsightsParameters.js";
+import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../../../../../types.js";
+declare class Index {
+    rc: RingCentralInterface;
+    _parent: ParentInterface;
+    constructor(_parent: ParentInterface);
+    path(): string;
+    /**
+     * Returns the insights of all call recordings in a session
+     * HTTP Method: get
+     * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/sessions/{sourceSessionId}/insights
+     * Rate Limit Group: Light
+     * App Permission: RingSense
+     */
+    get(queryParams?: GetSessionInsightsParameters, restRequestConfig?: RestRequestConfig): Promise<GetSessionInsightsResponse>;
+}
+export default Index;

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/Insights/index.js

@@ -0,0 +1,23 @@
+class Index {
+    rc;
+    _parent;
+    constructor(_parent) {
+        this._parent = _parent;
+        this.rc = _parent.rc;
+    }
+    path() {
+        return `${this._parent.path()}/insights`;
+    }
+    /**
+     * Returns the insights of all call recordings in a session
+     * HTTP Method: get
+     * Endpoint: /ai/ringsense/v1/public/accounts/{accountId}/domains/{domain}/sessions/{sourceSessionId}/insights
+     * Rate Limit Group: Light
+     * App Permission: RingSense
+     */
+    async get(queryParams, restRequestConfig) {
+        const r = await this.rc.get(this.path(), queryParams, restRequestConfig);
+        return r.data;
+    }
+}
+export default Index;

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.d.ts

@@ -0,0 +1,11 @@
+import Insights from "./Insights/index.js";
+import { ParentInterface, RingCentralInterface } from "../../../../../../../../types.js";
+declare class Index {
+    rc: RingCentralInterface;
+    _parent: ParentInterface;
+    sourceSessionId: string | null;
+    constructor(_parent: ParentInterface, sourceSessionId?: string | null);
+    path(withParameter?: boolean): string;
+    insights(): Insights;
+}
+export default Index;

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/Sessions/index.js

@@ -0,0 +1,21 @@
+import Insights from "./Insights/index.js";
+class Index {
+    rc;
+    _parent;
+    sourceSessionId;
+    constructor(_parent, sourceSessionId = null) {
+        this._parent = _parent;
+        this.rc = _parent.rc;
+        this.sourceSessionId = sourceSessionId;
+    }
+    path(withParameter = true) {
+        if (withParameter && this.sourceSessionId !== null) {
+            return `${this._parent.path()}/sessions/${this.sourceSessionId}`;
+        }
+        return `${this._parent.path()}/sessions`;
+    }
+    insights() {
+        return new Insights(this);
+    }
+}
+export default Index;

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.d.ts

@@ -1,3 +1,4 @@
+import Sessions from "./Sessions/index.js";
 import Records from "./Records/index.js";
 import { ParentInterface, RingCentralInterface } from "../../../../../../../types.js";
 declare class Index {
@@ -7,5 +8,6 @@ declare class Index {
     constructor(_parent: ParentInterface, domain?: string | null);
     path(withParameter?: boolean): string;
     records(sourceRecordId?: string | null): Records;
+    sessions(sourceSessionId?: string | null): Sessions;
 }
 export default Index;

package/dist/esm/paths/Ai/Ringsense/V1/Public/Accounts/Domains/index.js

@@ -1,3 +1,4 @@
+import Sessions from "./Sessions/index.js";
 import Records from "./Records/index.js";
 class Index {
     rc;
@@ -17,5 +18,8 @@ class Index {
     records(sourceRecordId = null) {
         return new Records(this, sourceRecordId);
     }
+    sessions(sourceSessionId = null) {
+        return new Sessions(this, sourceSessionId);
+    }
 }
 export default Index;

package/dist/esm/paths/Restapi/Account/Extension/Features/index.d.ts

@@ -22,6 +22,7 @@ declare class Index {
      * - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required;
      * - `InsufficientPermissions` - required permission is not granted to the current user (not the one, who is specified in the URL, but the one who is calling this API);
      * - `ConfigurationLimitation` - a feature is turned off for extension, e.g., by account administrator.
+     * - `PermissionLimitation` - a feature is unavailable due to a specific permission this extension has.
      *
      * Also, some features may have additional parameters, e.g. limits, which are returned in `params` attribute as a name-value collection:
      *

package/dist/esm/paths/Restapi/Account/Extension/Features/index.js

@@ -24,6 +24,7 @@ class Index {
      * - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required;
      * - `InsufficientPermissions` - required permission is not granted to the current user (not the one, who is specified in the URL, but the one who is calling this API);
      * - `ConfigurationLimitation` - a feature is turned off for extension, e.g., by account administrator.
+     * - `PermissionLimitation` - a feature is unavailable due to a specific permission this extension has.
      *
      * Also, some features may have additional parameters, e.g. limits, which are returned in `params` attribute as a name-value collection:
      *

package/dist/esm/paths/Restapi/Account/Extension/Grant/index.d.ts

@@ -7,9 +7,8 @@ declare class Index {
     constructor(_parent: ParentInterface);
     path(): string;
     /**
-     * Returns the list of extensions with information on grants
-     * given to the current extension regarding them. Currently the list of grants
-     * include: picking up a call, monitoring, calling or receiving a call on behalf
+     * Returns a list of extensions including information on grants given to the current extension towards them.
+     * Currently the list of grants includes: picking up a call, call monitoring, calling or receiving a call on behalf
      * of somebody, call delegation and calling paging groups.
      *
      * HTTP Method: get

package/dist/esm/paths/Restapi/Account/Extension/Grant/index.js

@@ -9,9 +9,8 @@ class Index {
         return `${this._parent.path()}/grant`;
     }
     /**
-     * Returns the list of extensions with information on grants
-     * given to the current extension regarding them. Currently the list of grants
-     * include: picking up a call, monitoring, calling or receiving a call on behalf
+     * Returns a list of extensions including information on grants given to the current extension towards them.
+     * Currently the list of grants includes: picking up a call, call monitoring, calling or receiving a call on behalf
      * of somebody, call delegation and calling paging groups.
      *
      * HTTP Method: get

package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.d.ts

@@ -0,0 +1,18 @@
+import SmsConfigurationResource from "../../../../../../definitions/SmsConfigurationResource.js";
+import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../../types.js";
+declare class Index {
+    rc: RingCentralInterface;
+    _parent: ParentInterface;
+    constructor(_parent: ParentInterface);
+    path(): string;
+    /**
+     * Returns SMS configuration for the specified phone number of the extension.
+     *
+     * HTTP Method: get
+     * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number/{phoneNumberId}/sms-configuration
+     * Rate Limit Group: Light
+     * App Permission: ReadAccounts
+     */
+    get(restRequestConfig?: RestRequestConfig): Promise<SmsConfigurationResource>;
+}
+export default Index;

package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/SmsConfiguration/index.js

@@ -0,0 +1,24 @@
+class Index {
+    rc;
+    _parent;
+    constructor(_parent) {
+        this._parent = _parent;
+        this.rc = _parent.rc;
+    }
+    path() {
+        return `${this._parent.path()}/sms-configuration`;
+    }
+    /**
+     * Returns SMS configuration for the specified phone number of the extension.
+     *
+     * HTTP Method: get
+     * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/phone-number/{phoneNumberId}/sms-configuration
+     * Rate Limit Group: Light
+     * App Permission: ReadAccounts
+     */
+    async get(restRequestConfig) {
+        const r = await this.rc.get(this.path(), undefined, restRequestConfig);
+        return r.data;
+    }
+}
+export default Index;

package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/index.d.ts

@@ -1,3 +1,4 @@
+import SmsConfiguration from "./SmsConfiguration/index.js";
 import GetExtensionPhoneNumbersResponse from "../../../../../definitions/GetExtensionPhoneNumbersResponse.js";
 import ListExtensionPhoneNumbersParameters from "../../../../../definitions/ListExtensionPhoneNumbersParameters.js";
 import { ParentInterface, RestRequestConfig, RingCentralInterface } from "../../../../../types.js";
@@ -20,5 +21,6 @@ declare class Index {
      * User Permission: ReadUserPhoneNumbers
      */
     get(queryParams?: ListExtensionPhoneNumbersParameters, restRequestConfig?: RestRequestConfig): Promise<GetExtensionPhoneNumbersResponse>;
+    smsConfiguration(): SmsConfiguration;
 }
 export default Index;

package/dist/esm/paths/Restapi/Account/Extension/PhoneNumber/index.js

@@ -1,3 +1,4 @@
+import SmsConfiguration from "./SmsConfiguration/index.js";
 class Index {
     rc;
     _parent;
@@ -25,5 +26,8 @@ class Index {
         const r = await this.rc.get(this.path(), queryParams, restRequestConfig);
         return r.data;
     }
+    smsConfiguration() {
+        return new SmsConfiguration(this);
+    }
 }
 export default Index;

package/dist/esm/paths/Restapi/V2/Accounts/Extensions/index.d.ts

@@ -12,8 +12,6 @@ declare class Index {
      * Deletes user extension(s) and either keeps or destroys the assets - numbers and devices.
      * Multiple extensions can be deleted with a single API call.
      *
-     * **Please note:** This API cannot be tested on Sandbox.
-     *
      * HTTP Method: delete
      * Endpoint: /restapi/v2/accounts/{accountId}/extensions
      * Rate Limit Group: Heavy

package/dist/esm/paths/Restapi/V2/Accounts/Extensions/index.js

@@ -14,8 +14,6 @@ class Index {
      * Deletes user extension(s) and either keeps or destroys the assets - numbers and devices.
      * Multiple extensions can be deleted with a single API call.
      *
-     * **Please note:** This API cannot be tested on Sandbox.
-     *
      * HTTP Method: delete
      * Endpoint: /restapi/v2/accounts/{accountId}/extensions
      * Rate Limit Group: Heavy

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rc-ex/core",
-  "version": "1.6.16",
+  "version": "1.6.17",
   "description": "Core for ringcentral-extensible project",
   "author": "Tyler Liu <tyler.liu@ringcentral.com>",
   "homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/core",
@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "@types/qs": "^6.9.18",
-    "axios": "^1.7.9",
+    "axios": "^1.8.3",
     "qs": "^6.14.0"
   },
   "devDependencies": {
@@ -50,5 +50,5 @@
   "scripts": {
     "build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json"
   },
-  "gitHead": "1ded64e887920a6e6a27bc3a2173ecf3cd1d50f9"
+  "gitHead": "45a55ad7b1ed4a4d9d64a179f97952f20942863a"
 }

package/dist/cjs/definitions/VoicemailOwnerResource.d.ts

@@ -1,14 +0,0 @@
-/**
- * Voicemail owner information. Supported for shared voicemail messages only
- */
-interface VoicemailOwnerResource {
-    /**
-     * Name of a voicemail owner
-     */
-    name?: string;
-    /**
-     * Internal identifier of an extension
-     */
-    extensionId?: string;
-}
-export default VoicemailOwnerResource;

package/dist/esm/definitions/VoicemailOwnerResource.d.ts

@@ -1,14 +0,0 @@
-/**
- * Voicemail owner information. Supported for shared voicemail messages only
- */
-interface VoicemailOwnerResource {
-    /**
-     * Name of a voicemail owner
-     */
-    name?: string;
-    /**
-     * Internal identifier of an extension
-     */
-    extensionId?: string;
-}
-export default VoicemailOwnerResource;