@talqing/sdk 0.4.0 → 0.4.1

package/dist/esm/gen/sdk.gen.js

@@ -1767,6 +1767,37 @@ export class Recipients2 extends HeyApiClient {
             }
         });
     }
+    /**
+     * Redraft Email Batch Recipients
+     *
+     * Draft rows again from scratch. **Each one runs the task and is billed again.**
+     *
+     * `selection` is `failed` (drafting failed), `stale_version` (drafted by an
+     * older published version of the task), `not_sent`, or `all` — which names
+     * every row it refuses. Rows already sent or queued are never redrafted.
+     *
+     * This revives a batch that had finished drafting, and a person's edited cells
+     * survive unless you pass `clear_overrides`.
+     */
+    redraft(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'redraftRequest', map: 'body' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/redraft',
+            ...options,
+            ...params,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options?.headers,
+                ...params.headers
+            }
+        });
+    }
     /**
      * Restore Email Batch Recipients
      *
@@ -1792,17 +1823,15 @@ export class Recipients2 extends HeyApiClient {
         });
     }
     /**
-     * Retry Email Batch Recipients
+     * Skip Email Batch Recipients
      *
-     * Draft rows whose first attempt failed, again.
+     * Take drafted rows out of consideration. Reversible with `restore`.
      *
-     * `selection: "all_eligible"` means every row whose drafting failed. This is
-     * the one action that revives a batch that has already finished drafting: it
-     * goes back to `drafting` and picks up exactly the rows you retried — the
-     * alternative would be telling you that twelve failed rows are unrecoverable
-     * because the other 4 988 finished first.
+     * Takes either `recipient_ids` or `selection: "all_eligible"`, which here means
+     * every row that has a draft. The reversible verbs keep that shorthand while
+     * `send` does not, because the rule is about irreversibility rather than bulk.
      */
-    retry(parameters, options) {
+    skip(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'selectRecipientsRequest', map: 'body' }] }]);
         return (options?.client ?? this.client).post({
             responseStyle: 'data',
@@ -1811,7 +1840,7 @@ export class Recipients2 extends HeyApiClient {
                     name: 'talqing_session',
                     type: 'apiKey'
                 }],
-            url: '/v1/email/batches/{batch_id}/retry',
+            url: '/v1/email/batches/{batch_id}/skip',
             ...options,
             ...params,
             headers: {
@@ -1821,21 +1850,47 @@ export class Recipients2 extends HeyApiClient {
             }
         });
     }
+}
+export class Sends extends HeyApiClient {
+    /**
+     * List Email Sends
+     *
+     * Every send on this batch, newest first, with its counts and its schedule.
+     */
+    list(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [
+                    { in: 'path', key: 'batch_id' },
+                    { in: 'query', key: 'limit' },
+                    { in: 'query', key: 'offset' }
+                ] }]);
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/sends',
+            ...options,
+            ...params
+        });
+    }
     /**
-     * Send Email Batch Recipients
+     * Create Email Send
      *
-     * Send the rows you name. **This mails real people and cannot be undone.**
+     * Send these rows. **This mails real people and cannot be undone.**
      *
-     * At most 50 rows per call, named one by one — there is no "select all" and no
-     * bulk form of this. A row whose `to`, `subject` or `body` does not resolve
-     * comes back in `rejected` and stays a draft; fix it with
-     * `patch_email_batch_recipient` and try again.
+     * Name `recipient_ids`, or pass `selection: "all_drafts"` for every reviewed
+     * draft. A row whose `to`, `subject` or `body` does not resolve comes back in
+     * `rejected` and stays a draft; fix it with `patch_email_batch_recipient`.
      *
-     * `from_email`, `from_name` and `reply_to` override the sender for this call
-     * only, and must be on a domain verified on the same Resend account.
+     * The send is a row you can steer: `start_at` schedules it, `window` holds it
+     * to business hours, `send_gap_seconds` paces it and `send_daily_cap` bounds
+     * how many leave per day. Everything omitted comes from the batch. Cancel it
+     * and every unsent row comes back as a draft.
      */
