@rc-ex/core 1.3.1 → 1.3.3

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

@@ -0,0 +1,22 @@
+import Users from './Users';
+import { 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(withParameter = false): string {
+    return `${this._parent.path()}/batch-provisioning`;
+  }
+
+  public users(): Users {
+    return new Users(this);
+  }
+}
+export default Index;

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

@@ -0,0 +1,47 @@
+import DeleteDeviceFromInventoryResponse from '../../../../../definitions/DeleteDeviceFromInventoryResponse';
+import DeleteDeviceFromInventoryRequest from '../../../../../definitions/DeleteDeviceFromInventoryRequest';
+import AddDeviceToInventoryResponse from '../../../../../definitions/AddDeviceToInventoryResponse';
+import AddDeviceToInventoryRequest from '../../../../../definitions/AddDeviceToInventoryRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): 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
+   * Endpoint: /restapi/v2/accounts/{accountId}/device-inventory
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   */
+  public async post(addDeviceToInventoryRequest: AddDeviceToInventoryRequest, restRequestConfig?: RestRequestConfig): Promise<AddDeviceToInventoryResponse> {
+    const r = await this.rc.post<AddDeviceToInventoryResponse>(this.path(), addDeviceToInventoryRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Deletes an existing unassigned (without digital line or phone number) device or multiple devices
+ * from the account inventory. It is possible to delete up to 10 devices per request.
+ *
+   * HTTP Method: delete
+   * Endpoint: /restapi/v2/accounts/{accountId}/device-inventory
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   */
+  public async delete(deleteDeviceFromInventoryRequest: DeleteDeviceFromInventoryRequest, restRequestConfig?: RestRequestConfig): Promise<DeleteDeviceFromInventoryResponse> {
+    const r = await this.rc.delete<DeleteDeviceFromInventoryResponse>(this.path(), deleteDeviceFromInventoryRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,32 @@
+import BulkAddDevicesResponse from '../../../../../../definitions/BulkAddDevicesResponse';
+import BulkAddDevicesRequest from '../../../../../../definitions/BulkAddDevicesRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/bulk-add`;
+  }
+
+  /**
+   * Adds BYOD devices to an account in bulk
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/devices/bulk-add
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   * User Permission: AddRemoveDevices
+   */
+  public async post(bulkAddDevicesRequest: BulkAddDevicesRequest, restRequestConfig?: RestRequestConfig): Promise<BulkAddDevicesResponse> {
+    const r = await this.rc.post<BulkAddDevicesResponse>(this.path(), bulkAddDevicesRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,22 @@
+import BulkAdd from './BulkAdd';
+import { 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(withParameter = false): string {
+    return `${this._parent.path()}/devices`;
+  }
+
+  public bulkAdd(): BulkAdd {
+    return new BulkAdd(this);
+  }
+}
+export default Index;

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

@@ -0,0 +1,37 @@
+import SwapDeviceRequest from '../../../../../../../definitions/SwapDeviceRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): 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.
+ * Please note:
+ *  - This method allows to replace a device itself, while a phone number, a digital Line and an emergency address associated with this device remain unchanged and will still work together in a chain with the replacement device.
+ *  - If a target device is from the inventory, then a source device will be moved to the inventory, and a target device will be assigned to the current extension.
+ *  - If a target device is currently assigned to another extension, then the devices will be just swapped.
+ *
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/extensions/{extensionId}/devices/{deviceId}/replace
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: EditUserDevices
+   */
+  public async post(swapDeviceRequest: SwapDeviceRequest, restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), swapDeviceRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,28 @@
+import Replace from './Replace';
+import { RingCentralInterface, ParentInterface } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public deviceId: string | null;
+
+  public constructor(_parent: ParentInterface, deviceId: string | null = null) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+    this.deviceId = deviceId;
+  }
+
+  public path(withParameter = true): string {
+    if (withParameter && this.deviceId !== null) {
+      return `${this._parent.path()}/devices/${this.deviceId}`;
+    }
+    return `${this._parent.path()}/devices`;
+  }
+
+  public replace(): Replace {
+    return new Replace(this);
+  }
+}
+export default Index;

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

@@ -0,0 +1,39 @@
+import Devices from './Devices';
+import BulkDeleteUsersResponse from '../../../../../definitions/BulkDeleteUsersResponse';
+import BulkDeleteUsersRequest from '../../../../../definitions/BulkDeleteUsersRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): 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.
+ *
+   * HTTP Method: delete
+   * Endpoint: /restapi/v2/accounts/{accountId}/extensions
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   * User Permission: Users
+   */
+  public async delete(bulkDeleteUsersRequest: BulkDeleteUsersRequest, restRequestConfig?: RestRequestConfig): Promise<BulkDeleteUsersResponse> {
+    const r = await this.rc.delete<BulkDeleteUsersResponse>(this.path(), bulkDeleteUsersRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  public devices(deviceId: (string | null) = null): Devices {
+    return new Devices(this, deviceId);
+  }
+}
+export default Index;

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

@@ -0,0 +1,51 @@
+import AddForwardedNumbersResponse from '../../../../../definitions/AddForwardedNumbersResponse';
+import AddForwardedNumbersRequest from '../../../../../definitions/AddForwardedNumbersRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/forwarded-numbers`;
+  }
+
+  /**
+   * Adds forwarded numbers to an account.
+ *
+ * **Flow #1. For Partners with their own number pool.**
+ *
+ * Adds forwarded (ported) phone number(s) in provisioned (activated) state,
+ * but the Partner is responsible for all further calls on behalf of this number from fraud perspective.
+ * If extension is specified in request body then the number will be added
+ * at extension level as `ForwardedNumber`. If extension is not specified in request,
+ * a number is assigned directly to an account as `ForwardedCompanyNumber`.
+ * A forwarded number can be used as an outbound caller ID.
+ * Once a number is finally ported it turns into ordinary (not forwarded) account/extension phone number.
+ *
+ * **Flow #2. For Partners with RingCentral-managed number pool.**
+ *
+ * Adds forwarded (ported) phone number(s) in non-activated state. A forwarded number should be activated
+ * via separated RC support flow.
+ * If extension is specified in request body then the number will be added
+ * at extension level as `ForwardedNumber`. If extension is not specified in request,
+ * a number is assigned directly to an account as `ForwardedCompanyNumber`.
+ *
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/forwarded-numbers
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async post(addForwardedNumbersRequest: AddForwardedNumbersRequest, restRequestConfig?: RestRequestConfig): Promise<AddForwardedNumbersResponse> {
+    const r = await this.rc.post<AddForwardedNumbersResponse>(this.path(), addForwardedNumbersRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,31 @@
+import BulkManageLicensesResponse from '../../../../../../definitions/BulkManageLicensesResponse';
+import BulkManageLicensesRequest from '../../../../../../definitions/BulkManageLicensesRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/bulk-assign`;
+  }
+
+  /**
+   * Assigns/unassigns multiple account licenses in bulk
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/licenses/bulk-assign
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   */
+  public async post(bulkManageLicensesRequest: BulkManageLicensesRequest, restRequestConfig?: RestRequestConfig): Promise<BulkManageLicensesResponse> {
+    const r = await this.rc.post<BulkManageLicensesResponse>(this.path(), bulkManageLicensesRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,40 @@
+import BulkAssign from './BulkAssign';
+import LicensesStatisticsResponse from '../../../../../definitions/LicensesStatisticsResponse';
+import ListLicensesV2Parameters from '../../../../../definitions/ListLicensesV2Parameters';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): 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);
+  }
+}
+export default Index;

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

@@ -0,0 +1,58 @@
+import GetBulkAddTaskResultsV2Response from '../../../../../../definitions/GetBulkAddTaskResultsV2Response';
+import AddPhoneNumbersResponse from '../../../../../../definitions/AddPhoneNumbersResponse';
+import AddPhoneNumbersRequest from '../../../../../../definitions/AddPhoneNumbersRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public taskId: string | null;
+
+  public constructor(_parent: ParentInterface, taskId: string | null = null) {
+    this._parent = _parent;
+    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.
+ * Only "Inventory" usageType is supported. Later we may support other values like "ForwardedNumber" etc.
+ *
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/bulk-add
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async post(addPhoneNumbersRequest: AddPhoneNumbersRequest, restRequestConfig?: RestRequestConfig): Promise<AddPhoneNumbersResponse> {
+    const r = await this.rc.post<AddPhoneNumbersResponse>(this.path(false), addPhoneNumbersRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Returns the result of asynchronous operation which added phone numbers to account inventory.
+ *
+   * HTTP Method: get
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/bulk-add/{taskId}
+   * Rate Limit Group: Heavy
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async get(restRequestConfig?: RestRequestConfig): Promise<GetBulkAddTaskResultsV2Response> {
+    if (this.taskId === null) {
+      throw new Error('taskId must be specified.');
+    }
+    const r = await this.rc.get<GetBulkAddTaskResultsV2Response>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,34 @@
+import AccountPhoneNumberInfo from '../../../../../../definitions/AccountPhoneNumberInfo';
+import ReplacePhoneNumberRequest from '../../../../../../definitions/ReplacePhoneNumberRequest';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/replace`;
+  }
+
+  /**
+   * Replaces (swaps) phone numbers from inventory to main, company, direct or company fax numbers.
+ * Used to replace temporary numbers when porting process is complete.
+ *
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}/replace
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async post(replacePhoneNumberRequest: ReplacePhoneNumberRequest, restRequestConfig?: RestRequestConfig): Promise<AccountPhoneNumberInfo> {
+    const r = await this.rc.post<AccountPhoneNumberInfo>(this.path(), replacePhoneNumberRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,98 @@
+import BulkAdd from './BulkAdd';
+import Replace from './Replace';
+import AccountPhoneNumberInfo from '../../../../../definitions/AccountPhoneNumberInfo';
+import AssignPhoneNumberRequest from '../../../../../definitions/AssignPhoneNumberRequest';
+import DeletePhoneNumbersResponse from '../../../../../definitions/DeletePhoneNumbersResponse';
+import DeletePhoneNumbersRequest from '../../../../../definitions/DeletePhoneNumbersRequest';
+import AccountPhoneNumberList from '../../../../../definitions/AccountPhoneNumberList';
+import ListAccountPhoneNumbersV2Parameters from '../../../../../definitions/ListAccountPhoneNumbersV2Parameters';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public phoneNumberId: string | null;
+
+  public constructor(_parent: ParentInterface, phoneNumberId: string | null = null) {
+    this._parent = _parent;
+    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.
+ * Conferencing numbers, hot desk and ELIN numbers are not returned.
+ *
+   * HTTP Method: get
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers
+   * Rate Limit Group: Heavy
+   * App Permission: ReadAccounts
+   * User Permission: ReadCompanyPhoneNumbers
+   */
+  public async get(queryParams?: ListAccountPhoneNumbersV2Parameters, restRequestConfig?: RestRequestConfig): Promise<AccountPhoneNumberList> {
+    const r = await this.rc.get<AccountPhoneNumberList>(this.path(false), queryParams, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Method can only delete numbers that have `"usageType": "Inventory"`.
+ * In other words, this method will not delete numbers which are in use on the account - extension direct numbers,
+ * main number, etc. It is possible to indicate phone numbers to be deleted using their IDs or exact string values
+ * in e.164 format. However the same lookup method (by ID or by value) must be used for all numbers within the same API call.
+ *
+   * HTTP Method: delete
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async delete(deletePhoneNumbersRequest: DeletePhoneNumbersRequest, restRequestConfig?: RestRequestConfig): Promise<DeletePhoneNumbersResponse> {
+    const r = await this.rc.delete<DeletePhoneNumbersResponse>(this.path(false), deletePhoneNumbersRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  /**
+   * Assigns or reassigns a phone number as a company or extension number.
+ *
+ * Assign scenarios supported:
+ * - from Inventory to company number
+ * - from Inventory to extension number.
+ *
+ * Reassign scenarios supported:
+ * - from extension to another extension
+ * - from extension to company number
+ * - from company number to extension.
+ *
+   * HTTP Method: patch
+   * Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: EditCompanyPhoneNumbers
+   */
+  public async patch(assignPhoneNumberRequest: AssignPhoneNumberRequest, restRequestConfig?: RestRequestConfig): Promise<AccountPhoneNumberInfo> {
+    if (this.phoneNumberId === null) {
+      throw new Error('phoneNumberId must be specified.');
+    }
+    const r = await this.rc.patch<AccountPhoneNumberInfo>(this.path(), assignPhoneNumberRequest, undefined, restRequestConfig);
+    return r.data;
+  }
+
+  public replace(): Replace {
+    return new Replace(this);
+  }
+
+  public bulkAdd(taskId: (string | null) = null): BulkAdd {
+    return new BulkAdd(this, taskId);
+  }
+}
+export default Index;

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

@@ -0,0 +1,30 @@
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/send-activation-email`;
+  }
+
+  /**
+   * Sends/resends activation email to the system user of unconfirmed account.
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/send-activation-email
+   * Rate Limit Group: Medium
+   * App Permission: EditAccounts
+   * User Permission: AccountAdministration
+   */
+  public async post(restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;

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

@@ -0,0 +1,31 @@
+import SendWelcomeEmailV2Request from '../../../../../definitions/SendWelcomeEmailV2Request';
+import { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
+
+class Index {
+  public rc: RingCentralInterface;
+
+  public _parent: ParentInterface;
+
+  public constructor(_parent: ParentInterface) {
+    this._parent = _parent;
+    this.rc = _parent.rc;
+  }
+
+  public path(withParameter = false): string {
+    return `${this._parent.path()}/send-welcome-email`;
+  }
+
+  /**
+   * Sends/resends welcome email to the system user of confirmed account
+   * HTTP Method: post
+   * Endpoint: /restapi/v2/accounts/{accountId}/send-welcome-email
+   * Rate Limit Group: Medium
+   * App Permission: EditExtensions
+   * User Permission: Users
+   */
+  public async post(sendWelcomeEmailV2Request: SendWelcomeEmailV2Request, restRequestConfig?: RestRequestConfig): Promise<string> {
+    const r = await this.rc.post<string>(this.path(), sendWelcomeEmailV2Request, undefined, restRequestConfig);
+    return r.data;
+  }
+}
+export default Index;