@narrative.io/data-collaboration-sdk-ts 3.8.0 → 4.0.0-beta.0

package/build/mappings/index.d.ts

@@ -2,6 +2,12 @@ import { BaseApi } from "../base-api";
 import { CompanyInfoApi } from "../company-info";
 import type { ApiRecords, Config } from "../types";
 import type { CachedMapping, CreateMapping, Mapping, MappingDefinition, MappingExpressionDependencies, MappingTestResult, MappingTestResults, ObjectMapping, PropertyMapping, RawCachedMapping, RawMappingDefinition, RawObjectMapping, RawPropertyMapping, RawValueMapping, ValueMapping } from "./types";
+interface GetMappingsParameters extends Record<string, string | number | boolean | number[] | undefined> {
+    /** Filter by attribute id. Can be repeated to match multiple attributes. */
+    attribute_id?: number | number[];
+    /** Filter by dataset id. Can be repeated to match multiple datasets. */
+    dataset_id?: number | number[];
+}
 /**
  * Class representing the Mappings API.
  * Extends the BaseApi to provide functionalities specific to mappings.
@@ -11,13 +17,14 @@ declare class MappingsApi extends BaseApi {
     private readonly companyInfoApi?;
     constructor(config: Config, companyInfoApi?: CompanyInfoApi | undefined);
     /**
-     * Retrieves all mappings.
+     * Retrieves all mappings owned by the caller's company, optionally filtered by attribute and/or dataset.
      *
+     * @param {GetMappingsParameters} [parameters] - Optional attribute/dataset filters.
      * @returns {Promise<ApiRecords<Mapping>>} A promise that resolves to a collection of Mapping records.
      * @public
      * @async
      */
-    getMappings(): Promise<ApiRecords<Mapping>>;
+    getMappings(parameters?: GetMappingsParameters): Promise<ApiRecords<Mapping>>;
     /**
      * Creates a new mapping specific to a company.
      *
@@ -89,18 +96,21 @@ declare class MappingsApi extends BaseApi {
      * @returns {Promise<void>} A promise that resolves when the mapping is succesfully promoted.
      * @public
      * @async
+     * @deprecated No corresponding `POST /mappings/{id}/promote` route was found in the backend
+     *   (narrative-marketplace-backend @ 6f3819c). Calling this will likely 404 — flagged for
+     *   review rather than removed, since callers may already depend on this signature.
      */
     promoteMapping(mappingId: string): Promise<void>;
     /**
      * Updates a mapping.
      *
      * @param {string} mappingId - The ID of the mapping to update.
-     * @param {CreateMapping} mapping - The mapping configuration to update.
+     * @param {Pick<CreateMapping, "mapping" | "tags">} mapping - The mapping definition (required) and tags (optional) to update.
      * @returns {Promise<Mapping>} A promise that resolves to the updated mapping.
      * @public
      * @async
      */
-    updateMapping(mappingId: string, mapping: Pick<CreateMapping, "mapping">): Promise<Mapping>;
+    updateMapping(mappingId: string, mapping: Pick<CreateMapping, "mapping" | "tags">): Promise<Mapping>;
     /**
      * Retrieves a mapping.
      *
@@ -111,4 +121,4 @@ declare class MappingsApi extends BaseApi {
      */
     getMapping(mappingId: string): Promise<Mapping>;
 }
-export { type CachedMapping, type CreateMapping, type Mapping, type MappingDefinition, type MappingExpressionDependencies, MappingsApi, type MappingTestResult, type MappingTestResults, type ObjectMapping, type PropertyMapping, type RawCachedMapping, type RawMappingDefinition, type RawObjectMapping, type RawPropertyMapping, type RawValueMapping, type ValueMapping, };
+export { type CachedMapping, type CreateMapping, type GetMappingsParameters, type Mapping, type MappingDefinition, type MappingExpressionDependencies, MappingsApi, type MappingTestResult, type MappingTestResults, type ObjectMapping, type PropertyMapping, type RawCachedMapping, type RawMappingDefinition, type RawObjectMapping, type RawPropertyMapping, type RawValueMapping, type ValueMapping, };

package/build/mappings/index.js

@@ -27,14 +27,16 @@ class MappingsApi extends BaseApi {
         }
     }
     /**
-     * Retrieves all mappings.
+     * Retrieves all mappings owned by the caller's company, optionally filtered by attribute and/or dataset.
      *
+     * @param {GetMappingsParameters} [parameters] - Optional attribute/dataset filters.
      * @returns {Promise<ApiRecords<Mapping>>} A promise that resolves to a collection of Mapping records.
      * @public
      * @async
      */
