doboxa-js 1.0.3 → 1.1.0

package/dist/{client-BfIS6ja2.d.ts → client-BrWpdgrN.d.ts}

@@ -75,15 +75,6 @@ declare class HTTPClient {
     patch<T>(path: string, body?: unknown, options?: RequestInit): Promise<T>;
 }
 
-/**
- * Boolean type alias
- */
-type Bool = boolean;
-declare function BoolFromJSON(json: any): Bool;
-declare function BoolFromJSONTyped(json: any, ignoreDiscriminator: boolean): Bool;
-declare function BoolToJSON(value?: Bool | null): any;
-declare function BoolToJSONTyped(value?: Bool | null, ignoreDiscriminator?: boolean): any;
-
 /**
  * API V2
  * API V2
@@ -1593,7 +1584,6 @@ declare function OrderToJSONTyped(value?: Omit<Order, 'billing_address' | 'order
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
 /**
  *
  * @export
@@ -1602,10 +1592,10 @@ declare function OrderToJSONTyped(value?: Omit<Order, 'billing_address' | 'order
 interface OrderCancellationResponse {
     /**
      * Cancellation result
-     * @type {Bool}
+     * @type {boolean}
      * @memberof OrderCancellationResponse
      */
-    cancelled?: Bool;
+    cancelled?: boolean;
     /**
      * Additional details regarding the cancellation process
      * @type {string}
@@ -2727,6 +2717,270 @@ declare class UsersResource {
     me(): Promise<Me>;
 }
 
+/**
+ * Actions supported by Doboxa's BaseLinker connector.
+ */
+type BaseLinkerAction = 'FileVersion' | 'SupportedMethods' | 'ProductsCategories' | 'ProductsList' | 'ProductsData';
+/**
+ * Credentials of Doboxa's BaseLinker connector (shop integration file).
+ */
+interface BaseLinkerConnectorConfig {
+    /**
+     * Connector URL, e.g. https://pl.doboxa.biz/api/base-linker/{clientToken}/{language}
+     */
+    url: string;
+    /**
+     * "Hasło" of the integration in the Doboxa client panel
+     */
+    password: string;
+}
+/**
+ * Parameters of a `ProductsList` call.
+ */
+interface ProductsListParams {
+    /**
+     * 1-based; past the end returns only `pages`
+     */
+    page?: number;
+    /**
+     * Filter the list by a single category id
+     */
+    category_id?: string;
+}
+/**
+ * Parameters of a `ProductsData` call.
+ */
+interface ProductsDataParams {
+    /**
+     * Design (parent) ids from ProductsList
+     */
+    products_id: string[];
+}
+/**
+ * Error body returned by the connector with HTTP 200.
+ */
+interface BaseLinkerError {
+    error: true;
+    error_code: 'no_password' | 'bad_password' | 'unsupported_method' | (string & {});
+    error_text: string;
+}
+/**
+ * Connector platform and version.
+ */
+interface FileVersionResponse {
+    /**
+     * e.g. "Magento"
+     */
+    platform: string;
+    /**
+     * e.g. "4.1.91"
+     */
+    version: string;
+    /**
+     * e.g. 4
+     */
+    standard: number;
+}
+/**
+ * List of actions the connector supports.
+ */
+type SupportedMethodsResponse = BaseLinkerAction[];
+/**
+ * Category id -> "Fototapety / Tematyka / Abstrakcja"
+ */
+type ProductsCategoriesResponse = Record<string, string>;
+/**
+ * First variant of a design, as shown in the list.
+ */
+interface ProductsListItem {
+    /**
+     * e.g. "Fototapeta Wikingowie I Smoki Flizelina 90x60"
+     */
+    name: string;
+    /**
+     * e.g. 999
+     */
+    quantity: number;
+    /**
+     * e.g. "20.244" - PLN, probably net
+     */
+    price: string;
+    /**
+     * e.g. "FT-2385-VE90-60"
+     */
+    sku: string;
+    /**
+     * e.g. "5905451113260"
+     */
+    ean: string;
+}
+/**
+ * A single product of a list page, with its design id.
+ */
+interface ProductsListEntry extends ProductsListItem {
+    /**
+     * Design (parent) product id
+     */
+    id: string;
+}
+/**
+ * A page of the product list.
+ */
+interface ProductsListResult {
+    /**
+     * Total number of pages
+     */
+    pages: number;
+    /**
+     * Products of the requested page
+     */
+    items: ProductsListEntry[];
+}
+/**
+ * Raw `ProductsList` response; keys are product ids and `pages` is the total page count.
+ */
+type ProductsListResponse = {
+    pages: number;
+} & {
+    [productId: string]: ProductsListItem | number;
+};
+/**
+ * [name, value] pair.
+ */
+type ProductFeature = [name: ProductFeatureName | (string & {}), value: string | null];
+/**
+ * Known feature names returned by the connector.
+ */
+type ProductFeatureName = 'product_type' | 'material' | 'dimensions' | 'dimensions_width' | 'dimensions_height' | 'size_code' | 'area_m2' | 'number_of_elements' | 'break_width' | 'break_height' | 'weight_gross' | 'weight_nett' | 'grammage' | 'lamination' | 'printing_technique' | 'structure' | 'length' | 'category_name';
+/**
+ * A single variant (size x material) of a design.
+ */
+interface ProductVariant {
+    /**
+     * Design name without size/material
+     */
+    full_name: string;
+    /**
+     * e.g. "… Flizelina 90x60"
+     */
+    name: string;
+    /**
+     * HTML/plain text
+     */
+    description: string;
+    /**
+     * Size code: "VE90-60", "VEM", "V4", "brak", …
+     */
+    rozmiar: string;
+    quantity: number;
+    /**
+     * e.g. "20.244"
+     */
+    price: string;
+    ean: string;
+    /**
+     * e.g. "FT-2385-VE90-60"
+     */
+    sku: string;
+    features: ProductFeature[];
+    /**
+     * [0] main image, [1] size render, then mask and room shots
+     */
+    images: string[];
+    category_id: string;
+    /**
+     * e.g. "Fototapety/Tematyka/Dziecięce/Dla chłopca"
+     */
+    category_name: string;
+}
+/**
+ * Parent (design) of a product. Its sku/ean/description are empty and its price
+ * is "0.00" - use the variants for the real values.
+ */
+interface ProductData {
+    sku: string;
+    ean: string;
+    /**
+     * e.g. "0.00"
+     */
+    price: string;
+    /**
+     * e.g. "1.14"
+     */
+    weight: string;
+    description: string;
+    /**
+     * Category path
+     */
+    description_extra1: string;
+    /**
+     * e.g. "Fototapeta Wikingowie I Smoki"
+     */
+    name: string;
+    quantity: number;
+    /**
+     * e.g. "Doboxa"
+     */
+    man_name: string;
+    features: ProductFeature[];
+    images: string[];
+    category_id: string;
+    category_name: string;
+    /**
+     * Variant product id -> variant
+     */
+    variants: Record<string, ProductVariant>;
+}
+/**
+ * Raw `ProductsData` response; keys are design ids.
+ */
+type ProductsDataResponse = Record<string, ProductData> | [];
+
+/**
+ * Product catalog resource.
+ *
+ * Wraps Doboxa's BaseLinker connector (shop integration file). The connector is
+ * a separate API: it lives on its own URL, takes a form body and reports errors
+ * with HTTP 200, so it is called directly instead of through the generated
+ * API v2 client.
+ */
+declare class CatalogResource {
+    private config;
+    constructor(config: BaseLinkerConnectorConfig);
+    /**
+     * Call a connector action.
+     *
+     * @param action - Connector action, e.g. "ProductsList"
+     * @param params - Additional action parameters
+     * @throws DoboxaConnectorError on HTTP or connector errors
+     */
+    private call;
+    /**
+     * Get the connector platform and version.
+     */
+    fileVersion(): Promise<FileVersionResponse>;
+    /**
+     * Get the list of actions the connector supports.
+     */
+    supportedMethods(): Promise<SupportedMethodsResponse>;
+    /**
+     * Get all product categories as a map of category id to category path.
+     */
+    categories(): Promise<ProductsCategoriesResponse>;
+    /**
+     * List one page of products (designs).
+     *
+     * @param params - Page number and optional category filter
+     */
+    list(params?: ProductsListParams): Promise<ProductsListResult>;
+    /**
+     * Get full product data (images, variants) for the given design ids.
+     *
+     * @param params - Design ids from the product list
+     */
+    data(params: ProductsDataParams): Promise<Record<string, ProductData>>;
+}
+
 interface DoboxaConfig {
     /**
      * API key (access token). If not provided, you must call authentication.login() first.
@@ -2736,6 +2990,13 @@ interface DoboxaConfig {
      * Base URL for the API. Defaults to DOBOXA_API_URL environment variable or http://localhost
      */
     baseURL?: string;
+    /**
+     * Product catalog credentials (Doboxa's BaseLinker connector).
+     * The connector URL and the "Hasło" are shown in the Doboxa panel:
+     * Integracje -> Edycja. When set, `doboxa.catalog` is available.
+     * The catalog does not use the API key, only the connector password.
+     */
+    catalog?: BaseLinkerConnectorConfig;
 }
 /**
  * Main Doboxa client class
@@ -2750,10 +3011,14 @@ declare class Doboxa {
     readonly orderComments: OrderCommentsResource;
     readonly orderStatusChanges: OrderStatusChangesResource;
     readonly users: UsersResource;
+    /**
+     * Product catalog (BaseLinker connector). Available only when `catalog` config is provided.
+     */
+    readonly catalog?: CatalogResource;
     private tokenManager;
     private httpClient;
     private config;
     constructor(config?: DoboxaConfig);
 }
 
