@rc-ex/core 1.3.15 → 1.4.1

package/lib/definitions/DeviceResource.d.ts

@@ -80,7 +80,8 @@ interface DeviceResource {
      */
     useAsCommonPhone?: boolean;
     /**
-     * This flag indicates whether this device is used for hot desking or not
+     * Indicates whether this device is used for hot desking or not.
+     *  Returned if `useAsCommonPhone` is set to false
      */
     hotDeskDevice?: boolean;
     /**

package/lib/definitions/EmailRecipientInfo.d.ts

@@ -12,9 +12,9 @@ interface EmailRecipientInfo {
      */
     extensionNumber?: string;
     /**
-     * Current state of an extension
+     * Extension status
      */
-    status?: 'Enabled' | 'Disable' | 'NotActivated' | 'Unassigned';
+    status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
      * List of user email addresses from extension notification settings.
      *  By default, main email address from contact information is returned

package/lib/definitions/EmergencyAddressInfo.d.ts

@@ -8,7 +8,8 @@ interface EmergencyAddressInfo {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/EmergencyLocationRequestResource.d.ts

@@ -35,7 +35,8 @@ interface EmergencyLocationRequestResource {
      */
     visibility?: 'Public';
     /**
-     * If 'true' address validation for non-us addresses is skipped
+     * Specifies emergency address validation during the ERL creation/update.
+     *  If set to 'true', then address validation for non-US addresses is skipped
      */
     trusted?: boolean;
 }

package/lib/definitions/EmergencyLocationResponseResource.d.ts

@@ -51,7 +51,8 @@ interface EmergencyLocationResponseResource {
      */
     addressFormatId?: string;
     /**
-     * If 'true' address validation for non-us addresses is skipped
+     * Specifies emergency address validation during the ERL creation/update.
+     *  If set to 'true', then address validation for non-US addresses is skipped
      */
     trusted?: boolean;
 }

package/lib/definitions/EmergencyServiceAddressResource.d.ts

@@ -40,7 +40,8 @@ interface EmergencyServiceAddressResource {
      */
     countryId?: string;
     /**
-     * ISO code of a country
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
+     * Example: US
      */
     countryIsoCode?: string;
     /**

package/lib/definitions/EventRecurrenceInfo.d.ts

@@ -0,0 +1,25 @@
+interface EventRecurrenceInfo {
+    /**
+     * Event recurrence settings. For non-periodic events the value
+     *  is `None`. Must be greater or equal to event duration: 1- Day/Weekday;
+     *  7 - Week; 28 - Month; 365 - Year
+     */
+    schedule?: 'None' | 'Day' | 'Weekday' | 'Week' | 'Month' | 'Year';
+    /**
+     * Condition of ending an event
+     */
+    endingCondition?: 'None' | 'Count' | 'Date';
+    /**
+     * Count of event iterations. For periodic events only. Value range is 1 - 10.
+     *  Must be specified if `endingCondition` is `Count`
+     * Format: int32
+     */
+    endingAfter?: number;
+    /**
+     * Iterations ending datetime for periodic events in
+     *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
+     * Format: date-time
+     */
+    endingOn?: string;
+}
+export default EventRecurrenceInfo;

package/lib/definitions/EventRecurrenceInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=EventRecurrenceInfo.js.map

package/lib/definitions/EventRecurrenceInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventRecurrenceInfo.js","sourceRoot":"","sources":["../../src/definitions/EventRecurrenceInfo.ts"],"names":[],"mappings":""}

package/lib/definitions/ExtensionBulkUpdateInfo.d.ts

@@ -13,8 +13,9 @@ interface ExtensionBulkUpdateInfo {
      */
     id?: string;
     /**
+     * Extension status
      */
-    status?: 'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen';
+    status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated';
     /**
      */
     statusInfo?: ExtensionStatusInfo;

package/lib/definitions/ExtensionBulkUpdateTaskResult.d.ts

@@ -1,12 +1,12 @@
-import type ExtensionUpdateShortResult from './ExtensionUpdateShortResult';
+import type ExtensionBulkUpdateTaskResultAffectedItems from './ExtensionBulkUpdateTaskResultAffectedItems';
 import type ErrorEntity from './ErrorEntity';
 /**
- * Result record on multiple extension update task
+ * Resulting record of a task on multiple extensions update
  */
 interface ExtensionBulkUpdateTaskResult {
     /**
      */
-    affectedItems?: ExtensionUpdateShortResult[];
+    affectedItems?: ExtensionBulkUpdateTaskResultAffectedItems;
     /**
      */
     errors?: ErrorEntity[];

package/lib/definitions/ExtensionBulkUpdateTaskResultAffectedItems.d.ts

@@ -0,0 +1,7 @@
+import type ExtensionUpdateShortResult from './ExtensionUpdateShortResult';
+interface ExtensionBulkUpdateTaskResultAffectedItems {
+    /**
+     */
+    result?: ExtensionUpdateShortResult[];
+}
+export default ExtensionBulkUpdateTaskResultAffectedItems;

package/lib/definitions/ExtensionBulkUpdateTaskResultAffectedItems.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ExtensionBulkUpdateTaskResultAffectedItems.js.map

package/lib/definitions/ExtensionBulkUpdateTaskResultAffectedItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtensionBulkUpdateTaskResultAffectedItems.js","sourceRoot":"","sources":["../../src/definitions/ExtensionBulkUpdateTaskResultAffectedItems.ts"],"names":[],"mappings":""}

package/lib/definitions/ExtensionCreationRequest.d.ts

@@ -48,9 +48,9 @@ interface ExtensionCreationRequest {
      */
     site?: SiteInfo;
     /**
-     * Extension current state
+     * Extension status
      */
-    status?: 'Enabled' | 'Disabled' | 'NotActivated' | 'Unassigned' | 'Frozen';
+    status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
      */
     statusInfo?: ExtensionStatusInfo;

package/lib/definitions/ExtensionCreationResponse.d.ts

@@ -77,9 +77,7 @@ interface ExtensionCreationResponse {
      */
     site?: ProvisioningSiteInfo;
     /**
-     * Extension current state. If 'Unassigned' is specified, then
-     *  extensions without `extensionNumber` are returned. If not specified, then
-     *  all extensions are returned
+     * Extension status
      */
     status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
@@ -89,7 +87,7 @@ interface ExtensionCreationResponse {
      * Extension type. Please note that legacy 'Department' extension type
      *  corresponds to 'Call Queue' extensions in modern RingCentral product terminology
      */
-    type?: 'User' | 'VirtualUser' | 'DigitalUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited';
+    type?: 'User' | 'VirtualUser' | 'DigitalUser' | 'FlexibleUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited';
     /**
      * Hides an extension from showing in company directory. Supported
      *  for extensions of 'User' type only

package/lib/definitions/ExtensionRegionalSettingRequest.d.ts

@@ -24,7 +24,7 @@ interface ExtensionRegionalSettingRequest {
      */
     currency?: ExtensionCurrencyInfoRequest;
     /**
-     * Time format setting
+     * Time format (12-hours or 24-hours).
      * Default: 12h
      */
     timeFormat?: '12h' | '24h';

package/lib/definitions/ExtensionStatusInfo.d.ts

@@ -1,6 +1,5 @@
 /**
- * Status information (reason, comment). Returned for 'Disabled'
- * status only
+ * Status information (reason, comment). Returned for `Disabled` extensions only
  *
  */
 interface ExtensionStatusInfo {
@@ -11,12 +10,6 @@ interface ExtensionStatusInfo {
     /**
      * Type of suspension
      */
-    reason?: 'SuspendedVoluntarily' | 'SuspendedInvoluntarily' | 'CancelledVoluntarily' | 'CancelledInvoluntarily';
-    /**
-     * Date until which an account will get deleted. The default
-     *  value is 30 days since the current date
-     * Format: date-time
-     */
-    till?: string;
+    reason?: 'Voluntarily' | 'Involuntarily';
 }
 export default ExtensionStatusInfo;

package/lib/definitions/ExtensionUpdateRequest.d.ts

@@ -8,8 +8,9 @@ import type SiteReference from './SiteReference';
 import type ReferenceInfo from './ReferenceInfo';
 interface ExtensionUpdateRequest {
     /**
+     * Extension status
      */
-    status?: 'Disabled' | 'Enabled' | 'NotActivated' | 'Frozen';
+    status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated';
     /**
      */
     statusInfo?: ExtensionStatusInfo;

package/lib/definitions/FaxResponseTo.d.ts

@@ -1,4 +1,8 @@
 interface FaxResponseTo {
+    /**
+     * Internal identifier of a fax recipient
+     */
+    recipientId?: string;
     /**
      * Phone number in E.164 (with '+' sign) format
      * Example: +18661234567
@@ -17,5 +21,12 @@ interface FaxResponseTo {
      *  the 'Sent' status is returned
      */
     messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
+    /**
+     * Contains party location (city, state) if one can be determined
+     *  from phoneNumber. This property is filled only when phoneNumber is not
+     *  empty and server can calculate location information from it (for example,
+     *  this information is unavailable for US toll-free numbers)
+     */
+    location?: string;
 }
 export default FaxResponseTo;

package/lib/definitions/GetAccountInfoResponse.d.ts

@@ -42,9 +42,9 @@ interface GetAccountInfoResponse {
      */
     signupInfo?: SignupInfoResource;
     /**
-     * Status of the current account
+     * Status of an account
      */
-    status?: 'Initial' | 'Confirmed' | 'Unconfirmed' | 'Disabled';
+    status?: 'Initial' | 'Unconfirmed' | 'Confirmed' | 'Disabled';
     /**
      */
     statusInfo?: AccountStatusInfo;

package/lib/definitions/GetConferencingInfoResponse.d.ts

@@ -27,6 +27,11 @@ interface GetConferencingInfoResponse {
      *  in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format
      */
     phoneNumber?: string;
+    /**
+     * Link to a branded support page
+     * Example: http://success.ringcentral.com
+     */
+    supportUri?: string;
     /**
      * Short URL leading to the service web page Tap to Join for audio
      *  conference bridge

package/lib/definitions/GetCountryInfoNumberParser.d.ts

@@ -9,13 +9,14 @@ interface GetCountryInfoNumberParser {
      */
     uri?: string;
     /**
-     * Country calling code defined by ITU-T recommendations `E.123`
-     *  and `E.164`, see Calling Codes
-     * Example: 1
+     * Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T)
+     *  recommendations, [E.123](http://en.wikipedia.org/wiki/E.123) and
+     *  [E.164](http://en.wikipedia.org/wiki/E.164).
+     *  See also [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)
      */
     callingCode?: string;
     /**
-     * Country code in `ISO 3166` alpha-2 format
+     * Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format
      * Example: US
      */
     isoCode?: string;

package/lib/definitions/GetExtensionInfoResponse.d.ts

@@ -95,9 +95,7 @@ interface GetExtensionInfoResponse {
      */
     setupWizardState?: 'NotStarted' | 'Incomplete' | 'Completed';
     /**
-     * Extension current state. If 'Unassigned' is specified, then
-     *  extensions without `extensionNumber` are returned. If not specified,
-     *  then all extensions are returned
+     * Extension status
      */
     status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
@@ -128,5 +126,15 @@ interface GetExtensionInfoResponse {
     /**
      */
     assignedCountry?: AssignedCountryInfo;
+    /**
+     * Extension creation date/time, in ISO 8601 format
+     * Format: date-time
+     * Example: 2024-06-06T07:01:14.123Z
+     */
+    creationTime?: string;
+    /**
+     * Site access status for cross-site limitation
+     */
+    siteAccess?: 'Limited' | 'Unlimited';
 }
 export default GetExtensionInfoResponse;

package/lib/definitions/GetExtensionListInfoResponse.d.ts

@@ -35,13 +35,11 @@ interface GetExtensionListInfoResponse {
      */
     profileImage?: ProfileImageInfo;
     /**
-     * Extension current state. If 'Unassigned' is specified, then
-     *  extensions without `extensionNumber` are returned. If not specified,
-     *  then all extensions are returned
+     * Extension status
      */
     status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
     /**
-     * Extension type. Please note that legacy 'Department' extension type
+     * Extension type. Please note that legacy `Department` extension type
      *  corresponds to 'Call Queue' extensions in modern RingCentral product
      *  terminology
      */
@@ -68,5 +66,11 @@ interface GetExtensionListInfoResponse {
     /**
      */
     costCenter?: CostCenterInfo;
+    /**
+     * Extension creation date/time, in ISO 8601 format
+     * Format: date-time
+     * Example: 2024-06-06T07:01:14.123Z
+     */
+    creationTime?: string;
 }
 export default GetExtensionListInfoResponse;

package/lib/definitions/GetMessageInfoResponse.d.ts

@@ -44,10 +44,6 @@ interface GetMessageInfoResponse {
      * Format: date-time
      */
     creationTime?: string;
-    /**
-     * SMS only. Delivery error code returned by gateway
-     */
-    deliveryErrorCode?: string;
     /**
      * Text message direction. Note that for some message types not all
      *  directions are allowed. For example voicemail messages can

package/lib/definitions/GetSMSMessageInfoResponse.d.ts

@@ -39,10 +39,6 @@ interface GetSMSMessageInfoResponse {
      * Format: date-time
      */
     creationTime?: string;
-    /**
-     * SMS only. Delivery error code returned by gateway
-     */
-    deliveryErrorCode?: string;
     /**
      * Text message direction. Note that for some message types not all
      *  directions are allowed. For example voicemail messages can

package/lib/definitions/GetTokenRequest.d.ts

@@ -1,37 +1,44 @@
+/**
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
+ *
+ */
 interface GetTokenRequest {
     /**
-     * For `password` grant type only. User login name: email or phone number in E.164 format
+     * Client assertion type for the `client_secret_jwt` or `private_key_jwt` client authentication types,
+     *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2).
+     *  This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types
      */
-    username?: string;
+    client_assertion_type?: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
     /**
-     * For `password` grant type only. User's password
-     * Format: password
-     */
-    password?: string;
-    /**
-     * For `password` grant type only. Optional. Extension short number. If company number
-     *  is specified as a username, and extension is not specified, the
-     *  server will attempt to authenticate client as main company administrator
-     *
-     *  DEPRECATED: use extension number embedded into username string like `+16501234567*101`
+     * Client assertion (JWT) for the `client_secret_jwt` or `private_key_jwt` client authentication types,
+     *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2).
+     *  This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types
      */
-    extension?: string;
+    client_assertion?: string;
     /**
      * Grant type
      * Required
      */
     grant_type?: 'authorization_code' | 'password' | 'refresh_token' | 'client_credentials' | 'urn:ietf:params:oauth:grant-type:jwt-bearer' | 'urn:ietf:params:oauth:grant-type:device_code' | 'device_certificate' | 'partner_jwt' | 'guest' | 'personal_jwt' | 'otp' | 'ivr_pin';
     /**
-     * For `authorization_code` grant type only. User's authorization code
+     * The list of application permissions (OAuth scopes) requested.
+     *  By default, it includes all permissions configured on
+     *  the client application registration
      */
-    code?: string;
+    scope?: string;
     /**
-     * For `authorization_code` grant type only. This is a callback URI which determines where the response
-     *  is sent. The value of this parameter must exactly match one of
-     *  the URIs you have provided for your app upon registration
-     * Format: uri
+     * The registered identifier of a client application.
+     *  Used to identify a client ONLY if the client authentication is not required and
+     *  corresponding credentials are not provided with this request
+     * Example: AZwEVwGEcfGet2PCouA7K6
      */
-    redirect_uri?: string;
+    client_id?: string;
+    /**
+     * The unique identifier of a client application instance. If not
+     *  specified, the derived or auto-generated value will be used
+     */
+    endpoint_id?: string;
     /**
      * Access token lifetime in seconds
      * Maximum: 3600
@@ -48,58 +55,96 @@ interface GetTokenRequest {
      */
     refresh_token_ttl?: number;
     /**
-     * List of application permissions to be used with access token.
-     *  By default, the scope includes all permissions configured during
-     *  the application registration phase
+     * For `otp` grant type only.
+     *  One-time password code
+     * Required
      */
-    scope?: string;
+    code?: string;
     /**
-     * For `refresh_token` grant type only. Previously issued refresh token.
+     * For `authorization_code` grant type only. This is a callback URI which determines where the response
+     *  is sent. The value of this parameter must exactly match one of
+     *  the URIs you have provided for your app upon registration
+     * Format: uri
      */
-    refresh_token?: string;
+    redirect_uri?: string;
     /**
-     * The unique identifier of a client application instance. If not
-     *  specified, the derived or auto generated value will be used
+     * For `authorization_code` grant type only.
+     *  The code verifier as defined by  the PKCE specification -
+     *  [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)
      */
-    endpoint_id?: string;
+    code_verifier?: string;
     /**
+     * For `password` grant type only. User login name: email or phone number in E.164 format
+     * Required
      */
-    pin?: string;
+    username?: string;
     /**
-     * OAuth client identifier (if not specified via `Authorization` header)
+     * For `password` grant type only. User's password
+     * Required
+     * Format: password
      */
-    client_id?: string;
+    password?: string;
     /**
+     * For `password` grant type only. Optional. Extension short number. If a company number
+     *  is specified as a username, and extension is not specified, the
+     *  server will attempt to authenticate client as main company administrator
+     *
+     *  DEPRECATED: use extension number embedded into username string like `+16501234567*101`
      */
-    account_id?: string;
+    extension?: string;
     /**
+     * IVR pin for pin-based authentication.
+     *
+     *  DEPRECATED: use a dedicated `ivr_pin` grant type instead
      */
-    partner_account_id?: string;
+    pin?: string;
     /**
-     * Client assertion type
+     * For `urn:ietf:params:oauth:grant-type:jwt-bearer` or `partner_jwt` grant types only.
+     *  Authorization grant assertion (JWT)
+     *  as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.1).
+     * Required
      */
-    client_assertion_type?: string;
+    assertion?: string;
     /**
-     * Client assertion
+     * For `refresh_token` grant type only. Previously issued refresh token.
+     * Required
      */
-    client_assertion?: string;
+    refresh_token?: string;
     /**
-     * For `jwt_bearer` grant type only. Assertion
+     * For `ivr_pin` grant type only. User's IVR pin.
+     * Required
      */
-    assertion?: string;
+    ivr_pin?: string;
+    /**
+     * For `urn:ietf:params:oauth:grant-type:device_code` grant type only.
+     *  The device verification code as defined by [RFC-8628](https://datatracker.ietf.org/doc/html/rfc8628#section-3.4)
+     * Required
+     */
+    device_code?: string;
     /**
+     * RingCentral Brand identifier.
+     * Required
      */
     brand_id?: string;
     /**
-     * PKCE code verifier
+     * RingCentral internal account ID
+     * Required
+     */
+    account_id?: string;
+    /**
+     * The ID of the account on RingCentral partner's side
+     * Required
      */
-    code_verifier?: string;
+    partner_account_id?: string;
     /**
+     * Resource type for the guest access.
+     * Required
      */
-    device_code?: string;
+    resource_type?: string;
     /**
-     * For `ivr_pin` grant type only. IVR pin.
+     * Resource URL for the guest access.
+     * Required
      */
-    ivr_pin?: string;
+    resource?: string;
 }
 export default GetTokenRequest;

package/lib/definitions/GuestTokenRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Token endpoint request parameters used in the "Guest" authorization flow
+ * with the `guest` grant type
+ *
+ */
+interface GuestTokenRequest {
+    /**
+     * Grant type
+     * Required
+     */
+    grant_type?: 'guest';
+    /**
+     * RingCentral Brand identifier.
+     */
+    brand_id?: string;
+    /**
+     * Resource type for the guest access.
+     * Required
+     */
+    resource_type?: string;
+    /**
+     * Resource URL for the guest access.
+     * Required
+     */
+    resource?: string;
+}
+export default GuestTokenRequest;

package/lib/definitions/{AnsweringRuleInfo.js → GuestTokenRequest.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=AnsweringRuleInfo.js.map
+//# sourceMappingURL=GuestTokenRequest.js.map

package/lib/definitions/GuestTokenRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GuestTokenRequest.js","sourceRoot":"","sources":["../../src/definitions/GuestTokenRequest.ts"],"names":[],"mappings":""}

package/lib/definitions/IdentityExtraValues.d.ts

@@ -1,5 +1,5 @@
 /**
- * Additional data to store along the identity.
+ * Additional data to store along with identity
  */
 interface IdentityExtraValues {
 }