npm - @rc-ex/core - Versions diffs - 1.3.4 → 1.3.5 - Mend

@rc-ex/core 1.3.4 → 1.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (832) hide show

package/src/paths/Restapi/Account/Sites/index.ts CHANGED Viewed

@@ -9,9 +9,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public siteId: string | null;
   public constructor(_parent: ParentInterface, siteId: string | null = null) {
@@ -19,14 +17,12 @@ class Index {
     this.rc = _parent.rc;
     this.siteId = siteId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.siteId !== null) {
       return `${this._parent.path()}/sites/${this.siteId}`;
     }
     return `${this._parent.path()}/sites`;
   }
   /**
    * Returns a list of sites for the specified account.
    *

package/src/paths/Restapi/Account/Telephony/CallOut/index.ts CHANGED Viewed

@@ -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()}/call-out`;
   }
   /**
    * Creates a new outbound call out session. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Conference/index.ts CHANGED Viewed

@@ -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()}/conference`;
   }
   /**
    * Initiates a conference call session.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Answer/index.ts CHANGED Viewed

@@ -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()}/answer`;
   }
   /**
    * Answers a call on a certain device by passing the corresponding device ID in request body. Supported for call forwarding, call transfer, call flip and call queues.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Bridge/index.ts CHANGED Viewed

@@ -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()}/bridge`;
   }
   /**
    * Allows the user to connect multiple call session participants over a conference call bridge. The current active call session ID and party ID of the user within this session should be specified in path; the bridged call session ID and party ID of the user within that session should be specified in request body. Thus the user connects participants of two sessions into one conference call using his/her own party IDs from both sessions.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/BringIn/index.ts CHANGED Viewed

@@ -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()}/bring-in`;
   }
   /**
    * Adds a new party to the call session by bringing-in an established SIP call connection. The maximum number of parties to bring-in is 10; only 1 call party can be added per request. Currently the method is supported for sessions of 'Conference' origin only.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Flip/index.ts CHANGED Viewed

@@ -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()}/flip`;
   }
   /**
    * Performs call flip procedure by holding opposite party and calling to the specified target
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Forward/index.ts CHANGED Viewed

@@ -1,21 +1,18 @@
-import type CallParty from '../../../../../../../definitions/CallParty';
+import type ForwardCallPartyResponse from '../../../../../../../definitions/ForwardCallPartyResponse';
 import type ForwardTarget from '../../../../../../../definitions/ForwardTarget';
 import type { 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(): string {
     return `${this._parent.path()}/forward`;
   }
   /**
    * Forwards a non-answered incoming call to the specified call party. Applicable for a call session in "Setup" or "Proceeding" state.
    * HTTP Method: post
@@ -23,8 +20,11 @@ class Index {
    * Rate Limit Group: Light
    * App Permission: CallControl
    */
-  public async post(forwardTarget: ForwardTarget, restRequestConfig?: RestRequestConfig): Promise<CallParty> {
-    const r = await this.rc.post<CallParty>(this.path(), forwardTarget, undefined, restRequestConfig);
+  public async post(
+    forwardTarget: ForwardTarget,
+    restRequestConfig?: RestRequestConfig,
+  ): Promise<ForwardCallPartyResponse> {
+    const r = await this.rc.post<ForwardCallPartyResponse>(this.path(), forwardTarget, undefined, restRequestConfig);
     return r.data;
   }
 }

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Hold/index.ts CHANGED Viewed

