@rc-ex/core 1.8.1 → 1.8.3

package/dist/definitions/MthListNotesParameters.d.mts

@@ -0,0 +1,44 @@
+//#region src/definitions/MthListNotesParameters.d.ts
+/**
+ * Query parameters for operation mthListNotes
+ */
+interface MthListNotesParameters {
+  /**
+   * Thread owner extension IDs
+   */
+  ownerExtensionIds?: string[];
+  /**
+   * Availability filter (by default only `Alive` records are returned)
+   * Default: Alive
+   */
+  availability?: ("Alive" | "Deleted")[];
+  /**
+   * List of thread IDs to filter the list of results
+   */
+  threadIds?: string[];
+  /**
+   * List of note IDs to filter the list of results
+   */
+  noteIds?: string[];
+  /**
+   * The number of items per page. If the provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+  /**
+   * The result set page number (1-indexed) to return
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 1
+   * Default: 1
+   */
+  page?: number;
+}
+//#endregion
+export { MthListNotesParameters as default };

package/dist/definitions/MthListNotesParameters.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthListThreadsParameters.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthListThreadsParameters.d.cts

@@ -0,0 +1,62 @@
+//#region src/definitions/MthListThreadsParameters.d.ts
+/**
+ * Query parameters for operation mthListThreads
+ */
+interface MthListThreadsParameters {
+  /**
+   * Thread status
+   */
+  threadStatus?: "Open" | "Resolved";
+  /**
+   * Thread owner extension IDs
+   */
+  ownerExtensionIds?: string[];
+  /**
+   * Start date/time for resulting message threads or messages (depending on path resource)
+   *  in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
+   *  This parameter is supported if `creationTimeTo` is specified
+   */
+  creationTimeFrom?: string;
+  /**
+   * End date/time for resulting message threads or messages (depending on path resource)
+   *  in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
+   *  This parameter is supported if `creationTimeFrom` is specified
+   */
+  creationTimeTo?: string;
+  /**
+   * Phone number in e.164 format (with '+' prefix)
+   * Example: +16501234567
+   */
+  ownerPhoneNumber?: string;
+  /**
+   * Phone number in e.164 format (with '+' prefix)
+   * Example: +16501234567
+   */
+  guestPhoneNumber?: string;
+  /**
+   * Availability filter (by default only `Alive` records are returned)
+   * Default: Alive
+   */
+  availability?: ("Alive" | "Deleted")[];
+  /**
+   * The number of items per page. If the provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+  /**
+   * The result set page number (1-indexed) to return
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 1
+   * Default: 1
+   */
+  page?: number;
+}
+//#endregion
+export { MthListThreadsParameters as default };

package/dist/definitions/MthListThreadsParameters.d.mts

@@ -0,0 +1,62 @@
+//#region src/definitions/MthListThreadsParameters.d.ts
+/**
+ * Query parameters for operation mthListThreads
+ */
+interface MthListThreadsParameters {
+  /**
+   * Thread status
+   */
+  threadStatus?: "Open" | "Resolved";
+  /**
+   * Thread owner extension IDs
+   */
+  ownerExtensionIds?: string[];
+  /**
+   * Start date/time for resulting message threads or messages (depending on path resource)
+   *  in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
+   *  This parameter is supported if `creationTimeTo` is specified
+   */
+  creationTimeFrom?: string;
+  /**
+   * End date/time for resulting message threads or messages (depending on path resource)
+   *  in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
+   *  This parameter is supported if `creationTimeFrom` is specified
+   */
+  creationTimeTo?: string;
+  /**
+   * Phone number in e.164 format (with '+' prefix)
+   * Example: +16501234567
+   */
+  ownerPhoneNumber?: string;
+  /**
+   * Phone number in e.164 format (with '+' prefix)
+   * Example: +16501234567
+   */
+  guestPhoneNumber?: string;
+  /**
+   * Availability filter (by default only `Alive` records are returned)
+   * Default: Alive
+   */
+  availability?: ("Alive" | "Deleted")[];
+  /**
+   * The number of items per page. If the provided value in the request
+   *  is greater than a maximum, the maximum value is applied
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 100
+   * Default: 100
+   */
+  perPage?: number;
+  /**
+   * The result set page number (1-indexed) to return
+   * Maximum: 1000
+   * Minimum: 1
+   * Format: int32
+   * Example: 1
+   * Default: 1
+   */
+  page?: number;
+}
+//#endregion
+export { MthListThreadsParameters as default };

package/dist/definitions/MthListThreadsParameters.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthReadMessageContentParameters.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthReadMessageContentParameters.d.cts

@@ -0,0 +1,16 @@
+//#region src/definitions/MthReadMessageContentParameters.d.ts
+/**
+ * Query parameters for operation mthReadMessageContent
+ */
+interface MthReadMessageContentParameters {
+  /**
+   * Whether the content is expected to be displayed in the browser, or downloaded and saved locally
+   */
+  contentDisposition?: "Inline" | "Attachment";
+  /**
+   * The default filename of the file to be downloaded
+   */
+  contentDispositionFilename?: string;
+}
+//#endregion
+export { MthReadMessageContentParameters as default };

package/dist/definitions/MthReadMessageContentParameters.d.mts

@@ -0,0 +1,16 @@
+//#region src/definitions/MthReadMessageContentParameters.d.ts
+/**
+ * Query parameters for operation mthReadMessageContent
+ */
+interface MthReadMessageContentParameters {
+  /**
+   * Whether the content is expected to be displayed in the browser, or downloaded and saved locally
+   */
+  contentDisposition?: "Inline" | "Attachment";
+  /**
+   * The default filename of the file to be downloaded
+   */
+  contentDispositionFilename?: string;
+}
+//#endregion
+export { MthReadMessageContentParameters as default };

package/dist/definitions/MthReadMessageContentParameters.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSendMessageRequest.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSendMessageRequest.d.cts

@@ -0,0 +1,19 @@
+import Attachment from "./Attachment.cjs";
+import NewThreadMessageRequest from "./NewThreadMessageRequest.cjs";
+
+//#region src/definitions/MthSendMessageRequest.d.ts
+/**
+ * Request body for operation mthSendMessage
+ */
+interface MthSendMessageRequest {
+  /**
+   * Required
+   */
+  metadata?: NewThreadMessageRequest;
+  /**
+   * Required
+   */
+  attachments?: Attachment[];
+}
+//#endregion
+export { MthSendMessageRequest as default };

package/dist/definitions/MthSendMessageRequest.d.mts

@@ -0,0 +1,19 @@
+import Attachment from "./Attachment.mjs";
+import NewThreadMessageRequest from "./NewThreadMessageRequest.mjs";
+
+//#region src/definitions/MthSendMessageRequest.d.ts
+/**
+ * Request body for operation mthSendMessage
+ */
+interface MthSendMessageRequest {
+  /**
+   * Required
+   */
+  metadata?: NewThreadMessageRequest;
+  /**
+   * Required
+   */
+  attachments?: Attachment[];
+}
+//#endregion
+export { MthSendMessageRequest as default };

package/dist/definitions/MthSendMessageRequest.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSyncAliveMessage.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSyncAliveMessage.d.cts

@@ -0,0 +1,67 @@
+import MessageAttachmentResponseEntry from "./MessageAttachmentResponseEntry.cjs";
+import MthSyncAliveMessageAuthor from "./MthSyncAliveMessageAuthor.cjs";
+
+//#region src/definitions/MthSyncAliveMessage.d.ts
+interface MthSyncAliveMessage {
+  /**
+   * Required
+   */
+  recordType?: "AliveMessage";
+  /**
+   * Internal identifier of a message
+   * Required
+   */
+  id?: string;
+  /**
+   * Internal identifier of a message thread
+   * Required
+   */
+  threadId?: string;
+  /**
+   * Thread/message availability
+   * Required
+   */
+  availability?: "Alive" | "Deleted";
+  /**
+   * Message creation date/time
+   * Required
+   * Format: date-time
+   */
+  creationTime?: string;
+  /**
+   * Message direction (inbound or outbound)
+   * Required
+   */
+  direction?: "Inbound" | "Outbound";
+  /**
+   * Message last modification date/time
+   * Required
+   * 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 or note text
+   * Example: Hello, how are you doing today?
+   */
+  text?: string;
+  /**
+   * Message attachments (if any)
+   */
+  attachments?: MessageAttachmentResponseEntry[];
+  /**
+   * Message author (for outbound messages only)
+   */
+  author?: MthSyncAliveMessageAuthor;
+}
+//#endregion
+export { MthSyncAliveMessage as default };

package/dist/definitions/MthSyncAliveMessage.d.mts

@@ -0,0 +1,67 @@
+import MessageAttachmentResponseEntry from "./MessageAttachmentResponseEntry.mjs";
+import MthSyncAliveMessageAuthor from "./MthSyncAliveMessageAuthor.mjs";
+
+//#region src/definitions/MthSyncAliveMessage.d.ts
+interface MthSyncAliveMessage {
+  /**
+   * Required
+   */
+  recordType?: "AliveMessage";
+  /**
+   * Internal identifier of a message
+   * Required
+   */
+  id?: string;
+  /**
+   * Internal identifier of a message thread
+   * Required
+   */
+  threadId?: string;
+  /**
+   * Thread/message availability
+   * Required
+   */
+  availability?: "Alive" | "Deleted";
+  /**
+   * Message creation date/time
+   * Required
+   * Format: date-time
+   */
+  creationTime?: string;
+  /**
+   * Message direction (inbound or outbound)
+   * Required
+   */
+  direction?: "Inbound" | "Outbound";
+  /**
+   * Message last modification date/time
+   * Required
+   * 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 or note text
+   * Example: Hello, how are you doing today?
+   */
+  text?: string;
+  /**
+   * Message attachments (if any)
+   */
+  attachments?: MessageAttachmentResponseEntry[];
+  /**
+   * Message author (for outbound messages only)
+   */
+  author?: MthSyncAliveMessageAuthor;
+}
+//#endregion
+export { MthSyncAliveMessage as default };

package/dist/definitions/MthSyncAliveMessage.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSyncAliveMessageAuthor.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSyncAliveMessageAuthor.d.cts

@@ -0,0 +1,22 @@
+//#region src/definitions/MthSyncAliveMessageAuthor.d.ts
+interface MthSyncAliveMessageAuthor {
+  /**
+   * Thread user's extension ID
+   * Example: 9876453210
+   */
+  extensionId?: string;
+  /**
+   * Thread user's name (first + last)
+   * Example: John Doe
+   */
+  name?: string;
+  /**
+   * Type of the extension. For unrecognized types the `Unknown` value is returned.
+   *  Please note that legacy 'Department' extension type corresponds to 'Call Queue'
+   *  extensions in modern RingCentral product terminology
+   * Example: User
+   */
+  extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser" | "TieLine" | "Unknown";
+}
+//#endregion
+export { MthSyncAliveMessageAuthor as default };

package/dist/definitions/MthSyncAliveMessageAuthor.d.mts

@@ -0,0 +1,22 @@
+//#region src/definitions/MthSyncAliveMessageAuthor.d.ts
+interface MthSyncAliveMessageAuthor {
+  /**
+   * Thread user's extension ID
+   * Example: 9876453210
+   */
+  extensionId?: string;
+  /**
+   * Thread user's name (first + last)
+   * Example: John Doe
+   */
+  name?: string;
+  /**
+   * Type of the extension. For unrecognized types the `Unknown` value is returned.
+   *  Please note that legacy 'Department' extension type corresponds to 'Call Queue'
+   *  extensions in modern RingCentral product terminology
+   * Example: User
+   */
+  extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser" | "TieLine" | "Unknown";
+}
+//#endregion
+export { MthSyncAliveMessageAuthor as default };

package/dist/definitions/MthSyncAliveMessageAuthor.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSyncAliveNote.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSyncAliveNote.d.cts

@@ -0,0 +1,47 @@
+import MthSyncAliveNoteAuthor from "./MthSyncAliveNoteAuthor.cjs";
+
+//#region src/definitions/MthSyncAliveNote.d.ts
+interface MthSyncAliveNote {
+  /**
+   * Required
+   */
+  recordType?: "AliveNote";
+  /**
+   * Internal identifier of a note
+   * Required
+   */
+  id?: string;
+  /**
+   * Internal identifier of a message thread
+   * Required
+   */
+  threadId?: string;
+  /**
+   * Thread/message availability
+   * Required
+   */
+  availability?: "Alive" | "Deleted";
+  /**
+   * Note creation date/time
+   * Required
+   * Format: date-time
+   */
+  creationTime?: string;
+  /**
+   * Message last modification date/time
+   * Required
+   * Format: date-time
+   */
+  lastModifiedTime?: string;
+  /**
+   * Message or note text
+   * Example: Hello, how are you doing today?
+   */
+  text?: string;
+  /**
+   * Thread note author
+   */
+  author?: MthSyncAliveNoteAuthor;
+}
+//#endregion
+export { MthSyncAliveNote as default };

package/dist/definitions/MthSyncAliveNote.d.mts

