scorecard-ai 1.0.0-alpha.6 → 1.0.0-alpha.8

package/resources/systems.js

@@ -22,6 +22,45 @@ class Systems extends resource_1.APIResource {
      *
      * This separation lets you evaluate any system as a black box, focusing on its
      * interface rather than implementation details.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.create('314', {
+     *   configSchema: {
+     *     type: 'object',
+     *     properties: {
+     *       temperature: { type: 'number' },
+     *       maxTokens: { type: 'integer' },
+     *       model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
+     *     },
+     *     required: ['model'],
+     *   },
+     *   description: 'Production chatbot powered by GPT-4',
+     *   inputSchema: {
+     *     type: 'object',
+     *     properties: {
+     *       messages: {
+     *         type: 'array',
+     *         items: {
+     *           type: 'object',
+     *           properties: {
+     *             role: { type: 'string', enum: ['system', 'user', 'assistant'] },
+     *             content: { type: 'string' },
+     *           },
+     *           required: ['role', 'content'],
+     *         },
+     *       },
+     *     },
+     *     required: ['messages'],
+     *   },
+     *   name: 'GPT-4 Chatbot',
+     *   outputSchema: {
+     *     type: 'object',
+     *     properties: { response: { type: 'string' } },
+     *     required: ['response'],
+     *   },
+     * });
+     * ```
      */
     create(projectID, body, options) {
         return this._client.post((0, path_1.path) `/projects/${projectID}/systems`, { body, ...options });
@@ -39,12 +78,32 @@ class Systems extends resource_1.APIResource {
      * - Schema updates won't invalidate existing evaluations or configurations
      * - For significant redesigns, creating a new system definition provides a cleaner
      *   separation
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.update(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     *   {
+     *     description:
+     *       'Updated production chatbot powered by GPT-4 Turbo',
+     *     name: 'GPT-4 Turbo Chatbot',
+     *   },
+     * );
+     * ```
      */
     update(systemID, body = {}, options) {
         return this._client.patch((0, path_1.path) `/systems/${systemID}`, { body, ...options });
     }
     /**
      * Retrieve a paginated list of all systems. Systems are ordered by creation date.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const system of client.systems.list('314')) {
+     *   // ...
+     * }
+     * ```
      */
     list(projectID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/projects/${projectID}/systems`, (pagination_1.PaginatedResponse), {
@@ -55,12 +114,26 @@ class Systems extends resource_1.APIResource {
     /**
      * Delete a system definition by ID. This will not delete associated system
      * configurations.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.delete(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     * );
+     * ```
      */
     delete(systemID, options) {
         return this._client.delete((0, path_1.path) `/systems/${systemID}`, options);
     }
     /**
      * Retrieve a specific system by ID.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.get(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     * );
+     * ```
      */
     get(systemID, options) {
         return this._client.get((0, path_1.path) `/systems/${systemID}`, options);

package/resources/systems.js.map

@@ -1 +1 @@
-{"version":3,"file":"systems.js","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,CAAA,8BAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAxED,0BAwEC"}
+{"version":3,"file":"systems.js","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,CAAA,8BAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAjJD,0BAiJC"}

package/resources/systems.mjs

@@ -19,6 +19,45 @@ export class Systems extends APIResource {
      *
      * This separation lets you evaluate any system as a black box, focusing on its
      * interface rather than implementation details.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.create('314', {
+     *   configSchema: {
+     *     type: 'object',
+     *     properties: {
+     *       temperature: { type: 'number' },
+     *       maxTokens: { type: 'integer' },
+     *       model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
+     *     },
+     *     required: ['model'],
+     *   },
+     *   description: 'Production chatbot powered by GPT-4',
+     *   inputSchema: {
+     *     type: 'object',
+     *     properties: {
+     *       messages: {
+     *         type: 'array',
+     *         items: {
+     *           type: 'object',
+     *           properties: {
+     *             role: { type: 'string', enum: ['system', 'user', 'assistant'] },
+     *             content: { type: 'string' },
+     *           },
+     *           required: ['role', 'content'],
+     *         },
+     *       },
+     *     },
+     *     required: ['messages'],
+     *   },
+     *   name: 'GPT-4 Chatbot',
+     *   outputSchema: {
+     *     type: 'object',
+     *     properties: { response: { type: 'string' } },
+     *     required: ['response'],
+     *   },
+     * });
+     * ```
      */
     create(projectID, body, options) {
         return this._client.post(path `/projects/${projectID}/systems`, { body, ...options });
@@ -36,12 +75,32 @@ export class Systems extends APIResource {
      * - Schema updates won't invalidate existing evaluations or configurations
      * - For significant redesigns, creating a new system definition provides a cleaner
      *   separation
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.update(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     *   {
+     *     description:
+     *       'Updated production chatbot powered by GPT-4 Turbo',
+     *     name: 'GPT-4 Turbo Chatbot',
+     *   },
+     * );
+     * ```
      */
     update(systemID, body = {}, options) {
         return this._client.patch(path `/systems/${systemID}`, { body, ...options });
     }
     /**
      * Retrieve a paginated list of all systems. Systems are ordered by creation date.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const system of client.systems.list('314')) {
+     *   // ...
+     * }
+     * ```
      */
     list(projectID, query = {}, options) {
         return this._client.getAPIList(path `/projects/${projectID}/systems`, (PaginatedResponse), {
@@ -52,12 +111,26 @@ export class Systems extends APIResource {
     /**
      * Delete a system definition by ID. This will not delete associated system
      * configurations.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.delete(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     * );
+     * ```
      */
     delete(systemID, options) {
         return this._client.delete(path `/systems/${systemID}`, options);
     }
     /**
      * Retrieve a specific system by ID.
+     *
+     * @example
+     * ```ts
+     * const system = await client.systems.get(
+     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
+     * );
+     * ```
      */
     get(systemID, options) {
         return this._client.get(path `/systems/${systemID}`, options);

package/resources/systems.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"systems.mjs","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,CAAA,iBAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
+{"version":3,"file":"systems.mjs","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,CAAA,iBAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}

package/resources/testcases.d.mts

@@ -5,39 +5,106 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Testcases extends APIResource {
     /**
      * Create multiple Testcases in the specified Testset.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.create('246', {
+     *   items: [
+     *     {
+     *       jsonData: {
+     *         question: 'What is the capital of France?',
+     *         idealAnswer: 'Paris',
+     *         provenance: 'hand_curated',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'What is the largest planet in our solar system?',
+     *         idealAnswer: 'Jupiter',
+     *         provenance: 'synthetic',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'How many planets are in our solar system?',
+     *         idealAnswer: 8,
+     *         provenance: 'user_feedback',
+     *       },
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(testsetID: string, body: TestcaseCreateParams, options?: RequestOptions): APIPromise<TestcaseCreateResponse>;
     /**
      * Replace the data of an existing Testcase while keeping its ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.update('248', {
+     *   jsonData: {
+     *     question: 'What is the capital of France?',
+     *     idealAnswer: 'Paris is the capital of France',
+     *     provenance: 'hand_curated',
+     *   },
+     * });
+     * ```
      */
     update(testcaseID: string, body: TestcaseUpdateParams, options?: RequestOptions): APIPromise<Testcase>;
     /**
      * Retrieve a paginated list of Testcases belonging to a Testset.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const testcase of client.testcases.list('246')) {
+     *   // ...
+     * }
+     * ```
      */
     list(testsetID: string, query?: TestcaseListParams | null | undefined, options?: RequestOptions): PagePromise<TestcasesPaginatedResponse, Testcase>;
     /**
      * Delete multiple Testcases by their IDs.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.delete({
+     *   ids: ['123', '124', '125'],
+     * });
+     * ```
      */
     delete(body: TestcaseDeleteParams, options?: RequestOptions): APIPromise<TestcaseDeleteResponse>;
     /**
      * Retrieve a specific Testcase by ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.get('248');
+     * ```
      */
     get(testcaseID: string, options?: RequestOptions): APIPromise<Testcase>;
 }
 export type TestcasesPaginatedResponse = PaginatedResponse<Testcase>;
 /**
  * A test case in the Scorecard system. Contains JSON data that is validated
- * against the schema defined by its Testset. The `inputs` and `labels` fields are
- * derived from the `data` field based on the Testset's `fieldMapping`, and include
- * all mapped fields, including those with validation errors. Testcases are stored
- * regardless of validation results, with any validation errors included in the
- * `validationErrors` field.
+ * against the schema defined by its Testset. The `inputs` and `expected` fields
+ * are derived from the `data` field based on the Testset's `fieldMapping`, and
+ * include all mapped fields, including those with validation errors. Testcases are
+ * stored regardless of validation results, with any validation errors included in
+ * the `validationErrors` field.
  */
 export interface Testcase {
     /**
      * The ID of the Testcase.
      */
     id: string;
+    /**
+     * Derived from data based on the Testset's fieldMapping. Contains all fields
+     * marked as expected outputs, including those with validation errors.
+     */
+    expected: Record<string, unknown>;
     /**
      * Derived from data based on the Testset's fieldMapping. Contains all fields
      * marked as inputs, including those with validation errors.
@@ -47,11 +114,6 @@ export interface Testcase {
      * The JSON data of the Testcase, which is validated against the Testset's schema.
      */
     jsonData: Record<string, unknown>;
-    /**
-     * Derived from data based on the Testset's fieldMapping. Contains all fields
-     * marked as labels, including those with validation errors.
-     */
-    labels: Record<string, unknown>;
     /**
      * The ID of the Testset this Testcase belongs to.
      */
@@ -90,14 +152,6 @@ export interface TestcaseCreateParams {
     items: Array<TestcaseCreateParams.Item>;
 }
 export declare namespace TestcaseCreateParams {
-    /**
-     * A test case in the Scorecard system. Contains JSON data that is validated
-     * against the schema defined by its Testset. The `inputs` and `labels` fields are
-     * derived from the `data` field based on the Testset's `fieldMapping`, and include
-     * all mapped fields, including those with validation errors. Testcases are stored
-     * regardless of validation results, with any validation errors included in the
-     * `validationErrors` field.
-     */
     interface Item {
         /**
          * The JSON data of the Testcase, which is validated against the Testset's schema.

package/resources/testcases.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"testcases.d.mts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"testcases.d.mts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;OAOG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/testcases.d.ts

@@ -5,39 +5,106 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class Testcases extends APIResource {
     /**
      * Create multiple Testcases in the specified Testset.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.create('246', {
+     *   items: [
+     *     {
+     *       jsonData: {
+     *         question: 'What is the capital of France?',
+     *         idealAnswer: 'Paris',
+     *         provenance: 'hand_curated',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'What is the largest planet in our solar system?',
+     *         idealAnswer: 'Jupiter',
+     *         provenance: 'synthetic',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'How many planets are in our solar system?',
+     *         idealAnswer: 8,
+     *         provenance: 'user_feedback',
+     *       },
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(testsetID: string, body: TestcaseCreateParams, options?: RequestOptions): APIPromise<TestcaseCreateResponse>;
     /**
      * Replace the data of an existing Testcase while keeping its ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.update('248', {
+     *   jsonData: {
+     *     question: 'What is the capital of France?',
+     *     idealAnswer: 'Paris is the capital of France',
+     *     provenance: 'hand_curated',
+     *   },
+     * });
+     * ```
      */
     update(testcaseID: string, body: TestcaseUpdateParams, options?: RequestOptions): APIPromise<Testcase>;
     /**
      * Retrieve a paginated list of Testcases belonging to a Testset.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const testcase of client.testcases.list('246')) {
+     *   // ...
+     * }
+     * ```
      */
     list(testsetID: string, query?: TestcaseListParams | null | undefined, options?: RequestOptions): PagePromise<TestcasesPaginatedResponse, Testcase>;
     /**
      * Delete multiple Testcases by their IDs.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.delete({
+     *   ids: ['123', '124', '125'],
+     * });
+     * ```
      */
     delete(body: TestcaseDeleteParams, options?: RequestOptions): APIPromise<TestcaseDeleteResponse>;
     /**
      * Retrieve a specific Testcase by ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.get('248');
+     * ```
      */
     get(testcaseID: string, options?: RequestOptions): APIPromise<Testcase>;
 }
 export type TestcasesPaginatedResponse = PaginatedResponse<Testcase>;
 /**
  * A test case in the Scorecard system. Contains JSON data that is validated
- * against the schema defined by its Testset. The `inputs` and `labels` fields are
- * derived from the `data` field based on the Testset's `fieldMapping`, and include
- * all mapped fields, including those with validation errors. Testcases are stored
- * regardless of validation results, with any validation errors included in the
- * `validationErrors` field.
+ * against the schema defined by its Testset. The `inputs` and `expected` fields
+ * are derived from the `data` field based on the Testset's `fieldMapping`, and
+ * include all mapped fields, including those with validation errors. Testcases are
+ * stored regardless of validation results, with any validation errors included in
+ * the `validationErrors` field.
  */
 export interface Testcase {
     /**
      * The ID of the Testcase.
      */
     id: string;
+    /**
+     * Derived from data based on the Testset's fieldMapping. Contains all fields
+     * marked as expected outputs, including those with validation errors.
+     */
+    expected: Record<string, unknown>;
     /**
      * Derived from data based on the Testset's fieldMapping. Contains all fields
      * marked as inputs, including those with validation errors.
@@ -47,11 +114,6 @@ export interface Testcase {
      * The JSON data of the Testcase, which is validated against the Testset's schema.
      */
     jsonData: Record<string, unknown>;
-    /**
-     * Derived from data based on the Testset's fieldMapping. Contains all fields
-     * marked as labels, including those with validation errors.
-     */
-    labels: Record<string, unknown>;
     /**
      * The ID of the Testset this Testcase belongs to.
      */
@@ -90,14 +152,6 @@ export interface TestcaseCreateParams {
     items: Array<TestcaseCreateParams.Item>;
 }
 export declare namespace TestcaseCreateParams {
-    /**
-     * A test case in the Scorecard system. Contains JSON data that is validated
-     * against the schema defined by its Testset. The `inputs` and `labels` fields are
-     * derived from the `data` field based on the Testset's `fieldMapping`, and include
-     * all mapped fields, including those with validation errors. Testcases are stored
-     * regardless of validation results, with any validation errors included in the
-     * `validationErrors` field.
-     */
     interface Item {
         /**
          * The JSON data of the Testcase, which is validated against the Testset's schema.

package/resources/testcases.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testcases.d.ts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"testcases.d.ts","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,QAAQ,CAAC;IAOpD;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;OAOG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;CAGxE;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;CACpD;AAED,yBAAiB,QAAQ,CAAC;IACxB,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;CAAG;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/testcases.js

@@ -8,18 +8,68 @@ const path_1 = require("../internal/utils/path.js");
 class Testcases extends resource_1.APIResource {
     /**
      * Create multiple Testcases in the specified Testset.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.create('246', {
+     *   items: [
+     *     {
+     *       jsonData: {
+     *         question: 'What is the capital of France?',
+     *         idealAnswer: 'Paris',
+     *         provenance: 'hand_curated',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'What is the largest planet in our solar system?',
+     *         idealAnswer: 'Jupiter',
+     *         provenance: 'synthetic',
+     *       },
+     *     },
+     *     {
+     *       jsonData: {
+     *         question:
+     *           'How many planets are in our solar system?',
+     *         idealAnswer: 8,
+     *         provenance: 'user_feedback',
+     *       },
+     *     },
+     *   ],
+     * });
+     * ```
      */
     create(testsetID, body, options) {
         return this._client.post((0, path_1.path) `/testsets/${testsetID}/testcases`, { body, ...options });
     }
     /**
      * Replace the data of an existing Testcase while keeping its ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.update('248', {
+     *   jsonData: {
+     *     question: 'What is the capital of France?',
+     *     idealAnswer: 'Paris is the capital of France',
+     *     provenance: 'hand_curated',
+     *   },
+     * });
+     * ```
      */
     update(testcaseID, body, options) {
         return this._client.put((0, path_1.path) `/testcases/${testcaseID}`, { body, ...options });
     }
     /**
      * Retrieve a paginated list of Testcases belonging to a Testset.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const testcase of client.testcases.list('246')) {
+     *   // ...
+     * }
+     * ```
      */
     list(testsetID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/testsets/${testsetID}/testcases`, (pagination_1.PaginatedResponse), {
@@ -29,12 +79,24 @@ class Testcases extends resource_1.APIResource {
     }
     /**
      * Delete multiple Testcases by their IDs.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.delete({
+     *   ids: ['123', '124', '125'],
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.post('/testcases/bulk-delete', { body, ...options });
     }
     /**
      * Retrieve a specific Testcase by ID.
+     *
+     * @example
+     * ```ts
+     * const testcase = await client.testcases.get('248');
+     * ```
      */
     get(testcaseID, options) {
         return this._client.get((0, path_1.path) `/testcases/${testcaseID}`, options);

package/resources/testcases.js.map

@@ -1 +1 @@
-{"version":3,"file":"testcases.js","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,CAAA,8BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA9CD,8BA8CC"}
+{"version":3,"file":"testcases.js","sourceRoot":"","sources":["../src/resources/testcases.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,SAAiB,EACjB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,UAAkB,EAAE,IAA0B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,YAAY,EAAE,CAAA,8BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,UAAkB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA5GD,8BA4GC"}