@rc-ex/core 1.3.15 → 1.4.1

package/src/definitions/CreateUserEmergencyLocationRequest.ts

@@ -12,7 +12,8 @@ interface CreateUserEmergencyLocationRequest {
   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/src/definitions/CustomCompanyGreetingInfo.ts

@@ -14,7 +14,7 @@ interface CustomCompanyGreetingInfo {
   id?: string;
 
   /**
-   * Type of company greeting
+   * Type of a company greeting
    */
   type?: 'Company' | 'StartRecording' | 'StopRecording' | 'AutomaticRecording' | 'TemplateGreeting';
 

package/src/definitions/DeletePhoneNumbersRequestItem.ts

@@ -1,5 +1,5 @@
 /**
- * The indication of a number to be deleted - either "id" or "phoneNumber" must be specified.
+ * The indication of a number to be deleted - either `id` or `phoneNumber` must be specified.
  */
 interface DeletePhoneNumbersRequestItem {
   /**

package/src/definitions/DeviceCodeTokenRequest.ts

@@ -0,0 +1,21 @@
+/**
+ * Token endpoint request parameters used in the "Device Authorization" flow
+ * with the `urn:ietf:params:oauth:grant-type:device_code` grant type
+ *
+ */
+interface DeviceCodeTokenRequest {
+  /**
+   * Grant type
+   * Required
+   */
+  grant_type?: 'urn:ietf:params:oauth:grant-type:device_code';
+
+  /**
+   * 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;
+}
+
+export default DeviceCodeTokenRequest;

package/src/definitions/DeviceEmergencyInfo.ts

@@ -1,4 +1,4 @@
-import type EmergencyAddressInfo from './EmergencyAddressInfo';
+import type CommonEmergencyLocationAddressInfoDefault from './CommonEmergencyLocationAddressInfoDefault';
 import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 
 /**
@@ -7,7 +7,7 @@ import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 interface DeviceEmergencyInfo {
   /**
    */
-  address?: EmergencyAddressInfo;
+  address?: CommonEmergencyLocationAddressInfoDefault;
 
   /**
    */

package/src/definitions/DeviceEmergencyServiceAddressResourceAu.ts

@@ -48,7 +48,8 @@ interface DeviceEmergencyServiceAddressResourceAu {
   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/src/definitions/DeviceEmergencyServiceAddressResourceDefault.ts

@@ -48,7 +48,8 @@ interface DeviceEmergencyServiceAddressResourceDefault {
   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/src/definitions/DeviceEmergencyServiceAddressResourceFr.ts

@@ -48,7 +48,8 @@ interface DeviceEmergencyServiceAddressResourceFr {
   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/src/definitions/DeviceResource.ts

@@ -97,7 +97,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/src/definitions/EmailRecipientInfo.ts

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

package/src/definitions/EmergencyAddressInfo.ts

@@ -10,7 +10,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/src/definitions/EmergencyLocationRequestResource.ts

@@ -44,7 +44,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/src/definitions/EmergencyLocationResponseResource.ts

@@ -63,7 +63,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/src/definitions/EmergencyServiceAddressResource.ts

@@ -50,7 +50,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/src/definitions/EventRecurrenceInfo.ts

@@ -0,0 +1,29 @@
+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/src/definitions/ExtensionBulkUpdateInfo.ts

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

package/src/definitions/ExtensionBulkUpdateTaskResult.ts

@@ -1,13 +1,13 @@
-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;
 
   /**
    */

package/src/definitions/ExtensionBulkUpdateTaskResultAffectedItems.ts

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

package/src/definitions/ExtensionCreationRequest.ts

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

package/src/definitions/ExtensionCreationResponse.ts

@@ -93,9 +93,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';
 
@@ -111,6 +109,7 @@ interface ExtensionCreationResponse {
     | 'User'
     | 'VirtualUser'
     | 'DigitalUser'
+    | 'FlexibleUser'
     | 'Department'
     | 'Announcement'
     | 'Voicemail'

package/src/definitions/ExtensionRegionalSettingRequest.ts

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

package/src/definitions/ExtensionStatusInfo.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 {
@@ -12,14 +11,7 @@ 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/src/definitions/ExtensionUpdateRequest.ts

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

package/src/definitions/FaxResponseTo.ts

@@ -1,4 +1,9 @@
 interface FaxResponseTo {
+  /**
+   * Internal identifier of a fax recipient
+   */
+  recipientId?: string;
+
   /**
    * Phone number in E.164 (with '+' sign) format
    * Example: +18661234567
@@ -19,6 +24,14 @@ 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/src/definitions/GetAccountInfoResponse.ts

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

package/src/definitions/GetConferencingInfoResponse.ts

@@ -34,6 +34,12 @@ interface GetConferencingInfoResponse {
    */
   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/src/definitions/GetCountryInfoNumberParser.ts

@@ -11,14 +11,15 @@ 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/src/definitions/GetExtensionInfoResponse.ts

@@ -114,9 +114,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';
 
@@ -175,6 +173,18 @@ 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/src/definitions/GetExtensionListInfoResponse.ts

@@ -43,14 +43,12 @@ 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
    */
@@ -103,6 +101,13 @@ 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/src/definitions/GetMessageInfoResponse.ts

@@ -53,11 +53,6 @@ interface GetMessageInfoResponse {
    */
   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/src/definitions/GetSMSMessageInfoResponse.ts

@@ -47,11 +47,6 @@ interface GetSMSMessageInfoResponse {
    */
   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