telnyx 7.21.0 → 7.23.0

package/resources/ai/typesafe/v1.d.ts

@@ -0,0 +1,274 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Beta API for evaluating shared context with typed questions and structured answers. Telnyx manages model selection.
+ */
+export declare class V1 extends APIResource {
+    /**
+     * **Beta API.** Telnyx controls model selection.
+     *
+     * Evaluate shared context using named choice, noul (yes/no), and score questions.
+     * Returns TypeSafe System One-compatible answer shapes, an opaque compatibility
+     * identifier, and token usage. See the
+     * [decision model guide](https://developers.telnyx.com/docs/inference/decision-models)
+     * for examples and compatibility limits.
+     *
+     * The supported request subset requires instructions for every question, string
+     * descriptions for criteria (or null for choice descriptions), 1–64 questions, and
+     * 2–64 options for choice and score questions. The SDK-supplied model value is
+     * ignored and cannot select a model. Other unknown fields are rejected. The
+     * endpoint is synchronous and does not stream.
+     *
+     * Use the TypeSafe Python SDK with base_url set to
+     * https://api.telnyx.com/v2/ai/typesafe and a Telnyx API key. The SDK appends
+     * /v1/systemone. Compatibility covers this operation and the documented request
+     * subset; it does not include TypeSafe model listing. Scores describe relative
+     * preference, not calibrated correctness.
+     *
+     * @example
+     * ```ts
+     * const response = await client.ai.typesafe.v1.systemone({
+     *   questions: {
+     *     team: {
+     *       type: 'choice',
+     *       instructions:
+     *         'Choose the team that should handle this incident.',
+     *       criteria: {
+     *         billing: 'Payments and refunds',
+     *         technical_support:
+     *           'Service faults and technical problems',
+     *         sales: 'New purchases',
+     *       },
+     *     },
+     *     production_incident: {
+     *       type: 'noul',
+     *       instructions:
+     *         'Does the message describe an active production incident?',
+     *     },
+     *     urgency: {
+     *       type: 'score',
+     *       instructions: 'Rate operational urgency.',
+     *       criteria: ['Low', 'Normal', 'High', 'Critical'],
+     *     },
+     *   },
+     *   state:
+     *     'Our production calls are failing. Every customer is affected.',
+     * });
+     * ```
+     */
+    systemone(body: V1SystemoneParams, options?: RequestOptions): APIPromise<V1SystemoneResponse>;
+}
+/**
+ * A complete synchronous evaluation. Answers are returned directly without a data
+ * wrapper.
+ */
+export interface V1SystemoneResponse {
+    /**
+     * Answers keyed by exactly the question IDs in the request. Each answer type
+     * matches its question.
+     */
+    answers: {
+        [key: string]: V1SystemoneResponse.DecisionModelChoiceAnswer | V1SystemoneResponse.DecisionModelNoulAnswer | V1SystemoneResponse.DecisionModelScoreAnswer;
+    };
+    /**
+     * Opaque Telnyx-controlled identifier retained for TypeSafe SDK response
+     * compatibility. It is not a selectable model name or a guarantee of a particular
+     * underlying model.
+     */
+    model: string;
+    /**
+     * Token usage for the completed evaluation.
+     */
+    usage: V1SystemoneResponse.Usage;
+}
+export declare namespace V1SystemoneResponse {
+    /**
+     * A selected option and the distribution across all supplied option keys.
+     */
+    interface DecisionModelChoiceAnswer {
+        /**
+         * The option key with the highest relative score. Ties favor the first option in
+         * request order.
+         */
+        choice: string;
+        /**
+         * Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
+         * and N is the number of options. Zero indicates a uniform distribution; one
+         * indicates concentration on one option. This is neither the winning probability
+         * nor calibrated correctness.
+         */
+        confidence: number;
+        /**
+         * Relative scores normalized across the supplied options, summing approximately
+         * to 1. These are not calibrated probabilities of correctness.
+         */
+        probabilities: {
+            [key: string]: number;
+        };
+        /**
+         * Answer type.
+         */
+        type: 'choice';
+    }
+    /**
+     * A yes/no score with no separate confidence or probabilities fields.
+     */
+    interface DecisionModelNoulAnswer {
+        /**
+         * Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
+         * This is a number, not a Boolean, and is not calibrated correctness.
+         */
+        noul: number;
+        /**
+         * Answer type.
+         */
+        type: 'noul';
+    }
+    /**
+     * An expected rating over the ordered criteria.
+     */
+    interface DecisionModelScoreAnswer {
+        /**
+         * Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
+         * and N is the number of options. Zero indicates a uniform distribution; one
+         * indicates concentration on one option. This is neither the winning probability
+         * nor calibrated correctness.
+         */
+        confidence: number;
+        /**
+         * Criterion descriptions keyed by stringified zero-based indices, such as "0",
+         * "1", and "2".
+         */
+        legend: {
+            [key: string]: string;
+        };
+        /**
+         * Relative scores keyed by the same stringified indices as legend.
+         */
+        probabilities: {
+            [key: string]: number;
+        };
+        /**
+         * Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
+         * N-1 for N criteria; fractional values are valid.
+         */
+        score: number;
+        /**
+         * Answer type.
+         */
+        type: 'score';
+    }
+    /**
+     * Token usage for the completed evaluation.
+     */
+    interface Usage {
+        /**
+         * Input tokens processed, including shared-context preparation and question
+         * evaluation. This can exceed the token count of the unique input text.
+         */
+        input_tokens: number;
+        /**
+         * Output tokens used for the evaluation, including shared-context preparation.
+         */
+        output_tokens: number;
+    }
+}
+export interface V1SystemoneParams {
+    /**
+     * Between 1 and 64 named questions. Each key identifies the corresponding answer.
+     */
+    questions: {
+        [key: string]: V1SystemoneParams.DecisionModelChoiceQuestion | V1SystemoneParams.DecisionModelNoulQuestion | V1SystemoneParams.DecisionModelScoreQuestion;
+    };
+    /**
+     * Shared context evaluated by every question.
+     */
+    state: string | {
+        [key: string]: unknown;
+    } | Array<unknown>;
+}
+export declare namespace V1SystemoneParams {
+    /**
+     * Select one of the supplied options.
+     */
+    interface DecisionModelChoiceQuestion {
+        /**
+         * Between 2 and 64 option keys mapped to description strings or null. A null
+         * description uses the option key as its text.
+         */
+        criteria: {
+            [key: string]: string | null;
+        };
+        /**
+         * Required instructions describing what to decide about the shared state.
+         */
+        instructions: string | {
+            [key: string]: unknown;
+        } | Array<unknown>;
+        /**
+         * Question type.
+         */
+        type: 'choice';
+    }
+    /**
+     * Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
+     */
+    interface DecisionModelNoulQuestion {
+        /**
+         * Required instructions describing what to decide about the shared state.
+         */
+        instructions: string | {
+            [key: string]: unknown;
+        } | Array<unknown>;
+        /**
+         * Question type.
+         */
+        type: 'noul';
+        /**
+         * Optional descriptions for the positive and negative outcomes. Descriptions must
+         * be strings.
+         */
+        criteria?: DecisionModelNoulQuestion.Criteria;
+    }
+    namespace DecisionModelNoulQuestion {
+        /**
+         * Optional descriptions for the positive and negative outcomes. Descriptions must
+         * be strings.
+         */
+        interface Criteria {
+            /**
+             * Description of the negative outcome.
+             */
+            false?: string;
+            /**
+             * Description of the positive outcome.
+             */
+            true?: string;
+        }
+    }
+    /**
+     * Rate the state against an ordered rubric.
+     */
+    interface DecisionModelScoreQuestion {
+        /**
+         * Between 2 and 64 description strings in ascending score order. Indices start at
+         * zero.
+         */
+        criteria: Array<string>;
+        /**
+         * Required instructions describing what to decide about the shared state.
+         */
+        instructions: string | {
+            [key: string]: unknown;
+        } | Array<unknown>;
+        /**
+         * Question type.
+         */
+        type: 'score';
+    }
+}
+export declare namespace V1 {
+    export { type V1SystemoneResponse as V1SystemoneResponse, type V1SystemoneParams as V1SystemoneParams };
+}
+//# sourceMappingURL=v1.d.ts.map

