@rc-ex/core 1.3.4 → 1.3.6

package/src/paths/Restapi/Subscription/index.ts

@@ -7,9 +7,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public subscriptionId: string | null;
 
   public constructor(_parent: ParentInterface, subscriptionId: string | null = null) {
@@ -17,14 +15,12 @@ class Index {
     this.rc = _parent.rc;
     this.subscriptionId = subscriptionId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.subscriptionId !== null) {
       return `${this._parent.path()}/subscription/${this.subscriptionId}`;
     }
     return `${this._parent.path()}/subscription`;
   }
-
   /**
    * Returns a list of subscriptions created by the user for the current authorized client application.
    *
@@ -141,7 +137,7 @@ class Index {
     if (this.subscriptionId === null) {
       throw new Error('subscriptionId must be specified.');
     }
-    const r = await this.rc.delete<string>(this.path(), undefined, restRequestConfig);
+    const r = await this.rc.delete<string>(this.path(), undefined, undefined, restRequestConfig);
     return r.data;
   }
 

package/src/paths/Restapi/V2/Accounts/BatchProvisioning/Users/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/users`;
   }
-
   /**
    * Creates multiple user extensions with BYOD (customer provided) devices.
    * If "extensionNumber" is not specified, the next available extension number will be assigned.

package/src/paths/Restapi/V2/Accounts/BatchProvisioning/index.ts

@@ -3,14 +3,12 @@ import type { RingCentralInterface, ParentInterface } from '../../../../../types
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/batch-provisioning`;
   }

package/src/paths/Restapi/V2/Accounts/DeviceInventory/index.ts

@@ -6,18 +6,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/device-inventory`;
   }
-
   /**
    * Adds an existing phone (customer provided device - BYOD) as an unassigned device to the account inventory.
    * HTTP Method: post

package/src/paths/Restapi/V2/Accounts/Devices/BulkAdd/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/bulk-add`;
   }
-
   /**
    * Adds multiple BYOD (customer provided) devices to an account.
    * HTTP Method: post

package/src/paths/Restapi/V2/Accounts/Devices/index.ts

@@ -1,19 +1,48 @@
 import BulkAdd from './BulkAdd';
-import type { RingCentralInterface, ParentInterface } from '../../../../../types';
+import type RemoveLineResponse from '../../../../../definitions/RemoveLineResponse';
+import type RemoveLineRequest from '../../../../../definitions/RemoveLineRequest';
+import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
+  public deviceId: string | null;
 
-  public constructor(_parent: ParentInterface) {
+  public constructor(_parent: ParentInterface, deviceId: string | null = null) {
     this._parent = _parent;
     this.rc = _parent.rc;
+    this.deviceId = deviceId;
   }
-
-  public path(): string {
+  public path(withParameter = true): string {
+    if (withParameter && this.deviceId !== null) {
+      return `${this._parent.path()}/devices/${this.deviceId}`;
+    }
     return `${this._parent.path()}/devices`;
   }
+  /**
+   * Disassociates phone line (DL & Device) from an extension.
+   *  - if value ```keepAssetsInInventory == true```,
+   * the given device is moved to unassigned devices and the number is moved to the number inventory;
+   *  - if value ```keepAssetsInInventory == false```, the given device and number is removed from the account;
+   *  - if the parameter keepAssetsInInventory is not set (empty body),
+   * default value ```keepAssetsInInventory == true``` is used.
+   *
+   * HTTP Method: delete
+   * Endpoint: /restapi/v2/accounts/{accountId}/devices/{deviceId}
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: EditAccountDevices
+   */
+  public async delete(
+    removeLineRequest: RemoveLineRequest,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<RemoveLineResponse> {
+    if (this.deviceId === null) {
+      throw new Error('deviceId must be specified.');
+    }
+    const r = await this.rc.delete<RemoveLineResponse>(this.path(), removeLineRequest, undefined, restRequestConfig);
+    return r.data;
+  }
 
   public bulkAdd(): BulkAdd {
     return new BulkAdd(this);

package/src/paths/Restapi/V2/Accounts/Extensions/Devices/Replace/index.ts

@@ -3,18 +3,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/replace`;
   }
-
   /**
    * Replaces the user device with another device, which is assigned to an extension or is stored in the inventory of the same account.
    * Currently the following device types can be swapped - HardPhone and OtherPhone.

package/src/paths/Restapi/V2/Accounts/Extensions/Devices/index.ts

@@ -3,9 +3,7 @@ import type { RingCentralInterface, ParentInterface } from '../../../../../../ty
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public deviceId: string | null;
 
   public constructor(_parent: ParentInterface, deviceId: string | null = null) {
@@ -13,7 +11,6 @@ class Index {
     this.rc = _parent.rc;
     this.deviceId = deviceId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.deviceId !== null) {
       return `${this._parent.path()}/devices/${this.deviceId}`;

package/src/paths/Restapi/V2/Accounts/Extensions/index.ts

@@ -5,21 +5,19 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/extensions`;
   }
-
   /**
    * 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

package/src/paths/Restapi/V2/Accounts/Licenses/BulkAssign/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/bulk-assign`;
   }
-
   /**
    * Assigns/unassigns multiple account licenses in bulk
    * HTTP Method: post

package/src/paths/Restapi/V2/Accounts/Licenses/index.ts

@@ -1,41 +1,18 @@
 import BulkAssign from './BulkAssign';
-import type LicensesStatisticsResponse from '../../../../../definitions/LicensesStatisticsResponse';
-import type ListLicensesV2Parameters from '../../../../../definitions/ListLicensesV2Parameters';
-import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+import type { RingCentralInterface, ParentInterface } from '../../../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/licenses`;
   }
 
-  /**
-   * Returns the information about account licenses.
-   * License blocks are grouped by "skuId", "assigned" flag and "costCenterId".
-   * Only recurring licenses are returned.
-   *
-   * HTTP Method: get
-   * Endpoint: /restapi/v2/accounts/{accountId}/licenses
-   * Rate Limit Group: Light
-   * App Permission: ReadAccounts
-   * User Permission: LicensesAndInventory
-   */
-  public async get(
-    queryParams?: ListLicensesV2Parameters,
-    restRequestConfig?: RestRequestConfig,
-  ): Promise<LicensesStatisticsResponse> {
-    const r = await this.rc.get<LicensesStatisticsResponse>(this.path(), queryParams, restRequestConfig);
-    return r.data;
-  }
-
   public bulkAssign(): BulkAssign {
     return new BulkAssign(this);
   }

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/BulkAdd/index.ts

@@ -5,9 +5,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public taskId: string | null;
 
   public constructor(_parent: ParentInterface, taskId: string | null = null) {
@@ -15,14 +13,12 @@ class Index {
     this.rc = _parent.rc;
     this.taskId = taskId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.taskId !== null) {
       return `${this._parent.path()}/bulk-add/${this.taskId}`;
     }
     return `${this._parent.path()}/bulk-add`;
   }
-
   /**
    * Adds phone numbers to the account Inventory as unassigned. Currently we support the following three enum values: 'Inventory',
    * 'InventoryPartnerBusinessMobileNumber' and 'PartnerBusinessMobileNumber'. Later we may support some other values like 'ForwardedNumber', etc.

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/Replace/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/replace`;
   }
-
   /**
    * Replaces (swaps) phone numbers from Inventory with the main, company, direct or company fax numbers.
    * This method is used to replace temporary numbers when the porting process is complete.

package/src/paths/Restapi/V2/Accounts/PhoneNumbers/index.ts

@@ -10,9 +10,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public phoneNumberId: string | null;
 
   public constructor(_parent: ParentInterface, phoneNumberId: string | null = null) {
@@ -20,14 +18,12 @@ class Index {
     this.rc = _parent.rc;
     this.phoneNumberId = phoneNumberId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.phoneNumberId !== null) {
       return `${this._parent.path()}/phone-numbers/${this.phoneNumberId}`;
     }
     return `${this._parent.path()}/phone-numbers`;
   }
-
   /**
    * Returns the list of phone numbers assigned to RingCentral customer
    * account. Both company-level and extension-level numbers are returned.

package/src/paths/Restapi/V2/Accounts/SendActivationEmail/index.ts

@@ -2,18 +2,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/send-activation-email`;
   }
-
   /**
    * Sends/resends activation email to the system user of unconfirmed account.
    * HTTP Method: post
@@ -23,7 +20,7 @@ class Index {
    * User Permission: AccountAdministration
    */
   public async post(restRequestConfig?: RestRequestConfig): Promise<string> {
-    const r = await this.rc.post<string>(this.path(), undefined, restRequestConfig);
+    const r = await this.rc.post<string>(this.path(), undefined, undefined, restRequestConfig);
     return r.data;
   }
 }