-export { instanceOfClient as $, AuthenticationResource as A, type Bool as B, ClientsResource as C, Doboxa as D, ApiV2AuthenticationTokenPost200ResponseFromJSON as E, ApiV2AuthenticationTokenPost200ResponseFromJSONTyped as F, ApiV2AuthenticationTokenPost200ResponseToJSON as G, ApiV2AuthenticationTokenPost200ResponseToJSONTyped as H, InvoicesResource as I, type Attachment as J, instanceOfAttachment as K, type LoginParams as L, AttachmentFromJSON as M, AttachmentFromJSONTyped as N, OrdersResource as O, AttachmentToJSON as P, AttachmentToJSONTyped as Q, type RefreshTokenParams as R, type BillingAddress as S, TrackingNumbersResource as T, UsersResource as U, instanceOfBillingAddress as V, BillingAddressFromJSON as W, BillingAddressFromJSONTyped as X, BillingAddressToJSON as Y, BillingAddressToJSONTyped as Z, type Client as _, type DoboxaConfig as a, OrderFromJSON as a$, ClientFromJSON as a0, ClientFromJSONTyped as a1, ClientToJSON as a2, ClientToJSONTyped as a3, type CreateOrderComment as a4, CreateOrderCommentAuthorTypeEnum as a5, instanceOfCreateOrderComment as a6, CreateOrderCommentFromJSON as a7, CreateOrderCommentFromJSONTyped as a8, CreateOrderCommentToJSON as a9, type InvoiceItem as aA, instanceOfInvoiceItem as aB, InvoiceItemFromJSON as aC, InvoiceItemFromJSONTyped as aD, InvoiceItemToJSON as aE, InvoiceItemToJSONTyped as aF, type InvoiceOrder as aG, instanceOfInvoiceOrder as aH, InvoiceOrderFromJSON as aI, InvoiceOrderFromJSONTyped as aJ, InvoiceOrderToJSON as aK, InvoiceOrderToJSONTyped as aL, type InvoiceOrderItem as aM, instanceOfInvoiceOrderItem as aN, InvoiceOrderItemFromJSON as aO, InvoiceOrderItemFromJSONTyped as aP, InvoiceOrderItemToJSON as aQ, InvoiceOrderItemToJSONTyped as aR, type Me as aS, instanceOfMe as aT, MeFromJSON as aU, MeFromJSONTyped as aV, MeToJSON as aW, MeToJSONTyped as aX, type Order as aY, OrderPaymentMethodEnum as aZ, instanceOfOrder as a_, CreateOrderCommentToJSONTyped as aa, type DeliveryAddress as ab, instanceOfDeliveryAddress as ac, DeliveryAddressFromJSON as ad, DeliveryAddressFromJSONTyped as ae, DeliveryAddressToJSON as af, DeliveryAddressToJSONTyped as ag, type GetApiV2DiscountCodesExternal200Response as ah, instanceOfGetApiV2DiscountCodesExternal200Response as ai, GetApiV2DiscountCodesExternal200ResponseFromJSON as aj, GetApiV2DiscountCodesExternal200ResponseFromJSONTyped as ak, GetApiV2DiscountCodesExternal200ResponseToJSON as al, GetApiV2DiscountCodesExternal200ResponseToJSONTyped as am, type GetApiV2DiscountCodesExternal200ResponseItemsInner as an, instanceOfGetApiV2DiscountCodesExternal200ResponseItemsInner as ao, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSON as ap, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSONTyped as aq, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSON as ar, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSONTyped as as, type Invoice as at, InvoiceDocumentTypeEnum as au, instanceOfInvoice as av, InvoiceFromJSON as aw, InvoiceFromJSONTyped as ax, InvoiceToJSON as ay, InvoiceToJSONTyped as az, DiscountCodesResource as b, OrderStatusChangeToJSONTyped as b$, OrderFromJSONTyped as b0, OrderToJSON as b1, OrderToJSONTyped as b2, type OrderCancellationResponse as b3, OrderCancellationResponseDetailsEnum as b4, instanceOfOrderCancellationResponse as b5, OrderCancellationResponseFromJSON as b6, OrderCancellationResponseFromJSONTyped as b7, OrderCancellationResponseToJSON as b8, OrderCancellationResponseToJSONTyped as b9, OrderItemOriginalDataToJSONTyped as bA, type OrderItemStatus as bB, OrderItemStatusStatusEnum as bC, instanceOfOrderItemStatus as bD, OrderItemStatusFromJSON as bE, OrderItemStatusFromJSONTyped as bF, OrderItemStatusToJSON as bG, OrderItemStatusToJSONTyped as bH, type OrderOriginalData as bI, instanceOfOrderOriginalData as bJ, OrderOriginalDataFromJSON as bK, OrderOriginalDataFromJSONTyped as bL, OrderOriginalDataToJSON as bM, OrderOriginalDataToJSONTyped as bN, type OrderStatus as bO, OrderStatusStatusEnum as bP, instanceOfOrderStatus as bQ, OrderStatusFromJSON as bR, OrderStatusFromJSONTyped as bS, OrderStatusToJSON as bT, OrderStatusToJSONTyped as bU, type OrderStatusChange as bV, OrderStatusChangeStatusEnum as bW, instanceOfOrderStatusChange as bX, OrderStatusChangeFromJSON as bY, OrderStatusChangeFromJSONTyped as bZ, OrderStatusChangeToJSON as b_, type OrderComment as ba, OrderCommentAuthorTypeEnum as bb, instanceOfOrderComment as bc, OrderCommentFromJSON as bd, OrderCommentFromJSONTyped as be, OrderCommentToJSON as bf, OrderCommentToJSONTyped as bg, type OrderItem as bh, instanceOfOrderItem as bi, OrderItemFromJSON as bj, OrderItemFromJSONTyped as bk, OrderItemToJSON as bl, OrderItemToJSONTyped as bm, type OrderItemCropData as bn, OrderItemCropDataFilterEnum as bo, OrderItemCropDataReflectionEnum as bp, instanceOfOrderItemCropData as bq, OrderItemCropDataFromJSON as br, OrderItemCropDataFromJSONTyped as bs, OrderItemCropDataToJSON as bt, OrderItemCropDataToJSONTyped as bu, type OrderItemOriginalData as bv, instanceOfOrderItemOriginalData as bw, OrderItemOriginalDataFromJSON as bx, OrderItemOriginalDataFromJSONTyped as by, OrderItemOriginalDataToJSON as bz, OrderCommentsResource as c, instanceOfReturnLabel as c$, type PageOfClients as c0, instanceOfPageOfClients as c1, PageOfClientsFromJSON as c2, PageOfClientsFromJSONTyped as c3, PageOfClientsToJSON as c4, PageOfClientsToJSONTyped as c5, type PageOfInvoices as c6, instanceOfPageOfInvoices as c7, PageOfInvoicesFromJSON as c8, PageOfInvoicesFromJSONTyped as c9, type PostOrderResponse as cA, instanceOfPostOrderResponse as cB, PostOrderResponseFromJSON as cC, PostOrderResponseFromJSONTyped as cD, PostOrderResponseToJSON as cE, PostOrderResponseToJSONTyped as cF, type PostOrderStatus as cG, PostOrderStatusStatusEnum as cH, instanceOfPostOrderStatus as cI, PostOrderStatusFromJSON as cJ, PostOrderStatusFromJSONTyped as cK, PostOrderStatusToJSON as cL, PostOrderStatusToJSONTyped as cM, type PostOrderStatusItem as cN, PostOrderStatusItemStatusEnum as cO, instanceOfPostOrderStatusItem as cP, PostOrderStatusItemFromJSON as cQ, PostOrderStatusItemFromJSONTyped as cR, PostOrderStatusItemToJSON as cS, PostOrderStatusItemToJSONTyped as cT, type PostOrderStatusResponse as cU, instanceOfPostOrderStatusResponse as cV, PostOrderStatusResponseFromJSON as cW, PostOrderStatusResponseFromJSONTyped as cX, PostOrderStatusResponseToJSON as cY, PostOrderStatusResponseToJSONTyped as cZ, type ReturnLabel as c_, PageOfInvoicesToJSON as ca, PageOfInvoicesToJSONTyped as cb, type PageOfOrderComments as cc, instanceOfPageOfOrderComments as cd, PageOfOrderCommentsFromJSON as ce, PageOfOrderCommentsFromJSONTyped as cf, PageOfOrderCommentsToJSON as cg, PageOfOrderCommentsToJSONTyped as ch, type PageOfOrderStatusChanges as ci, instanceOfPageOfOrderStatusChanges as cj, PageOfOrderStatusChangesFromJSON as ck, PageOfOrderStatusChangesFromJSONTyped as cl, PageOfOrderStatusChangesToJSON as cm, PageOfOrderStatusChangesToJSONTyped as cn, type PageOfTrackingNumbers as co, instanceOfPageOfTrackingNumbers as cp, PageOfTrackingNumbersFromJSON as cq, PageOfTrackingNumbersFromJSONTyped as cr, PageOfTrackingNumbersToJSON as cs, PageOfTrackingNumbersToJSONTyped as ct, type PostOrderCommentResponse as cu, instanceOfPostOrderCommentResponse as cv, PostOrderCommentResponseFromJSON as cw, PostOrderCommentResponseFromJSONTyped as cx, PostOrderCommentResponseToJSON as cy, PostOrderCommentResponseToJSONTyped as cz, OrderStatusChangesResource as d, ReturnLabelFromJSON as d0, ReturnLabelFromJSONTyped as d1, ReturnLabelToJSON as d2, ReturnLabelToJSONTyped as d3, type TrackingNumber as d4, instanceOfTrackingNumber as d5, TrackingNumberFromJSON as d6, TrackingNumberFromJSONTyped as d7, TrackingNumberToJSON as d8, TrackingNumberToJSONTyped as d9, type TrackingNumberItem as da, instanceOfTrackingNumberItem as db, TrackingNumberItemFromJSON as dc, TrackingNumberItemFromJSONTyped as dd, TrackingNumberItemToJSON as de, TrackingNumberItemToJSONTyped as df, type Waybill as dg, WaybillDeliveryMethodEnum as dh, instanceOfWaybill as di, WaybillFromJSON as dj, WaybillFromJSONTyped as dk, WaybillToJSON as dl, WaybillToJSONTyped as dm, type OrderCreateParams as e, type OrderStatusUpdateParams as f, type OrderCommentCreateParams as g, type OrderCancelParams as h, type InvoiceListParams as i, type ClientListParams as j, type DiscountCodeListParams as k, type TrackingNumberListParams as l, type OrderCommentListParams as m, type OrderStatusChangeListParams as n, BoolFromJSON as o, BoolFromJSONTyped as p, BoolToJSON as q, BoolToJSONTyped as r, type ApiV2AuthenticationRefreshTokenPost200Response as s, instanceOfApiV2AuthenticationRefreshTokenPost200Response as t, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSON as u, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSONTyped as v, ApiV2AuthenticationRefreshTokenPost200ResponseToJSON as w, ApiV2AuthenticationRefreshTokenPost200ResponseToJSONTyped as x, type ApiV2AuthenticationTokenPost200Response as y, instanceOfApiV2AuthenticationTokenPost200Response as z };
+export { ClientToJSONTyped as $, AuthenticationResource as A, ApiV2AuthenticationTokenPost200ResponseToJSONTyped as B, ClientsResource as C, Doboxa as D, type Attachment as E, instanceOfAttachment as F, AttachmentFromJSON as G, AttachmentFromJSONTyped as H, InvoicesResource as I, AttachmentToJSON as J, AttachmentToJSONTyped as K, type LoginParams as L, type BillingAddress as M, instanceOfBillingAddress as N, OrdersResource as O, BillingAddressFromJSON as P, BillingAddressFromJSONTyped as Q, type RefreshTokenParams as R, BillingAddressToJSON as S, TrackingNumbersResource as T, UsersResource as U, BillingAddressToJSONTyped as V, type Client as W, instanceOfClient as X, ClientFromJSON as Y, ClientFromJSONTyped as Z, ClientToJSON as _, type DoboxaConfig as a, type OrderCancellationResponse as a$, type CreateOrderComment as a0, CreateOrderCommentAuthorTypeEnum as a1, instanceOfCreateOrderComment as a2, CreateOrderCommentFromJSON as a3, CreateOrderCommentFromJSONTyped as a4, CreateOrderCommentToJSON as a5, CreateOrderCommentToJSONTyped as a6, type DeliveryAddress as a7, instanceOfDeliveryAddress as a8, DeliveryAddressFromJSON as a9, InvoiceItemToJSON as aA, InvoiceItemToJSONTyped as aB, type InvoiceOrder as aC, instanceOfInvoiceOrder as aD, InvoiceOrderFromJSON as aE, InvoiceOrderFromJSONTyped as aF, InvoiceOrderToJSON as aG, InvoiceOrderToJSONTyped as aH, type InvoiceOrderItem as aI, instanceOfInvoiceOrderItem as aJ, InvoiceOrderItemFromJSON as aK, InvoiceOrderItemFromJSONTyped as aL, InvoiceOrderItemToJSON as aM, InvoiceOrderItemToJSONTyped as aN, type Me as aO, instanceOfMe as aP, MeFromJSON as aQ, MeFromJSONTyped as aR, MeToJSON as aS, MeToJSONTyped as aT, type Order as aU, OrderPaymentMethodEnum as aV, instanceOfOrder as aW, OrderFromJSON as aX, OrderFromJSONTyped as aY, OrderToJSON as aZ, OrderToJSONTyped as a_, DeliveryAddressFromJSONTyped as aa, DeliveryAddressToJSON as ab, DeliveryAddressToJSONTyped as ac, type GetApiV2DiscountCodesExternal200Response as ad, instanceOfGetApiV2DiscountCodesExternal200Response as ae, GetApiV2DiscountCodesExternal200ResponseFromJSON as af, GetApiV2DiscountCodesExternal200ResponseFromJSONTyped as ag, GetApiV2DiscountCodesExternal200ResponseToJSON as ah, GetApiV2DiscountCodesExternal200ResponseToJSONTyped as ai, type GetApiV2DiscountCodesExternal200ResponseItemsInner as aj, instanceOfGetApiV2DiscountCodesExternal200ResponseItemsInner as ak, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSON as al, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSONTyped as am, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSON as an, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSONTyped as ao, type Invoice as ap, InvoiceDocumentTypeEnum as aq, instanceOfInvoice as ar, InvoiceFromJSON as as, InvoiceFromJSONTyped as at, InvoiceToJSON as au, InvoiceToJSONTyped as av, type InvoiceItem as aw, instanceOfInvoiceItem as ax, InvoiceItemFromJSON as ay, InvoiceItemFromJSONTyped as az, DiscountCodesResource as b, PageOfClientsFromJSONTyped as b$, OrderCancellationResponseDetailsEnum as b0, instanceOfOrderCancellationResponse as b1, OrderCancellationResponseFromJSON as b2, OrderCancellationResponseFromJSONTyped as b3, OrderCancellationResponseToJSON as b4, OrderCancellationResponseToJSONTyped as b5, type OrderComment as b6, OrderCommentAuthorTypeEnum as b7, instanceOfOrderComment as b8, OrderCommentFromJSON as b9, OrderItemStatusFromJSON as bA, OrderItemStatusFromJSONTyped as bB, OrderItemStatusToJSON as bC, OrderItemStatusToJSONTyped as bD, type OrderOriginalData as bE, instanceOfOrderOriginalData as bF, OrderOriginalDataFromJSON as bG, OrderOriginalDataFromJSONTyped as bH, OrderOriginalDataToJSON as bI, OrderOriginalDataToJSONTyped as bJ, type OrderStatus as bK, OrderStatusStatusEnum as bL, instanceOfOrderStatus as bM, OrderStatusFromJSON as bN, OrderStatusFromJSONTyped as bO, OrderStatusToJSON as bP, OrderStatusToJSONTyped as bQ, type OrderStatusChange as bR, OrderStatusChangeStatusEnum as bS, instanceOfOrderStatusChange as bT, OrderStatusChangeFromJSON as bU, OrderStatusChangeFromJSONTyped as bV, OrderStatusChangeToJSON as bW, OrderStatusChangeToJSONTyped as bX, type PageOfClients as bY, instanceOfPageOfClients as bZ, PageOfClientsFromJSON as b_, OrderCommentFromJSONTyped as ba, OrderCommentToJSON as bb, OrderCommentToJSONTyped as bc, type OrderItem as bd, instanceOfOrderItem as be, OrderItemFromJSON as bf, OrderItemFromJSONTyped as bg, OrderItemToJSON as bh, OrderItemToJSONTyped as bi, type OrderItemCropData as bj, OrderItemCropDataFilterEnum as bk, OrderItemCropDataReflectionEnum as bl, instanceOfOrderItemCropData as bm, OrderItemCropDataFromJSON as bn, OrderItemCropDataFromJSONTyped as bo, OrderItemCropDataToJSON as bp, OrderItemCropDataToJSONTyped as bq, type OrderItemOriginalData as br, instanceOfOrderItemOriginalData as bs, OrderItemOriginalDataFromJSON as bt, OrderItemOriginalDataFromJSONTyped as bu, OrderItemOriginalDataToJSON as bv, OrderItemOriginalDataToJSONTyped as bw, type OrderItemStatus as bx, OrderItemStatusStatusEnum as by, instanceOfOrderItemStatus as bz, OrderCommentsResource as c, ReturnLabelToJSONTyped as c$, PageOfClientsToJSON as c0, PageOfClientsToJSONTyped as c1, type PageOfInvoices as c2, instanceOfPageOfInvoices as c3, PageOfInvoicesFromJSON as c4, PageOfInvoicesFromJSONTyped as c5, PageOfInvoicesToJSON as c6, PageOfInvoicesToJSONTyped as c7, type PageOfOrderComments as c8, instanceOfPageOfOrderComments as c9, PostOrderResponseToJSON as cA, PostOrderResponseToJSONTyped as cB, type PostOrderStatus as cC, PostOrderStatusStatusEnum as cD, instanceOfPostOrderStatus as cE, PostOrderStatusFromJSON as cF, PostOrderStatusFromJSONTyped as cG, PostOrderStatusToJSON as cH, PostOrderStatusToJSONTyped as cI, type PostOrderStatusItem as cJ, PostOrderStatusItemStatusEnum as cK, instanceOfPostOrderStatusItem as cL, PostOrderStatusItemFromJSON as cM, PostOrderStatusItemFromJSONTyped as cN, PostOrderStatusItemToJSON as cO, PostOrderStatusItemToJSONTyped as cP, type PostOrderStatusResponse as cQ, instanceOfPostOrderStatusResponse as cR, PostOrderStatusResponseFromJSON as cS, PostOrderStatusResponseFromJSONTyped as cT, PostOrderStatusResponseToJSON as cU, PostOrderStatusResponseToJSONTyped as cV, type ReturnLabel as cW, instanceOfReturnLabel as cX, ReturnLabelFromJSON as cY, ReturnLabelFromJSONTyped as cZ, ReturnLabelToJSON as c_, PageOfOrderCommentsFromJSON as ca, PageOfOrderCommentsFromJSONTyped as cb, PageOfOrderCommentsToJSON as cc, PageOfOrderCommentsToJSONTyped as cd, type PageOfOrderStatusChanges as ce, instanceOfPageOfOrderStatusChanges as cf, PageOfOrderStatusChangesFromJSON as cg, PageOfOrderStatusChangesFromJSONTyped as ch, PageOfOrderStatusChangesToJSON as ci, PageOfOrderStatusChangesToJSONTyped as cj, type PageOfTrackingNumbers as ck, instanceOfPageOfTrackingNumbers as cl, PageOfTrackingNumbersFromJSON as cm, PageOfTrackingNumbersFromJSONTyped as cn, PageOfTrackingNumbersToJSON as co, PageOfTrackingNumbersToJSONTyped as cp, type PostOrderCommentResponse as cq, instanceOfPostOrderCommentResponse as cr, PostOrderCommentResponseFromJSON as cs, PostOrderCommentResponseFromJSONTyped as ct, PostOrderCommentResponseToJSON as cu, PostOrderCommentResponseToJSONTyped as cv, type PostOrderResponse as cw, instanceOfPostOrderResponse as cx, PostOrderResponseFromJSON as cy, PostOrderResponseFromJSONTyped as cz, OrderStatusChangesResource as d, type TrackingNumber as d0, instanceOfTrackingNumber as d1, TrackingNumberFromJSON as d2, TrackingNumberFromJSONTyped as d3, TrackingNumberToJSON as d4, TrackingNumberToJSONTyped as d5, type TrackingNumberItem as d6, instanceOfTrackingNumberItem as d7, TrackingNumberItemFromJSON as d8, TrackingNumberItemFromJSONTyped as d9, type ProductsDataResponse as dA, TrackingNumberItemToJSON as da, TrackingNumberItemToJSONTyped as db, type Waybill as dc, WaybillDeliveryMethodEnum as dd, instanceOfWaybill as de, WaybillFromJSON as df, WaybillFromJSONTyped as dg, WaybillToJSON as dh, WaybillToJSONTyped as di, type BaseLinkerAction as dj, type BaseLinkerConnectorConfig as dk, type ProductsListParams as dl, type ProductsDataParams as dm, type BaseLinkerError as dn, type FileVersionResponse as dp, type SupportedMethodsResponse as dq, type ProductsCategoriesResponse as dr, type ProductsListItem as ds, type ProductsListEntry as dt, type ProductsListResult as du, type ProductsListResponse as dv, type ProductFeature as dw, type ProductFeatureName as dx, type ProductVariant as dy, type ProductData as dz, CatalogResource as e, type OrderCreateParams as f, type OrderStatusUpdateParams as g, type OrderCommentCreateParams as h, type OrderCancelParams as i, type InvoiceListParams as j, type ClientListParams as k, type DiscountCodeListParams as l, type TrackingNumberListParams as m, type OrderCommentListParams as n, type OrderStatusChangeListParams as o, type ApiV2AuthenticationRefreshTokenPost200Response as p, instanceOfApiV2AuthenticationRefreshTokenPost200Response as q, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSON as r, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSONTyped as s, ApiV2AuthenticationRefreshTokenPost200ResponseToJSON as t, ApiV2AuthenticationRefreshTokenPost200ResponseToJSONTyped as u, type ApiV2AuthenticationTokenPost200Response as v, instanceOfApiV2AuthenticationTokenPost200Response as w, ApiV2AuthenticationTokenPost200ResponseFromJSON as x, ApiV2AuthenticationTokenPost200ResponseFromJSONTyped as y, ApiV2AuthenticationTokenPost200ResponseToJSON as z };