package/resources/ai/typesafe/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../../src/resources/ai/typesafe/v1.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,SAAS,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG9F;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,OAAO,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GACR,mBAAmB,CAAC,yBAAyB,GAC7C,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,wBAAwB,CAAC;KAClD,CAAC;IAEF;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC;CAClC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;WAKG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;;;;WAKG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,MAAM,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAElC;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GACR,iBAAiB,CAAC,2BAA2B,GAC7C,iBAAiB,CAAC,yBAAyB,GAC3C,iBAAiB,CAAC,0BAA0B,CAAC;KAClD,CAAC;IAEF;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;CAC7D;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;QAE3C;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAEnE;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAEnE;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,QAAQ,CAAC,EAAE,yBAAyB,CAAC,QAAQ,CAAC;KAC/C;IAED,UAAiB,yBAAyB,CAAC;QACzC;;;WAGG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAEnE;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/ai/typesafe/v1.js

@@ -0,0 +1,67 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V1 = void 0;
+const resource_1 = require("../../../core/resource.js");
+/**
+ * Beta API for evaluating shared context with typed questions and structured answers. Telnyx manages model selection.
+ */
+class V1 extends resource_1.APIResource {
+    /**
+     * **Beta API.** Telnyx controls model selection.
+     *
+     * Evaluate shared context using named choice, noul (yes/no), and score questions.
+     * Returns TypeSafe System One-compatible answer shapes, an opaque compatibility
+     * identifier, and token usage. See the
+     * [decision model guide](https://developers.telnyx.com/docs/inference/decision-models)
+     * for examples and compatibility limits.
+     *
+     * The supported request subset requires instructions for every question, string
+     * descriptions for criteria (or null for choice descriptions), 1–64 questions, and
+     * 2–64 options for choice and score questions. The SDK-supplied model value is
+     * ignored and cannot select a model. Other unknown fields are rejected. The
+     * endpoint is synchronous and does not stream.
+     *
+     * Use the TypeSafe Python SDK with base_url set to
+     * https://api.telnyx.com/v2/ai/typesafe and a Telnyx API key. The SDK appends
+     * /v1/systemone. Compatibility covers this operation and the documented request
+     * subset; it does not include TypeSafe model listing. Scores describe relative
+     * preference, not calibrated correctness.
+     *
+     * @example
+     * ```ts
+     * const response = await client.ai.typesafe.v1.systemone({
+     *   questions: {
+     *     team: {
+     *       type: 'choice',
+     *       instructions:
+     *         'Choose the team that should handle this incident.',
+     *       criteria: {
+     *         billing: 'Payments and refunds',
+     *         technical_support:
+     *           'Service faults and technical problems',
+     *         sales: 'New purchases',
+     *       },
+     *     },
+     *     production_incident: {
+     *       type: 'noul',
+     *       instructions:
+     *         'Does the message describe an active production incident?',
+     *     },
+     *     urgency: {
+     *       type: 'score',
+     *       instructions: 'Rate operational urgency.',
+     *       criteria: ['Low', 'Normal', 'High', 'Critical'],
+     *     },
+     *   },
+     *   state:
+     *     'Our production calls are failing. Every customer is affected.',
+     * });
+     * ```
+     */
+    systemone(body, options) {
+        return this._client.post('/ai/typesafe/v1/systemone', { body, ...options });
+    }
+}
+exports.V1 = V1;
+//# sourceMappingURL=v1.js.map

