@talqing/sdk 0.15.2 → 0.16.0

package/dist/cjs/gen/types.gen.d.ts

@@ -747,6 +747,19 @@ export type AssistantStartedEvent = {
      */
     trigger_item_id: string;
 };
+/**
+ * AttachmentNotKept
+ *
+ * A file the person sent that could not be stored.
+ */
+export type AttachmentNotKept = {
+    /**
+     * Reason
+     *
+     * Why, as a sentence for a person.
+     */
+    reason: string;
+};
 /**
  * AvatarCatalogEntryResponse
  */
@@ -1863,9 +1876,11 @@ export type ChatMessageRequest = {
      */
     client_message_id: string;
     /**
-     * Images
+     * Files
+     *
+     * Any type; photos, PDFs and Word files are read by the agent.
      */
-    images?: Array<InboundImage>;
+    files?: Array<InboundFile>;
     /**
      * Message
      */
@@ -2107,11 +2122,115 @@ export type ConversationActivity = {
     state: 'running' | 'idle';
 };
 /**
- * ConversationAttachment
+ * ConversationDocument
+ *
+ * A PDF or Word file the person sent, and whether the agent could read it.
+ */
+export type ConversationDocument = {
+    /**
+     * Bytes
+     */
+    bytes: number;
+    /**
+     * Filename
+     */
+    filename: string | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Kind
+     */
+    kind?: 'document';
+    /**
+     * Mime Type
+     */
+    mime_type: string;
+    /**
+     * Pages
+     *
+     * A PDF's page count; null for Word files.
+     */
+    pages: number | null;
+    /**
+     * Status
+     *
+     * `pending` until the agent's next turn reads it.
+     */
+    status: 'pending' | 'read' | 'unreadable';
+    /**
+     * Unreadable Reason
+     *
+     * Why the agent could not read it.
+     */
+    unreadable_reason: string | null;
+    /**
+     * Url
+     *
+     * Signed download link; valid until `url_expires_at`.
+     */
+    url: string;
+    /**
+     * Url Expires At
+     */
+    url_expires_at: string;
+};
+/**
+ * ConversationFile
  *
- * One image as the API returns it: the same record, signed, minus the key.
+ * Any other file the person sent, stored for you; the agent cannot open it.
  */
-export type ConversationAttachment = {
+export type ConversationFile = {
+    /**
+     * Bytes
+     */
+    bytes: number;
+    /**
+     * Extension
+     *
+     * The type read from its bytes, e.g. `xlsx`; `bin` if unknown.
+     */
+    extension: string;
+    /**
+     * Filename
+     */
+    filename: string | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Kind
+     */
+    kind?: 'file';
+    /**
+     * Mime Type
+     */
+    mime_type: string;
+    /**
+     * Playable
+     *
+     * Set when `url` plays in an `<audio>` or `<video>` element.
+     */
+    playable: 'audio' | 'video' | null;
+    /**
+     * Url
+     *
+     * Signed link; valid until `url_expires_at`.
+     */
+    url: string;
+    /**
+     * Url Expires At
+     */
+    url_expires_at: string;
+};
+/**
+ * ConversationImage
+ *
+ * A photo the person sent, with a short-lived link to it.
+ */
+export type ConversationImage = {
     /**
      * Bytes
      */
@@ -2138,6 +2257,8 @@ export type ConversationAttachment = {
     mime_type: string;
     /**
      * Url
+     *
+     * Signed; valid until `url_expires_at`.
      */
     url: string;
     /**
@@ -2164,7 +2285,13 @@ export type ConversationItemResponse = {
     /**
      * Attachments
      */
-    attachments: Array<ConversationAttachment>;
+    attachments: Array<ConversationImage | ConversationDocument | ConversationFile>;
+    /**
+     * Attachments Not Kept
+     *
+     * Files the person sent that could not be stored.
+     */
+    attachments_not_kept: Array<AttachmentNotKept>;
     /**
      * Who at your business posted this.
      */
@@ -2212,12 +2339,6 @@ export type ConversationItemResponse = {
      * Idempotency Key
      */
     idempotency_key: string | null;
-    /**
-     * Images Not Kept
-     *
-     * Images the person sent that were not stored, and why.
-     */
-    images_not_kept: Array<ImageNotKept>;
     latency: ReplyLatency | null;
     /**
      * Metadata
@@ -5256,15 +5377,6 @@ export type IfOperation = {
      */
     then?: Array<HttpOperation | CodeOperation | FrontendRpcOperation | IfOperation | SetVariableOperation | SayOperation | GenerateReplyOperation | AddMessageOperation | EndCallOperation | HandoffOperation | TransferOperation | SendDtmfOperation> | null;
 };
-/**
- * ImageNotKept
- */
-export type ImageNotKept = {
-    /**
-     * Reason
-     */
-    reason: string;
-};
 /**
  * ImportPhoneNumbersRequest
  */
@@ -5342,13 +5454,15 @@ export type InboundContent = {
     replied_to?: string | null;
 };
 /**
- * InboundImage
+ * InboundFile
  *
- * One image on an inbound text message: the bytes, and what to call them.
+ * One file on an inbound text message: the bytes, and what to call them.
  */
-export type InboundImage = {
+export type InboundFile = {
     /**
      * Data Url
+     *
+     * `data:<mime>;base64,<bytes>`, up to 20 MB decoded.
      */
     data_url: string;
     /**
@@ -5895,7 +6009,13 @@ export type ItemCreatedEvent = {
     /**
      * Attachments
      */
-    attachments: Array<ConversationAttachment>;
+    attachments: Array<ConversationImage | ConversationDocument | ConversationFile>;
+    /**
+     * Attachments Not Kept
+     *
+     * Files the person sent that could not be stored.
+     */
+    attachments_not_kept: Array<AttachmentNotKept>;
     /**
      * Who at your business posted this.
      */
@@ -5947,12 +6067,6 @@ export type ItemCreatedEvent = {
      * Idempotency Key
      */
     idempotency_key: string | null;
-    /**
-     * Images Not Kept
-     *
-     * Images the person sent that were not stored, and why.
-     */
-    images_not_kept: Array<ImageNotKept>;
     latency: ReplyLatency | null;
     /**
      * Metadata
@@ -16637,6 +16751,55 @@ export type ConversationsUpdateResults = {
     200: ConversationResponse;
 };
 export type ConversationsUpdateResult = ConversationsUpdateResults[keyof ConversationsUpdateResults];
+export type ConversationsAttachmentsGetData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation Id
+         */
+        conversation_id: string;
+        /**
+         * Attachment Id
+         */
+        attachment_id: string;
+    };
+    query?: never;
+    url: '/v1/conversations/{conversation_id}/attachments/{attachment_id}';
+};
+export type ConversationsAttachmentsGetErrors = {
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+export type ConversationsAttachmentsGetError = ConversationsAttachmentsGetErrors[keyof ConversationsAttachmentsGetErrors];
+export type ConversationsAttachmentsGetResults = {
+    /**
+     * Response Conversations.Attachments.Get
+     *
+     * Successful Response
+     */
+    200: ({
+        kind: 'image';
+    } & ConversationImage) | ({
+        kind: 'document';
+    } & ConversationDocument) | ({
+        kind: 'file';
+    } & ConversationFile);
+};
+export type ConversationsAttachmentsGetResult = ConversationsAttachmentsGetResults[keyof ConversationsAttachmentsGetResults];
 export type ConversationsEventsData = {
     body?: never;
     path: {