colacloud 1.2.0 → 1.4.0

package/README.md

@@ -336,6 +336,6 @@ MIT
 
 ## Support
 
-- Documentation: https://colacloud.us/docs/api
+- Documentation: https://docs.colacloud.us/api-reference
 - Issues: https://github.com/cola-cloud-us/colacloud-js/issues
 - Email: support@colacloud.us

package/dist/index.d.mts

@@ -20,10 +20,14 @@ interface Pagination {
     page: number;
     /** Number of items per page */
     per_page: number;
-    /** Total number of items across all pages */
-    total: number;
-    /** Total number of pages */
-    pages: number;
+    /** Total number of items across all pages (null when using offset pagination without count) */
+    total: number | null;
+    /** Total number of pages (null when using offset pagination without count) */
+    pages: number | null;
+    /** Whether there are more results available */
+    has_more?: boolean;
+    /** Pagination mode: "cursor" or "offset" */
+    mode?: string;
 }
 /**
  * Response wrapper for paginated list endpoints
@@ -42,24 +46,26 @@ interface SingleResponse<T> {
     data: T;
 }
 /**
- * Rate limit information from response headers
+ * Quota information parsed from response headers
  */
-interface RateLimitInfo {
-    /** Maximum requests allowed per minute */
+interface QuotaInfo {
+    /** Which meter this quota applies to */
+    meter: 'detail_views' | 'list_records';
+    /** Quota limit for the current billing period */
     limit: number;
-    /** Remaining requests in the current window */
+    /** Remaining quota in the current billing period */
     remaining: number;
-    /** Unix timestamp when the rate limit resets */
+    /** Unix timestamp when quotas reset (first of next month) */
     reset: number;
 }
 /**
- * Extended response that includes rate limit information
+ * Extended response that includes quota information
  */
-interface ResponseWithRateLimit<T> {
+interface ResponseWithQuota<T> {
     /** The response data */
     data: T;
-    /** Rate limit information from headers */
-    rateLimit: RateLimitInfo | null;
+    /** Quota information from headers */
+    quota: QuotaInfo | null;
 }
 /**
  * Summary information about a COLA (Certificate of Label Approval)
@@ -322,6 +328,140 @@ interface UsageStats {
     /** Per-minute burst limit */
     per_minute_limit: number;
 }
+/**
+ * Metadata for reference data list responses
+ */
+interface ReferenceListMeta {
+    /** Total number of items */
+    total: number;
+}
+/**
+ * Metadata for paginated reference data responses
+ */
+interface ReferenceListPaginatedMeta {
+    /** Total number of items */
+    total: number;
+    /** Current page number */
+    page: number;
+    /** Items per page */
+    per_page: number;
+    /** Whether there are more results */
+    has_more: boolean;
+}
+/**
+ * Response wrapper for reference data list endpoints
+ */
+interface ReferenceListResponse<T> {
+    /** Array of items */
+    data: T[];
+    /** Response metadata */
+    meta: ReferenceListMeta;
+}
+/**
+ * Response wrapper for paginated reference data list endpoints
+ */
+interface ReferencePaginatedResponse<T> {
+    /** Array of items */
+    data: T[];
+    /** Response metadata with pagination */
+    meta: ReferenceListPaginatedMeta;
+}
+/**
+ * Response wrapper for single reference data endpoints
+ */
+interface ReferenceSingleResponse<T> {
+    /** The requested item */
+    data: T;
+}
+/**
+ * Query parameters for processing times overview
+ */
+interface ProcessingTimesParams {
+    /** Filter by commodity type */
+    commodity?: string;
+}
+/**
+ * Query parameters for formula processing times
+ */
+interface FormulaProcessingTimesParams {
+    /** Filter by formula type */
+    formulaType?: string;
+    /** Filter by commodity type */
+    commodity?: string;
+}
+/**
+ * Query parameters for registration processing times
+ */
+interface RegistrationProcessingTimesParams {
+    /** Filter by category */
+    category?: string;
+    /** Filter by application type */
+    applicationType?: string;
+}
+/**
+ * Query parameters for production reports
+ */
+interface ProductionReportsParams {
+    /** Filter by commodity type */
+    commodity?: string;
+    /** Filter by year */
+    year?: number;
+    /** Filter by month */
+    month?: number;
+    /** Filter by report type */
+    reportType?: string;
+    /** Filter by statistical group */
+    statisticalGroup?: string;
+    /** Page number (1-indexed, default 1) */
+    page?: number;
+    /** Items per page (default 100, max 100) */
+    perPage?: number;
+}
+/**
+ * Query parameters for AVA (American Viticultural Area) list
+ */
+interface AvaListParams {
+    /** Filter by state */
+    state?: string;
+    /** Search by name */
+    q?: string;
+}
+/**
+ * A processing time record
+ */
+interface ProcessingTime {
+    [key: string]: unknown;
+}
+/**
+ * A formula processing time record
+ */
+interface FormulaProcessingTime {
+    [key: string]: unknown;
+}
+/**
+ * A registration processing time record
+ */
+interface RegistrationProcessingTime {
+    [key: string]: unknown;
+}
+/**
+ * A production report record
+ */
+interface ProductionReport {
+    [key: string]: unknown;
+}
+/**
+ * An AVA (American Viticultural Area) summary record
+ */
+interface AvaSummary {
+    [key: string]: unknown;
+}
+/**
+ * Full AVA (American Viticultural Area) detail record
+ */
+interface AvaDetail {
+    [key: string]: unknown;
+}
 /**
  * Error response structure from the API
  */
@@ -373,6 +513,12 @@ declare class ColaCloud {
     readonly barcodes: BarcodesResource;
     /** Usage statistics endpoint */
     readonly usage: UsageResource;
+    /** Processing times reference data endpoints */
+    readonly processingTimes: ProcessingTimesResource;
+    /** Production reports reference data endpoints */
+    readonly productionReports: ProductionReportsResource;
+    /** AVA (American Viticultural Area) reference data endpoints */
+    readonly avas: AvasResource;
     /**
      * Create a new COLA Cloud API client
      * @param config Configuration options
@@ -382,7 +528,7 @@ declare class ColaCloud {
      * Make an authenticated request to the API
      * @internal
      */
-    request<T>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, params?: Record<string, unknown>): Promise<ResponseWithRateLimit<T>>;
+    request<T>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, params?: Record<string, unknown>): Promise<ResponseWithQuota<T>>;
     /**
      * Handle error responses from the API
      */