package/resources/ai/typesafe/v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../../src/resources/ai/typesafe/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD;;GAEG;AACH,MAAa,EAAG,SAAQ,sBAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,SAAS,CAAC,IAAuB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAxDD,gBAwDC"}

package/resources/ai/typesafe/v1.mjs

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+/**
+ * Beta API for evaluating shared context with typed questions and structured answers. Telnyx manages model selection.
+ */
+export class V1 extends APIResource {
+    /**
+     * **Beta API.** Telnyx controls model selection.
+     *
+     * Evaluate shared context using named choice, noul (yes/no), and score questions.
+     * Returns TypeSafe System One-compatible answer shapes, an opaque compatibility
+     * identifier, and token usage. See the
+     * [decision model guide](https://developers.telnyx.com/docs/inference/decision-models)
+     * for examples and compatibility limits.
+     *
+     * The supported request subset requires instructions for every question, string
+     * descriptions for criteria (or null for choice descriptions), 1–64 questions, and
+     * 2–64 options for choice and score questions. The SDK-supplied model value is
+     * ignored and cannot select a model. Other unknown fields are rejected. The
+     * endpoint is synchronous and does not stream.
+     *
+     * Use the TypeSafe Python SDK with base_url set to
+     * https://api.telnyx.com/v2/ai/typesafe and a Telnyx API key. The SDK appends
+     * /v1/systemone. Compatibility covers this operation and the documented request
+     * subset; it does not include TypeSafe model listing. Scores describe relative
+     * preference, not calibrated correctness.
+     *
+     * @example
+     * ```ts
+     * const response = await client.ai.typesafe.v1.systemone({
+     *   questions: {
+     *     team: {
+     *       type: 'choice',
+     *       instructions:
+     *         'Choose the team that should handle this incident.',
+     *       criteria: {
+     *         billing: 'Payments and refunds',
+     *         technical_support:
+     *           'Service faults and technical problems',
+     *         sales: 'New purchases',
+     *       },
+     *     },
+     *     production_incident: {
+     *       type: 'noul',
+     *       instructions:
+     *         'Does the message describe an active production incident?',
+     *     },
+     *     urgency: {
+     *       type: 'score',
+     *       instructions: 'Rate operational urgency.',
+     *       criteria: ['Low', 'Normal', 'High', 'Critical'],
+     *     },
+     *   },
+     *   state:
+     *     'Our production calls are failing. Every customer is affected.',
+     * });
+     * ```
+     */
+    systemone(body, options) {
+        return this._client.post('/ai/typesafe/v1/systemone', { body, ...options });
+    }
+}
+//# sourceMappingURL=v1.mjs.map