package/src/paths/Restapi/V2/Accounts/SendWelcomeEmail/index.ts

@@ -3,18 +3,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/send-welcome-email`;
   }
-
   /**
    * Sends/resends welcome email to the system user of confirmed account
    * HTTP Method: post

package/src/paths/Restapi/V2/Accounts/index.ts

@@ -11,9 +11,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public accountId: string | null;
 
   public constructor(_parent: ParentInterface, accountId: string | null = '~') {
@@ -21,14 +19,12 @@ class Index {
     this.rc = _parent.rc;
     this.accountId = accountId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.accountId !== null) {
       return `${this._parent.path()}/accounts/${this.accountId}`;
     }
     return `${this._parent.path()}/accounts`;
   }
-
   /**
    * Returns basic information about particular RingCentral account
    * HTTP Method: get
@@ -45,8 +41,8 @@ class Index {
     return r.data;
   }
 
-  public devices(): Devices {
-    return new Devices(this);
+  public devices(deviceId: string | null = null): Devices {
+    return new Devices(this, deviceId);
   }
 
   public licenses(): Licenses {

package/src/paths/Restapi/V2/index.ts

@@ -3,14 +3,12 @@ import type { RingCentralInterface, ParentInterface } from '../../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path(false)}/v2`;
   }

package/src/paths/Restapi/index.ts