@@ -401,11 +547,11 @@ declare class ColasResource {
      */
     list(params?: ColaListParams): Promise<PaginatedResponse<ColaSummary>>;
     /**
-     * List COLAs with rate limit information
+     * List COLAs with quota information
      * @param params Search and filter parameters
-     * @returns Paginated list with rate limit info
+     * @returns Paginated list with quota info
      */
-    listWithRateLimit(params?: ColaListParams): Promise<ResponseWithRateLimit<PaginatedResponse<ColaSummary>>>;
+    listWithQuota(params?: ColaListParams): Promise<ResponseWithQuota<PaginatedResponse<ColaSummary>>>;
     /**
      * Get a single COLA by TTB ID
      * @param ttbId The unique TTB identifier
@@ -413,11 +559,11 @@ declare class ColasResource {
      */
     get(ttbId: string): Promise<ColaDetail>;
     /**
-     * Get a single COLA with rate limit information
+     * Get a single COLA with quota information
      * @param ttbId The unique TTB identifier
-     * @returns COLA details with rate limit info
+     * @returns COLA details with quota info
      */
-    getWithRateLimit(ttbId: string): Promise<ResponseWithRateLimit<ColaDetail>>;
+    getWithQuota(ttbId: string): Promise<ResponseWithQuota<ColaDetail>>;
     /**
      * Create an async iterator that automatically pages through all results
      * @param params Search and filter parameters (page is ignored)
@@ -445,11 +591,11 @@ declare class PermitteesResource {
      */
     list(params?: PermitteeListParams): Promise<PaginatedResponse<PermitteeSummary>>;
     /**
-     * List permittees with rate limit information
+     * List permittees with quota information
      * @param params Search and filter parameters
-     * @returns Paginated list with rate limit info
+     * @returns Paginated list with quota info
      */
-    listWithRateLimit(params?: PermitteeListParams): Promise<ResponseWithRateLimit<PaginatedResponse<PermitteeSummary>>>;
+    listWithQuota(params?: PermitteeListParams): Promise<ResponseWithQuota<PaginatedResponse<PermitteeSummary>>>;
     /**
      * Get a single permittee by permit number
      * @param permitNumber The unique permit number
@@ -457,11 +603,11 @@ declare class PermitteesResource {
      */
     get(permitNumber: string): Promise<PermitteeDetail>;
     /**
-     * Get a single permittee with rate limit information
+     * Get a single permittee with quota information
      * @param permitNumber The unique permit number
-     * @returns Permittee details with rate limit info
+     * @returns Permittee details with quota info
      */
-    getWithRateLimit(permitNumber: string): Promise<ResponseWithRateLimit<PermitteeDetail>>;
+    getWithQuota(permitNumber: string): Promise<ResponseWithQuota<PermitteeDetail>>;
     /**
      * Create an async iterator that automatically pages through all results
      * @param params Search and filter parameters (page is ignored)
@@ -489,11 +635,11 @@ declare class BarcodesResource {
      */
     lookup(barcodeValue: string): Promise<BarcodeLookupResult>;
     /**
-     * Look up barcode with rate limit information
+     * Look up barcode with quota information
      * @param barcodeValue The barcode to search for
-     * @returns Barcode lookup result with rate limit info
+     * @returns Barcode lookup result with quota info
      */
-    lookupWithRateLimit(barcodeValue: string): Promise<ResponseWithRateLimit<BarcodeLookupResult>>;
+    lookupWithQuota(barcodeValue: string): Promise<ResponseWithQuota<BarcodeLookupResult>>;
 }
 /**
  * Usage statistics resource handler
@@ -507,10 +653,67 @@ declare class UsageResource {
      */
     get(): Promise<UsageStats>;
     /**
-     * Get usage statistics with rate limit information
-     * @returns Usage statistics with rate limit info
+     * Get usage statistics with quota information
+     * @returns Usage statistics with quota info
+     */
+    getWithQuota(): Promise<ResponseWithQuota<UsageStats>>;
+}
+/**
+ * Processing times reference data resource handler
+ */
+declare class ProcessingTimesResource {
+    private readonly client;
+    constructor(client: ColaCloud);
+    /**
+     * Get processing times overview
+     * @param params Optional filter parameters
+     * @returns Processing times data with total count
+     */
+    list(params?: ProcessingTimesParams): Promise<ReferenceListResponse<ProcessingTime>>;
+    /**
+     * Get formula processing times
+     * @param params Optional filter parameters
+     * @returns Formula processing times data with total count
+     */
+    formula(params?: FormulaProcessingTimesParams): Promise<ReferenceListResponse<FormulaProcessingTime>>;
+    /**
+     * Get registration processing times
+     * @param params Optional filter parameters
+     * @returns Registration processing times data with total count
+     */
+    registration(params?: RegistrationProcessingTimesParams): Promise<ReferenceListResponse<RegistrationProcessingTime>>;
+}
+/**
+ * Production reports reference data resource handler
+ */
+declare class ProductionReportsResource {
+    private readonly client;
+    constructor(client: ColaCloud);
+    /**
+     * List production reports with pagination
+     * @param params Filter and pagination parameters
+     * @returns Paginated production reports data
+     */
+    list(params?: ProductionReportsParams): Promise<ReferencePaginatedResponse<ProductionReport>>;
+}
+/**
+ * AVA (American Viticultural Area) reference data resource handler
+ */
+declare class AvasResource {
+    private readonly client;
+    constructor(client: ColaCloud);
+    /**
+     * List and search AVAs
+     * @param params Optional filter parameters
+     * @returns AVA data with total count
+     */
+    list(params?: AvaListParams): Promise<ReferenceListResponse<AvaSummary>>;
+    /**
+     * Get a single AVA by ID
+     * @param avaId The unique AVA identifier
+     * @returns Full AVA details
      */
-    getWithRateLimit(): Promise<ResponseWithRateLimit<UsageStats>>;
+    get(avaId: string): Promise<AvaDetail>;
 }
 
 /**
@@ -543,11 +746,11 @@ declare class AuthenticationError extends ColaCloudError {
  * Error thrown when rate limit is exceeded (429 Too Many Requests)
  */
 declare class RateLimitError extends ColaCloudError {
-    /** Rate limit information from headers */
-    readonly rateLimit: RateLimitInfo | null;
+    /** Quota information from headers */
+    readonly quota: QuotaInfo | null;
     /** Seconds until the rate limit resets */
     readonly retryAfter: number | null;
-    constructor(message?: string, rateLimit?: RateLimitInfo | null, retryAfter?: number | null);
+    constructor(message?: string, quota?: QuotaInfo | null, retryAfter?: number | null);
 }
 /**
  * Error thrown when a requested resource is not found (404 Not Found)
@@ -605,7 +808,7 @@ interface PaginatedIteratorOptions<TParams> {
         page: number;
     }) => Promise<{
         response: PaginatedResponse<unknown>;
-        rateLimit: RateLimitInfo | null;
+        quota: QuotaInfo | null;
     }>;
     /** Starting page number (defaults to 1) */
     startPage?: number;