package/resources/ai/typesafe/v1.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../../src/resources/ai/typesafe/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD;;GAEG;AACH,MAAM,OAAO,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,SAAS,CAAC,IAAuB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/resources/ai/typesafe.d.mts

@@ -0,0 +1,2 @@
+export * from "./typesafe/index.mjs";
+//# sourceMappingURL=typesafe.d.mts.map

package/resources/ai/typesafe.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesafe.d.mts","sourceRoot":"","sources":["../../src/resources/ai/typesafe.ts"],"names":[],"mappings":"AAEA,qCAAiC"}

package/resources/ai/typesafe.d.ts

@@ -0,0 +1,2 @@
+export * from "./typesafe/index.js";
+//# sourceMappingURL=typesafe.d.ts.map

package/resources/ai/typesafe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesafe.d.ts","sourceRoot":"","sources":["../../src/resources/ai/typesafe.ts"],"names":[],"mappings":"AAEA,oCAAiC"}

package/resources/ai/typesafe.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../../internal/tslib.js");
+tslib_1.__exportStar(require("./typesafe/index.js"), exports);
+//# sourceMappingURL=typesafe.js.map

package/resources/ai/typesafe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesafe.js","sourceRoot":"","sources":["../../src/resources/ai/typesafe.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}

package/resources/ai/typesafe.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./typesafe/index.mjs";
+//# sourceMappingURL=typesafe.mjs.map

