@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/CreateConversationRequest.ts

@@ -2,7 +2,9 @@ import type CreateConversationRequestMembers from './CreateConversationRequestMe
 
 interface CreateConversationRequest {
   /**
-   * Identifier(s) of chat member(s). The maximum supported number of IDs is 15. User's own ID is optional. If `members` section is omitted then 'Personal' chat will be returned
+   * Identifier(s) of chat member(s). The maximum supported number
+   *  of IDs is 15. User's own ID is optional. If `members` section is omitted
+   *  then "Personal" chat will be returned
    * Required
    */
   members?: CreateConversationRequestMembers[];

package/src/definitions/CreateCustomUserGreetingRequest.ts

@@ -6,7 +6,7 @@ import type GreetingAnsweringRuleId from './GreetingAnsweringRuleId';
  */
 interface CreateCustomUserGreetingRequest {
   /**
-   * Type of a greeting, specifying the case when the greeting is played.
+   * Type of greeting, specifying the case when the greeting is played.
    * Required
    */
   type?:

package/src/definitions/CreateNetworkRequest.ts

@@ -1,7 +1,6 @@
 import type AutomaticLocationUpdatesSiteInfo from './AutomaticLocationUpdatesSiteInfo';
 import type PublicIpRangeInfo from './PublicIpRangeInfo';
 import type PrivateIpRangeInfoRequest from './PrivateIpRangeInfoRequest';
-import type ERLLocationInfo from './ERLLocationInfo';
 
 interface CreateNetworkRequest {
   /**
@@ -22,10 +21,6 @@ interface CreateNetworkRequest {
    * Required
    */
   privateIpRanges?: PrivateIpRangeInfoRequest[];
-
-  /**
-   */
-  emergencyLocation?: ERLLocationInfo;
 }
 
 export default CreateNetworkRequest;

package/src/definitions/CreateSubscriptionRequest.ts

@@ -18,6 +18,7 @@ interface CreateSubscriptionRequest {
    *  | `WebSocket`         | n/a (the parameter is ignored) |
    * Minimum: 1
    * Format: int32
+   * Example: 1200
    */
   expiresIn?: number;
 

package/src/definitions/CreateSwitchInfo.ts

@@ -1,5 +1,5 @@
 import type SwitchSiteInfo from './SwitchSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 import type EmergencyLocationInfo from './EmergencyLocationInfo';
 
 interface CreateSwitchInfo {
@@ -25,7 +25,7 @@ interface CreateSwitchInfo {
 
   /**
    */
-  emergencyAddress?: EmergencyAddressInfoDefault;
+  emergencyAddress?: EmergencyAddressInfo;
 
   /**
    */

package/src/definitions/CreateUserEmergencyLocationRequest.ts

@@ -1,4 +1,4 @@
-import type CreateUserEmergencyLocationRequestAddress from './CreateUserEmergencyLocationRequestAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
 
 interface CreateUserEmergencyLocationRequest {
   /**
@@ -7,13 +7,13 @@ interface CreateUserEmergencyLocationRequest {
   name?: string;
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 
   /**
    */
-  address?: CreateUserEmergencyLocationRequestAddress;
+  address?: CommonEmergencyLocationAddressInfo;
 }
 
 export default CreateUserEmergencyLocationRequest;

package/src/definitions/CreateWebhookSubscriptionRequest.ts

@@ -18,6 +18,7 @@ interface CreateWebhookSubscriptionRequest {
    *  | `WebSocket`         | n/a (the parameter is ignored) |
    * Minimum: 1
    * Format: int32
+   * Example: 1200
    */
   expiresIn?: number;
 

package/src/definitions/CreateWirelessPoint.ts

@@ -1,5 +1,5 @@
 import type EmergencyAddressAutoUpdateSiteInfo from './EmergencyAddressAutoUpdateSiteInfo';
-import type EmergencyAddressInfoDefault from './EmergencyAddressInfoDefault';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 import type EmergencyLocationInfo from './EmergencyLocationInfo';
 
 interface CreateWirelessPoint {
@@ -21,7 +21,7 @@ interface CreateWirelessPoint {
 
   /**
    */
-  emergencyAddress?: EmergencyAddressInfoDefault;
+  emergencyAddress?: EmergencyAddressInfo;
 
   /**
    */

package/src/definitions/CustomCompanyGreetingInfo.ts

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

package/src/definitions/CustomUserGreetingInfo.ts

@@ -13,7 +13,7 @@ interface CustomUserGreetingInfo {
   id?: string;
 
   /**
-   * Type of a custom user greeting
+   * Type of custom user greeting
    */
   type?:
     | 'Introductory'

package/src/definitions/DeleteMessageByFilterParameters.ts

@@ -8,7 +8,7 @@ interface DeleteMessageByFilterParameters {
 
   /**
    * Messages received earlier then the date specified will be deleted.
-   *  The default value is current datetime
+   *  The default value is current date/time
    * Format: date-time
    */
   dateTo?: string;

package/src/definitions/DeletePhoneNumbersRequest.ts

@@ -2,7 +2,7 @@ import type DeletePhoneNumbersRequestItem from './DeletePhoneNumbersRequestItem'
 
 interface DeletePhoneNumbersRequest {
   /**
-   * List of phone numbers or phone ids to be deleted
+   * List of phone numbers or phone IDs to be deleted
    * Required
    */
   records?: DeletePhoneNumbersRequestItem[];

package/src/definitions/DetailedExtensionPresenceEventBody.ts

@@ -47,17 +47,17 @@ interface DetailedExtensionPresenceEventBody {
   dndStatus?: 'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly';
 
   /**
-   * If 'True' enables other extensions to see the extension presence status
+   * If `true` enables other extensions to see the extension presence status
    */
   allowSeeMyPresence?: boolean;
 
   /**
-   * If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
+   * If `true` enables to ring extension phone, if any user monitored by this extension is ringing
    */
   ringOnMonitoredCall?: boolean;
 
   /**
-   * If 'True' enables the extension user to pick up a monitored line on hold
+   * If `true` enables the extension user to pick up a monitored line on hold
    */
   pickUpCallsOnHold?: boolean;
 

package/src/definitions/DetailedExtensionPresenceWithSIPEventBody.ts

@@ -47,17 +47,17 @@ interface DetailedExtensionPresenceWithSIPEventBody {
   dndStatus?: 'TakeAllCalls' | 'DoNotAcceptAnyCalls' | 'DoNotAcceptDepartmentCalls' | 'TakeDepartmentCallsOnly';
 
   /**
-   * If 'True' enables other extensions to see the extension presence status
+   * If `true` enables other extensions to see the extension presence status
    */
   allowSeeMyPresence?: boolean;
 
   /**
-   * If 'True' enables to ring extension phone, if any user monitored by this extension is ringing
+   * If `true` enables to ring extension phone, if any user monitored by this extension is ringing
    */
   ringOnMonitoredCall?: boolean;
 
   /**
-   * If 'True' enables the extension user to pick up a monitored line on hold
+   * If `true` enables the extension user to pick up a monitored line on hold
    */
   pickUpCallsOnHold?: boolean;
 

package/src/definitions/DeviceDefinition.ts

@@ -15,7 +15,7 @@ interface DeviceDefinition {
   emergency?: DeviceDefinitionEmergency;
 
   /**
-   * To be used to assign a number by id
+   * To be used to assign a number by ID
    * Required
    */
   phoneInfo?: DeviceDefinitionPhoneInfo;

package/src/definitions/DeviceEmergencyInfo.ts

@@ -1,4 +1,4 @@
-import type DeviceEmergencyInfoAddress from './DeviceEmergencyInfoAddress';
+import type EmergencyAddressInfo from './EmergencyAddressInfo';
 import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
 
 /**
@@ -6,13 +6,8 @@ import type DeviceEmergencyLocationInfo from './DeviceEmergencyLocationInfo';
  */
 interface DeviceEmergencyInfo {
   /**
-   * Automatically determined emergency address. If `emergencyAddressState`
-   *  value is 'Assigned', then this address is assigned to the current device.
-   *  If `emergencyAddressState` value is 'Unconfirmed', then the specified address
-   *  must be confirmed by the user before being registered as emergency address
-   *  for the current device. In all other cases the value is null
    */
-  address?: DeviceEmergencyInfoAddress;
+  address?: EmergencyAddressInfo;
 
   /**
    */
@@ -37,7 +32,7 @@ interface DeviceEmergencyInfo {
 
   /**
    * Resulting status of the emergency address synchronization. Returned
-   *  if `syncEmergencyAddress` parameter is set to 'True'
+   *  if `syncEmergencyAddress` parameter is set to `true`
    */
   syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed';
 

package/src/definitions/DeviceEmergencyLocationInfo.ts

@@ -13,7 +13,7 @@ interface DeviceEmergencyLocationInfo {
   name?: string;
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }

package/src/definitions/DeviceInfoRequest.ts

@@ -14,12 +14,12 @@ interface DeviceInfoRequest {
   appExternalId?: string;
 
   /**
-   * Computer name (for SoftPhone only).
+   * Computer name (for devices of `SoftPhone` type only)
    */
   computerName?: string;
 
   /**
-   * Endpoint/device instance identifier for Softphone and mobile applications.
+   * Endpoint/device instance identifier for Softphone and mobile applications
    */
   serial?: string;
 }

package/src/definitions/DeviceModelInfo.ts

@@ -5,7 +5,7 @@ import type DeviceAddonInfo from './DeviceAddonInfo';
  */
 interface DeviceModelInfo {
   /**
-   * Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier
+   * Addon identifier. For HardPhones of certain types, which are compatible with this add-on identifier
    */
   id?: string;
 
@@ -15,7 +15,7 @@ interface DeviceModelInfo {
   name?: string;
 
   /**
-   * Addons description
+   * Add-ons description
    * Required
    */
   addons?: DeviceAddonInfo[];

package/src/definitions/DevicePhoneNumberInfo.ts

@@ -37,7 +37,7 @@ interface DevicePhoneNumberInfo {
     | 'ContactCenterNumber';
 
   /**
-   * Type of a phone number
+   * Type of phone number
    */
   type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
 }

package/src/definitions/DeviceProvisioningExtensionInfo.ts

@@ -23,7 +23,7 @@ interface DeviceProvisioningExtensionInfo {
    *  created by partner. The RingCentral supports the mapping of accounts and
    *  stores the corresponding account ID/extension ID for each partner ID of
    *  a client application. In request URIs partner IDs are accepted instead
-   *  of regular RingCentral native IDs as path parameters using pid = XXX clause.
+   *  of regular RingCentral native IDs as path parameters using `pid=XXX` clause.
    *  Though in response URIs contain the corresponding account IDs and extension
    *  IDs. In all request and response bodies these values are reflected via
    *  partnerId attributes of account and extension

package/src/definitions/DeviceResource.ts

@@ -20,10 +20,10 @@ interface DeviceResource {
   uri?: string;
 
   /**
-   * Device identification number (stock keeping unit) in the format
-   *  TP-ID [-AT-AC], where TP is a device type (HP for RC HardPhone, DV for all
-   *  other devices including SoftPhone); ID - device model ID; AT -addon type
-   *  ID; AC - addon count (if any). For example 'HP-56-2-2'
+   * Device identification number (SKU, Stock Keeping Unit) in the format
+   *  TP-ID [-AT-AC], where TP is device type (HP for RC desk phones, DV for all
+   *  other devices including soft phones); ID - device model ID; AT - add-on type
+   *  ID; AC - add-on count (if any). For example 'HP-56-2-2'
    */
   sku?: string;
 
@@ -35,14 +35,14 @@ interface DeviceResource {
 
   /**
    * Device name. Mandatory if ordering SoftPhone or OtherPhone.
-   *  Optional for  HardPhone. If not specified for HardPhone, then
+   *  Optional for HardPhone. If not specified for HardPhone, then
    *  a device model is used as a device name
    */
   name?: string;
 
   /**
    * Serial number for HardPhone (is returned only when the phone
-   *  is shipped and provisioned); endpoint_id for SoftPhone and
+   *  is shipped and provisioned); endpoint ID for SoftPhone and
    *  mobile applications
    */
   serial?: string;
@@ -53,7 +53,7 @@ interface DeviceResource {
   status?: 'Offline' | 'Online';
 
   /**
-   * PC name for softphone
+   * Computer name (for devices of `SoftPhone` type only)
    */
   computerName?: string;
 
@@ -85,7 +85,7 @@ interface DeviceResource {
   /**
    * 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 for HardPhone
+   *  model structure, or boxBillingId  must be specified for HardPhone
    * Format: int64
    */
   boxBillingId?: number;
@@ -97,8 +97,13 @@ interface DeviceResource {
   useAsCommonPhone?: boolean;
 
   /**
-   * Network location status. 'True' if the device is located in
-   *  the configured corporate network (On-Net); 'False' for Off-Net location.
+   * This flag indicates whether this device is used for hot desking or not
+   */
+  hotDeskDevice?: boolean;
+
+  /**
+   * Network location status. `true` if the device is located in
+   *  the configured corporate network (On-Net); `false` for Off-Net location.
    *  Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not
    *  enabled for the account/user, or if device network location is not determined
    */
@@ -109,7 +114,7 @@ interface DeviceResource {
   site?: DeviceSiteInfo;
 
   /**
-   * Datetime of receiving last location report in
+   * Date/time of receiving last location report in
    *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z
    * Format: date-time
@@ -117,7 +122,7 @@ interface DeviceResource {
   lastLocationReportTime?: string;
 
   /**
-   * Pooling type of a device:
+   * 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.)

package/src/definitions/DictionaryGreetingInfo.ts

@@ -19,7 +19,7 @@ interface DictionaryGreetingInfo {
   name?: string;
 
   /**
-   * Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension.
+   * Usage type of greeting, specifying if the greeting is applied for user extension or department (call queue) extension.
    */
   usageType?:
     | 'UserExtensionAnsweringRule'
@@ -46,7 +46,7 @@ interface DictionaryGreetingInfo {
   contentUri?: string;
 
   /**
-   * Type of a greeting, specifying the case when the greeting is played.
+   * Type of greeting, specifying the case when the greeting is played.
    */
   type?:
     | 'Introductory'

package/src/definitions/ERLLocationInfo.ts

@@ -13,7 +13,7 @@ interface ERLLocationInfo {
   name?: string;
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }

package/src/definitions/EmailRecipientInfo.ts

@@ -21,7 +21,7 @@ interface EmailRecipientInfo {
 
   /**
    * List of user email addresses from extension notification settings.
-   *  By default main email address from contact information is returned
+   *  By default, main email address from contact information is returned
    */
   emailAddresses?: string[];
 

package/src/definitions/EmergencyAddress.ts

@@ -1,11 +1,11 @@
 interface EmergencyAddress {
   /**
-   * If set to 'True' then specifying emergency address is required
+   * If set to `true` then specifying emergency address is required
    */
   required?: boolean;
 
   /**
-   * If set to 'True' then only local emergency address can be specified
+   * If set to `true` then only local emergency address can be specified
    */
   localOnly?: boolean;
 

package/src/definitions/{EmergencyLocationInfoRequestAddress.ts → EmergencyAddressInfo.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationInfoRequestAddress {
+interface EmergencyAddressInfo {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationInfoRequestAddress {
   city?: string;
 
   /**
-   * The name of the street (The field is utilised as 'streetName' field for FR addresses)
+   * The name of the street (The field is utilized as 'streetName' field for FR addresses)
    */
   street?: string;
 
@@ -84,6 +84,13 @@ interface EmergencyLocationInfoRequestAddress {
    * Building/street number
    */
   buildingNumber?: string;
+
+  /**
+   * Resulting status of emergency address synchronization. Returned
+   *  for 'Get Device Info' request if `syncEmergencyAddress` parameter is set
+   *  to `true`
+   */
+  syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed';
 }
 
-export default EmergencyLocationInfoRequestAddress;
+export default EmergencyAddressInfo;

package/src/definitions/EmergencyLocationInfo.ts

@@ -14,7 +14,7 @@ interface EmergencyLocationInfo {
   name?: string;
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }

package/src/definitions/EmergencyLocationInfoRequest.ts

@@ -1,4 +1,4 @@
-import type EmergencyLocationInfoRequestAddress from './EmergencyLocationInfoRequestAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
 import type ShortSiteInfo from './ShortSiteInfo';
 
 interface EmergencyLocationInfoRequest {
@@ -9,7 +9,7 @@ interface EmergencyLocationInfoRequest {
 
   /**
    */
-  address?: EmergencyLocationInfoRequestAddress;
+  address?: CommonEmergencyLocationAddressInfo;
 
   /**
    * Emergency response location name
@@ -31,7 +31,7 @@ interface EmergencyLocationInfoRequest {
   usageStatus?: 'Active' | 'Inactive';
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 

package/src/definitions/EmergencyLocationsResource.ts

@@ -1,10 +1,10 @@
-import type EmergencyLocationResource from './EmergencyLocationResource';
+import type CommonEmergencyLocationResource from './CommonEmergencyLocationResource';
 import type EmergencyLocationsPaging from './EmergencyLocationsPaging';
 
 interface EmergencyLocationsResource {
   /**
    */
-  records?: EmergencyLocationResource[];
+  records?: CommonEmergencyLocationResource[];
 
   /**
    */

package/src/definitions/EmergencyServiceAddressResource.ts

@@ -71,7 +71,7 @@ interface EmergencyServiceAddressResource {
 
   /**
    * Resulting status of emergency address synchronization. Returned
-   *  if `syncEmergencyAddress` parameter is set to 'True'
+   *  if `syncEmergencyAddress` parameter is set to `true`
    */
   syncStatus?: 'Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed';
 

package/src/definitions/EveryoneTeamInfo.ts

@@ -5,7 +5,7 @@ interface EveryoneTeamInfo {
   id?: string;
 
   /**
-   * Type of a chat
+   * Type of chat
    */
   type?: 'Everyone';
 

package/src/definitions/ExtensionBulkUpdateInfo.ts

@@ -3,6 +3,7 @@ import type ContactInfoUpdateRequest from './ContactInfoUpdateRequest';
 import type ExtensionRegionalSettingRequest from './ExtensionRegionalSettingRequest';
 import type CallQueueInfoRequest from './CallQueueInfoRequest';
 import type UserTransitionInfo from './UserTransitionInfo';
+import type CostCenterInfo from './CostCenterInfo';
 import type CustomFieldInfo from './CustomFieldInfo';
 import type ProvisioningSiteInfo from './ProvisioningSiteInfo';
 import type ReferenceInfo from './ReferenceInfo';
@@ -72,6 +73,10 @@ interface ExtensionBulkUpdateInfo {
    */
   transition?: UserTransitionInfo;
 
+  /**
+   */
+  costCenter?: CostCenterInfo;
+
   /**
    */
   customFields?: CustomFieldInfo[];

package/src/definitions/ExtensionBulkUpdateTaskResource.ts

@@ -25,14 +25,14 @@ interface ExtensionBulkUpdateTaskResource {
   status?: 'Accepted' | 'InProgress' | 'Completed' | 'Failed';
 
   /**
-   * Task creation datetime
+   * Task creation date/time
    * Required
    * Format: date-time
    */
   creationTime?: string;
 
   /**
-   * Task latest update datetime
+   * Task latest update date/time
    * Required
    * Format: date-time
    */

package/src/definitions/ExtensionCallerIdInfo.ts

@@ -17,13 +17,13 @@ interface ExtensionCallerIdInfo {
   byFeature?: CallerIdByFeature[];
 
   /**
-   * If 'True', then user first name and last name will be used
+   * If `true`, then user first name and last name will be used
    *  as caller ID when making outbound calls from extension
    */
   extensionNameForOutboundCalls?: boolean;
 
   /**
-   * If 'True', then extension number will be used as caller ID
+   * If `true`, then extension number will be used as caller ID
    *  when making internal calls
    */
   extensionNumberForInternalCalls?: boolean;

package/src/definitions/ExtensionCallerIdInfoRequest.ts

@@ -17,13 +17,13 @@ interface ExtensionCallerIdInfoRequest {
   byFeature?: CallerIdByFeatureRequest[];
 
   /**
-   * If 'True', then the user first name and last name will be used
+   * If `true`, then the user first name and last name will be used
    *  as caller ID when making outbound calls from extension
    */
   extensionNameForOutboundCalls?: boolean;
 
   /**
-   * If 'True', then extension number will be used as caller ID
+   * If `true`, then extension number will be used as caller ID
    *  when making internal calls
    */
   extensionNumberForInternalCalls?: boolean;