-    send(parameters, options) {
-        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'sendEmailBatchRequest', map: 'body' }] }]);
+    create(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'createEmailSendRequest', map: 'body' }] }]);
         return (options?.client ?? this.client).post({
             responseStyle: 'data',
             security: [{ scheme: 'bearer', type: 'http' }, {
@@ -1843,7 +1898,7 @@ export class Recipients2 extends HeyApiClient {
                     name: 'talqing_session',
                     type: 'apiKey'
                 }],
-            url: '/v1/email/batches/{batch_id}/send',
+            url: '/v1/email/batches/{batch_id}/sends',
             ...options,
             ...params,
             headers: {
@@ -1854,24 +1909,49 @@ export class Recipients2 extends HeyApiClient {
         });
     }
     /**
-     * Skip Email Batch Recipients
+     * Get Email Send
      *
-     * Take drafted rows out of consideration. Reversible with `restore`.
+     * One send: where its rows are, and when it next does something.
      *
-     * Takes either `recipient_ids` or `selection: "all_eligible"`, which here means
-     * every row that has a draft. The reversible verbs keep that shorthand while
-     * `send` does not, because the rule is about irreversibility rather than bulk.
+     * `next_send_at` covers all three reasons a send waits — a start time, a closed
+     * window, and a daily cap already spent.
      */
-    skip(parameters, options) {
-        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'selectRecipientsRequest', map: 'body' }] }]);
-        return (options?.client ?? this.client).post({
+    get(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { in: 'path', key: 'send_id' }] }]);
+        return (options?.client ?? this.client).get({
             responseStyle: 'data',
             security: [{ scheme: 'bearer', type: 'http' }, {
                     in: 'cookie',
                     name: 'talqing_session',
                     type: 'apiKey'
                 }],
-            url: '/v1/email/batches/{batch_id}/skip',
+            url: '/v1/email/batches/{batch_id}/sends/{send_id}',
+            ...options,
+            ...params
+        });
+    }
+    /**
+     * Patch Email Send
+     *
+     * Re-steer one send: its pace, its hours, its daily cap, its start time.
+     *
+     * Never its sender, and never which rows it holds — to change that, cancel it
+     * and create another. `start_at` moves only before the send has begun.
+     */
+    update(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [
+                    { in: 'path', key: 'batch_id' },
+                    { in: 'path', key: 'send_id' },
+                    { key: 'patchEmailSendRequest', map: 'body' }
+                ] }]);
+        return (options?.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/sends/{send_id}',
             ...options,
             ...params,
             headers: {
@@ -1881,6 +1961,68 @@ export class Recipients2 extends HeyApiClient {
             }
         });
     }
+    /**
+     * Cancel Email Send
+     *
+     * Stop this send, and give every row it has not sent back as a draft.
+     *
+     * Not a destructive action: the drafts come back exactly as they were, ready
+     * for another send. It is also the only way to change what a scheduled send
+     * contains — a send's rows are fixed once it exists.
+     */
+    cancel(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { in: 'path', key: 'send_id' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/sends/{send_id}/cancel',
+            ...options,
+            ...params
+        });
+    }
+    /**
+     * Pause Email Send
+     *
+     * Stop sending. It takes hold on the next email, and nothing is lost —
+     * the rows stay queued for whenever you resume.
+     */
+    pause(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { in: 'path', key: 'send_id' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/sends/{send_id}/pause',
+            ...options,
+            ...params
+        });
+    }
+    /**
+     * Resume Email Send
+     *
+     * Undo a pause and carry on from where it stopped.
+     */
+    resume(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { in: 'path', key: 'send_id' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/email/batches/{batch_id}/sends/{send_id}/resume',
+            ...options,
+            ...params
+        });
+    }
 }
 export class Batches2 extends HeyApiClient {
     /**
@@ -1922,13 +2064,16 @@ export class Batches2 extends HeyApiClient {
      * scraped contacts — and this runs on your account under your agreement.
      *
      * **Nothing is sent that a person has not selected.** Creating a batch only
-     * starts drafting; sending is a separate call over at most 50 named rows.
+     * starts drafting; sending is a separate call that creates a send you can
+     * schedule, pace, pause and cancel.
      *
-     * **Every row runs your task as it stands right now** — a task has no
-     * versions, so editing it mid-batch changes every row drafted after that.
+     * **Every row runs the task's CURRENT published version**, re-read every pass,
+     * so publishing a better prompt mid-batch changes every row drafted after it.
      *
      * `field_map` points `to`, `subject` and `body` at a column of your list or at
-     * a field the task produces. An invalid batch is a 400 listing every problem.
+     * a field the task produces. `window` is when email may LEAVE, inherited by
+     * every send; drafting is not restricted by hours. An invalid batch is a 400
+     * listing every problem.
      *
      * There is no spend cap: every row runs the task and is billed, so a 5 000-row
      * batch doing research costs 5 000 task runs whether or not anything is sent.
@@ -1957,8 +2102,8 @@ export class Batches2 extends HeyApiClient {
      *
      * One batch: its policy, its per-status counts and what drafting has cost.
      *
-     * While the batch is waiting on a start time or a closed window, the response
-     * also carries `next_draft_at`.
+     * `drafted_versions` says which published version of the task wrote how many
+     * rows, and `sent_today` how much of `send_daily_cap` is left today.
      */
     get(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }] }]);
@@ -1979,10 +2124,12 @@ export class Batches2 extends HeyApiClient {
      *
      * Edit a batch's policy. The next drafting pass reads the new row.
      *
-     * Pacing and the calling window are editable at any time. The sender, the body
-     * format and the field map freeze once the batch has sent anything — changing
-     * them then would make the rows already delivered no longer describe what they
-     * were sent as. `start_at` moves only while the batch is still scheduled.
+     * Pacing, the window and the daily cap are editable at any time; the sending
+     * half is the DEFAULT for the next send, and a send already created carries its
+     * own copy. The sender, the body format and the field map freeze once the batch
+     * has sent anything — changing them then would make the rows already delivered
+     * no longer describe what they were sent as. `start_at` moves only while the
+     * batch is still scheduled.
      */
     update(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }, { key: 'patchEmailBatchRequest', map: 'body' }] }]);
@@ -2006,12 +2153,12 @@ export class Batches2 extends HeyApiClient {
     /**
      * Cancel Email Batch
      *
-     * Stop drafting for good. This is the only terminal action — a batch cannot
-     * be deleted, because it is the record of what was sent to whom.
+     * Stop drafting for good. A batch cannot be deleted, because it is the
+     * record of what was sent to whom.
      *
-     * Rows already drafted are **not** touched: cancelling stops drafting, and
-     * drafts already produced are still worth reviewing and sending. Rows never
-     * reached report as `canceled`.
+     * Rows already drafted are **not** touched and neither is any send: cancelling
+     * stops drafting, and drafts already produced are still worth reviewing and
+     * sending. Rows never reached report as `canceled`.
      */
     cancel(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'batch_id' }] }]);
@@ -2071,6 +2218,9 @@ export class Batches2 extends HeyApiClient {
     get recipients() {
         return this._recipients ?? (this._recipients = new Recipients2({ client: this.client }));
     }
+    get sends() {
+        return this._sends ?? (this._sends = new Sends({ client: this.client }));
+    }
 }
 export class Senders extends HeyApiClient {
     /**
@@ -2892,8 +3042,8 @@ export class Runs extends HeyApiClient {
      *
      * This task's runs, newest first, each with its output, trace and cost.
      *
-     * A run records the task's *name* and nothing else about the definition it ran
-     * under, so two runs either side of an edit are indistinguishable here.
+     * `task_version` says which published definition each one ran, and is null for
+     * a run of the draft.
      */
     list(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [
@@ -2922,10 +3072,12 @@ export class Runs extends HeyApiClient {
      * the MCP servers spend your credits, and the model spends your tokens. A task
      * that books a slot, charges a card or sends a message will do so.
      *
-     * `vars` must match what the task declares — an unknown name is refused rather
-     * than dropped. The response is the whole run: the structured `output`, a
-     * `trace` of every tool call, the steps used and what the tokens cost. On
-     * failure `error.type` says whose problem it is. Secrets are redacted.
+     * Runs the published version unless `version` names another one, or `"draft"`
+     * to run the unpublished config. `vars` must match what that version declares
+     * — an unknown name is refused rather than dropped. The response is the whole
+     * run: the structured `output`, a `trace` of every tool call, the steps used
+     * and what the tokens cost. On failure `error.type` says whose problem it is.
+     * Secrets are redacted.
      */
     create(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }, { key: 'runTaskRequest', map: 'body' }] }]);
@@ -2971,6 +3123,55 @@ export class Runs extends HeyApiClient {
         });
     }
 }
+export class Versions2 extends HeyApiClient {
+    /**
+     * Get Task Version
+     *
+     * Fetch what one published version of a task actually contains.
+     *
+     * `get_task` lists the versions and when each was published; this returns the
+     * frozen definition itself — prompt, model, output fields and the tool
+     * versions it pinned, exactly as they were at that publish.
+     */
+    get(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }, { in: 'path', key: 'version' }] }]);
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/tasks/{task_id}/versions/{version}',
+            ...options,
+            ...params
+        });
+    }
+    /**
+     * Rollback Task Version
+     *
+     * Put an earlier published version of a task back into production.
+     *
+     * That version becomes live **immediately** and **replaces the current draft**,
+     * so any unpublished edits are lost. No new version is created. The restored
+     * draft tracks each tool's latest published version, not the ones this version
+     * pinned.
+     */
+    rollback(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }, { in: 'path', key: 'version' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/tasks/{task_id}/versions/{version}/rollback',
+            ...options,
+            ...params
+        });
+    }
+}
 export class Tasks2 extends HeyApiClient {
     /**
      * List Tasks
@@ -2979,9 +3180,8 @@ export class Tasks2 extends HeyApiClient {
      *
      * A task is an agent nobody talks to: a prompt, one LLM, tools and MCP
      * servers, the variables it takes as input, and the typed result it must
-     * produce. `last_run` says how the most recent run of each one went, so a
-     * task whose prompt stopped calling `submit_result` is visible here rather
-     * than only in its own history.
+     * produce. Each item carries the full draft config, the published version
+     * number (null while it has never been published), and `last_run`.
      */
     list(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'limit' }, { in: 'query', key: 'offset' }] }]);
