@talqing/sdk 0.16.1 → 0.17.0

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

@@ -3158,6 +3158,9 @@ export type CreateChatRequest = {
 };
 /**
  * CreateEmailBatchRequest
+ *
+ * Each email is written either by an agent task (`task_id` + `field_map`) or by
+ * a fixed `template` filled from the row's columns.
  */
 export type CreateEmailBatchRequest = {
     /**
@@ -3182,7 +3185,10 @@ export type CreateEmailBatchRequest = {
      * Draft Retry After Minutes
      */
     draft_retry_after_minutes?: number;
-    field_map: FieldMap;
+    /**
+     * With `task_id` only.
+     */
+    field_map?: FieldMap | null;
     /**
      * From Email
      *
@@ -3244,7 +3250,11 @@ export type CreateEmailBatchRequest = {
      *
      * The agent task that drafts each row.
      */
-    task_id: string;
+    task_id?: string | null;
+    /**
+     * Instead of a task: no drafting, every row is ready at once.
+     */
+    template?: EmailTemplate | null;
     /**
      * Timezone
      */
@@ -4185,7 +4195,7 @@ export type EmailBatchResponse = {
      * Failure Reason
      */
     failure_reason: string | null;
-    field_map: FieldMap;
+    field_map: FieldMap | null;
     /**
      * From Email
      */
@@ -4295,6 +4305,7 @@ export type EmailBatchResponse = {
      * Task Name
      */
     task_name: string | null;
+    template: EmailTemplate | null;
     /**
      * Timezone
      */
@@ -4358,6 +4369,7 @@ export type EmailRecipientResponse = {
     columns: {
         [key: string]: unknown;
     };
+    email: ResolvedEmail | null;
     /**
      * Id
      */
@@ -4564,6 +4576,27 @@ export type EmailSendResponse = {
     timezone: string;
     window: TimeWindow | null;
 };
+/**
+ * EmailTemplate
+ *
+ * A fixed email, filled per row: `{{column}}` in subject or body takes that row's cell.
+ */
+export type EmailTemplate = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * To
+     *
+     * The list column holding the address.
+     */
+    to: string;
+};
 /**
  * EndCallConfig
  *
@@ -8296,6 +8329,8 @@ export type PatchEmailBatchRequest = {
     draft_retry_after_minutes?: number;
     /**
      * Field Map
+     *
+     * Task batches only.
      */
     field_map?: FieldMap;
     /**
@@ -8338,6 +8373,12 @@ export type PatchEmailBatchRequest = {
      * Start At
      */
     start_at?: string | null;
+    /**
+     * Template
+     *
+     * Template batches only.
+     */
+    template?: EmailTemplate;
     /**
      * Timezone
      */
@@ -9889,6 +9930,25 @@ export type ReplyLatency = {
      */
     total_ms: number;
 };
+/**
+ * ResolvedEmail
+ *
+ * The email this row sends, as it stands now.
+ */
+export type ResolvedEmail = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * To
+     */
+    to: string;
+};
 /**
  * ResumeCallRequest
  */
@@ -10463,6 +10523,62 @@ export type SendMessageResponse = {
      */
     turn_id: string;
 };
+/**
+ * SendTestEmailRequest
+ *
+ * One email to yourself, filled from `vars` the way a template batch fills a row.
+ */
+export type SendTestEmailRequest = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Body Format
+     */
+    body_format?: 'text' | 'html';
+    /**
+     * From Email
+     */
+    from_email: string;
+    /**
+     * From Name
+     */
+    from_name?: string | null;
+    /**
+     * Integration Id
+     */
+    integration_id: string;
+    /**
+     * Reply To
+     */
+    reply_to?: string | null;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * Vars
+     *
+     * One row's cells.
+     */
+    vars?: {
+        [key: string]: string;
+    };
+};
+/**
+ * SendTestEmailResponse
+ */
+export type SendTestEmailResponse = {
+    /**
+     * Provider Message Id
+     */
+    provider_message_id: string;
+    /**
+     * To
+     */
+    to: string;
+};
 /**
  * SendWhatsAppBatchRequest
  *
@@ -18322,6 +18438,46 @@ export type EmailSendersListResults = {
     200: VerifiedSendersResponse;
 };
 export type EmailSendersListResult = EmailSendersListResults[keyof EmailSendersListResults];
+export type EmailTestSendsCreateData = {
+    body: SendTestEmailRequest;
+    path?: never;
+    query?: never;
+    url: '/v1/email/test-sends';
+};
+export type EmailTestSendsCreateErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: 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 EmailTestSendsCreateError = EmailTestSendsCreateErrors[keyof EmailTestSendsCreateErrors];
+export type EmailTestSendsCreateResults = {
+    /**
+     * Successful Response
+     */
+    200: SendTestEmailResponse;
+};
+export type EmailTestSendsCreateResult = EmailTestSendsCreateResults[keyof EmailTestSendsCreateResults];
 export type FaqsListData = {
     body?: never;
     path?: never;