bc-api-client 0.1.0-beta.1 → 0.1.0-beta.3

package/dist/client.d.ts

@@ -1,30 +1,103 @@
 import { RateLimitOptions, RequestOptions, StoreOptions } from './net';
+/**
+ * Options for GET requests to the BigCommerce API
+ */
 export type GetOptions = {
+    /** The API endpoint to call */
     endpoint: string;
+    /** Query parameters to include in the request */
     query?: Record<string, string>;
+    /** API version to use (v2 or v3) */
     version?: 'v2' | 'v3';
 };
+/**
+ * Options for POST/PUT requests to the BigCommerce API
+ */
 export type PostOptions<T> = GetOptions & {
+    /** Request body data */
     body: T;
 };
+/**
+ * Options for controlling concurrent request behavior
+ */
 export type ConcurrencyOptions = {
+    /** Maximum number of concurrent requests (default: 10) */
     concurrency?: number;
+    /** Whether to skip errors and continue processing (default: false) */
     skipErrors?: boolean;
 };
+/**
+ * Options for querying multiple values against a single filter field
+ */
 export type QueryOptions = Omit<GetOptions, 'version'> & ConcurrencyOptions & {
+    /** The field name to query against */
     key: string;
+    /** Array of values to query for */
     values: (string | number)[];
 };
+/**
+ * Configuration options for the BigCommerce client
+ */
 export type Config = StoreOptions & RateLimitOptions;
+/**
+ * Client for interacting with the BigCommerce API
+ *
+ * This client provides methods for making HTTP requests to the BigCommerce API,
+ * with support for both v2 and v3 endpoints, pagination, and concurrent requests.
+ */
 export declare class BigCommerceClient {
     private readonly config;
+    /**
+     * Creates a new BigCommerce client instance
+     * @param config - Configuration options for the client
+     */
     constructor(config: Config);
+    /**
+     * Makes a GET request to the BigCommerce API
+     * @param options - Request options
+     * @returns Promise resolving to the response data
+     */
     get<R>(options: GetOptions): Promise<R>;
+    /**
+     * Makes a POST request to the BigCommerce API
+     * @param options - Request options including body data
+     * @returns Promise resolving to the response data
+     */
     post<T, R>(options: PostOptions<T>): Promise<R>;
+    /**
+     * Makes a PUT request to the BigCommerce API
+     * @param options - Request options including body data
+     * @returns Promise resolving to the response data
+     */
     put<T, R>(options: PostOptions<T>): Promise<R>;
+    /**
+     * Makes a DELETE request to the BigCommerce API
+     * @param endpoint - The API endpoint to delete
+     */
     delete<R>(endpoint: string): Promise<void>;
+    /**
+     * Executes multiple requests concurrently with controlled concurrency
+     * @param requests - Array of request options to execute
+     * @param options - Concurrency control options
+     * @returns Promise resolving to array of response data
+     */
     concurrent<T, R>(requests: RequestOptions<T>[], options: ConcurrencyOptions): Promise<R[]>;
+    /**
+     * Collects all pages of data from a paginated v3 API endpoint
+     * @param options - Request options with pagination parameters
+     * @returns Promise resolving to array of all items across all pages
+     */
     collect<T>(options: Omit<GetOptions, 'version'> & ConcurrencyOptions): Promise<T[]>;
+    /**
+     * Collects all pages of data from a paginated v2 API endpoint
+     * @param options - Request options with pagination parameters
+     * @returns Promise resolving to array of all items across all pages
+     */
     collectV2<T>(options: Omit<GetOptions, 'version'> & ConcurrencyOptions): Promise<T[]>;
+    /**
+     * Queries multiple values against a single field using the v3 API
+     * @param options - Query options including field name and values
+     * @returns Promise resolving to array of matching items
+     */
     query<T>(options: QueryOptions): Promise<T[]>;
 }

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './client';
 export * from './core';
 export * from './auth';
+export { Methods } from './net';