package/resources/ai/typesafe.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesafe.mjs","sourceRoot":"","sources":["../../src/resources/ai/typesafe.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,qCAAiC"}

package/resources/bot-challenge.d.mts

@@ -0,0 +1,80 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA challenge designed to be easy for LLMs and hard for humans, registers an account, and signs in by consuming a magic link emailed to the account owner. All endpoints are public and unauthenticated; signup endpoints are additionally gated by the freemium feature flags and per-country availability.
+ */
+export declare class BotChallenge extends APIResource {
+    /**
+     * Generates a reverse-CAPTCHA challenge used to gate the bot signup flow. A random
+     * active problem is selected from the pool; math problems are returned obfuscated
+     * (case randomization, symbol injection, spacing noise) with an unobfuscated
+     * rounding instruction appended, while string and binary problems are returned
+     * as-is. The response contains a single-use nonce, the problem text, and the
+     * current terms-and-conditions and privacy-policy URLs, which must be echoed back
+     * on the signup request. Challenges expire after a short window (10 minutes by
+     * default) and can only be answered once. This endpoint is public and
+     * unauthenticated.
+     *
+     * @example
+     * ```ts
+     * const botChallenge = await client.botChallenge.create({
+     *   llm_model_name: 'claude-opus-4',
+     *   llm_parameter_count: '175B',
+     *   llm_quantization: 'int8',
+     * });
+     * ```
+     */
+    create(body?: BotChallengeCreateParams | null | undefined, options?: RequestOptions): APIPromise<BotChallengeCreateResponse>;
+}
+export interface BotChallengeCreateResponse {
+    data: BotChallengeCreateResponse.Data;
+}
+export declare namespace BotChallengeCreateResponse {
+    interface Data {
+        /**
+         * Type of challenge.
+         */
+        challenge_type: 'math' | 'string' | 'binary';
+        /**
+         * Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
+         * signup request.
+         */
+        nonce: string;
+        /**
+         * Current privacy-policy URL. Echo this back on the signup request.
+         */
+        privacy_policy_url: string;
+        /**
+         * Problem text to solve. Math problems are obfuscated and end with an unobfuscated
+         * rounding instruction; string and binary problems are returned as-is.
+         */
+        problem: string;
+        /**
+         * Current terms-and-conditions URL. Echo this back on the signup request.
+         */
+        terms_and_conditions_url: string;
+        /**
+         * Decimal places expected in the answer. Present only for math challenges.
+         */
+        precision?: number;
+    }
+}
+export interface BotChallengeCreateParams {
+    /**
+     * Name of the LLM the client is using.
+     */
+    llm_model_name?: string;
+    /**
+     * Parameter count of the client LLM.
+     */
+    llm_parameter_count?: string;
+    /**
+     * Quantization of the client LLM.
+     */
+    llm_quantization?: string;
+}
+export declare namespace BotChallenge {
+    export { type BotChallengeCreateResponse as BotChallengeCreateResponse, type BotChallengeCreateParams as BotChallengeCreateParams, };
+}
+//# sourceMappingURL=bot-challenge.d.mts.map

package/resources/bot-challenge.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-challenge.d.mts","sourceRoot":"","sources":["../src/resources/bot-challenge.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAE7C;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/bot-challenge.d.ts