@@ -0,0 +1,47 @@
+import MthSyncAliveNoteAuthor from "./MthSyncAliveNoteAuthor.mjs";
+
+//#region src/definitions/MthSyncAliveNote.d.ts
+interface MthSyncAliveNote {
+  /**
+   * Required
+   */
+  recordType?: "AliveNote";
+  /**
+   * Internal identifier of a note
+   * Required
+   */
+  id?: string;
+  /**
+   * Internal identifier of a message thread
+   * Required
+   */
+  threadId?: string;
+  /**
+   * Thread/message availability
+   * Required
+   */
+  availability?: "Alive" | "Deleted";
+  /**
+   * Note creation date/time
+   * Required
+   * Format: date-time
+   */
+  creationTime?: string;
+  /**
+   * Message last modification date/time
+   * Required
+   * Format: date-time
+   */
+  lastModifiedTime?: string;
+  /**
+   * Message or note text
+   * Example: Hello, how are you doing today?
+   */
+  text?: string;
+  /**
+   * Thread note author
+   */
+  author?: MthSyncAliveNoteAuthor;
+}
+//#endregion
+export { MthSyncAliveNote as default };

package/dist/definitions/MthSyncAliveNote.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSyncAliveNoteAuthor.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSyncAliveNoteAuthor.d.cts

@@ -0,0 +1,22 @@
+//#region src/definitions/MthSyncAliveNoteAuthor.d.ts
+interface MthSyncAliveNoteAuthor {
+  /**
+   * Thread user's extension ID
+   * Example: 9876453210
+   */
+  extensionId?: string;
+  /**
+   * Thread user's name (first + last)
+   * Example: John Doe
+   */
+  name?: string;
+  /**
+   * Type of the extension. For unrecognized types the `Unknown` value is returned.
+   *  Please note that legacy 'Department' extension type corresponds to 'Call Queue'
+   *  extensions in modern RingCentral product terminology
+   * Example: User
+   */
+  extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser" | "TieLine" | "Unknown";
+}
+//#endregion
+export { MthSyncAliveNoteAuthor as default };

package/dist/definitions/MthSyncAliveNoteAuthor.d.mts

@@ -0,0 +1,22 @@
+//#region src/definitions/MthSyncAliveNoteAuthor.d.ts
+interface MthSyncAliveNoteAuthor {
+  /**
+   * Thread user's extension ID
+   * Example: 9876453210
+   */
+  extensionId?: string;
+  /**
+   * Thread user's name (first + last)
+   * Example: John Doe
+   */
+  name?: string;
+  /**
+   * Type of the extension. For unrecognized types the `Unknown` value is returned.
+   *  Please note that legacy 'Department' extension type corresponds to 'Call Queue'
+   *  extensions in modern RingCentral product terminology
+   * Example: User
+   */
+  extensionType?: "User" | "Department" | "Announcement" | "Voicemail" | "DigitalUser" | "VirtualUser" | "FaxUser" | "PagingOnly" | "SharedLinesGroup" | "DelegatedLinesGroup" | "GroupCallPickup" | "IvrMenu" | "ApplicationExtension" | "ProxyAdmin" | "RoomConnector" | "ParkLocation" | "Limited" | "Bot" | "Site" | "Room" | "FlexibleUser" | "TieLine" | "Unknown";
+}
+//#endregion
+export { MthSyncAliveNoteAuthor as default };

package/dist/definitions/MthSyncAliveNoteAuthor.mjs

@@ -0,0 +1 @@
+export {};

package/dist/definitions/MthSyncAssignedHint.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/dist/definitions/MthSyncAssignedHint.d.cts

@@ -0,0 +1,39 @@
+import MthSyncAssignedHintInitiator from "./MthSyncAssignedHintInitiator.cjs";
+import ThreadUserModel from "./ThreadUserModel.cjs";
+
+//#region src/definitions/MthSyncAssignedHint.d.ts
+interface MthSyncAssignedHint {
+  /**
+   * Required
+   */
+  recordType?: "ThreadCreatedHint" | "ThreadResolvedHint" | "ThreadDeletedHint" | "ThreadAssignedHint";
+  /**
+   * Internal identifier of a system message
+   * Required
+   */
+  id?: string;
+  /**
+   * Internal identifier of a message thread
+   * Required
+   */
+  threadId?: string;
+  /**
+   * Last modification date/time (always the same as a creation time since the system hints are immutable)
+   * Required
+   * Format: date-time
+   */
+  lastModifiedTime?: string;
+  /**
+   * Initiator of the action.
+   *  Can be missing if the action was initiated by the system.
+   */
+  initiator?: MthSyncAssignedHintInitiator;
+  /**
+   */
+  assignee?: ThreadUserModel;
+  /**
+   */
+  previousAssignee?: ThreadUserModel;
+}
+//#endregion
+export { MthSyncAssignedHint as default };