@rc-ex/debug 1.3.12 → 1.4.0

package/dist/core/src/definitions/GetExtensionRecordingsParameters.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Query parameters for operation getExtensionRecordings
+ */
+interface GetExtensionRecordingsParameters {
+    /**
+     * The token indicating the particular page of the result set to be retrieved.
+     *  If omitted the first page will be returned.
+     */
+    pageToken?: string;
+    /**
+     * The number of items per page. If provided value in the request
+     *  is greater than a maximum, the maximum value is applied
+     * Format: int32
+     */
+    perPage?: number;
+}
+export default GetExtensionRecordingsParameters;

package/dist/core/src/definitions/GetInternalTextMessageInfoResponse.d.ts

@@ -0,0 +1,92 @@
+import type ConversationInfo from "./ConversationInfo.js";
+import type MessageAttachmentInfo from "./MessageAttachmentInfo.js";
+import type MessageStoreCallerInfoResponseFrom from "./MessageStoreCallerInfoResponseFrom.js";
+import type MessageStoreCallerInfoResponseTo from "./MessageStoreCallerInfoResponseTo.js";
+interface GetInternalTextMessageInfoResponse {
+    /**
+     * Internal identifier of a message
+     * Format: int64
+     */
+    id?: number;
+    /**
+     * Canonical URI of a message
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * The list of message attachments
+     */
+    attachments?: MessageAttachmentInfo[];
+    /**
+     * 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";
+    /**
+     * SMS and Pager only. Identifier of a conversation that the message
+     *  belongs to
+     * Format: int64
+     */
+    conversationId?: number;
+    /**
+     */
+    conversation?: ConversationInfo;
+    /**
+     * Message creation date/time in ISO 8601 format including timezone,
+     *  for example 2016-03-10T18:07:52.534Z
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * Message direction (inbound or outbound)
+     */
+    direction?: "Inbound" | "Outbound";
+    /**
+     */
+    from?: MessageStoreCallerInfoResponseFrom;
+    /**
+     * 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
+     */
+    lastModifiedTime?: string;
+    /**
+     * Message status. Different message types may have different
+     *  allowed status values. For outbound faxes the aggregated message status
+     *  is returned. If, for multi-recipient 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" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
+    /**
+     * Pager only. `true` if at least one of a message recipients
+     *  is 'Department' extension
+     */
+    pgToDepartment?: boolean;
+    /**
+     * Message priority
+     */
+    priority?: "Normal" | "High";
+    /**
+     * Message read status
+     */
+    readStatus?: "Read" | "Unread";
+    /**
+     * Message subject. For SMS and Pager messages it replicates message
+     *  text which is also returned as an attachment
+     */
+    subject?: string;
+    /**
+     * Recipient information
+     */
+    to?: MessageStoreCallerInfoResponseTo[];
+    /**
+     * Message type
+     */
+    type?: "Fax" | "SMS" | "VoiceMail" | "Pager" | "Text";
+}
+export default GetInternalTextMessageInfoResponse;

package/dist/core/src/definitions/GetLocationListResponse.d.ts

@@ -0,0 +1,23 @@
+import type EnumeratedPagingModel from "./EnumeratedPagingModel.js";
+import type LocationInfo from "./LocationInfo.js";
+import type PageNavigationModel from "./PageNavigationModel.js";
+interface GetLocationListResponse {
+    /**
+     * Link to the location list resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * List of locations
+     */
+    records?: LocationInfo[];
+    /**
+     * Required
+     */
+    navigation?: PageNavigationModel;
+    /**
+     * Required
+     */
+    paging?: EnumeratedPagingModel;
+}
+export default GetLocationListResponse;

package/dist/core/src/definitions/GetMessageForwardingInfo.d.ts

@@ -0,0 +1,13 @@
+import type MessageStoreCallerInfoResponseTo from "./MessageStoreCallerInfoResponseTo.js";
+interface GetMessageForwardingInfo {
+    /**
+     */
+    originalSender?: MessageStoreCallerInfoResponseTo;
+    /**
+     * Original message creation date/time in ISO 8601 format including timezone,
+     *  for example 2016-03-10T18:07:52.534Z
+     * Format: date-time
+     */
+    originalCreationTime?: string;
+}
+export default GetMessageForwardingInfo;

package/dist/core/src/definitions/GetMessageInfoResponse.d.ts

