@rc-ex/core 1.3.12 → 1.3.14

package/src/paths/Ai/Text/V1/Async/Punctuate/index.ts

@@ -15,7 +15,7 @@ class Index {
     return `${this._parent.path()}/punctuate`;
   }
   /**
-   * Returns Smart Punctuation to the provided webhook uri.
+   * Returns Smart Punctuation to the provided webhook URI.
    * HTTP Method: post
    * Endpoint: /ai/text/v1/async/punctuate
    * Rate Limit Group: Heavy

package/src/paths/Ai/Text/V1/Async/Summarize/index.ts

@@ -15,7 +15,9 @@ class Index {
     return `${this._parent.path()}/summarize`;
   }
   /**
-   * Returns Conversational Summarization to webhook uri for segmented transcript of audios with start,end,speakerId, text(alphanumeric and punctuations).
+   * Returns Conversational Summarization to the webhook URI for segmented transcript of audios
+   * with start, end, speakerId, text(alphanumeric and punctuations).
+   *
    * HTTP Method: post
    * Endpoint: /ai/text/v1/async/summarize
    * Rate Limit Group: Heavy

package/src/paths/Cx/SocialMessaging/V1/Identities/index.ts

@@ -1,6 +1,3 @@
-import Deanonymize from './Deanonymize';
-import Anonymize from './Anonymize';
-import Import from './Import';
 import type SocMsgListIdentitiesParameters from '../../../../../definitions/SocMsgListIdentitiesParameters';
 import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../../types';
 
@@ -59,17 +56,5 @@ class Index {
     const r = await this.rc.get<string>(this.path(), undefined, restRequestConfig);
     return r.data;
   }
-
-  public import(): Import {
-    return new Import(this);
-  }
-
-  public anonymize(): Anonymize {
-    return new Anonymize(this);
-  }
-
-  public deanonymize(): Deanonymize {
-    return new Deanonymize(this);
-  }
 }
 export default Index;

package/src/paths/Restapi/Account/A2pSms/OptOuts/index.ts

@@ -15,7 +15,10 @@ class Index {
     return `${this._parent.path()}/opt-outs`;
   }
   /**
-   * Returns the list of numbers opted out from the account. The list can be filtered by `to`/`from` phone number query parameters. Specifying `text/csv` in the Accept header downloads the data in CSV format.
+   * Returns the list of numbers opted out from the account. The list
+   * can be filtered by `to`/`from` phone number query parameters. Specifying `text/csv`
+   * in the `Accept` header lets download the data in the CSV format.
+   *
    * HTTP Method: get
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/a2p-sms/opt-outs
    * Rate Limit Group: Light

package/src/paths/Restapi/Account/EmergencyLocations/index.ts

@@ -1,7 +1,8 @@
 import type DeleteEmergencyLocationParameters from '../../../../definitions/DeleteEmergencyLocationParameters';
-import type ReadEmergencyLocationParameters from '../../../../definitions/ReadEmergencyLocationParameters';
 import type CommonEmergencyLocationResource from '../../../../definitions/CommonEmergencyLocationResource';
-import type EmergencyLocationInfoRequest from '../../../../definitions/EmergencyLocationInfoRequest';
+import type ReadEmergencyLocationParameters from '../../../../definitions/ReadEmergencyLocationParameters';
+import type EmergencyLocationResponseResource from '../../../../definitions/EmergencyLocationResponseResource';
+import type EmergencyLocationRequestResource from '../../../../definitions/EmergencyLocationRequestResource';
 import type EmergencyLocationsResource from '../../../../definitions/EmergencyLocationsResource';
 import type ListEmergencyLocationsParameters from '../../../../definitions/ListEmergencyLocationsParameters';
 import type { RingCentralInterface, ParentInterface, RestRequestConfig } from '../../../../types';
@@ -47,12 +48,12 @@ class Index {
    * User Permission: ConfigureEmergencyMaps
    */
   public async post(
-    emergencyLocationInfoRequest: EmergencyLocationInfoRequest,
+    emergencyLocationRequestResource: EmergencyLocationRequestResource,
     restRequestConfig?: RestRequestConfig,
-  ): Promise<CommonEmergencyLocationResource> {
-    const r = await this.rc.post<CommonEmergencyLocationResource>(
+  ): Promise<EmergencyLocationResponseResource> {
+    const r = await this.rc.post<EmergencyLocationResponseResource>(
       this.path(false),
-      emergencyLocationInfoRequest,
+      emergencyLocationRequestResource,
       undefined,
       restRequestConfig,
     );
@@ -87,15 +88,15 @@ class Index {
    * User Permission: ConfigureEmergencyMaps
    */
   public async put(
-    emergencyLocationInfoRequest: EmergencyLocationInfoRequest,
+    emergencyLocationRequestResource: EmergencyLocationRequestResource,
     restRequestConfig?: RestRequestConfig,
-  ): Promise<CommonEmergencyLocationResource> {
+  ): Promise<EmergencyLocationResponseResource> {
     if (this.locationId === null) {
       throw new Error('locationId must be specified.');
     }
-    const r = await this.rc.put<CommonEmergencyLocationResource>(
+    const r = await this.rc.put<EmergencyLocationResponseResource>(
       this.path(),
-      emergencyLocationInfoRequest,
+      emergencyLocationRequestResource,
       undefined,
       restRequestConfig,
     );

package/src/paths/Restapi/Account/Extension/AssignedRole/index.ts

@@ -20,7 +20,7 @@ class Index {
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/assigned-role
    * Rate Limit Group: Light
    * App Permission: ReadAccounts
-   * User Permission: ReadExtensions
+   * User Permission: ReadAssignedRoles
    */
   public async get(
     queryParams?: ListUserAssignedRolesParameters,

package/src/paths/Restapi/Account/Extension/EmergencyLocations/index.ts

@@ -1,6 +1,7 @@
 import type DeleteExtensionEmergencyLocationParameters from '../../../../../definitions/DeleteExtensionEmergencyLocationParameters';
-import type EmergencyLocationInfoRequest from '../../../../../definitions/EmergencyLocationInfoRequest';
+import type EmergencyLocationRequestResource from '../../../../../definitions/EmergencyLocationRequestResource';
 import type CommonEmergencyLocationResource from '../../../../../definitions/CommonEmergencyLocationResource';
+import type EmergencyLocationResponseResource from '../../../../../definitions/EmergencyLocationResponseResource';
 import type CreateUserEmergencyLocationRequest from '../../../../../definitions/CreateUserEmergencyLocationRequest';
 import type EmergencyLocationsResource from '../../../../../definitions/EmergencyLocationsResource';
 import type GetExtensionEmergencyLocationsParameters from '../../../../../definitions/GetExtensionEmergencyLocationsParameters';
@@ -48,8 +49,8 @@ class Index {
   public async post(
     createUserEmergencyLocationRequest: CreateUserEmergencyLocationRequest,
     restRequestConfig?: RestRequestConfig,
-  ): Promise<CommonEmergencyLocationResource> {
-    const r = await this.rc.post<CommonEmergencyLocationResource>(
+  ): Promise<EmergencyLocationResponseResource> {
+    const r = await this.rc.post<EmergencyLocationResponseResource>(
       this.path(false),
       createUserEmergencyLocationRequest,
       undefined,
@@ -83,15 +84,15 @@ class Index {
    * User Permission: EmergencyFramework
    */
   public async put(
-    emergencyLocationInfoRequest: EmergencyLocationInfoRequest,
+    emergencyLocationRequestResource: EmergencyLocationRequestResource,
     restRequestConfig?: RestRequestConfig,
-  ): Promise<CommonEmergencyLocationResource> {
+  ): Promise<EmergencyLocationResponseResource> {
     if (this.locationId === null) {
       throw new Error('locationId must be specified.');
     }
-    const r = await this.rc.put<CommonEmergencyLocationResource>(
+    const r = await this.rc.put<EmergencyLocationResponseResource>(
       this.path(),
-      emergencyLocationInfoRequest,
+      emergencyLocationRequestResource,
       undefined,
       restRequestConfig,
     );

package/src/paths/Restapi/Account/Extension/Features/index.ts

@@ -14,23 +14,23 @@ class Index {
     return `${this._parent.path()}/features`;
   }
   /**
-   * Returns a list of supported features and information on their
-   * availability for the current extension. Specific feature(s) might
+   * Returns a list of supported features and the information on their
+   * availability for the current extension. Particular feature(s) can
    * be checked by providing `featureId` query parameter. Multiple values
    * are supported in the format: `?featureId=Feature1&featureId=Feature2`.
    * To get only available features in order to decrease response size,
-   * `availableOnly=true` query param might be specified. In case a feature
+   * `availableOnly=true` query param can be specified. If a feature
    * is available for the current user, `"available": true` is returned in
    * response for the record with the corresponding feature ID. Otherwise,
-   * additional attribute `reason` is returned with the appropriate code:
+   * the additional attribute `reason` is returned with the appropriate code:
    * - `ServicePlanLimitation` -  a feature is not included in account service plan;
    * - `AccountLimitation` - a feature is turned off for account;
    * - `ExtensionTypeLimitation` - a feature is not applicable for extension type;
    * - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required;
-   * - `InsufficientPermissions` - required permission not granted to the current user (not the one, who is specified in the URL, but the one who's access token is used);
+   * - `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.
    *
-   * Also, some features may have additional parameters, e.g., limits, which are returned in `params` attribute as a name-value collection:
+   * Also, some features may have additional parameters, e.g. limits, which are returned in `params` attribute as a name-value collection:
    *
    *     {
    *       "id": "HUD",

package/src/paths/Restapi/Account/Extension/MessageStore/index.ts

@@ -81,8 +81,8 @@ class Index {
   }
 
   /**
-   * Updates message(s) by their ID(s). Currently only message read status
-   * can be updated through this method.
+   * Updates message(s) by their ID(s). Currently, only the `readStatus`
+   * can be updated using this method.
    *
    * Bulk syntax is supported, max number of IDs passed as query/path
    * parameters is 50. Alternative bulk syntax is also supported - user messages can be updated
@@ -138,7 +138,7 @@ class Index {
   }
 
   /**
-   * Patches message(s) by ID(s). Currently only message read status update and
+   * Patches message(s) by ID(s). Currently, only updating the `readStatus` and
    * restoring deleted messages are supported through this method.
    *
    * For changing status of a message send `readStatus` set to either 'Read' or 'Unread' in request.

package/src/paths/Restapi/Account/Extension/OverflowSettings/index.ts

@@ -28,7 +28,6 @@ class Index {
 
   /**
    * Updates overflow settings for a call queue specified in path.
-   *
    * HTTP Method: put
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{callQueueId}/overflow-settings
    * Rate Limit Group: Heavy

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

@@ -14,7 +14,12 @@ class Index {
     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.
+   * 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 the one conference call
+   * using his/her own party IDs from both sessions."
+   *
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/bridge
    * Rate Limit Group: Light

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

@@ -14,7 +14,11 @@ class Index {
     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.
+   * 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 the `Conference` origin only.
+   *
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/bring-in
    * Rate Limit Group: Light

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

@@ -14,7 +14,7 @@ class Index {
     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.
+   * 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 un-hold both endpoints to remove Hold Music and bring media back.
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold
    * Rate Limit Group: Light

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

@@ -13,7 +13,7 @@ class Index {
     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.
+   * 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
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park
    * Rate Limit Group: Light

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

@@ -14,7 +14,17 @@ class Index {
     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.
+   * 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 devices
+   * only, since device IDs for WebRTC/Mobile apps cannot be obtained.
+   *
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/supervise
    * Rate Limit Group: Light

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

@@ -13,7 +13,7 @@ class Index {
     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.
+   * 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 un-hold both endpoints to remove Hold Music and bring media back.
    * HTTP Method: post
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/unhold
    * Rate Limit Group: Light

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

@@ -14,7 +14,7 @@ class Index {
     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.
+   * Allows monitoring 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
    * Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise
    * Rate Limit Group: Light

package/src/paths/Webinar/Configuration/V1/Webinars/index.ts

@@ -102,7 +102,7 @@ class Index {
 
   /**
    * Updates a Webinar. The payload may contain just changed fields of a Webinar resource (it is a partial update):
-   * - host cannot be changed and host user information cannot be updated;
+   * - host cannot be changed, and host user information cannot be updated;
    * - only the settings which are not mandated at account level or are unlocked can be
    * changed;
    * - in order to reset a webinar password it should be passed as an empty string;

package/src/paths/Webinar/Notifications/V1/Subscriptions/index.ts

@@ -69,7 +69,7 @@ class Index {
    * Updates the existing subscription. The client application can extend/narrow
    * the list of events for which it receives notifications within this subscription.
    * If event filters are specified, calling this method modifies them for the
-   * existing subscription. The method also allows to set the subscription expiration time.
+   * existing subscription. The method also allows setting the subscription expiration time.
    * If other than `events` and `expiresIn` parameters are passed in the request they will be ignored.
    * If the request body is empty then the specified subscription will be just renewed without any
    * event filter modifications and with default expiration time.