@@ -624,8 +827,8 @@ interface PaginatedIteratorResult<T> {
     indexInPage: number;
     /** Total items across all pages */
     total: number;
-    /** Rate limit info from the last request */
-    rateLimit: RateLimitInfo | null;
+    /** Quota info from the last request */
+    quota: QuotaInfo | null;
 }
 /**
  * Creates an async iterator that automatically handles pagination
@@ -655,4 +858,4 @@ declare function collectAll<T>(iterator: AsyncIterable<T>, maxItems?: number): P
  */
 declare function take<T>(iterator: AsyncIterable<T>, count: number): Promise<T[]>;
 
-export { type ApiErrorResponse, AuthenticationError, type BarcodeLookupResult, type ColaBarcode, ColaCloud, type ColaCloudConfig, ColaCloudError, type ColaDetail, type ColaImage, type ColaListParams, type ColaSummary, NetworkError, NotFoundError, type PaginatedIteratorOptions, type PaginatedIteratorResult, type PaginatedResponse, type Pagination, type PermitteeDetail, type PermitteeListParams, type PermitteeSummary, RateLimitError, type RateLimitInfo, type ResponseWithRateLimit, ServerError, type SingleResponse, TimeoutError, type UsageStats, ValidationError, collectAll, createPaginatedIterator, createPaginatedIteratorWithMetadata, take };
+export { type ApiErrorResponse, AuthenticationError, type AvaDetail, type AvaListParams, type AvaSummary, type BarcodeLookupResult, type ColaBarcode, ColaCloud, type ColaCloudConfig, ColaCloudError, type ColaDetail, type ColaImage, type ColaListParams, type ColaSummary, type FormulaProcessingTime, type FormulaProcessingTimesParams, NetworkError, NotFoundError, type PaginatedIteratorOptions, type PaginatedIteratorResult, type PaginatedResponse, type Pagination, type PermitteeDetail, type PermitteeListParams, type PermitteeSummary, type ProcessingTime, type ProcessingTimesParams, type ProductionReport, type ProductionReportsParams, type QuotaInfo, RateLimitError, type ReferenceListMeta, type ReferenceListPaginatedMeta, type ReferenceListResponse, type ReferencePaginatedResponse, type ReferenceSingleResponse, type RegistrationProcessingTime, type RegistrationProcessingTimesParams, type ResponseWithQuota, ServerError, type SingleResponse, TimeoutError, type UsageStats, ValidationError, collectAll, createPaginatedIterator, createPaginatedIteratorWithMetadata, take };