@rc-ex/core 1.1.3 → 1.2.0

package/src/definitions/EmergencyAddress.ts

@@ -1,13 +1,18 @@
 interface EmergencyAddress {
   /**
-   * 'True' if specifying of emergency address is required
+   * If set to 'True' then specifying emergency address is required
    */
   required?: boolean;
 
   /**
-   * 'True' if only local emergency address can be specified
+   * If set to 'True' then only local emergency address can be specified
    */
   localOnly?: boolean;
+
+  /**
+   * This status is associated with a phone line provision state
+   */
+  lineProvisioningStatus?: ('Valid' | 'Provisioning' | 'Invalid');
 }
 
 export default EmergencyAddress;

package/src/definitions/EmergencyServiceAddressResource.ts

@@ -1,5 +1,7 @@
 /**
- * Address for emergency cases. The same emergency address is assigned to all the numbers of one device
+ * Address for emergency cases. The same emergency address is assigned
+ * to all the numbers of one device
+ *
 */
 interface EmergencyServiceAddressResource {
   /**
@@ -68,32 +70,40 @@ interface EmergencyServiceAddressResource {
   outOfCountry?: boolean;
 
   /**
-   * Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'
+   * Resulting status of emergency address synchronization. Returned
+ *  if `syncEmergencyAddress` parameter is set to 'True'
    */
   syncStatus?: ('Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed');
 
   /**
-   * Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia.
+   * Name of an additional contact person. Should be specified for
+ *  countries except the US, Canada, the UK and Australia.
    */
   additionalCustomerName?: string;
 
   /**
-   * Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia.
+   * Email of a primary contact person (receiver). Should be specified
+ *  for countries except the US, Canada, the UK and Australia.
+   * Format: email
    */
   customerEmail?: string;
 
   /**
-   * Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia.
+   * Email of an additional contact person. Should be specified
+ *  for countries except the US, Canada, the UK and Australia.
+   * Format: email
    */
   additionalCustomerEmail?: string;
 
   /**
-   * Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia
+   * Phone number of a primary contact person (receiver). Should
+ *  be specified for countries except the US, Canada, the UK and Australia
    */
   customerPhone?: string;
 
   /**
-   * Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia.
+   * Phone number of an additional contact person. Should be specified
+ *  for countries except the US, Canada, the UK & Australia.
    */
   additionalCustomerPhone?: string;
 

package/src/definitions/EmergencyServiceAddressResourceRequest.ts

@@ -1,5 +1,8 @@
 /**
- * Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in `emergency` resource, then this value is ignored
+ * Address for emergency cases. The same emergency address is assigned to all
+ * numbers of a single device. If the emergency address is also specified in
+ * `emergency` resource, then this value is ignored
+ *
 */
 interface EmergencyServiceAddressResourceRequest {
   /**

package/src/definitions/EmotionApiResponse.ts

@@ -0,0 +1,13 @@
+import EmotionSegment from './EmotionSegment';
+
+interface EmotionApiResponse {
+  /**
+   */
+  status?: ('Success' | 'Fail');
+
+  /**
+   */
+  response?: EmotionSegment[];
+}
+
+export default EmotionApiResponse;

package/src/definitions/EmotionSegment.ts

@@ -0,0 +1,29 @@
+interface EmotionSegment {
+  /**
+   * Required
+   * Format: float
+   * Example: 0.3
+   */
+  start?: number;
+
+  /**
+   * Required
+   * Format: float
+   * Example: 5.1
+   */
+  end?: number;
+
+  /**
+   * Required
+   * Example: Neutral
+   */
+  emotion?: ('Anger' | 'Excitement' | 'Frustration' | 'Joy' | 'Sadness' | 'Neutral');
+
+  /**
+   * Format: float
+   * Example: 0.97
+   */
+  confidence?: number;
+}
+
+export default EmotionSegment;

package/src/definitions/EnrollmentInput.ts

@@ -0,0 +1,30 @@
+interface EnrollmentInput {
+  /**
+   * The encoding of the original audio
+   * Required
+   * Example: Mpeg
+   */
+  encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
+
+  /**
+   * Language spoken in the audio file.
+   * Example: en-US
+   */
+  languageCode?: string;
+
+  /**
+   * Base64-encoded audio file data.
+   * Required
+   * Example: base64EncodedAudioInput
+   */
+  content?: string;
+
+  /**
+   * The enrollment ID to be registered. Acceptable format [a-zA-Z0-9_]+
+   * Required
+   * Example: JohnDoe
+   */
+  enrollmentId?: string;
+}
+
+export default EnrollmentInput;

package/src/definitions/EnrollmentPatchInput.ts

@@ -0,0 +1,23 @@
+interface EnrollmentPatchInput {
+  /**
+   * The encoding of the original audio
+   * Required
+   * Example: Mpeg
+   */
+  encoding?: ('Mpeg' | 'Mp4' | 'Wav' | 'Webm' | 'Webp' | 'Aac' | 'Avi' | 'Ogg');
+
+  /**
+   * Language spoken in the audio file.
+   * Example: en-US
+   */
+  languageCode?: string;
+
+  /**
+   * Base64-encoded audio file data.
+   * Required
+   * Example: base64EncodedAudioInput
+   */
+  content?: string;
+}
+
+export default EnrollmentPatchInput;

package/src/definitions/EnrollmentStatus.ts

@@ -0,0 +1,37 @@
+interface EnrollmentStatus {
+  /**
+   * Quality of the enrollment.
+   * Example: Average
+   */
+  enrollmentQuality?: ('Poor' | 'Average' | 'Good' | 'High');
+
+  /**
+   * Status of the enrollment.
+   * Required
+   * Example: true
+   */
+  enrollmentComplete?: boolean;
+
+  /**
+   * Required
+   * Example: JohnDoe
+   */
+  enrollmentId?: string;
+
+  /**
+   * Total speech duration of the enrollment in seconds.
+   * Format: float
+   * Example: 20.1
+   */
+  totalEnrollDuration?: number;
+
+  /**
+   * Total duration of the enrollment in seconds.
+   * Required
+   * Format: float
+   * Example: 30.5
+   */
+  totalSpeechDuration?: number;
+}
+
+export default EnrollmentStatus;

package/src/definitions/EnumeratedPagingModel.ts

@@ -0,0 +1,56 @@
+interface EnumeratedPagingModel {
+  /**
+   * Current page size, describes how many items are in each page.
+ *  Matches "perPage" parameter from the request.
+   * Required
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 50
+   */
+  perPage?: number;
+
+  /**
+   * The current page number. 1-indexed, so the first page is 1
+ *  by default. May be omitted if result is empty (because non-existent page
+ *  was specified or perPage=0 was requested)
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 5
+   */
+  page?: number;
+
+  /**
+   * The zero-based number of the first element on the current page.
+ *  Omitted if the page is omitted or result is empty
+   * Format: int32
+   */
+  pageStart?: number;
+
+  /**
+   * The zero-based index of the last element on the current page.
+ *  Omitted if the page is omitted or result is empty
+   * Format: int32
+   * Example: 5
+   */
+  pageEnd?: number;
+
+  /**
+   * The total number of pages in a dataset. May be omitted for
+ *  some resources due to performance reasons
+   * Format: int32
+   * Example: 25
+   */
+  totalPages?: number;
+
+  /**
+   * The total number of elements in a dataset. May be omitted for
+ *  some resource due to performance reasons
+   * Format: int32
+   * Example: 25
+   */
+  totalElements?: number;
+}
+
+export default EnumeratedPagingModel;

package/src/definitions/EveryoneCanControl.ts

@@ -0,0 +1,17 @@
+/**
+ * Controls whether participants can start and pause recording
+*/
+interface EveryoneCanControl {
+  /**
+   * Controls whether preference is enabled
+   * Example: true
+   */
+  enabled?: boolean;
+
+  /**
+   * Describes whether preference is locked on Service Web
+   */
+  locked?: boolean;
+}
+
+export default EveryoneCanControl;

package/src/definitions/ExtensionBulkUpdateInfo.ts

@@ -4,7 +4,7 @@ import ExtensionRegionalSettingRequest from './ExtensionRegionalSettingRequest';
 import CallQueueInfoRequest from './CallQueueInfoRequest';
 import UserTransitionInfo from './UserTransitionInfo';
 import CustomFieldInfo from './CustomFieldInfo';
-import AutomaticLocationUpdatesSiteInfo from './AutomaticLocationUpdatesSiteInfo';
+import ProvisioningSiteInfo from './ProvisioningSiteInfo';
 import ReferenceInfo from './ReferenceInfo';
 
 interface ExtensionBulkUpdateInfo {
@@ -83,7 +83,7 @@ interface ExtensionBulkUpdateInfo {
 
   /**
    */
-  site?: AutomaticLocationUpdatesSiteInfo;
+  site?: ProvisioningSiteInfo;
 
   /**
    * Extension type. Please note that legacy 'Department' extension

package/src/definitions/ExtensionCreationResponse.ts

@@ -5,7 +5,7 @@ import ProfileImageInfo from './ProfileImageInfo';
 import ReferenceInfo from './ReferenceInfo';
 import RegionalSettings from './RegionalSettings';
 import ExtensionServiceFeatureInfo from './ExtensionServiceFeatureInfo';
-import AutomaticLocationUpdatesSiteInfo from './AutomaticLocationUpdatesSiteInfo';
+import ProvisioningSiteInfo from './ProvisioningSiteInfo';
 import ExtensionStatusInfo from './ExtensionStatusInfo';
 
 interface ExtensionCreationResponse {
@@ -84,7 +84,7 @@ interface ExtensionCreationResponse {
 
   /**
    */
-  site?: AutomaticLocationUpdatesSiteInfo;
+  site?: ProvisioningSiteInfo;
 
   /**
    * Extension current state. If 'Unassigned' is specified, then

package/src/definitions/ExtensionInfoCallLog.ts

@@ -1,12 +1,17 @@
+/**
+ * Information about extension on whose behalf a call is initiated. For Secretary call log the Boss extension info is returned
+*/
 interface ExtensionInfoCallLog {
   /**
    * Internal identifier of an extension
+   * Required
    * Format: int64
    */
   id?: number;
 
   /**
    * Canonical URI of an extension
+   * Required
    * Format: uri
    */
   uri?: string;

package/src/definitions/ExtensionInfoIntId.ts

@@ -10,6 +10,7 @@ interface ExtensionInfoIntId {
 
   /**
    * Canonical URI of an extension
+   * Format: uri
    */
   uri?: string;
 
@@ -19,7 +20,14 @@ interface ExtensionInfoIntId {
   extensionNumber?: string;
 
   /**
-   * For Partner Applications Internal identifier of an extension 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. 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
+   * For Partner Applications Internal identifier of an extension
+ *  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.
+ *  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
    */
   partnerId?: string;
 }

package/src/definitions/ExtensionPresenceEventBody.ts

@@ -1,6 +1,7 @@
 interface ExtensionPresenceEventBody {
   /**
    * Internal identifier of an extension. Optional parameter
+   * Default: ~
    */
   extensionId?: string;
 

package/src/definitions/ExtensionUpdateRequest.ts

@@ -4,7 +4,7 @@ import ExtensionRegionalSettingRequest from './ExtensionRegionalSettingRequest';
 import CallQueueInfoRequest from './CallQueueInfoRequest';
 import UserTransitionInfo from './UserTransitionInfo';
 import CustomFieldInfo from './CustomFieldInfo';
-import AutomaticLocationUpdatesSiteInfoRequest from './AutomaticLocationUpdatesSiteInfoRequest';
+import SiteReference from './SiteReference';
 import ReferenceInfo from './ReferenceInfo';
 
 interface ExtensionUpdateRequest {
@@ -73,7 +73,7 @@ interface ExtensionUpdateRequest {
 
   /**
    */
-  site?: AutomaticLocationUpdatesSiteInfoRequest;
+  site?: SiteReference;
 
   /**
    * Extension type. Please note that legacy 'Department' extension

package/src/definitions/ExtensionWithRolesCollectionResource.ts

@@ -1,4 +1,6 @@
 import ExtensionWithRolesResource from './ExtensionWithRolesResource';
+import EnumeratedPagingModel from './EnumeratedPagingModel';
+import PageNavigationModel from './PageNavigationModel';
 
 interface ExtensionWithRolesCollectionResource {
   /**
@@ -9,6 +11,14 @@ interface ExtensionWithRolesCollectionResource {
   /**
    */
   records?: ExtensionWithRolesResource[];
+
+  /**
+   */
+  paging?: EnumeratedPagingModel;
+
+  /**
+   */
+  navigation?: PageNavigationModel;
 }
 
 export default ExtensionWithRolesCollectionResource;

package/src/definitions/ExternalIntegrationResource.ts

@@ -19,6 +19,11 @@ interface ExternalIntegrationResource {
    */
   displayName?: string;
 
+  /**
+   * Example: Account
+   */
+  routingType?: string;
+
   /**
    * Example: 1726
    */

package/src/definitions/FaxCoverPageInfo.ts

@@ -1,6 +1,8 @@
 interface FaxCoverPageInfo {
   /**
-   * Internal identifier of a fax cover page. The possible value range is 0-13 (for language setting en-US) and 0, 15-28 (for all other languages)
+   * Internal identifier of a fax cover page. The supported value
+ *  range is 0-13 (for language setting en-US) and 0, 15-28
+ *  (for all other languages)
    */
   id?: string;
 

package/src/definitions/FaxReceiver.ts

@@ -0,0 +1,16 @@
+/**
+ * Fax receiver
+*/
+interface FaxReceiver {
+  /**
+   * Phone number in E.164 format
+   */
+  phoneNumber?: string;
+
+  /**
+   * Name of the receiver
+   */
+  name?: string;
+}
+
+export default FaxReceiver;

package/src/definitions/FaxResponse.ts

@@ -1,5 +1,5 @@
-import CallerInfoFrom from './CallerInfoFrom';
-import CallerInfoTo from './CallerInfoTo';
+import MessageStoreCallerInfoResponseFrom from './MessageStoreCallerInfoResponseFrom';
+import MessageStoreCallerInfoResponseTo from './MessageStoreCallerInfoResponseTo';
 import MessageAttachmentInfoIntId from './MessageAttachmentInfoIntId';
 
 interface FaxResponse {
@@ -11,25 +11,27 @@ interface FaxResponse {
 
   /**
    * Canonical URI of a message
+   * Format: uri
    */
   uri?: string;
 
   /**
    * Message type - 'Fax'
    */
-  type?: string;
+  type?: ('Fax');
 
   /**
    */
-  from?: CallerInfoFrom;
+  from?: MessageStoreCallerInfoResponseFrom;
 
   /**
    * Recipient information
    */
-  to?: CallerInfoTo[];
+  to?: MessageStoreCallerInfoResponseTo[];
 
   /**
-   * Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
+   * Message creation datetime in ISO 8601 format including timezone,
+ *  for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   creationTime?: string;
@@ -45,48 +47,68 @@ interface FaxResponse {
   priority?: ('Normal' | 'High');
 
   /**
-   * The list of message attachments
+   * List of message attachments
    */
   attachments?: MessageAttachmentInfoIntId[];
 
   /**
-   * Message direction
+   * Text message direction. Note that for some message types not all
+ *  directions are allowed. For example voicemail messages can
+ *  be only inbound
    */
   direction?: ('Inbound' | 'Outbound');
 
   /**
-   * Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly
+   * Message availability status. Message in 'Deleted' state is still
+ *  preserved with all its attachments and can be restored. 'Purged' means
+ *  that all attachments are already deleted and the message itself is about
+ *  to be physically deleted shortly
    */
   availability?: ('Alive' | 'Deleted' | 'Purged');
 
   /**
-   * Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default)
+   * Message status. Different message types may have different
+ *  allowed status values. For outbound faxes the aggregated message status
+ *  is returned. If, for outbound message, a status for at least one recipient is 'Queued', then
+ *  the 'Queued' value is returned. If a status for at least one recipient is
+ *  'SendingFailed', then the 'SendingFailed' value is returned. In other cases
+ *  the 'Sent' status is returned
    */
-  messageStatus?: ('Queued' | 'Sent' | 'SendingFailed' | 'Received');
+  messageStatus?: ('Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received');
 
   /**
-   * Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)
+   * Fax only. Resolution of a fax message. 'High' for black and
+ *  white image scanned at 200 dpi, 'Low' for black and white image scanned
+ *  at 100 dpi
    */
   faxResolution?: ('High' | 'Low');
 
   /**
    * Page count in a fax message
+   * Format: int32
    */
   faxPageCount?: number;
 
   /**
-   * Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z
+   * Datetime when the message was modified on server in ISO 8601
+ *  format including timezone, for example 2016-03-10T18:07:52.534Z
    * Format: date-time
    */
   lastModifiedTime?: string;
 
   /**
-   * Cover page identifier. If coverIndex is set to '0' (zero) cover page is not attached. For the list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings')
+   * Cover page identifier. If `coverIndex` is set to '0' (zero), a cover
+ *  page is not attached. For a list of available cover page identifiers
+ *  (1-13) please call the Fax Cover Pages method. If not specified,
+ *  the default cover page is attached (which is configured in
+ *  'Outbound Fax Settings')
+   * Format: int32
    */
   coverIndex?: number;
 
   /**
-   * Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols
+   * Cover page text, entered by a fax sender and printed on a
+ *  cover page. Maximum length is limited to 1024 symbols
    */
   coverPageText?: string;
 }

package/src/definitions/FixedAnswerModel.ts

@@ -0,0 +1,16 @@
+interface FixedAnswerModel {
+  /**
+   * ID of the custom question
+   * Required
+   * Example: 123456789
+   */
+  questionId?: string;
+
+  /**
+   * The list of answer IDs
+   * Required
+   */
+  answerIds?: string[];
+}
+
+export default FixedAnswerModel;

package/src/definitions/FixedOrderAgentsExtensionInfo.ts

@@ -6,6 +6,7 @@ interface FixedOrderAgentsExtensionInfo {
 
   /**
    * Canonical URI of an extension
+   * Format: uri
    */
   uri?: string;
 

package/src/definitions/ForwardAllCallsReason.ts

@@ -1,6 +1,7 @@
 interface ForwardAllCallsReason {
   /**
-   * Specifies the type of limitation. `ExtensionLimitation` means that the feature is turned off for this particular extension. `FeatureLimitation` means that the user may enable this feature and setup the rule via the Service Web UI
+   * Specifies the type of limitation. `ExtensionLimitation` means that the feature is turned off for this particular extension.
+ *  `FeatureLimitation` means that the user may enable this feature and setup the rule via the Service Web UI
    */
   code?: ('ExtensionLimitation' | 'FeatureLimitation');
 

package/src/definitions/ForwardingNumberInfo.ts

@@ -8,6 +8,7 @@ interface ForwardingNumberInfo {
 
   /**
    * Canonical URI of a forwarding/call flip phone number
+   * Format: uri
    */
   uri?: string;
 

package/src/definitions/GetAccountRecordingsParameters.ts

@@ -0,0 +1,17 @@
+/**
+ * Query parameters for operation getAccountRecordings
+*/
+interface GetAccountRecordingsParameters {
+  /**
+   * Token to get the next page
+   */
+  pageToken?: string;
+
+  /**
+   * Number of records returned
+   * Format: int32
+   */
+  perPage?: number;
+}
+
+export default GetAccountRecordingsParameters;

package/src/definitions/GetBridgeByPstnPinParameters.ts

@@ -0,0 +1,16 @@
+/**
+ * Query parameters for operation getBridgeByPstnPin
+*/
+interface GetBridgeByPstnPinParameters {
+  /**
+   * Phone number to find a phone group for PSTN PIN. If it is not specified, then the default phone group will be used.
+   */
+  phoneNumber?: string;
+
+  /**
+   * Bridge hash password
+   */
+  pw?: string;
+}
+
+export default GetBridgeByPstnPinParameters;