@@ -0,0 +1,163 @@
+import type ConversationInfo from "./ConversationInfo.js";
+import type GetMessageForwardingInfo from "./GetMessageForwardingInfo.js";
+import type MessageAttachmentInfo from "./MessageAttachmentInfo.js";
+import type MessageStoreCallerInfoResponseFrom from "./MessageStoreCallerInfoResponseFrom.js";
+import type MessageStoreCallerInfoResponseTo from "./MessageStoreCallerInfoResponseTo.js";
+import type OwnerResource from "./OwnerResource.js";
+interface GetMessageInfoResponse {
+    /**
+     * Internal identifier of a message
+     * Format: int64
+     * Example: 1724099032020
+     */
+    id?: number;
+    /**
+     * Canonical URI of a message
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Internal identifier of an extension
+     */
+    extensionId?: string;
+    /**
+     * List of message attachments
+     */
+    attachments?: MessageAttachmentInfo[];
+    /**
+     * 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";
+    /**
+     * SMS and Pager only. Identifier of a conversation the message
+     *  belongs to
+     * Format: int64
+     */
+    conversationId?: number;
+    /**
+     */
+    conversation?: ConversationInfo;
+    /**
+     * Message creation date/time in ISO 8601 format including timezone,
+     *  for example 2016-03-10T18:07:52.534Z
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * SMS only. Delivery error code returned by gateway
+     */
+    deliveryErrorCode?: string;
+    /**
+     * SMS size in segments
+     * Format: int32
+     */
+    segmentCount?: number;
+    /**
+     * Message direction (inbound or outbound)
+     */
+    direction?: "Inbound" | "Outbound";
+    /**
+     * Fax only. Page count in a fax message
+     * Format: int32
+     */
+    faxPageCount?: number;
+    /**
+     * 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";
+    /**
+     */
+    from?: MessageStoreCallerInfoResponseFrom;
+    /**
+     * 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
+     */
+    lastModifiedTime?: string;
+    /**
+     * Message status. Different message types may have different
+     *  allowed status values. For outbound faxes the aggregated message status
+     *  is returned. If, for multi-recipient 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" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
+    /**
+     * Pager only. `true` if at least one of the message recipients is
+     *  'Department' extension
+     */
+    pgToDepartment?: boolean;
+    /**
+     * Message priority
+     */
+    priority?: "Normal" | "High";
+    /**
+     * Message read status
+     */
+    readStatus?: "Read" | "Unread";
+    /**
+     * 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
+     * Format: date-time
+     */
+    smsDeliveryTime?: string;
+    /**
+     * SMS only. Number of attempts made to send an outbound SMS to
+     *  the Gateway (if Gateway is temporary unavailable)
+     * Format: int32
+     */
+    smsSendingAttemptsCount?: number;
+    /**
+     * Message subject. For SMS and Pager messages it replicates message
+     *  text which is also returned as an attachment
+     */
+    subject?: string;
+    /**
+     * Recipient information
+     */
+    to?: MessageStoreCallerInfoResponseTo[];
+    /**
+     * Message type
+     */
+    type?: "Fax" | "SMS" | "VoiceMail" | "Pager" | "Text";
+    /**
+     * Voicemail only. Status of a voicemail to text transcription.
+     *  If 'VoicemailToText' feature is not activated for account,
+     *  the 'NotAvailable' value is returned
+     */
+    vmTranscriptionStatus?: "NotAvailable" | "InProgress" | "TimedOut" | "Completed" | "CompletedPartially" | "Failed" | "Unknown";
+    /**
+     * 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')
+     * 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
+     */
+    coverPageText?: string;
+    /**
+     */
+    owner?: OwnerResource;
+    /**
+     * Indicator which tells that this Voice Message can't be forwarded.
+     */
+    private?: boolean;
+    /**
+     */
+    forwarding?: GetMessageForwardingInfo;
+}
+export default GetMessageInfoResponse;

package/dist/core/src/definitions/GetMessageList.d.ts

@@ -0,0 +1,24 @@
+import type GetMessageInfoResponse from "./GetMessageInfoResponse.js";
+import type MessagingNavigationInfo from "./MessagingNavigationInfo.js";
+import type MessagingPagingInfo from "./MessagingPagingInfo.js";
+interface GetMessageList {
+    /**
+     * Link to a list of user messages
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * List of records with message information
+     * Required
+     */
+    records?: GetMessageInfoResponse[];
+    /**
+     * Required
+     */
+    navigation?: MessagingNavigationInfo;
+    /**
+     * Required
+     */
+    paging?: MessagingPagingInfo;
+}
+export default GetMessageList;

package/dist/core/src/definitions/GetMessageSyncResponse.d.ts