package/dist/client.d.mts

@@ -1 +1 @@
-export { D as Doboxa, a as DoboxaConfig } from './client-BfIS6ja2.mjs';
+export { D as Doboxa, a as DoboxaConfig } from './client-BrWpdgrN.mjs';

package/dist/client.d.ts

@@ -1 +1 @@
-export { D as Doboxa, a as DoboxaConfig } from './client-BfIS6ja2.js';
+export { D as Doboxa, a as DoboxaConfig } from './client-BrWpdgrN.js';

package/dist/client.js

@@ -344,6 +344,15 @@ var DoboxaAuthenticationError = class _DoboxaAuthenticationError extends DoboxaE
     Object.setPrototypeOf(this, _DoboxaAuthenticationError.prototype);
   }
 };
+var DoboxaConnectorError = class _DoboxaConnectorError extends DoboxaError {
+  constructor(errorCode, errorText, message) {
+    super(message || errorText || `BaseLinker connector error: ${errorCode}`);
+    this.name = "DoboxaConnectorError";
+    this.errorCode = errorCode;
+    this.errorText = errorText;
+    Object.setPrototypeOf(this, _DoboxaConnectorError.prototype);
+  }
+};
 function parseErrorResponse(statusCode, body) {
   if (typeof body === "object" && body !== null) {
     if ("invalid_parameters" in body || "error_message" in body) {
@@ -579,11 +588,6 @@ var AuthenticationResource = class {
   }
 };
 
-// src/types/generated/src/models/Bool.ts
-function BoolFromJSON(json) {
-  return json;
-}
-
 // src/types/generated/src/models/Attachment.ts
 function AttachmentToJSON(json) {
   return AttachmentToJSONTyped(json, false);
@@ -891,7 +895,7 @@ function OrderCancellationResponseFromJSONTyped(json, ignoreDiscriminator) {
     return json;
   }
   return {
-    "cancelled": json["cancelled"] == null ? void 0 : BoolFromJSON(json["cancelled"]),
+    "cancelled": json["cancelled"] == null ? void 0 : json["cancelled"],
     "details": json["details"] == null ? void 0 : json["details"]
   };
 }
@@ -1991,6 +1995,118 @@ var UsersResource = class {
   }
 };
 
+// src/resources/catalog.ts
+var CatalogResource = class {
+  constructor(config) {
+    this.config = config;
+  }
+  /**
+   * Call a connector action.
+   *
+   * @param action - Connector action, e.g. "ProductsList"
+   * @param params - Additional action parameters
+   * @throws DoboxaConnectorError on HTTP or connector errors
+   */
+  call(_0) {
+    return __async(this, arguments, function* (action, params = {}) {
+      const response = yield fetch(this.config.url, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded"
+        },
+        body: new URLSearchParams(__spreadValues({
+          bl_pass: this.config.password,
+          action
+        }, params))
+      });
+      if (!response.ok) {
+        throw new DoboxaConnectorError(
+          `http_${response.status}`,
+          response.statusText || "Unexpected HTTP status",
+          `BaseLinker connector request failed with HTTP ${response.status}`
+        );
+      }
+      let payload;
+      try {
+        payload = yield response.json();
+      } catch (e) {
+        throw new DoboxaConnectorError(
+          "invalid_response",
+          "Connector response is not valid JSON",
+          "BaseLinker connector returned a non-JSON response"
+        );
+      }
+      if (payload !== null && typeof payload === "object" && !Array.isArray(payload) && payload.error === true) {
+        const error = payload;
+        throw new DoboxaConnectorError(error.error_code, error.error_text);
+      }
+      return payload;
+    });
+  }
+  /**
+   * Get the connector platform and version.
+   */
+  fileVersion() {
+    return __async(this, null, function* () {
+      return this.call("FileVersion");
+    });
+  }
+  /**
+   * Get the list of actions the connector supports.
+   */
+  supportedMethods() {
+    return __async(this, null, function* () {
+      return this.call("SupportedMethods");
+    });
+  }
+  /**
+   * Get all product categories as a map of category id to category path.
+   */
+  categories() {
+    return __async(this, null, function* () {
+      return this.call("ProductsCategories");
+    });
+  }
+  /**
+   * List one page of products (designs).
+   *
+   * @param params - Page number and optional category filter
+   */
+  list() {
+    return __async(this, arguments, function* (params = {}) {
+      var _a;
+      const response = yield this.call("ProductsList", __spreadValues({
+        page: String((_a = params.page) != null ? _a : 1)
+      }, params.category_id !== void 0 ? { category_id: params.category_id } : {}));
+      const items = [];
+      for (const id of Object.keys(response)) {
+        if (id === "pages") {
+          continue;
+        }
+        const value = response[id];
+        if (typeof value !== "object" || value === null) {
+          continue;
+        }
+        items.push(__spreadValues({ id }, value));
+      }
+      return { pages: response.pages, items };
+    });
+  }
+  /**
+   * Get full product data (images, variants) for the given design ids.
+   *
+   * @param params - Design ids from the product list
+   */
+  data(params) {
+    return __async(this, null, function* () {
+      const response = yield this.call("ProductsData", {
+        products_id: params.products_id.join(",")
+      });
+      return Array.isArray(response) ? {} : response;
+    });
+  }
+};
+
 // src/client.ts
 var Doboxa = class {
   constructor(config = {}) {
@@ -2057,6 +2173,9 @@ var Doboxa = class {
       this.config
     );
     this.users = new UsersResource(this.httpClient, this.config);
+    if (config.catalog) {
+      this.catalog = new CatalogResource(config.catalog);
+    }
   }
 };
 // Annotate the CommonJS export names for ESM import in node: