@rc-ex/core 1.3.12 → 1.3.14

package/lib/paths/Webinar/Configuration/V1/Webinars/index.d.ts

@@ -58,7 +58,7 @@ declare class Index {
     delete(restRequestConfig?: RestRequestConfig): Promise<string>;
     /**
      * 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/lib/paths/Webinar/Configuration/V1/Webinars/index.js

@@ -81,7 +81,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/lib/paths/Webinar/Notifications/V1/Subscriptions/index.d.ts

@@ -35,7 +35,7 @@ declare 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.

package/lib/paths/Webinar/Notifications/V1/Subscriptions/index.js

@@ -53,7 +53,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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rc-ex/core",
-  "version": "1.3.12",
+  "version": "1.3.14",
   "description": "Core for ringcentral-extensible project",
   "author": "Tyler Liu <tyler.liu@ringcentral.com>",
   "homepage": "https://github.com/ringcentral/ringcentral-extensible/tree/master/packages/core",
@@ -30,5 +30,5 @@
   "scripts": {
     "generate": "ts-node -r dotenv-override-true/config code-generator.ts"
   },
-  "gitHead": "ee58ff317cb8e6b16048911a95233d225e26d76c"
+  "gitHead": "4b1cbc48d8c68694e751697c41f6f383431a6921"
 }

package/src/Rest.ts

@@ -74,11 +74,7 @@ export default class Rest {
       ...config,
     };
     // /restapi/oauth/wstoken uses bearer token
-    if (
-      endpoint === '/restapi/oauth/token' ||
-      endpoint === '/restapi/oauth/revoke' ||
-      endpoint === '/restapi/oauth/initiate-otp'
-    ) {
+    if (endpoint === '/restapi/oauth/token' || endpoint === '/restapi/oauth/revoke') {
       if (this.clientSecret) {
         // basic token
         newConfig.auth = {

package/src/definitions/ContactBusinessAddressInfo.ts

@@ -1,32 +1,32 @@
 /**
- * Extension user business address. The default is
+ * User's business address. The default is
  * Company (Auto-Receptionist) settings
  *
  */
 interface ContactBusinessAddressInfo {
   /**
-   * Country name of an extension user company
+   * Country name of a user's company
    */
   country?: string;
 
   /**
-   * State/province name of an extension user company. Mandatory
+   * State/province name of a user's company. Mandatory
    *  for the USA, UK and Canada
    */
   state?: string;
 
   /**
-   * City name of an extension user company
+   * City name of a user's company
    */
   city?: string;
 
   /**
-   * Street address of an extension user company
+   * Street address of a user's company
    */
   street?: string;
 
   /**
-   * Zip code of an extension user company
+   * Zip code of a user's company
    */
   zip?: string;
 }

package/src/definitions/ContactInfo.ts

@@ -2,49 +2,48 @@ import type ContactBusinessAddressInfo from './ContactBusinessAddressInfo';
 import type PronouncedNameInfo from './PronouncedNameInfo';
 
 /**
- * Contact detailed information
+ * Detailed contact information
  */
 interface ContactInfo {
   /**
-   * For User extension type only. Extension user first name
+   * User's first name (for extensions of `User` type only)
    */
   firstName?: string;
 
   /**
-   * For User extension type only. Extension user last name
+   * For User extension type only. User's last name (for extensions of `User` type only)
    */
   lastName?: string;
 
   /**
-   * Extension user name (first name and last name)
+   * Extension name (for extensions of `User` type - concatenation of first and last name)
    */
   name?: string;
 
   /**
-   * Extension user company name
+   * User's company name
    */
   company?: string;
 
   /**
+   * User's job title
    */
   jobTitle?: string;
 
   /**
-   * Contact email of extension user
+   * User's contact email
    * Format: email
    */
   email?: string;
 
   /**
-   * Extension user contact phone number in
-   *  [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+   * User's contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
    *  (with '+' sign) format
    */
   businessPhone?: string;
 
   /**
-   * Extension user mobile (**non** Toll Free) phone number in
-   *  [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
+   * User's mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
    *  (with '+' sign) format
    */
   mobilePhone?: string;
@@ -54,8 +53,8 @@ interface ContactInfo {
   businessAddress?: ContactBusinessAddressInfo;
 
   /**
-   * If `true` then contact email is enabled as login name for this
-   *  user. Please note that email should be unique in this case.
+   * Indicates that the contact email is enabled as a login name for this
+   *  user. Please note that the email must be unique in this case.
    */
   emailAsLoginName?: boolean;
 
@@ -64,7 +63,7 @@ interface ContactInfo {
   pronouncedName?: PronouncedNameInfo;
 
   /**
-   * Extension user department, if any
+   * User's department name
    */
   department?: string;
 }

package/src/definitions/CreateFaxMessageRequest.ts

@@ -26,7 +26,8 @@ interface CreateFaxMessageRequest {
   sendTime?: string;
 
   /**
-   * ISO Code. e.g UK
+   * Alpha-2 ISO Code of a country
+   * Example: US
    */
   isoCode?: string;
 

package/src/definitions/CreateUserEmergencyLocationRequest.ts

@@ -11,6 +11,11 @@ interface CreateUserEmergencyLocationRequest {
    */
   addressFormatId?: string;
 
+  /**
+   * If 'true' address validation for non-us addresses is skipped
+   */
+  trusted?: boolean;
+
   /**
    */
   address?: CommonEmergencyLocationAddressInfo;

package/src/definitions/DepartmentInfo.ts

@@ -1,5 +1,5 @@
 /**
- * Please note that legacy 'Department' extension type corresponds to
+ * Please note that the `Department` extension type corresponds to
  * 'Call Queue' extensions in modern RingCentral product terminology
  *
  */
@@ -17,7 +17,7 @@ interface DepartmentInfo {
   uri?: string;
 
   /**
-   * Number of a department extension
+   * Short number of a department extension
    */
   extensionNumber?: string;
 }

package/src/definitions/DeviceResource.ts

@@ -83,9 +83,9 @@ interface DeviceResource {
   shipping?: ShippingInfo;
 
   /**
-   * Box billing identifier of a device. Applicable only for HardPhones.
+   * Box billing identifier of a device. Applicable only for devices of `HardPhone` type.
    *  It is an alternative way to identify the device to be ordered. Either
-   *  model structure, or boxBillingId  must be specified for HardPhone
+   *  `model` structure, or `boxBillingId` must be specified
    * Format: int64
    */
   boxBillingId?: number;
@@ -123,9 +123,9 @@ interface DeviceResource {
 
   /**
    * Pooling type of device:
-   *  - Host - a device with standalone paid phone line which can be linked to a soft client instance
-   *  - Guest - a device with a linked phone line
-   *  - None - a device without a phone line or with specific line (free, BLA, etc.)
+   *  - `Host` - device with a standalone paid phone line which can be linked to soft phone client instance;
+   *  - `Guest` - device with a linked phone line;
+   *  - `None` - device without a phone line or with a specific line (free, BLA, etc.)
    */
   linePooling?: 'Host' | 'Guest' | 'None';
 

package/src/definitions/EmergencyLocationRequestResource.ts

@@ -0,0 +1,52 @@
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
+import type ShortSiteInfo from './ShortSiteInfo';
+
+interface EmergencyLocationRequestResource {
+  /**
+   * Internal identifier of an emergency response location
+   */
+  id?: string;
+
+  /**
+   */
+  address?: CommonEmergencyLocationAddressInfo;
+
+  /**
+   * Emergency response location name
+   */
+  name?: string;
+
+  /**
+   */
+  site?: ShortSiteInfo;
+
+  /**
+   * Emergency address status
+   */
+  addressStatus?: 'Valid' | 'Invalid';
+
+  /**
+   * Status of an emergency response location usage.
+   */
+  usageStatus?: 'Active' | 'Inactive';
+
+  /**
+   * Address format ID
+   */
+  addressFormatId?: string;
+
+  /**
+   * Visibility of an emergency response location. If `Private`
+   *  is set, then a location is visible only for restricted number of users,
+   *  specified in `owners` array
+   * Default: Public
+   */
+  visibility?: 'Public';
+
+  /**
+   * If 'true' address validation for non-us addresses is skipped
+   */
+  trusted?: boolean;
+}
+
+export default EmergencyLocationRequestResource;

package/src/definitions/EmergencyLocationResponseResource.ts

@@ -0,0 +1,71 @@
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
+import type ShortSiteInfo from './ShortSiteInfo';
+import type LocationOwnerInfo from './LocationOwnerInfo';
+
+/**
+ * Company emergency response location details
+ */
+interface EmergencyLocationResponseResource {
+  /**
+   * Internal identifier of an emergency response location
+   */
+  id?: string;
+
+  /**
+   */
+  address?: CommonEmergencyLocationAddressInfo;
+
+  /**
+   * Emergency response location name
+   */
+  name?: string;
+
+  /**
+   */
+  site?: ShortSiteInfo;
+
+  /**
+   * Emergency address status
+   */
+  addressStatus?: 'Valid' | 'Invalid' | 'Provisioning';
+
+  /**
+   * Status of emergency response location usage.
+   */
+  usageStatus?: 'Active' | 'Inactive';
+
+  /**
+   * Resulting status of emergency address synchronization. Returned
+   *  if `syncEmergencyAddress` parameter is set to `true`
+   */
+  syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'ActivationProcess' | 'NotRequired' | 'Unsupported' | 'Failed';
+
+  /**
+   */
+  addressType?: 'LocationWithElins' | 'LocationWithEndpoint';
+
+  /**
+   * Visibility of an emergency response location. If `Private`
+   *  is set, then location is visible only for the restricted number of users,
+   *  specified in `owners` array
+   * Default: Public
+   */
+  visibility?: 'Private' | 'Public';
+
+  /**
+   * List of private location owners
+   */
+  owners?: LocationOwnerInfo[];
+
+  /**
+   * Address format ID
+   */
+  addressFormatId?: string;
+
+  /**
+   * If 'true' address validation for non-us addresses is skipped
+   */
+  trusted?: boolean;
+}
+
+export default EmergencyLocationResponseResource;

package/src/definitions/ExtensionBulkUpdateInfo.ts

@@ -46,6 +46,8 @@ interface ExtensionBulkUpdateInfo {
   regionalSettings?: ExtensionRegionalSettingRequest;
 
   /**
+   * Initial configuration wizard state
+   * Default: NotStarted
    */
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
 

package/src/definitions/ExtensionCreationRequest.ts

@@ -50,8 +50,7 @@ interface ExtensionCreationRequest {
   ivrPin?: string;
 
   /**
-   * Specifies extension configuration wizard state (web service
-   *  setup).
+   * Initial configuration wizard state
    * Default: NotStarted
    */
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';

package/src/definitions/ExtensionCreationResponse.ts

@@ -83,8 +83,8 @@ interface ExtensionCreationResponse {
   serviceFeatures?: ExtensionServiceFeatureInfo[];
 
   /**
-   * Specifies extension configuration wizard state (web service
-   *  setup). The default value is 'NotStarted'
+   * Initial configuration wizard state
+   * Default: NotStarted
    */
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
 

package/src/definitions/ExtensionUpdateRequest.ts

@@ -30,6 +30,8 @@ interface ExtensionUpdateRequest {
   regionalSettings?: ExtensionRegionalSettingRequest;
 
   /**
+   * Initial configuration wizard state
+   * Default: NotStarted
    */
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
 

package/src/definitions/GetAccountInfoResponse.ts

@@ -43,10 +43,9 @@ interface GetAccountInfoResponse {
   serviceInfo?: ServiceInfo;
 
   /**
-   * Specifies account configuration wizard state (web service setup)
-   * Default: NotStarted
+   * Initial configuration wizard state
    */
-  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
+  setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed' | 'Unknown';
 
   /**
    */

package/src/definitions/GetExtensionInfoResponse.ts

@@ -108,7 +108,7 @@ interface GetExtensionInfoResponse {
   serviceFeatures?: ExtensionServiceFeatureInfo[];
 
   /**
-   * Specifies extension configuration wizard state (web service setup)
+   * Initial configuration wizard state
    * Default: NotStarted
    */
   setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';

package/src/definitions/GrantInfo.ts

@@ -61,6 +61,11 @@ interface GrantInfo {
    */
   callQueueMessages?: boolean;
 
+  /**
+   * Specifies whether the current extension is granted *Forward All Calls (FAC)* permission
+   */
+  callQueueFacSetup?: boolean;
+
   /**
    * Specifies whether the user referenced in extension object is sharing voicemails
    *  with the current extension

package/src/definitions/MessageStoreConfiguration.ts

@@ -1,7 +1,7 @@
 interface MessageStoreConfiguration {
   /**
    * Retention policy setting, specifying how long to keep messages;
-   *  the supported value range is 7-90 days. Currently the retention period is supported for Fax and Voicemail messages only.
+   *  the supported value range is 7-90 days. Currently, the retention period is supported for `Fax` and `Voicemail` messages only.
    *  SMS messages are stored with no time limits
    * Maximum: 90
    * Minimum: 7

package/src/definitions/PauseResumeCallRecordingParameters.ts

@@ -3,7 +3,7 @@
  */
 interface PauseResumeCallRecordingParameters {
   /**
-   * Identifies a brand of a logged in user or a brand of a sign-up session
+   * Identifies a brand of a logged-in user or a brand of a sign-up session
    * Default: ~
    */
   brandId?: string;

package/src/definitions/PronouncedNameInfo.ts

@@ -2,16 +2,15 @@ import type PronouncedNamePromptInfo from './PronouncedNamePromptInfo';
 
 interface PronouncedNameInfo {
   /**
-   * Voice name type. 'Default' - default extension name; first
-   *  name and last name specified in user profile; 'TextToSpeech' - custom
-   *  text; user name spelled the way it sounds and specified by user; 'Recorded'
-   *  - custom audio, user name recorded in user's own voice (supported only
-   *  for extension retrieval)
+   * The method used to pronounce the user's name:
+   *  - `Default` - default extension name; first and last name specified in user's profile are pronounced using text-to-speech;
+   *  - `TextToSpeech` - custom text specified by a user  pronounced using text-to-speech;
+   *  - `Recorded` - custom audio uploaded by a user, the name recorded in user's own voice (supported only for extension retrieval).
    */
   type?: 'Default' | 'TextToSpeech' | 'Recorded';
 
   /**
-   * Custom text
+   * Custom text (for `TextToSpeech` type only)
    */
   text?: string;
 

package/src/definitions/ReadA2PSMSOptOutsParameters.ts

@@ -3,7 +3,8 @@
  */
 interface ReadA2PSMSOptOutsParameters {
   /**
-   * The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages. The asterisk value "*" means any number in `from` field
+   * The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.
+   *  The asterisk value "*" means any number in `from` field
    * Example: 15551234455
    */
   from?: string;

package/src/definitions/ReadCallSessionStatusParameters.ts

@@ -8,7 +8,8 @@ interface ReadCallSessionStatusParameters {
   timestamp?: string;
 
   /**
-   * The time frame of awaiting for a status change before sending the resulting one in response
+   * The time frame of awaiting for a status change before sending
+   *  the resulting one in response
    */
   timeout?: string;
 }

package/src/definitions/SipRegistrationDeviceInfo.ts

@@ -79,9 +79,7 @@ interface SipRegistrationDeviceInfo {
   phoneLines?: DevicePhoneLinesInfo[];
 
   /**
-   * Box billing identifier of a device. Applicable only for HardPhones.
-   *  It is an alternative way to identify the device to be ordered. Either
-   *  model  structure, or  boxBillingId  must be specified forT?HardPhone
+   * Box billing identifier of a device. Applicable only for devices of `HardPhone` type.
    * Format: int64
    */
   boxBillingId?: number;
@@ -93,10 +91,9 @@ interface SipRegistrationDeviceInfo {
 
   /**
    * Pooling type of device:
-   *  - `Host` - device with standalone paid
-   *    phone line which can be linked to soft phone client instance
-   *  - `Guest` - device with a linked phone line
-   *  - `None` - device without a phone line or with specific line (free, BLA, etc.)
+   *  - `Host` - device with a standalone paid phone line which can be linked to soft phone client instance;
+   *  - `Guest` - device with a linked phone line;
+   *  - `None` - device without a phone line or with a specific line (free, BLA, etc.)
    */
   linePooling?: 'Host' | 'Guest' | 'None';
 

package/src/definitions/SyncAccountCallLogParameters.ts

@@ -20,7 +20,10 @@ interface SyncAccountCallLogParameters {
   dateFrom?: string;
 
   /**
-   * For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync frame to the past, the maximum number of records is 250
+   * For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.
+   *
+   *  For `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past
+   *  (the maximum number of records is 250)
    * Minimum: 1
    * Format: int32
    */

package/src/definitions/SyncMessagesParameters.ts

@@ -51,7 +51,7 @@ interface SyncMessagesParameters {
   recordCount?: number;
 
   /**
-   * Value of syncToken property of last sync request response
+   * A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
    */
   syncToken?: string;
 

package/src/definitions/SyncUserCallLogParameters.ts

@@ -9,18 +9,23 @@ interface SyncUserCallLogParameters {
   syncType?: 'FSync' | 'ISync';
 
   /**
-   * Value of syncToken property of last sync request response. Mandatory parameter for 'ISync' sync type
+   * A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)
    */
   syncToken?: string;
 
   /**
-   * The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment
+   * The start datetime for resulting records in ISO 8601 format including
+   *  timezone, for example 2016-03-10T18:07:52.534Z. The default value is the
+   *  current moment
    * Format: date-time
    */
   dateFrom?: string;
 
   /**
-   * For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250
+   * For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.
+   *
+   *  For `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past
+   *  (the maximum number of records is 250)
    * Format: int32
    */
   recordCount?: number;

package/src/definitions/TokenInfo.ts

@@ -54,7 +54,7 @@ interface TokenInfo {
   endpoint_id?: string;
 
   /**
-   * OIDC ID token (if OpenId Connect flow was activated during authorization)
+   * OIDC ID token (if OpenID Connect flow was activated during authorization)
    */
   id_token?: string;
 
@@ -64,13 +64,13 @@ interface TokenInfo {
   session_id?: string;
 
   /**
-   * Absolute value of session expiration time as ISO datetime
+   * Absolute value of session expiration time as an ISO timestamp
    * Format: date-time
    */
   session_expiration_time?: string;
 
   /**
-   * Remaining time (in seconds) until session expiration due to absolute timeout
+   * Remaining time (in seconds) until session expiration due to the absolute timeout
    * Format: int32
    */
   session_expires_in?: number;

package/src/paths/Ai/Audio/V1/Async/SpeakerIdentify/index.ts

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

package/src/paths/Ai/Audio/V1/Async/SpeechToText/index.ts

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