@@ -0,0 +1,19 @@
+import type GetMessageInfoResponse from "./GetMessageInfoResponse.js";
+import type SyncInfoMessages from "./SyncInfoMessages.js";
+interface GetMessageSyncResponse {
+    /**
+     * Link to the message sync resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * List of message records with synchronization information
+     * Required
+     */
+    records?: GetMessageInfoResponse[];
+    /**
+     * Required
+     */
+    syncInfo?: SyncInfoMessages;
+}
+export default GetMessageSyncResponse;

package/dist/core/src/definitions/GetPresenceExtensionInfo.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Information on extension, for which this presence data is returned
+ */
+interface GetPresenceExtensionInfo {
+    /**
+     * Internal identifier of an extension
+     * Format: int64
+     */
+    id?: number;
+    /**
+     * Canonical URI of an extension
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Extension number (usually 3 or 4 digits)
+     */
+    extensionNumber?: string;
+}
+export default GetPresenceExtensionInfo;

package/dist/core/src/definitions/GetRecordingInsightsParameters.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Query parameters for operation getRecordingInsights
+ */
+interface GetRecordingInsightsParameters {
+    /**
+     * AI Insight Types
+     */
+    insightTypes?: ("NextSteps" | "Transcript" | "Summary" | "Highlights" | "BulletedSummary" | "AIScore" | "CallNotes" | "Sentiment")[];
+}
+export default GetRecordingInsightsParameters;

package/dist/core/src/definitions/GetRingOutStatusResponse.d.ts

@@ -0,0 +1,16 @@
+import type RingOutStatusInfo from "./RingOutStatusInfo.js";
+interface GetRingOutStatusResponse {
+    /**
+     * Internal identifier of a RingOut call
+     */
+    id?: string;
+    /**
+     * Link to a RingOut call resource
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     */
+    status?: RingOutStatusInfo;
+}
+export default GetRingOutStatusResponse;

package/dist/core/src/definitions/GetSMSMessageInfoResponse.d.ts

@@ -0,0 +1,101 @@
+import type ConversationInfo from "./ConversationInfo.js";
+import type MessageAttachmentInfo from "./MessageAttachmentInfo.js";
+import type MessageStoreCallerInfoResponseFrom from "./MessageStoreCallerInfoResponseFrom.js";
+import type MessageStoreCallerInfoResponseTo from "./MessageStoreCallerInfoResponseTo.js";
+interface GetSMSMessageInfoResponse {
+    /**
+     * Internal identifier of a message
+     * Format: int64
+     */
+    id?: number;
+    /**
+     * Canonical URI of a message
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * List of message attachments
+     */
+    attachments?: MessageAttachmentInfo[];
+    /**
+     * 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";
+    /**
+     * SMS and Pager only. Identifier of a conversation that the message
+     *  belongs to
+     * Format: int64
+     */
+    conversationId?: number;
+    /**
+     */
+    conversation?: ConversationInfo;
+    /**
+     * Message creation date/time in ISO 8601 format including timezone,
+     *  for example 2016-03-10T18:07:52.534Z
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * Message direction (inbound or outbound)
+     */
+    direction?: "Inbound" | "Outbound";
+    /**
+     */
+    from?: MessageStoreCallerInfoResponseFrom;
+    /**
+     * 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
+     */
+    lastModifiedTime?: string;
+    /**
+     * Message status. Different message types may have different
+     *  allowed status values. For outbound faxes the aggregated message status
+     *  is returned. If, for multi-recipient 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" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
+    /**
+     * Message priority
+     */
+    priority?: "Normal" | "High";
+    /**
+     * Message read status
+     */
+    readStatus?: "Read" | "Unread";
+    /**
+     * 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
+     * Format: date-time
+     */
+    smsDeliveryTime?: string;
+    /**
+     * SMS only. Number of attempts made to send an outbound SMS to
+     *  the Gateway (if Gateway is temporary unavailable)
+     * Format: int32
+     */
+    smsSendingAttemptsCount?: number;
+    /**
+     * Message subject. For SMS and Pager messages it replicates message
+     *  text which is also returned as an attachment
+     */
+    subject?: string;
+    /**
+     * Recipient information
+     */
+    to?: MessageStoreCallerInfoResponseTo[];
+    /**
+     * Message type
+     */
+    type?: "Fax" | "SMS" | "VoiceMail" | "Pager" | "Text";
+}
+export default GetSMSMessageInfoResponse;

package/dist/core/src/definitions/GetSessionInsightsParameters.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Query parameters for operation getSessionInsights
+ */
+interface GetSessionInsightsParameters {
+    /**
+     * AI Insight Types
+     */
+    insightTypes?: ("NextSteps" | "Transcript" | "Summary" | "Highlights" | "BulletedSummary" | "AIScore" | "CallNotes" | "Sentiment")[];
+}
+export default GetSessionInsightsParameters;