@@ -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()}/hold`;
   }
   /**
    * Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Ignore/index.ts CHANGED Viewed

@@ -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()}/ignore`;
   }
   /**
    * Ignores a call to a call queue agent in `Setup` or `Proceeding` state.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Park/index.ts CHANGED Viewed

@@ -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()}/park`;
   }
   /**
    * Parks a call to a virtual location from where it can further be retrieved by any user from any phone of the system. The call session and call party identifiers should be specified in path. Currently the users can park only their own incoming calls. Up to 50 calls can be parked simultaneously. Park location starts with asterisk (*) and ranges 801-899.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Pickup/index.ts CHANGED Viewed

@@ -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()}/pickup`;
   }
   /**
    * Picks up a call parked to the specified park location.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Recordings/index.ts CHANGED Viewed

@@ -5,9 +5,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public recordingId: string | null;
   public constructor(_parent: ParentInterface, recordingId: string | null = null) {
@@ -15,14 +13,12 @@ class Index {
     this.rc = _parent.rc;
     this.recordingId = recordingId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.recordingId !== null) {
       return `${this._parent.path()}/recordings/${this.recordingId}`;
     }
     return `${this._parent.path()}/recordings`;
   }
   /**
    * Starts a new call recording for the party
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Reject/index.ts CHANGED Viewed

@@ -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()}/reject`;
   }
   /**
    * Rejects an inbound call in a "Setup" or "Proceeding" state
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Reply/index.ts CHANGED Viewed

@@ -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()}/reply`;
   }
   /**
    * Replies with text/pattern without picking up a call.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Supervise/index.ts CHANGED Viewed

@@ -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()}/supervise`;
   }
   /**
    * Allows to monitor a call party in 'Listen' mode. Input parameters are extension number of a monitored user and internal identifier of a supervisor's device. Call session and party identifiers should be specified in path. Please note that for this method dual channel audio flow is supported, which means that you need to make one more request for monitoring the second participant of a call. And as a result of each monitoring request the client receives SIP invite with the following header `p-rc-api-monitoring-ids` containing IDs of the monitored party and session. The flow is supported for calls with no more than 2 participants. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Transfer/index.ts CHANGED Viewed

@@ -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()}/transfer`;
   }
   /**
    * Transfers an answered call to the specified call party. Applicable for a call session in "Answered" or "Hold" state.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/Unhold/index.ts CHANGED Viewed

@@ -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()}/unhold`;
   }
   /**
    * Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/Parties/index.ts CHANGED Viewed

@@ -19,9 +19,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public partyId: string | null;
   public constructor(_parent: ParentInterface, partyId: string | null = null) {
@@ -29,14 +27,12 @@ class Index {
     this.rc = _parent.rc;
     this.partyId = partyId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.partyId !== null) {
       return `${this._parent.path()}/parties/${this.partyId}`;
     }
     return `${this._parent.path()}/parties`;
   }
   /**
    * Returns a call party status by ID.
    * HTTP Method: get

package/src/paths/Restapi/Account/Telephony/Sessions/Supervise/index.ts CHANGED Viewed

@@ -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()}/supervise`;
   }
   /**
    * Allows to monitor a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.
    * HTTP Method: post

package/src/paths/Restapi/Account/Telephony/Sessions/index.ts CHANGED Viewed

@@ -6,9 +6,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public telephonySessionId: string | null;
   public constructor(_parent: ParentInterface, telephonySessionId: string | null = null) {
@@ -16,14 +14,12 @@ class Index {
     this.rc = _parent.rc;
     this.telephonySessionId = telephonySessionId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.telephonySessionId !== null) {
       return `${this._parent.path()}/sessions/${this.telephonySessionId}`;
     }
     return `${this._parent.path()}/sessions`;
   }
   /**
    * Returns the status of a call session by ID.
    * HTTP Method: get

package/src/paths/Restapi/Account/Telephony/index.ts CHANGED Viewed

@@ -5,14 +5,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()}/telephony`;
   }

package/src/paths/Restapi/Account/Templates/index.ts CHANGED Viewed

@@ -5,9 +5,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public templateId: string | null;
   public constructor(_parent: ParentInterface, templateId: string | null = null) {
@@ -15,14 +13,12 @@ class Index {
     this.rc = _parent.rc;
     this.templateId = templateId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.templateId !== null) {
       return `${this._parent.path()}/templates/${this.templateId}`;
     }
     return `${this._parent.path()}/templates`;
   }
   /**
    * Returns the list of user templates for the current account.
    *

package/src/paths/Restapi/Account/UserRole/BulkAssign/index.ts CHANGED Viewed

@@ -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()}/bulk-assign`;
   }
   /**
    * Assigns multiple user roles.
    * HTTP Method: post

package/src/paths/Restapi/Account/UserRole/Default/index.ts CHANGED Viewed

@@ -1,20 +1,18 @@
 import type DefaultUserRoleRequest from '../../../../../definitions/DefaultUserRoleRequest';
+import type DefaultUserRole from '../../../../../definitions/DefaultUserRole';
 import type { 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(): string {
     return `${this._parent.path()}/default`;
   }
   /**
    * Returns the default user role of the current account.
    * HTTP Method: get
@@ -23,8 +21,8 @@ class Index {
    * App Permission: RoleManagement
    * User Permission: Roles
    */