@@ -0,0 +1,80 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA challenge designed to be easy for LLMs and hard for humans, registers an account, and signs in by consuming a magic link emailed to the account owner. All endpoints are public and unauthenticated; signup endpoints are additionally gated by the freemium feature flags and per-country availability.
+ */
+export declare class BotChallenge extends APIResource {
+    /**
+     * Generates a reverse-CAPTCHA challenge used to gate the bot signup flow. A random
+     * active problem is selected from the pool; math problems are returned obfuscated
+     * (case randomization, symbol injection, spacing noise) with an unobfuscated
+     * rounding instruction appended, while string and binary problems are returned
+     * as-is. The response contains a single-use nonce, the problem text, and the
+     * current terms-and-conditions and privacy-policy URLs, which must be echoed back
+     * on the signup request. Challenges expire after a short window (10 minutes by
+     * default) and can only be answered once. This endpoint is public and
+     * unauthenticated.
+     *
+     * @example
+     * ```ts
+     * const botChallenge = await client.botChallenge.create({
+     *   llm_model_name: 'claude-opus-4',
+     *   llm_parameter_count: '175B',
+     *   llm_quantization: 'int8',
+     * });
+     * ```
+     */
+    create(body?: BotChallengeCreateParams | null | undefined, options?: RequestOptions): APIPromise<BotChallengeCreateResponse>;
+}
+export interface BotChallengeCreateResponse {
+    data: BotChallengeCreateResponse.Data;
+}
+export declare namespace BotChallengeCreateResponse {
+    interface Data {
+        /**
+         * Type of challenge.
+         */
+        challenge_type: 'math' | 'string' | 'binary';
+        /**
+         * Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
+         * signup request.
+         */
+        nonce: string;
+        /**
+         * Current privacy-policy URL. Echo this back on the signup request.
+         */
+        privacy_policy_url: string;
+        /**
+         * Problem text to solve. Math problems are obfuscated and end with an unobfuscated
+         * rounding instruction; string and binary problems are returned as-is.
+         */
+        problem: string;
+        /**
+         * Current terms-and-conditions URL. Echo this back on the signup request.
+         */
+        terms_and_conditions_url: string;
+        /**
+         * Decimal places expected in the answer. Present only for math challenges.
+         */
+        precision?: number;
+    }
+}
+export interface BotChallengeCreateParams {
+    /**
+     * Name of the LLM the client is using.
+     */
+    llm_model_name?: string;
+    /**
+     * Parameter count of the client LLM.
+     */
+    llm_parameter_count?: string;
+    /**
+     * Quantization of the client LLM.
+     */
+    llm_quantization?: string;
+}
+export declare namespace BotChallenge {
+    export { type BotChallengeCreateResponse as BotChallengeCreateResponse, type BotChallengeCreateParams as BotChallengeCreateParams, };
+}
+//# sourceMappingURL=bot-challenge.d.ts.map

package/resources/bot-challenge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-challenge.d.ts","sourceRoot":"","sources":["../src/resources/bot-challenge.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,0BAA0B,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAE7C;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/bot-challenge.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotChallenge = void 0;
+const resource_1 = require("../core/resource.js");
+/**
+ * Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA challenge designed to be easy for LLMs and hard for humans, registers an account, and signs in by consuming a magic link emailed to the account owner. All endpoints are public and unauthenticated; signup endpoints are additionally gated by the freemium feature flags and per-country availability.
+ */
+class BotChallenge extends resource_1.APIResource {
+    /**
+     * Generates a reverse-CAPTCHA challenge used to gate the bot signup flow. A random
+     * active problem is selected from the pool; math problems are returned obfuscated
+     * (case randomization, symbol injection, spacing noise) with an unobfuscated
+     * rounding instruction appended, while string and binary problems are returned
+     * as-is. The response contains a single-use nonce, the problem text, and the
+     * current terms-and-conditions and privacy-policy URLs, which must be echoed back
+     * on the signup request. Challenges expire after a short window (10 minutes by
+     * default) and can only be answered once. This endpoint is public and
+     * unauthenticated.
+     *
+     * @example
+     * ```ts
+     * const botChallenge = await client.botChallenge.create({
+     *   llm_model_name: 'claude-opus-4',
+     *   llm_parameter_count: '175B',
+     *   llm_quantization: 'int8',
+     * });
+     * ```
+     */
+    create(body = {}, options) {
+        return this._client.post('/v2/bot_challenge', { body, ...options });
+    }
+}
+exports.BotChallenge = BotChallenge;
+//# sourceMappingURL=bot-challenge.js.map

package/resources/bot-challenge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-challenge.js","sourceRoot":"","sources":["../src/resources/bot-challenge.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,OAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA3BD,oCA2BC"}