-    async getMappings() {
-        return await this.get(resourceName);
+    async getMappings(parameters) {
+        const queryString = this.constructQueryString(parameters);
+        return await this.get(`${resourceName}${queryString}`);
     }
     /**
      * Creates a new mapping specific to a company.
@@ -125,6 +127,9 @@ class MappingsApi extends BaseApi {
      * @returns {Promise<void>} A promise that resolves when the mapping is succesfully promoted.
      * @public
      * @async
+     * @deprecated No corresponding `POST /mappings/{id}/promote` route was found in the backend
+     *   (narrative-marketplace-backend @ 6f3819c). Calling this will likely 404 — flagged for
+     *   review rather than removed, since callers may already depend on this signature.
      */
     async promoteMapping(mappingId) {
         await this.post(`${resourceName}/${mappingId}/promote`);
@@ -133,7 +138,7 @@ class MappingsApi extends BaseApi {
      * Updates a mapping.
      *
      * @param {string} mappingId - The ID of the mapping to update.
-     * @param {CreateMapping} mapping - The mapping configuration to update.
+     * @param {Pick<CreateMapping, "mapping" | "tags">} mapping - The mapping definition (required) and tags (optional) to update.
      * @returns {Promise<Mapping>} A promise that resolves to the updated mapping.
      * @public
      * @async

package/build/mappings/types.d.ts

@@ -8,16 +8,18 @@ export interface Mapping {
     updated_at: string;
     created_by: number;
     updated_by: number;
-    company_id: number;
+    company_id?: number;
     scope: MappingScope;
     source: MappingSource;
-    derived_from: string;
+    derived_from?: string;
     tags?: string[];
 }
 type MappingStatus = "active" | "archived" | "pending" | "rejected";
 type MappingScope = "global" | "private";
 type MappingSource = "system" | "admin" | "company" | "lineage" | "rosetta_stone";
 type CreateMappingSource = "company" | "rosetta_stone";
+/** Only `active` and `pending` are accepted when creating a new mapping. */
+type CreateMappingStatus = "active" | "pending";
 export interface MappingExpressionDependencies {
     properties: string[];
 }
@@ -73,7 +75,7 @@ export interface CreateMapping {
     dataset_id: number;
     mapping: RawMappingDefinition;
     tags?: string[];
-    status?: MappingStatus;
+    status?: CreateMappingStatus;
     source?: CreateMappingSource;
 }
 export interface MappingTestResult {

package/build/model-inference/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from "../base-api";
 import type { ModelInferenceRunJob } from "../jobs";
-import type { InferenceConfig, InferenceMessage, InferenceModel, InferenceUsage, MessageRole, ModelInferenceRunRequest, ModelInferenceRunResult } from "./types";
+import type { InferenceConfig, InferenceContentMessage, InferenceMessage, InferenceModel, InferenceRequestMessage, InferenceUsage, MessageRole, ModelInferenceRunRequest, ModelInferenceRunResult } from "./types";
 /**
  * @module ModelInferenceApi
  * @description This module provides methods for running model inference jobs.
@@ -15,4 +15,4 @@ declare class ModelInferenceApi extends BaseApi {
      */
     runModelInference(request: ModelInferenceRunRequest): Promise<ModelInferenceRunJob>;
 }
-export { type InferenceConfig, type InferenceMessage, type InferenceModel, type InferenceUsage, type MessageRole, ModelInferenceApi, type ModelInferenceRunRequest, type ModelInferenceRunResult, };
+export { type InferenceConfig, type InferenceContentMessage, type InferenceMessage, type InferenceModel, type InferenceRequestMessage, type InferenceUsage, type MessageRole, ModelInferenceApi, type ModelInferenceRunRequest, type ModelInferenceRunResult, };

package/build/model-inference/types.d.ts

@@ -1,21 +1,40 @@
+import type { ContentBlock } from "../agents/types";
 /**
  * Model identifiers supported by the Narrative model inference API.
  * Maps to Scala ModelInferenceRunJobInput.Model
  */
-export type InferenceModel = "anthropic.claude-haiku-4.5" | "anthropic.claude-sonnet-4.5" | "anthropic.claude-sonnet-4.6" | "anthropic.claude-opus-4.5" | "anthropic.claude-opus-4.6" | "openai.gpt-oss-120b" | "openai.gpt-4.1" | "openai.o4-mini";
+export type InferenceModel = "anthropic.claude-haiku-4.5" | "anthropic.claude-sonnet-4.5" | "anthropic.claude-sonnet-4.6" | "anthropic.claude-sonnet-5.0" | "anthropic.claude-opus-4.5" | "anthropic.claude-opus-4.6" | "anthropic.claude-opus-4.7" | "anthropic.claude-opus-4.8" | "openai.gpt-oss-120b" | "openai.gpt-4.1" | "openai.o4-mini";
 /**
  * Message role for inference requests.
  * Maps to Scala ModelInferenceRunJobInput.Role
  */
 export type MessageRole = "user" | "assistant" | "system";
 /**
- * A message in the inference conversation.
- * Maps to Scala ModelInferenceRunJobInput.Message
+ * A message in the inference conversation using the current content-block
+ * wire shape (the same `ContentBlock` union used by the agents API).
+ * Responses always emit this shape; new integrations should send it too.
+ * Maps to Scala ModelInferenceRunJobInput.Message.
+ */
+export interface InferenceContentMessage {
+    role: MessageRole;
+    content: ContentBlock[];
+}
+/**
+ * A message in the inference conversation using the legacy `{role, text}`
+ * shape. Still accepted on requests for backwards compatibility — the API
+ * auto-canonicalizes it into a single `text` content block — but new
+ * integrations should prefer {@link InferenceContentMessage}.
+ * Maps to Scala ModelInferenceRunJobInput.Message (legacy decoder).
  */
 export interface InferenceMessage {
     role: MessageRole;
     text: string;
 }
+/**
+ * Any message shape accepted by `POST /model-inference/run`: the current
+ * content-block shape or the legacy `{role, text}` shape.
+ */
+export type InferenceRequestMessage = InferenceContentMessage | InferenceMessage;
 /**
  * Configuration for the inference request.
  * Maps to Scala ModelInferenceRunJobInput.InferenceConfig
@@ -42,7 +61,7 @@ export interface ModelInferenceRunRequest {
     /** The model to use for inference */
     model: InferenceModel;
     /** The conversation messages */
-    messages: InferenceMessage[];
+    messages: InferenceRequestMessage[];
     /** Configuration for the inference */
     inference_config: InferenceConfig;
     /** Optional tags for the job */

package/build/model-training/types.d.ts

@@ -6,18 +6,33 @@ export interface OutputModel {
     tags?: string[];
     license_id?: string;
 }
+/**
+ * A destination connection to create for the model produced by a training run.
+ */
+export interface NewModelConnection {
+    /** Destination-specific quick settings; shape depends on the destination app. */
+    quick_settings?: Record<string, unknown>;
+    /** UUID of the app profile backing the connection. */
+    profile_id: string;
+}
 export interface TrainModelRequest {
     base_model_id: number;
     dataset_id: number;
     training_config: ModelTrainingConfig;
     output_model: OutputModel;
+    /**
+     * Connections to create for the trained model. Optional until the UI supports
+     * adding connections when kicking off training runs.
+     */
+    connections?: NewModelConnection[];
 }
 export interface TrainModelResponse {
     job_id: string;
 }
 export interface ModelTrainingConfig {
     instance_type: string;
-    custom_axolotl_config_override?: string;
+    /** Free-form JSON override merged into the generated Axolotl config (Scala `Option[Json]`). */
+    custom_axolotl_config_override?: Record<string, unknown>;
 }
 export interface TrainClassifierRequest {
     config: Record<string, unknown>;

package/build/models/index.d.ts

@@ -1,31 +1,32 @@
 import { BaseApi } from "../base-api";
-import type { ApiRecords } from "../types";
-import type { CreateModelRequest, Model, ModelCollaborators, UpdateModelRequest } from "./types";
+import type { ApiRecordsV2 } from "../types";
+import type { CreateModelRequest, GetModelsParams, Model, ModelCollaborators, ModelOrderBy, ModelParticipants, ModelRepository, ModelRepositoryType, ModelStatus, UpdateModelRequest } from "./types";
 /**
  * A class for accessing the Models API.
  * @extends BaseApi
  */
 declare class ModelsApi extends BaseApi {
     /**
-     * Gets a list of accessable models from the API.
+     * Gets a paginated list of models accessible to the authenticated company from the API.
      *
-     * @returns {Promise<ApiRecords<Model>>} A promise that resolves with the list of models.
+     * @param {GetModelsParams} [params] - Optional pagination, repository type, and sort filters.
+     * @returns {Promise<ApiRecordsV2<Model>>} A promise that resolves with the paginated list of models.
      */
-    getModels(): Promise<ApiRecords<Model>>;
+    getModels(params?: GetModelsParams): Promise<ApiRecordsV2<Model>>;
     /**
      * Updates an existing model on the API.
      *
-     * @param {string} modelId - The ID of the model to update.
-     * @param {UpdateNqlModelRequest} data - The updated data for the model.
+     * @param {number} modelId - The ID of the model to update.
+     * @param {UpdateModelRequest} data - The updated data for the model.
      * @returns {Promise<Model>} A promise that resolves with the updated model.
      */
-    updateModel(modelId: string, data: UpdateModelRequest): Promise<Model>;
+    updateModel(modelId: number, data: UpdateModelRequest): Promise<Model>;
     /**
-     * Deletes a model from the API.
+     * Deletes (archives) a model from the API.
      *
-     * @param {string} modelId - The ID of the model to delete.
+     * @param {number} modelId - The ID of the model to delete.
      * @returns {Promise<void>} A promise that resolves when the model is deleted.
      */
-    deleteModel(modelId: string): Promise<void>;
+    deleteModel(modelId: number): Promise<void>;
 }
-export { type CreateModelRequest, type Model, type ModelCollaborators, ModelsApi, type UpdateModelRequest, };
+export { type CreateModelRequest, type GetModelsParams, type Model, type ModelCollaborators, type ModelOrderBy, type ModelParticipants, type ModelRepository, type ModelRepositoryType, type ModelStatus, ModelsApi, type UpdateModelRequest, };

package/build/models/index.js

@@ -12,27 +12,48 @@ const resourceName = "models";
  */
 class ModelsApi extends BaseApi {
     /**
-     * Gets a list of accessable models from the API.
+     * Gets a paginated list of models accessible to the authenticated company from the API.
      *
-     * @returns {Promise<ApiRecords<Model>>} A promise that resolves with the list of models.
+     * @param {GetModelsParams} [params] - Optional pagination, repository type, and sort filters.
+     * @returns {Promise<ApiRecordsV2<Model>>} A promise that resolves with the paginated list of models.
      */
-    async getModels() {
-        return await this.get(`${resourceName}`);
+    async getModels(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.page) {
+            queryParams.append("page", params.page.toString());
+        }
+        if (params?.per_page) {
+            queryParams.append("per_page", params.per_page.toString());
+        }
+        if (params?.repository_type) {
+            const repositoryTypes = Array.isArray(params.repository_type)
+                ? params.repository_type
+                : [params.repository_type];
+            for (const repositoryType of repositoryTypes) {
+                queryParams.append("repository_type", repositoryType);
+            }
+        }
+        if (params?.order_by) {
+            queryParams.append("order_by", params.order_by);
+        }
+        const queryString = queryParams.toString();
+        const url = queryString ? `${resourceName}?${queryString}` : resourceName;
+        return await this.get(url);
     }
     /**
      * Updates an existing model on the API.
      *
-     * @param {string} modelId - The ID of the model to update.
-     * @param {UpdateNqlModelRequest} data - The updated data for the model.
+     * @param {number} modelId - The ID of the model to update.
+     * @param {UpdateModelRequest} data - The updated data for the model.
      * @returns {Promise<Model>} A promise that resolves with the updated model.
      */
     async updateModel(modelId, data) {
         return await this.put(`${resourceName}/${modelId}`, data);
     }
     /**
-     * Deletes a model from the API.
+     * Deletes (archives) a model from the API.
      *
-     * @param {string} modelId - The ID of the model to delete.
+     * @param {number} modelId - The ID of the model to delete.
      * @returns {Promise<void>} A promise that resolves when the model is deleted.
      */
     async deleteModel(modelId) {

package/build/models/types.d.ts

@@ -1,18 +1,85 @@
-import type { CollaboratorList, GeneralCollaborator } from "../types";
+/**
+ * Repository backed by a HuggingFace organization.
+ */
+export interface HuggingFaceRepository {
+    type: "hugging_face";
+    organization: string;
+}
+/**
+ * Repository backed by a Narrative company.
+ */
+export interface NarrativeRepository {
+    type: "narrative";
+    company_id: number;
+}
+/**
+ * Discriminated union describing where a model's artifacts are stored.
+ */
+export type ModelRepository = HuggingFaceRepository | NarrativeRepository;
+/**
+ * No companies are allowed to participate.
+ */
+export interface ModelParticipantsNone {
+    type: "none";
+}
+/**
+ * All companies are allowed to participate.
+ */
+export interface ModelParticipantsAll {
+    type: "all";
+}
+/**
+ * Anyone, including unauthenticated callers. `view` only.
+ */
+export interface ModelParticipantsAnonymous {
+    type: "anonymous";
+}
+/**
+ * Only the listed companies are allowed to participate. `company_ids` must be non-empty.
+ */
+export interface ModelParticipantsInclusion {
+    type: "inclusion";
+    company_ids: number[];
+}
+/**
+ * Every company except the listed ones. `company_ids` must be non-empty.
+ */
+export interface ModelParticipantsExclusion {
+    type: "exclusion";
+    company_ids: number[];
+}
+/**
+ * Who may view a model. Adds the `anonymous` variant the other two lack — see
+ * `ViewCollaborators` in `datashops-protocol`.
+ */
+export type ModelViewParticipants = ModelParticipantsAnonymous | ModelParticipantsAll | ModelParticipantsNone | ModelParticipantsInclusion | ModelParticipantsExclusion;
+/**
+ * Who may train on, or deploy, a model — see `TrainCollaborators` /
+ * `DeployCollaborators` in `datashops-protocol`.
+ */
+export type ModelParticipants = ModelParticipantsAll | ModelParticipantsNone | ModelParticipantsInclusion | ModelParticipantsExclusion;
+/**
+ * Defines which companies may view, train on, and deploy a model. Maps to Scala
+ * `ModelTrainingCollaborators`, which backs both `ModelResponse.collaborators` and
+ * `TrainRequest.OutputModel.collaborators`. All three keys are required.
+ */
 export interface ModelCollaborators {
-    view: CollaboratorList | GeneralCollaborator;
-    train: CollaboratorList | GeneralCollaborator;
-    deploy: CollaboratorList | GeneralCollaborator;
+    view: ModelViewParticipants;
+    train: ModelParticipants;
+    deploy: ModelParticipants;
 }
+/**
+ * Current status of a model.
+ */
+export type ModelStatus = "active" | "archived";
 export interface Model {
     id: number;
     company_id: number;
     name: string;
+    /** A human readable name for the model. Always emitted (Scala non-Option). */
+    display_name: string;
     license_id: string;
-    repository: {
-        type: string;
-        organization: string;
-    };
+    repository: ModelRepository;
     collaborators: ModelCollaborators;
     description?: string;
     tags: string[];
@@ -21,19 +88,38 @@ export interface Model {
     updated_at: string | null;
     archived_at: string | null;
     version: number;
-    status: string;
+    status: ModelStatus;
 }
 export interface CreateModelRequest {
     name: string;
     license_id: string;
-    repository: string;
+    repository: ModelRepository;
     collaborators: ModelCollaborators;
     description?: string;
     tags?: string[];
     base_model_id?: number;
+    display_name?: string;
 }
 export interface UpdateModelRequest {
     description?: string;
     tags?: string[];
     license_id?: string;
+    display_name?: string;
+}
+/**
+ * Repository type values usable to filter models via `GET /models`.
+ */
+export type ModelRepositoryType = "hugging_face" | "narrative";
+/**
+ * Sort order values usable with `GET /models`.
+ */
+export type ModelOrderBy = "created_at_asc" | "created_at_desc";
+/**
+ * Query parameters accepted by `GET /models`.
+ */
+export interface GetModelsParams {
+    page?: number;
+    per_page?: number;
+    repository_type?: ModelRepositoryType | ModelRepositoryType[];
+    order_by?: ModelOrderBy;
 }

package/build/nql/types.d.ts

@@ -33,7 +33,7 @@ export type NqlBudget = z.infer<typeof NqlBudgetObj>;
  */
 export declare const NqlQueryInputObj: z.ZodObject<{
     nql: z.ZodString;
-    data_plane_id: z.ZodNullable<z.ZodString>;
+    data_plane_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     execution_cluster: z.ZodOptional<z.ZodObject<{
         type: z.ZodEnum<{
             shared: "shared";
@@ -306,37 +306,47 @@ export interface BatchInfo {
     batch_size: number;
     related_jobs: RelatedJob[];
 }
+/**
+ * Job state for an NQL run, as returned by `POST /nql/run` and `GET /nql/{id}`.
+ */
+export type NqlJobState = "failed" | "cancelled" | "completed" | "pending" | "scheduled" | "pending_cancellation" | "running";
 export interface NqlResult {
     id: string;
     company_id: number;
-    completed_at: string;
+    /** `null` while the job hasn't completed yet. */
+    completed_at: string | null;
     created_at: string;
     failures: unknown[];
-    idempotency_key: string;
     input: {
         nql: string;
         dataset?: Dataset;
+        /** Present on `EXPLAIN`/forecast runs. */
+        compiled_sql?: string;
+        /** Present on `CREATE MATERIALIZED VIEW` runs. */
         compiled_select?: string;
+        /** Present on `CREATE MATERIALIZED VIEW` runs. */
+        create_as_view?: boolean;
     };
+    idempotency_key: string;
     request_source: {
         type: string;
         company_id: number;
         user_id: number;
     };
-    result: {
+    /** `null`/absent while the job hasn't completed yet. */
+    result?: {
         type: string;
         rows: number;
         cost: number;
         nql_type: string;
-    };
-    state: string;
+    } | null;
+    state: NqlJobState;
     updated_at: string;
     chunking_context?: BatchInfo;
 }
 export type NqlMappingErrors = Record<number, string>;
 export interface NqlCompileResult {
     sql: string;
-    mappingErrors?: NqlMappingErrors;
 }
 export interface ForecastBody {
     as_of: string;

package/build/nql/types.js

@@ -38,7 +38,11 @@ export const NqlQueryInputObj = z.object({
         message: "NQL query cannot contain a JOIN statement.",
     })
         .describe("A NQL query"),
-    data_plane_id: z.string().nullable().describe("Data plane identifier"),
+    data_plane_id: z
+        .string()
+        .nullable()
+        .optional()
+        .describe("Data plane identifier"),
     execution_cluster: z
         .object({
         type: z.enum(["shared", "dedicated"]).describe("Execution cluster type"),

package/build/ping/index.d.ts

@@ -8,7 +8,11 @@ export declare class PingApi extends BaseApi {
     /**
      * Gets the result of a ping from the API.
      *
-     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the ping.
+     * Note: the backend's `/ping` route (`PingRoute` in `HealthCheckRoutes.scala`) responds with the
+     * literal plain-text body `"pong"`, not JSON. Parsing behavior therefore depends on how the
+     * underlying HTTP client handles non-JSON responses; the `PingStatus` type here is a placeholder.
+     *
+     * @returns {Promise<PingStatus>} A promise that resolves with the result of the ping.
      */
     ping(): Promise<PingStatus>;
 }

package/build/ping/index.js

@@ -14,7 +14,11 @@ export class PingApi extends BaseApi {
     /**
      * Gets the result of a ping from the API.
      *
-     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the ping.
+     * Note: the backend's `/ping` route (`PingRoute` in `HealthCheckRoutes.scala`) responds with the
+     * literal plain-text body `"pong"`, not JSON. Parsing behavior therefore depends on how the
+     * underlying HTTP client handles non-JSON responses; the `PingStatus` type here is a placeholder.
+     *
+     * @returns {Promise<PingStatus>} A promise that resolves with the result of the ping.
      */
     async ping() {
         return await this.get(resourceName);

package/build/products/index.d.ts

@@ -1,4 +1,5 @@
 import { BaseApi } from "../base-api";
+import type { ApiRecords } from "../types";
 import type { Product } from "./types";
 /**
  * A class for accessing the Products API.
@@ -6,10 +7,10 @@ import type { Product } from "./types";
  */
 declare class ProductsApi extends BaseApi {
     /**
-     * Gets the result of a product from the API.
+     * Gets a paginated list of products from the API.
      *
-     * @returns {Promise<Product[]>} A promise that resolves with the products.
+     * @returns {Promise<ApiRecords<Product>>} A promise that resolves with the products.
      */
-    getHealthCheck(): Promise<Product[]>;
+    getHealthCheck(): Promise<ApiRecords<Product>>;
 }
 export { type Product, ProductsApi };

package/build/products/index.js

@@ -12,9 +12,9 @@ const resourceName = "admin/products";
  */
 class ProductsApi extends BaseApi {
     /**
-     * Gets the result of a product from the API.
+     * Gets a paginated list of products from the API.
      *
-     * @returns {Promise<Product[]>} A promise that resolves with the products.
+     * @returns {Promise<ApiRecords<Product>>} A promise that resolves with the products.
      */
     async getHealthCheck() {
         return await this.get(resourceName);