package/dist/core/src/definitions/GetSingleMessageInfoResponse.d.ts

@@ -0,0 +1,168 @@
+import type ConversationInfo from "./ConversationInfo.js";
+import type GetMessageForwardingInfo from "./GetMessageForwardingInfo.js";
+import type MessageAttachmentInfo from "./MessageAttachmentInfo.js";
+import type MessageStoreCallerInfoResponseFrom from "./MessageStoreCallerInfoResponseFrom.js";
+import type MessageStoreCallerInfoResponseTo from "./MessageStoreCallerInfoResponseTo.js";
+import type OwnerResource from "./OwnerResource.js";
+interface GetSingleMessageInfoResponse {
+    /**
+     * Internal identifier of a message
+     * Format: int64
+     * Example: 1724099032020
+     */
+    id?: number;
+    /**
+     * Canonical URI of a message
+     * Format: uri
+     */
+    uri?: string;
+    /**
+     * Internal identifier of an extension
+     */
+    extensionId?: string;
+    /**
+     * List of message attachments
+     */
+    attachments?: MessageAttachmentInfo[];
+    /**
+     * 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";
+    /**
+     * SMS and Pager only. Identifier of a conversation the message
+     *  belongs to
+     * Format: int64
+     */
+    conversationId?: number;
+    /**
+     */
+    conversation?: ConversationInfo;
+    /**
+     * Message creation date/time in ISO 8601 format including timezone,
+     *  for example 2016-03-10T18:07:52.534Z
+     * Format: date-time
+     */
+    creationTime?: string;
+    /**
+     * SMS only. Delivery error code returned by gateway
+     */
+    deliveryErrorCode?: string;
+    /**
+     * SMS size in segments
+     * Format: int32
+     */
+    segmentCount?: number;
+    /**
+     * Message direction (inbound or outbound)
+     */
+    direction?: "Inbound" | "Outbound";
+    /**
+     * Fax only. Page count in a fax message
+     * Format: int32
+     */
+    faxPageCount?: number;
+    /**
+     * 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";
+    /**
+     */
+    from?: MessageStoreCallerInfoResponseFrom;
+    /**
+     * 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
+     */
+    lastModifiedTime?: string;
+    /**
+     * Message status. Different message types may have different
+     *  allowed status values. For outbound faxes the aggregated message status
+     *  is returned. If, for multi-recipient 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" | "Delivered" | "DeliveryFailed" | "SendingFailed" | "Received";
+    /**
+     * Pager only. `true` if at least one of the message recipients is
+     *  'Department' extension
+     */
+    pgToDepartment?: boolean;
+    /**
+     * Message priority
+     */
+    priority?: "Normal" | "High";
+    /**
+     * Message read status
+     */
+    readStatus?: "Read" | "Unread";
+    /**
+     * 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
+     * Format: date-time
+     */
+    smsDeliveryTime?: string;
+    /**
+     * SMS only. Number of attempts made to send an outbound SMS to
+     *  the Gateway (if Gateway is temporary unavailable)
+     * Format: int32
+     */
+    smsSendingAttemptsCount?: number;
+    /**
+     * Message subject. For SMS and Pager messages it replicates message
+     *  text which is also returned as an attachment
+     */
+    subject?: string;
+    /**
+     * Recipient information
+     */
+    to?: MessageStoreCallerInfoResponseTo[];
+    /**
+     * Message type
+     */
+    type?: "Fax" | "SMS" | "VoiceMail" | "Pager" | "Text";
+    /**
+     * Voicemail only. Status of a voicemail to text transcription.
+     *  If 'VoicemailToText' feature is not activated for account,
+     *  the 'NotAvailable' value is returned
+     */
+    vmTranscriptionStatus?: "NotAvailable" | "InProgress" | "TimedOut" | "Completed" | "CompletedPartially" | "Failed" | "Unknown";
+    /**
+     * 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')
+     * 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
+     */
+    coverPageText?: string;
+    /**
+     */
+    owner?: OwnerResource;
+    /**
+     * Indicator which tells that this Voice Message can't be forwarded.
+     */
+    private?: boolean;
+    /**
+     */
+    forwarding?: GetMessageForwardingInfo;
+    /**
+     * List of other users (side recipients) who also received the voicemail in case of VM sending to multiple users or VM forwarding to multiple users.
+     * Required
+     */
+    vmSideRecipients?: MessageStoreCallerInfoResponseTo[];
+}
+export default GetSingleMessageInfoResponse;