@@ -11,21 +11,18 @@ import type { RingCentralInterface, RestRequestConfig } from '../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public apiVersion: string | null;
 
   public constructor(rc: RingCentralInterface, apiVersion: string | null = 'v1.0') {
     this.rc = rc;
     this.apiVersion = apiVersion;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.apiVersion !== null) {
       return `/restapi/${this.apiVersion}`;
     }
     return '/restapi';
   }
-
   /**
    * Returns current API version(s) and server info.
    * HTTP Method: get

package/src/paths/Scim/ResourceTypes/index.ts

@@ -4,9 +4,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public type: string | null;
 
   public constructor(_parent: ParentInterface, type: string | null = null) {
@@ -14,14 +12,12 @@ class Index {
     this.rc = _parent.rc;
     this.type = type;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.type !== null) {
       return `${this._parent.path()}/ResourceTypes/${this.type}`;
     }
     return `${this._parent.path()}/ResourceTypes`;
   }
-
   /**
    * Returns the list of supported SCIM resource types
    * HTTP Method: get

package/src/paths/Scim/Schemas/index.ts

@@ -4,9 +4,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public uri: string | null;
 
   public constructor(_parent: ParentInterface, uri: string | null = null) {
@@ -14,14 +12,12 @@ class Index {
     this.rc = _parent.rc;
     this.uri = uri;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.uri !== null) {
       return `${this._parent.path()}/Schemas/${this.uri}`;
     }
     return `${this._parent.path()}/Schemas`;
   }
-
   /**
    * Returns the list of schemas
    * HTTP Method: get

package/src/paths/Scim/ServiceProviderConfig/index.ts

@@ -3,18 +3,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/ServiceProviderConfig`;
   }
-
   /**
    * Returns SCIM service provider configuration
    * HTTP Method: get

package/src/paths/Scim/Users/DotSearch/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/.search`;
   }
-
   /**
    * Returns the list of users satisfying search criteria
    * HTTP Method: post

package/src/paths/Scim/Users/index.ts

@@ -8,9 +8,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public scimUserId: string | null;
 
   public constructor(_parent: ParentInterface, scimUserId: string | null = null) {
@@ -18,14 +16,12 @@ class Index {
     this.rc = _parent.rc;
     this.scimUserId = scimUserId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.scimUserId !== null) {
       return `${this._parent.path()}/Users/${this.scimUserId}`;
     }
     return `${this._parent.path()}/Users`;
   }
-
   /**
    * Returns the list of users satisfying search criteria
    * HTTP Method: get
@@ -94,7 +90,7 @@ class Index {
     if (this.scimUserId === null) {
       throw new Error('scimUserId must be specified.');
     }
-    const r = await this.rc.delete<string>(this.path(), undefined, restRequestConfig);
+    const r = await this.rc.delete<string>(this.path(), undefined, undefined, restRequestConfig);
     return r.data;
   }
 

package/src/paths/Scim/index.ts

@@ -6,14 +6,12 @@ import type { RingCentralInterface } from '../../types';
 
 class Index {
   public rc: RingCentralInterface;
-
   public version: string | null;
 
   public constructor(rc: RingCentralInterface, version: string | null = 'v2') {
     this.rc = rc;
     this.version = version;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.version !== null) {
       return `/scim/${this.version}`;

package/src/paths/TeamMessaging/V1/AdaptiveCards/index.ts

@@ -5,9 +5,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
-
   public cardId: string | null;
 
   public constructor(_parent: ParentInterface, cardId: string | null = null) {
@@ -15,14 +13,12 @@ class Index {
     this.rc = _parent.rc;
     this.cardId = cardId;
   }
-
   public path(withParameter = true): string {
     if (withParameter && this.cardId !== null) {
       return `${this._parent.path()}/adaptive-cards/${this.cardId}`;
     }
     return `${this._parent.path()}/adaptive-cards`;
   }
-
   /**
    * Returns adaptive card(s) with given id(s).
    * HTTP Method: get
@@ -67,7 +63,7 @@ class Index {
     if (this.cardId === null) {
       throw new Error('cardId must be specified.');
     }
-    const r = await this.rc.delete<string>(this.path(), undefined, restRequestConfig);
+    const r = await this.rc.delete<string>(this.path(), undefined, undefined, restRequestConfig);
     return r.data;
   }
 }

package/src/paths/TeamMessaging/V1/Chats/AdaptiveCards/index.ts

@@ -4,18 +4,15 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 
 class Index {
   public rc: RingCentralInterface;
-
   public _parent: ParentInterface;
 
   public constructor(_parent: ParentInterface) {
     this._parent = _parent;
     this.rc = _parent.rc;
   }
-
   public path(): string {
     return `${this._parent.path()}/adaptive-cards`;
   }
-
   /**
    * Creates a new adaptive card in the chat specified in path.
    * HTTP Method: post