-  public async get(restRequestConfig?: RestRequestConfig): Promise<string> {
-    const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
+  public async get(restRequestConfig?: RestRequestConfig): Promise<DefaultUserRole> {
+    const r = await this.rc.get<DefaultUserRole>(this.path(), undefined, restRequestConfig);
     return r.data;
   }
@@ -39,8 +37,8 @@ class Index {
   public async put(
     defaultUserRoleRequest: DefaultUserRoleRequest,
     restRequestConfig?: RestRequestConfig,
-  ): Promise<string> {
-    const r = await this.rc.put<string>(this.path(), defaultUserRoleRequest, undefined, restRequestConfig);
+  ): Promise<DefaultUserRole> {
+    const r = await this.rc.put<DefaultUserRole>(this.path(), defaultUserRoleRequest, undefined, restRequestConfig);
     return r.data;
   }
 }

package/src/paths/Restapi/Account/UserRole/index.ts CHANGED Viewed

@@ -8,9 +8,7 @@ import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '.
 class Index {
   public rc: RingCentralInterface;
   public _parent: ParentInterface;
   public roleId: string | null;
   public constructor(_parent: ParentInterface, roleId: string | null = null) {
@@ -18,14 +16,12 @@ class Index {
     this.rc = _parent.rc;
     this.roleId = roleId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.roleId !== null) {
       return `${this._parent.path()}/user-role/${this.roleId}`;
     }
     return `${this._parent.path()}/user-role`;
   }
   /**
    * Returns a list of account user roles.
    * HTTP Method: get

package/src/paths/Restapi/Account/index.ts CHANGED Viewed

@@ -8,6 +8,7 @@ import EmergencyLocations from './EmergencyLocations';
 import PagingOnlyGroups from './PagingOnlyGroups';
 import ForwardAllCalls from './ForwardAllCalls';
 import BusinessAddress from './BusinessAddress';
+import CallRecordings from './CallRecordings';
 import CallRecording from './CallRecording';
 import BusinessHours from './BusinessHours';
 import AnsweringRule from './AnsweringRule';
@@ -38,9 +39,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 = '~') {
@@ -48,17 +47,14 @@ class Index {
     this.rc = _parent.rc;
     this.accountId = accountId;
   }
   public path(withParameter = true): string {
     if (withParameter && this.accountId !== null) {
       return `${this._parent.path()}/account/${this.accountId}`;
     }
     return `${this._parent.path()}/account`;
   }
   /**
-   * Returns basic information about a particular RingCentral
-   * customer account.
+   * Returns basic information about a particular RingCentral customer account.
    *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}
@@ -174,6 +170,10 @@ class Index {
     return new CallRecording(this);
   }
+  public callRecordings(): CallRecordings {
+    return new CallRecordings(this);
+  }
   public businessAddress(): BusinessAddress {
     return new BusinessAddress(this);
   }

package/src/paths/Restapi/ClientInfo/SipProvision/index.ts CHANGED Viewed

@@ -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()}/sip-provision`;
   }
   /**
    * Creates SIP registration of a device/application (WebPhone, Mobile, Softphone).
    *

package/src/paths/Restapi/ClientInfo/index.ts CHANGED Viewed

@@ -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()}/client-info`;
   }