@reminix/sdk 0.11.0 → 0.13.0

package/resources/memory.d.mts

@@ -0,0 +1,148 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class MemoryResource extends APIResource {
+    /**
+     * Get a memory value by key for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.retrieve('x');
+     * ```
+     */
+    retrieve(key: string, options?: RequestOptions): APIPromise<Memory>;
+    /**
+     * List all memory keys for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix. For
+     * example: `?identity.user_id=user_123&identity.tenant_id=acme`
+     *
+     * Returns memory keys and metadata (not full values for efficiency).
+     *
+     * @example
+     * ```ts
+     * const memories = await client.memory.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<MemoryListResponse>;
+    /**
+     * Delete a memory by key for a specific identity.
+     *
+     * @example
+     * ```ts
+     * await client.memory.delete('x');
+     * ```
+     */
+    delete(key: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Delete all memories for a specific identity.
+     *
+     * @example
+     * ```ts
+     * const response = await client.memory.deleteAll();
+     * ```
+     */
+    deleteAll(options?: RequestOptions): APIPromise<MemoryDeleteAllResponse>;
+    /**
+     * Store a key-value memory for a specific identity.
+     *
+     * If a memory with the same key already exists, it will be updated.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.store({
+     *   identity: { user_id: 'user_123' },
+     *   key: 'preferred_language',
+     *   value: 'en',
+     * });
+     * ```
+     */
+    store(body: MemoryStoreParams, options?: RequestOptions): APIPromise<Memory>;
+}
+export interface Memory {
+    /**
+     * Unique memory ID
+     */
+    id: string;
+    /**
+     * When the memory was created
+     */
+    createdAt: string;
+    /**
+     * When the memory expires
+     */
+    expiresAt: string | null;
+    /**
+     * Identity fields for memory scoping (e.g., user_id, tenant_id)
+     */
+    identity: {
+        [key: string]: unknown;
+    };
+    /**
+     * Memory key
+     */
+    key: string;
+    /**
+     * Project ID
+     */
+    projectId: string;
+    /**
+     * When the memory was last updated
+     */
+    updatedAt: string;
+    /**
+     * Memory value
+     */
+    value?: unknown;
+}
+export interface MemoryListResponse {
+    data: Array<MemoryListResponse.Data>;
+}
+export declare namespace MemoryListResponse {
+    interface Data {
+        /**
+         * When the memory expires (if set)
+         */
+        expiresAt: string | null;
+        /**
+         * Memory key
+         */
+        key: string;
+        /**
+         * When the memory was last updated
+         */
+        updatedAt: string;
+    }
+}
+export interface MemoryDeleteAllResponse {
+    /**
+     * Number of memories deleted
+     */
+    deleted: number;
+}
+export interface MemoryStoreParams {
+    /**
+     * Identity fields for memory scoping (e.g., user_id, tenant_id)
+     */
+    identity: {
+        [key: string]: unknown;
+    };
+    /**
+     * Memory key
+     */
+    key: string;
+    /**
+     * Optional expiration time (ISO 8601)
+     */
+    expiresAt?: string;
+    /**
+     * Value to store
+     */
+    value?: unknown;
+}
+export declare namespace MemoryResource {
+    export { type Memory as Memory, type MemoryListResponse as MemoryListResponse, type MemoryDeleteAllResponse as MemoryDeleteAllResponse, type MemoryStoreParams as MemoryStoreParams, };
+}
+//# sourceMappingURL=memory.d.mts.map

package/resources/memory.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.mts","sourceRoot":"","sources":["../src/resources/memory.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAInE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9D;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO/D;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIxE;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG7E;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/memory.d.ts

@@ -0,0 +1,148 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class MemoryResource extends APIResource {
+    /**
+     * Get a memory value by key for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.retrieve('x');
+     * ```
+     */
+    retrieve(key: string, options?: RequestOptions): APIPromise<Memory>;
+    /**
+     * List all memory keys for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix. For
+     * example: `?identity.user_id=user_123&identity.tenant_id=acme`
+     *
+     * Returns memory keys and metadata (not full values for efficiency).
+     *
+     * @example
+     * ```ts
+     * const memories = await client.memory.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<MemoryListResponse>;
+    /**
+     * Delete a memory by key for a specific identity.
+     *
+     * @example
+     * ```ts
+     * await client.memory.delete('x');
+     * ```
+     */
+    delete(key: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Delete all memories for a specific identity.
+     *
+     * @example
+     * ```ts
+     * const response = await client.memory.deleteAll();
+     * ```
+     */
+    deleteAll(options?: RequestOptions): APIPromise<MemoryDeleteAllResponse>;
+    /**
+     * Store a key-value memory for a specific identity.
+     *
+     * If a memory with the same key already exists, it will be updated.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.store({
+     *   identity: { user_id: 'user_123' },
+     *   key: 'preferred_language',
+     *   value: 'en',
+     * });
+     * ```
+     */
+    store(body: MemoryStoreParams, options?: RequestOptions): APIPromise<Memory>;
+}
+export interface Memory {
+    /**
+     * Unique memory ID
+     */
+    id: string;
+    /**
+     * When the memory was created
+     */
+    createdAt: string;
+    /**
+     * When the memory expires
+     */
+    expiresAt: string | null;
+    /**
+     * Identity fields for memory scoping (e.g., user_id, tenant_id)
+     */
+    identity: {
+        [key: string]: unknown;
+    };
+    /**
+     * Memory key
+     */
+    key: string;
+    /**
+     * Project ID
+     */
+    projectId: string;
+    /**
+     * When the memory was last updated
+     */
+    updatedAt: string;
+    /**
+     * Memory value
+     */
+    value?: unknown;
+}
+export interface MemoryListResponse {
+    data: Array<MemoryListResponse.Data>;
+}
+export declare namespace MemoryListResponse {
+    interface Data {
+        /**
+         * When the memory expires (if set)
+         */
+        expiresAt: string | null;
+        /**
+         * Memory key
+         */
+        key: string;
+        /**
+         * When the memory was last updated
+         */
+        updatedAt: string;
+    }
+}
+export interface MemoryDeleteAllResponse {
+    /**
+     * Number of memories deleted
+     */
+    deleted: number;
+}
+export interface MemoryStoreParams {
+    /**
+     * Identity fields for memory scoping (e.g., user_id, tenant_id)
+     */
+    identity: {
+        [key: string]: unknown;
+    };
+    /**
+     * Memory key
+     */
+    key: string;
+    /**
+     * Optional expiration time (ISO 8601)
+     */
+    expiresAt?: string;
+    /**
+     * Value to store
+     */
+    value?: unknown;
+}
+export declare namespace MemoryResource {
+    export { type Memory as Memory, type MemoryListResponse as MemoryListResponse, type MemoryDeleteAllResponse as MemoryDeleteAllResponse, type MemoryStoreParams as MemoryStoreParams, };
+}
+//# sourceMappingURL=memory.d.ts.map

package/resources/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../src/resources/memory.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAInE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9D;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO/D;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIxE;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG7E;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/memory.js

@@ -0,0 +1,82 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryResource = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+class MemoryResource extends resource_1.APIResource {
+    /**
+     * Get a memory value by key for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.retrieve('x');
+     * ```
+     */
+    retrieve(key, options) {
+        return this._client.get((0, path_1.path) `/memory/${key}`, options);
+    }
+    /**
+     * List all memory keys for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix. For
+     * example: `?identity.user_id=user_123&identity.tenant_id=acme`
+     *
+     * Returns memory keys and metadata (not full values for efficiency).
+     *
+     * @example
+     * ```ts
+     * const memories = await client.memory.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/memory', options);
+    }
+    /**
+     * Delete a memory by key for a specific identity.
+     *
+     * @example
+     * ```ts
+     * await client.memory.delete('x');
+     * ```
+     */
+    delete(key, options) {
+        return this._client.delete((0, path_1.path) `/memory/${key}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Delete all memories for a specific identity.
+     *
+     * @example
+     * ```ts
+     * const response = await client.memory.deleteAll();
+     * ```
+     */
+    deleteAll(options) {
+        return this._client.delete('/memory', options);
+    }
+    /**
+     * Store a key-value memory for a specific identity.
+     *
+     * If a memory with the same key already exists, it will be updated.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.store({
+     *   identity: { user_id: 'user_123' },
+     *   key: 'preferred_language',
+     *   value: 'en',
+     * });
+     * ```
+     */
+    store(body, options) {
+        return this._client.post('/memory', { body, ...options });
+    }
+}
+exports.MemoryResource = MemoryResource;
+//# sourceMappingURL=memory.js.map

package/resources/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../src/resources/memory.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAW,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAW,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,GAAG,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAuB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AA5ED,wCA4EC"}

package/resources/memory.mjs

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class MemoryResource extends APIResource {
+    /**
+     * Get a memory value by key for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.retrieve('x');
+     * ```
+     */
+    retrieve(key, options) {
+        return this._client.get(path `/memory/${key}`, options);
+    }
+    /**
+     * List all memory keys for a specific identity.
+     *
+     * Identity is specified via query parameters with the `identity.` prefix. For
+     * example: `?identity.user_id=user_123&identity.tenant_id=acme`
+     *
+     * Returns memory keys and metadata (not full values for efficiency).
+     *
+     * @example
+     * ```ts
+     * const memories = await client.memory.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/memory', options);
+    }
+    /**
+     * Delete a memory by key for a specific identity.
+     *
+     * @example
+     * ```ts
+     * await client.memory.delete('x');
+     * ```
+     */
+    delete(key, options) {
+        return this._client.delete(path `/memory/${key}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Delete all memories for a specific identity.
+     *
+     * @example
+     * ```ts
+     * const response = await client.memory.deleteAll();
+     * ```
+     */
+    deleteAll(options) {
+        return this._client.delete('/memory', options);
+    }
+    /**
+     * Store a key-value memory for a specific identity.
+     *
+     * If a memory with the same key already exists, it will be updated.
+     *
+     * @example
+     * ```ts
+     * const memory = await client.memory.store({
+     *   identity: { user_id: 'user_123' },
+     *   key: 'preferred_language',
+     *   value: 'en',
+     * });
+     * ```
+     */
+    store(body, options) {
+        return this._client.post('/memory', { body, ...options });
+    }
+}
+//# sourceMappingURL=memory.mjs.map

package/resources/memory.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.mjs","sourceRoot":"","sources":["../src/resources/memory.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAW,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAW,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,GAAG,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAuB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF"}

package/resources/tools.d.mts

@@ -26,25 +26,25 @@ export declare class Tools extends APIResource {
      */
     list(query?: ToolListParams | null | undefined, options?: RequestOptions): PagePromise<ToolsCursor, Tool>;
     /**
-     * Execute a tool with the provided input parameters.
+     * Call a tool with the provided input parameters.
      *
-     * **Timeout:** Tool executions have a 60-second timeout. If the tool takes longer
-     * to respond, you will receive a 504 Gateway Timeout error.
+     * **Timeout:** Tool calls have a 60-second timeout. If the tool takes longer to
+     * respond, you will receive a 504 Gateway Timeout error.
      *
      * **Use cases:**
      *
      * - Calling custom tools from your deployment
-     * - Executing utility functions
+     * - Invoking utility functions
      * - Integrating with external services via tools
      *
      * @example
      * ```ts
-     * const response = await client.tools.execute('x', {
+     * const response = await client.tools.call('x', {
      *   input: { name: 'World', greeting: 'Hello' },
      * });
      * ```
      */
-    execute(name: string, body: ToolExecuteParams, options?: RequestOptions): APIPromise<ToolExecuteResponse>;
+    call(name: string, body: ToolCallParams, options?: RequestOptions): APIPromise<ToolCallResponse>;
 }
 export type ToolsCursor = Cursor<Tool>;
 export interface Tool {
@@ -103,26 +103,84 @@ export declare namespace Tool {
      * JSON Schema for agent input parameters
      */
     interface Output {
-        type: string;
+        /**
+         * Default value for the property
+         */
+        default?: unknown;
+        /**
+         * Description of the schema
+         */
+        description?: string;
+        /**
+         * Enumeration of allowed values
+         */
+        enum?: Array<unknown>;
+        /**
+         * Schema for array items
+         */
+        items?: unknown;
+        /**
+         * Property definitions for object types
+         */
         properties?: {
             [key: string]: unknown;
         };
+        /**
+         * List of required property names
+         */
         required?: Array<string>;
+        /**
+         * Human-readable title
+         */
+        title?: string;
+        /**
+         * JSON Schema type (e.g., "object", "string", "array")
+         */
+        type?: string;
         [k: string]: unknown;
     }
     /**
      * JSON Schema for agent input parameters
      */
     interface Parameters {
-        type: string;
+        /**
+         * Default value for the property
+         */
+        default?: unknown;
+        /**
+         * Description of the schema
+         */
+        description?: string;
+        /**
+         * Enumeration of allowed values
+         */
+        enum?: Array<unknown>;
+        /**
+         * Schema for array items
+         */
+        items?: unknown;
+        /**
+         * Property definitions for object types
+         */
         properties?: {
             [key: string]: unknown;
         };
+        /**
+         * List of required property names
+         */
         required?: Array<string>;
+        /**
+         * Human-readable title
+         */
+        title?: string;
+        /**
+         * JSON Schema type (e.g., "object", "string", "array")
+         */
+        type?: string;
         [k: string]: unknown;
     }
 }
-export interface ToolExecuteResponse {
+export interface ToolCallResponse {
     /**
      * Output from the tool execution.
      */
@@ -138,7 +196,7 @@ export interface ToolListParams extends CursorParams {
      */
     type?: string;
 }
-export interface ToolExecuteParams {
+export interface ToolCallParams {
     /**
      * Input parameters for the tool. Structure depends on tool definition.
      */
@@ -147,6 +205,6 @@ export interface ToolExecuteParams {
     };
 }
 export declare namespace Tools {
-    export { type Tool as Tool, type ToolExecuteResponse as ToolExecuteResponse, type ToolsCursor as ToolsCursor, type ToolListParams as ToolListParams, type ToolExecuteParams as ToolExecuteParams, };
+    export { type Tool as Tool, type ToolCallResponse as ToolCallResponse, type ToolsCursor as ToolsCursor, type ToolListParams as ToolListParams, type ToolCallParams as ToolCallParams, };
 }
 //# sourceMappingURL=tools.d.mts.map

package/resources/tools.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"tools.d.mts","sourceRoot":"","sources":["../src/resources/tools.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIlE;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC;IAIjC;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG1G;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEvC,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"tools.d.mts","sourceRoot":"","sources":["../src/resources/tools.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAC1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIlE;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC;IAIjC;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAGjG;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEvC,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}