@rc-ex/core 1.3.7 → 1.3.9

package/src/definitions/ExtensionCreationRequest.ts

@@ -1,5 +1,5 @@
 import type ContactInfoCreationRequest from './ContactInfoCreationRequest';
-import type ExtensionCreationRequestCostCenter from './ExtensionCreationRequestCostCenter';
+import type CostCenterInfo from './CostCenterInfo';
 import type CustomFieldInfo from './CustomFieldInfo';
 import type ReferenceInfo from './ReferenceInfo';
 import type RegionalSettings from './RegionalSettings';
@@ -17,23 +17,20 @@ interface ExtensionCreationRequest {
   extensionNumber?: string;
 
   /**
-   * Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
    */
-  costCenter?: ExtensionCreationRequestCostCenter;
+  costCenter?: CostCenterInfo;
 
   /**
    */
   customFields?: CustomFieldInfo[];
 
   /**
-   * Password for extension. If not specified, the password
-   *  is auto-generated
+   * Password for extension. If not specified, the password is auto-generated
    */
   password?: string;
 
   /**
-   * List of non-RC internal identifiers assigned to an
-   *  extension
+   * List of non-RC internal identifiers assigned to an extension
    */
   references?: ReferenceInfo[];
 
@@ -93,8 +90,8 @@ interface ExtensionCreationRequest {
   /**
    * Hides extension from showing in company directory. Supported
    *  for extensions of 'User' type only. For unassigned extensions the value
-   *  is set to 'True' by default. For assigned extensions the value is set
-   *  to 'False' by default
+   *  is set to `true` by default. For assigned extensions the value is set
+   *  to `false` by default
    */
   hidden?: boolean;
 }

package/src/definitions/ExtensionCreationResponse.ts

@@ -1,5 +1,5 @@
 import type ContactInfo from './ContactInfo';
-import type ExtensionCreationResponseCostCenter from './ExtensionCreationResponseCostCenter';
+import type CostCenterInfo from './CostCenterInfo';
 import type CustomFieldInfo from './CustomFieldInfo';
 import type ExtensionPermissions from './ExtensionPermissions';
 import type ProfileImageInfo from './ProfileImageInfo';
@@ -28,9 +28,8 @@ interface ExtensionCreationResponse {
   contact?: ContactInfo;
 
   /**
-   * Cost center information
    */
-  costCenter?: ExtensionCreationResponseCostCenter;
+  costCenter?: CostCenterInfo;
 
   /**
    */
@@ -52,7 +51,7 @@ interface ExtensionCreationResponse {
    *  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
@@ -95,7 +94,7 @@ interface ExtensionCreationResponse {
 
   /**
    * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without ‘extensionNumber’ are returned. If not specified, then
+   *  extensions without `extensionNumber` are returned. If not specified, then
    *  all extensions are returned
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';

package/src/definitions/ExtensionFavoritesEvent.ts

@@ -12,7 +12,7 @@ interface ExtensionFavoritesEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in
+   * Date/time of sending a notification in
    *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    * Format: date-time

package/src/definitions/ExtensionGrantListEvent.ts

@@ -12,7 +12,7 @@ interface ExtensionGrantListEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in
+   * Date/time of sending a notification in
    *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */

package/src/definitions/ExtensionInfo.ts

@@ -31,7 +31,7 @@ interface ExtensionInfo {
    *  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/ExtensionInfoEvent.ts

@@ -12,8 +12,8 @@ interface ExtensionInfoEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in
-   *  [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601)
+   * Date/time of sending a notification in
+   *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */
   timestamp?: string;

package/src/definitions/ExtensionInfoIntId.ts

@@ -24,7 +24,7 @@ interface ExtensionInfoIntId {
    *  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/ExtensionListEvent.ts

@@ -12,7 +12,7 @@ interface ExtensionListEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in
+   * Date/time of sending a notification in
    *  [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
    *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */

package/src/definitions/ExtensionPresenceEventBody.ts

@@ -32,17 +32,17 @@ interface ExtensionPresenceEventBody {
   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/ExtensionServiceFeatureInfo.ts

@@ -71,7 +71,7 @@ interface ExtensionServiceFeatureInfo {
 
   /**
    * Reason for limitation of a particular service feature. Returned
-   *  only if the enabled parameter value is 'False', see Service Feature
+   *  only if the enabled parameter value is `false`, see Service Feature
    *  Limitations and Reasons. When retrieving service features for an extension,
    *  the reasons for limitations, if any, are returned in response
    */

package/src/definitions/ExtensionTelephonySessionsEvent.ts

@@ -12,7 +12,8 @@ interface ExtensionTelephonySessionsEvent {
   event?: string;
 
   /**
-   * Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*
+   * Date/time of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   *  format including timezone, for example *2016-03-10T18:07:52.534Z*
    */
   timestamp?: string;
 

package/src/definitions/ExtensionUpdateRequest.ts

@@ -88,10 +88,10 @@ interface ExtensionUpdateRequest {
     | 'GroupCallPickup';
 
   /**
-   * Extension sub-type, if applicable. For any unsupported sub-types
+   * Extension subtype, if applicable. For any unsupported subtypes
    *  the 'Unknown' value will be returned
    */
-  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown';
+  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignageOnlyRooms' | 'Unknown' | 'Emergency';
 
   /**
    * List of non-RC internal identifiers assigned to an extension

package/src/definitions/FaxResponse.ts

@@ -30,7 +30,7 @@ interface FaxResponse {
   to?: FaxResponseTo[];
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone,
+   * Message creation date/time in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -90,7 +90,7 @@ interface FaxResponse {
   faxPageCount?: number;
 
   /**
-   * Datetime when the message was modified on server in ISO 8601
+   * Date/time when the message was modified on server in ISO 8601
    *  format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */

package/src/definitions/ForwardCallPartyResponse.ts

@@ -27,8 +27,8 @@ interface ForwardCallPartyResponse {
   muted?: boolean;
 
   /**
-   * If 'True' then the party is not connected to a session voice
-   *  conference, 'False' means the party is connected to other parties in a
+   * If `true` then the party is not connected to a session voice
+   *  conference, `false` means the party is connected to other parties in a
    *  session
    */
   standAlone?: boolean;

package/src/definitions/ForwardingInfo.ts

@@ -10,7 +10,7 @@ interface ForwardingInfo {
   notifyMySoftPhones?: boolean;
 
   /**
-   * Deprecated parameter. Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'
+   * Deprecated parameter. Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is `false`
    */
   notifyAdminSoftPhones?: boolean;
 
@@ -21,7 +21,7 @@ interface ForwardingInfo {
   softPhonesRingCount?: number;
 
   /**
-   * Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to 'True' then `softPhonesRingCount` is ignored
+   * Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to `true` then `softPhonesRingCount` is ignored
    * Default: true
    */
   softPhonesAlwaysRing?: boolean;

package/src/definitions/ForwardingInfoCreateRuleRequest.ts

@@ -5,12 +5,12 @@ import type ForwardingRuleCreateRequest from './ForwardingRuleCreateRequest';
  */
 interface ForwardingInfoCreateRuleRequest {
   /**
-   * Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'
+   * Specifies if the first ring on desktop/mobile apps is enabled. The default value is `true`
    */
   notifyMySoftPhones?: boolean;
 
   /**
-   * Deprecated parameter. Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'.
+   * Deprecated parameter. Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is `true`.
    */
   notifyAdminSoftPhones?: boolean;
 
@@ -21,7 +21,7 @@ interface ForwardingInfoCreateRuleRequest {
   softPhonesRingCount?: number;
 
   /**
-   * Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to 'True' then `softPhonesRingCount` is ignored
+   * Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to `true` then `softPhonesRingCount` is ignored
    * Default: true
    */
   softPhonesAlwaysRing?: boolean;

package/src/definitions/GetAccountInfoResponse.ts

@@ -82,7 +82,7 @@ interface GetAccountInfoResponse {
    * Customer facing identifier. Returned for accounts with the
    *  turned off PBX features. Equals to main company number in
    *  [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)
-   *  (without ''+'' sign)format
+   *  (without "+" sign)format
    */
   cfid?: string;
 

package/src/definitions/GetExtensionInfoResponse.ts

@@ -1,5 +1,6 @@
 import type GetExtensionAccountInfo from './GetExtensionAccountInfo';
 import type ContactInfo from './ContactInfo';
+import type CostCenterInfo from './CostCenterInfo';
 import type CustomFieldInfo from './CustomFieldInfo';
 import type DepartmentInfo from './DepartmentInfo';
 import type ExtensionPermissions from './ExtensionPermissions';
@@ -34,6 +35,10 @@ interface GetExtensionInfoResponse {
    */
   contact?: ContactInfo;
 
+  /**
+   */
+  costCenter?: CostCenterInfo;
+
   /**
    */
   customFields?: CustomFieldInfo[];
@@ -67,7 +72,7 @@ interface GetExtensionInfoResponse {
    *  created by partner. The RingCentral supports 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
@@ -110,7 +115,7 @@ interface GetExtensionInfoResponse {
 
   /**
    * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without ‘extensionNumber’ are returned. If not specified,
+   *  extensions without `extensionNumber` are returned. If not specified,
    *  then all extensions are returned
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
@@ -148,10 +153,10 @@ interface GetExtensionInfoResponse {
     | 'GroupCallPickup';
 
   /**
-   * Extension sub-type, if applicable. For any unsupported sub-types the
-   *  'Unknown' value will be returned"
+   * Extension subtype, if applicable. For any unsupported subtypes the
+   *  `Unknown` value will be returned
    */
-  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
 
   /**
    */

package/src/definitions/GetExtensionListInfoResponse.ts

@@ -4,6 +4,7 @@ import type ProfileImageInfo from './ProfileImageInfo';
 import type CallQueueExtensionInfo from './CallQueueExtensionInfo';
 import type ProvisioningSiteInfo from './ProvisioningSiteInfo';
 import type AssignedCountryInfo from './AssignedCountryInfo';
+import type CostCenterInfo from './CostCenterInfo';
 
 interface GetExtensionListInfoResponse {
   /**
@@ -43,7 +44,7 @@ interface GetExtensionListInfoResponse {
 
   /**
    * Extension current state. If 'Unassigned' is specified, then
-   *  extensions without ‘extensionNumber’ are returned. If not specified,
+   *  extensions without `extensionNumber` are returned. If not specified,
    *  then all extensions are returned
    */
   status?: 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned';
@@ -76,10 +77,10 @@ interface GetExtensionListInfoResponse {
     | 'GroupCallPickup';
 
   /**
-   * Extension sub-type, if applicable. For any unsupported sub-types the
-   *  'Unknown' value will be returned"
+   * Extension subtype, if applicable. For any unsupported subtypes the
+   *  `Unknown` value will be returned
    */
-  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown';
+  subType?: 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Unknown' | 'Emergency';
 
   /**
    */
@@ -98,6 +99,10 @@ interface GetExtensionListInfoResponse {
   /**
    */
   assignedCountry?: AssignedCountryInfo;
+
+  /**
+   */
+  costCenter?: CostCenterInfo;
 }
 
 export default GetExtensionListInfoResponse;

package/src/definitions/GetInternalTextMessageInfoResponse.ts

@@ -41,7 +41,7 @@ interface GetInternalTextMessageInfoResponse {
   conversation?: ConversationInfo;
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone,
+   * Message creation date/time in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -59,7 +59,7 @@ interface GetInternalTextMessageInfoResponse {
   from?: MessageStoreCallerInfoResponseFrom;
 
   /**
-   * Datetime when the message was modified on server in ISO
+   * Date/time when the message was modified on server in ISO
    *  8601 format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -76,7 +76,7 @@ interface GetInternalTextMessageInfoResponse {
   messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
 
   /**
-   * Pager only. 'True' if at least one of a message recipients
+   * Pager only. `true` if at least one of a message recipients
    *  is 'Department' extension
    */
   pgToDepartment?: boolean;

package/src/definitions/GetMessageInfoResponse.ts

@@ -47,7 +47,7 @@ interface GetMessageInfoResponse {
   conversation?: ConversationInfo;
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone,
+   * Message creation date/time in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -83,7 +83,7 @@ interface GetMessageInfoResponse {
   from?: MessageStoreCallerInfoResponseFrom;
 
   /**
-   * The datetime when the message was modified on server in ISO
+   * The date/time when the message was modified on server in ISO
    *  8601 format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -100,7 +100,7 @@ interface GetMessageInfoResponse {
   messageStatus?: 'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received';
 
   /**
-   * Pager only. 'True' if at least one of the message recipients is
+   * Pager only. `true` if at least one of the message recipients is
    *  'Department' extension
    */
   pgToDepartment?: boolean;
@@ -116,7 +116,7 @@ interface GetMessageInfoResponse {
   readStatus?: 'Read' | 'Unread';
 
   /**
-   * SMS only. Datetime when outbound SMS was delivered to recipient's
+   * SMS only. Date/time when outbound SMS was delivered to recipient's
    *  handset in ISO 8601 format including timezone, for example
    *  2016-03-10T18:07:52.534Z. It is filled only if a carrier sends a delivery
    *  receipt to RingCentral

package/src/definitions/GetPresenceInfo.ts

@@ -9,12 +9,12 @@ interface GetPresenceInfo {
   uri?: string;
 
   /**
-   * If set to 'True' - enables other extensions to see the extension presence status
+   * If set to `true` - enables other extensions to see the extension presence status
    */
   allowSeeMyPresence?: boolean;
 
   /**
-   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to 'True',
+   * Configures the user presence visibility. When the `allowSeeMyPresence` parameter is set to `true`,
    *  the following visibility options are supported via this parameter - All, None, PermittedUsers
    */
   callerIdVisibility?: 'All' | 'None' | 'PermittedUsers';
@@ -41,7 +41,7 @@ interface GetPresenceInfo {
   message?: string;
 
   /**
-   * 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;
 
@@ -51,7 +51,7 @@ interface GetPresenceInfo {
   presenceStatus?: 'Offline' | 'Busy' | 'Available';
 
   /**
-   * 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;
 

package/src/definitions/GetSMSMessageInfoResponse.ts

@@ -41,7 +41,7 @@ interface GetSMSMessageInfoResponse {
   conversation?: ConversationInfo;
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone,
+   * Message creation date/time in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -64,7 +64,7 @@ interface GetSMSMessageInfoResponse {
   from?: MessageStoreCallerInfoResponseFrom;
 
   /**
-   * Datetime when the message was modified on server in ISO
+   * Date/time when the message was modified on server in ISO
    *  8601 format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
@@ -91,7 +91,7 @@ interface GetSMSMessageInfoResponse {
   readStatus?: 'Read' | 'Unread';
 
   /**
-   * SMS only. The datetime when outbound SMS was delivered to
+   * SMS only. The date/time when outbound SMS was delivered to
    *  recipient's handset in ISO 8601 format including timezone,
    *  for example 2016-03-10T18:07:52.534Z. It is filled only if
    *  the carrier sends a delivery receipt to RingCentral

package/src/definitions/GetTokenRequest.ts

@@ -69,7 +69,7 @@ interface GetTokenRequest {
 
   /**
    * List of application permissions to be used with access token.
-   *  By default the scope includes all permissions configured during
+   *  By default, the scope includes all permissions configured during
    *  the application registration phase
    */
   scope?: string;

package/src/definitions/GreetingInfo.ts

@@ -3,7 +3,7 @@ import type CustomGreetingInfoRequest from './CustomGreetingInfoRequest';
 
 interface GreetingInfo {
   /**
-   * 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/Host.ts

@@ -3,17 +3,17 @@
  */
 interface Host {
   /**
-   * account id
+   * Account id
    */
   accountId?: string;
 
   /**
-   * extension id
+   * Extension id
    */
   extensionId?: string;
 
   /**
-   * displayName
+   * Display name
    */
   displayName?: string;
 }

package/src/definitions/IdentitiesList.ts

@@ -0,0 +1,16 @@
+import type IdentityModel from './IdentityModel';
+import type NonEnumeratedPagingModel from './NonEnumeratedPagingModel';
+
+interface IdentitiesList {
+  /**
+   * Required
+   */
+  records?: IdentityModel[];
+
+  /**
+   * Required
+   */
+  paging?: NonEnumeratedPagingModel;
+}
+
+export default IdentitiesList;

package/src/definitions/IdentityExtraValues.ts

@@ -0,0 +1,7 @@
+/**
+ * Additional data to store along the identity.
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface IdentityExtraValues {}
+
+export default IdentityExtraValues;