@rc-ex/core 1.3.7 → 1.3.8

package/src/definitions/{EmergencyLocationAddressInfoAu.ts → CommonEmergencyLocationAddressInfoAu.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoAu {
+interface CommonEmergencyLocationAddressInfoAu {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationAddressInfoAu {
   city?: string;
 
   /**
-   * The name of the street (The field is utilised as 'streetName' field for Au addresses)
+   * The name of the street (the field is utilized as 'streetName' field for AU addresses)
    */
   street?: string;
 
@@ -70,8 +70,7 @@ interface EmergencyLocationAddressInfoAu {
   buildingNumber?: string;
 
   /**
-   * Second line address (apartment, suite, unit, building, floor,
-   *  etc.)
+   * Second line address (apartment, suite, unit, building, floor, etc.)
    */
   street2?: string;
 
@@ -86,4 +85,4 @@ interface EmergencyLocationAddressInfoAu {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoAu;
+export default CommonEmergencyLocationAddressInfoAu;

package/src/definitions/{EmergencyLocationAddressInfoDefault.ts → CommonEmergencyLocationAddressInfoDefault.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoDefault {
+interface CommonEmergencyLocationAddressInfoDefault {
   /**
    * Country name
    */
@@ -66,4 +66,4 @@ interface EmergencyLocationAddressInfoDefault {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoDefault;
+export default CommonEmergencyLocationAddressInfoDefault;

package/src/definitions/{EmergencyLocationAddressInfoFr.ts → CommonEmergencyLocationAddressInfoFr.ts}

@@ -1,4 +1,4 @@
-interface EmergencyLocationAddressInfoFr {
+interface CommonEmergencyLocationAddressInfoFr {
   /**
    * Country name
    */
@@ -45,7 +45,7 @@ interface EmergencyLocationAddressInfoFr {
   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;
 
@@ -81,4 +81,4 @@ interface EmergencyLocationAddressInfoFr {
   customerName?: string;
 }
 
-export default EmergencyLocationAddressInfoFr;
+export default CommonEmergencyLocationAddressInfoFr;

package/src/definitions/{EmergencyLocationResource.ts → CommonEmergencyLocationResource.ts}

@@ -1,11 +1,11 @@
-import type EmergencyLocationResourceAddress from './EmergencyLocationResourceAddress';
+import type CommonEmergencyLocationAddressInfo from './CommonEmergencyLocationAddressInfo';
 import type ShortSiteInfo from './ShortSiteInfo';
 import type LocationOwnerInfo from './LocationOwnerInfo';
 
 /**
  * Company emergency response location details
  */
-interface EmergencyLocationResource {
+interface CommonEmergencyLocationResource {
   /**
    * Internal identifier of an emergency response location
    */
@@ -13,7 +13,7 @@ interface EmergencyLocationResource {
 
   /**
    */
-  address?: EmergencyLocationResourceAddress;
+  address?: CommonEmergencyLocationAddressInfo;
 
   /**
    * Emergency response location name
@@ -36,7 +36,7 @@ interface EmergencyLocationResource {
 
   /**
    * 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' | 'ActivationProcess' | 'NotRequired' | 'Unsupported' | 'Failed';
 
@@ -58,9 +58,9 @@ interface EmergencyLocationResource {
   owners?: LocationOwnerInfo[];
 
   /**
-   * Address format id
+   * Address format ID
    */
   addressFormatId?: string;
 }
 
-export default EmergencyLocationResource;
+export default CommonEmergencyLocationResource;

package/src/definitions/CompanyAnsweringRuleRequest.ts

@@ -10,7 +10,7 @@ interface CompanyAnsweringRuleRequest {
   name?: string;
 
   /**
-   * Specifies if the rule is active or inactive. The default value is 'True'
+   * Specifies if the rule is active or inactive. The default value is `true`
    * Default: true
    */
   enabled?: boolean;

package/src/definitions/CompanyAnsweringRuleUpdate.ts

@@ -5,7 +5,7 @@ import type GreetingInfo from './GreetingInfo';
 
 interface CompanyAnsweringRuleUpdate {
   /**
-   * Specifies if a rule is active or inactive. The default value is 'True'
+   * Specifies if a rule is active or inactive. The default value is `true`
    * Default: true
    */
   enabled?: boolean;

package/src/definitions/CompanyPhoneNumberInfo.ts

@@ -25,7 +25,7 @@ interface CompanyPhoneNumberInfo {
   extension?: ExtensionInfo;
 
   /**
-   * Custom user name of a phone number, if any
+   * Custom user-defined name of a phone number, if any
    */
   label?: string;
 
@@ -58,8 +58,8 @@ interface CompanyPhoneNumberInfo {
   type?: 'VoiceFax' | 'FaxOnly' | 'VoiceOnly';
 
   /**
-   * Usage type of a phone number. Usage type of a phone number.
-   *  Numbers of 'NumberPool' type wont't be returned for phone number list
+   * Usage type of phone number. Usage type of phone number.
+   *  Numbers of 'NumberPool' type are not returned in phone number list
    *  requests
    */
   usageType?:
@@ -87,7 +87,7 @@ interface CompanyPhoneNumberInfo {
   contactCenterProvider?: ContactCenterProvider;
 
   /**
-   * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern
+   * Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters `nxx` plus `line` or `numberPattern`
    */
   vanityPattern?: string;
 

package/src/definitions/ConferencePhoneNumberInfo.ts

@@ -5,7 +5,7 @@ interface ConferencePhoneNumberInfo {
   phoneNumber?: string;
 
   /**
-   * The value should be 'True' if the number is default for the conference. Default
+   * The value should be `true` if the number is default for the conference. Default
    *  conference number is a domestic number that can be set by user (otherwise
    *  it is set by the system). Only one default number per country is allowed
    */

package/src/definitions/ContactCenterProvider.ts

@@ -1,5 +1,7 @@
 /**
- * CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'
+ * CCRN (Contact Center Routing Number) provider. If not specified
+ * then the default value 'InContact/North America' is used, its ID is '1'
+ *
  */
 interface ContactCenterProvider {
   /**

package/src/definitions/ContactInfo.ts

@@ -54,7 +54,7 @@ interface ContactInfo {
   businessAddress?: ContactBusinessAddressInfo;
 
   /**
-   * If 'True' then contact email is enabled as login name for this
+   * If `true` then contact email is enabled as login name for this
    *  user. Please note that email should be unique in this case.
    */
   emailAsLoginName?: boolean;

package/src/definitions/ContactInfoCreationRequest.ts

@@ -49,9 +49,9 @@ interface ContactInfoCreationRequest {
   businessAddress?: ContactBusinessAddressInfo;
 
   /**
-   * If 'True' then contact email is enabled as login name for
+   * If `true` then contact email is enabled as login name for
    *  this user. Please note that email should be unique in this case.
-   *  The default value is 'False'
+   *  The default value is `false`
    */
   emailAsLoginName?: boolean;
 

package/src/definitions/ContactInfoUpdateRequest.ts

@@ -46,9 +46,9 @@ interface ContactInfoUpdateRequest {
   businessAddress?: ContactBusinessAddressInfo;
 
   /**
-   * If 'True' then contact email is enabled as login name for
+   * If `true` then contact email is enabled as login name for
    *  this user. Please note that email should be unique in this case.
-   *  The default value is 'False'
+   *  The default value is `false`
    */
   emailAsLoginName?: boolean;
 

package/src/definitions/ContactResource.ts

@@ -132,9 +132,10 @@ interface ContactResource {
   integration?: ExternalIntegrationResource;
 
   /**
-   * Example: 3
+   * Extension subtype
+   * Example: Unknown
    */
-  subType?: string;
+  subType?: 'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency';
 }
 
 export default ContactResource;

package/src/definitions/CostCenterInfo.ts

@@ -0,0 +1,16 @@
+/**
+ * Cost center information. Applicable if Cost Center feature is enabled. The default is `root` cost center value
+ */
+interface CostCenterInfo {
+  /**
+   * Internal identifier of a cost center
+   */
+  id?: string;
+
+  /**
+   * Name of a cost center
+   */
+  name?: string;
+}
+
+export default CostCenterInfo;

package/src/definitions/CreateAnsweringRuleForwardingNumberInfo.ts

@@ -21,7 +21,7 @@ interface CreateAnsweringRuleForwardingNumberInfo {
   label?: string;
 
   /**
-   * Type of a forwarding number
+   * Type of forwarding number
    */
   type?:
     | 'Home'

package/src/definitions/CreateAnsweringRuleRequest.ts

@@ -12,7 +12,7 @@ import type GreetingInfo from './GreetingInfo';
 interface CreateAnsweringRuleRequest {
   /**
    * Specifies if the rule is active or inactive. The default value
-   *  is 'True'
+   *  is `true`
    */
   enabled?: boolean;
 

package/src/definitions/CreateBridgeRequest.ts

@@ -10,7 +10,7 @@ interface CreateBridgeRequest {
   name?: string;
 
   /**
-   * Type of a bridge. It specifies bridge life cycle.
+   * Type of bridge. It specifies bridge life cycle.
    *  1) Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
    *  2) Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long
    *  time after the last meeting, then it will be deleted.

package/src/definitions/CreateCompanyGreetingRequest.ts

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

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