@@ -3003,16 +3203,10 @@ export class Tasks2 extends HeyApiClient {
      * Create an agent task: an agent nobody talks to, which takes named inputs
      * and returns a typed result.
      *
-     * A task has no draft and no publish step: it is valid the moment it saves and
-     * callable immediately. An invalid config is a 400 listing every problem and
-     * nothing is stored.
-     *
      * `output` is what makes this a task rather than a chat agent — declare the
      * fields the model must produce and it is given a `submit_result` tool built
-     * from them. `vars` are its inputs, read as `{{vars.name}}`.
-     *
-     * `warnings` reports the non-fatal problems. There is no publish screen to
-     * show them on, so read them here.
+     * from them. `vars` are its inputs, read as `{{vars.name}}`. The task starts
+     * unpublished; publish it before running it.
      */
     create(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ key: 'createTaskRequest', map: 'body' }] }]);
@@ -3036,7 +3230,8 @@ export class Tasks2 extends HeyApiClient {
     /**
      * Delete Task
      *
-     * Delete a task. Its run history survives, still named after it.
+     * Delete a task and its published versions. Its runs survive, still named
+     * after it.
      */
     delete(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }] }]);
@@ -3055,7 +3250,7 @@ export class Tasks2 extends HeyApiClient {
     /**
      * Get Task
      *
-     * Fetch one task's config and how its last run went.
+     * Fetch one task's draft config, published version, history and last run.
      */
     get(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }] }]);
@@ -3074,12 +3269,11 @@ export class Tasks2 extends HeyApiClient {
     /**
      * Update Task
      *
-     * Replace a task's config.
+     * Replace the task's draft config with the one supplied.
      *
-     * The whole config is sent, so include every field you mean to keep, and it is
-     * validated exactly as `create_task` is. The edit takes effect on the next run
-     * — a task has no versions, so there is no old wording to go back to and no
-     * record of which definition produced an earlier run.
+     * The whole config is sent, so include every field you mean to keep. Writes
+     * land on the draft only — runs and email batches keep using the published
+     * version until you publish again.
      */
     update(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }, { key: 'patchTaskRequest', map: 'body' }] }]);
@@ -3100,9 +3294,59 @@ export class Tasks2 extends HeyApiClient {
             }
         });
     }
+    /**
+     * Publish Task
+     *
+     * Freeze the current draft as a new immutable version and make it live.
+     *
+     * Validation must pass. Publishing pins every attached tool to the tool
+     * version live right now, so republishing a tool does not change this task
+     * until the task is published again.
+     */
+    publish(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/tasks/{task_id}/publish',
+            ...options,
+            ...params
+        });
+    }
+    /**
+     * Validate Task
+     *
+     * Run publish-grade validation on the draft without publishing it.
+     *
+     * Covers everything a draft write checks plus what publishing adds: a
+     * workspace API key for the model, at least one output field, the operation
+     * trees of the attached tools, and the email batches already drafting with
+     * this task. Returns errors (blocking) and warnings (advisory).
+     */
+    validate(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: 'path', key: 'task_id' }] }]);
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: 'talqing_session',
+                    type: 'apiKey'
+                }],
+            url: '/v1/tasks/{task_id}/validate',
+            ...options,
+            ...params
+        });
+    }
     get runs() {
         return this._runs ?? (this._runs = new Runs({ client: this.client }));
     }
+    get versions() {
+        return this._versions ?? (this._versions = new Versions2({ client: this.client }));
+    }
 }
 export class Accounts extends HeyApiClient {
     /**
@@ -3504,7 +3748,7 @@ export class Telephony extends HeyApiClient {
         return this._providers ?? (this._providers = new Providers({ client: this.client }));
     }
 }
-export class Versions2 extends HeyApiClient {
+export class Versions3 extends HeyApiClient {
     /**
      * Get Tool Version
      *
@@ -3760,7 +4004,7 @@ export class Tools2 extends HeyApiClient {
         });
     }
     get versions() {
-        return this._versions ?? (this._versions = new Versions2({ client: this.client }));
+        return this._versions ?? (this._versions = new Versions3({ client: this.client }));
     }
 }
 export class Webhooks extends HeyApiClient {