@revenexx/sdk 0.0.4 → 0.0.5

package/types/services/carts.d.ts

@@ -1,5 +1,11 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { CartIoDirection } from '../enums/cart-io-direction';
+import { CartIoApplyMode } from '../enums/cart-io-apply-mode';
+import { CartIoEntity } from '../enums/cart-io-entity';
+import { CartIoFormat } from '../enums/cart-io-format';
+import { CartItemType } from '../enums/cart-item-type';
+import { CartExportFormat } from '../enums/cart-export-format';
 export declare class Carts {
     client: Client;
     constructor(client: Client);
@@ -11,22 +17,100 @@ export declare class Carts {
     cartsList(): Promise<{}>;
     /**
      *
+     * @param {string} params.channelId -
+     * @param {string} params.contactId - Owning customer contact.
+     * @param {string} params.currency - ISO 4217 code (default EUR).
+     * @param {boolean} params.isCurrent - Make this THE current cart of its owner.
+     * @param {string} params.marketId -
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name - Display name (default 'Cart').
+     * @param {string} params.sessionKey - Owning guest session.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Cart>}
      */
-    cartsCreate(): Promise<Models.Cart>;
+    cartsCreate(params?: {
+        channelId?: string;
+        contactId?: string;
+        currency?: string;
+        isCurrent?: boolean;
+        marketId?: string;
+        metadata?: object;
+        name?: string;
+        sessionKey?: string;
+    }): Promise<Models.Cart>;
+    /**
+     *
+     * @param {string} channelId -
+     * @param {string} contactId - Owning customer contact.
+     * @param {string} currency - ISO 4217 code (default EUR).
+     * @param {boolean} isCurrent - Make this THE current cart of its owner.
+     * @param {string} marketId -
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name - Display name (default 'Cart').
+     * @param {string} sessionKey - Owning guest session.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Cart>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    cartsCreate(channelId?: string, contactId?: string, currency?: string, isCurrent?: boolean, marketId?: string, metadata?: object, name?: string, sessionKey?: string): Promise<Models.Cart>;
+    /**
+     *
+     * @param {string} params.contactId - Contact taking ownership.
+     * @param {string} params.sessionKey - Guest session whose active carts are handed over.
+     * @param {string} params.targetCartId - Merge the session carts into this cart instead of adopting them.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    cartsClaim(params: {
+        contactId: string;
+        sessionKey: string;
+        targetCartId?: string;
+    }): Promise<{}>;
     /**
      *
+     * @param {string} contactId - Contact taking ownership.
+     * @param {string} sessionKey - Guest session whose active carts are handed over.
+     * @param {string} targetCartId - Merge the session carts into this cart instead of adopting them.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsClaim(): Promise<{}>;
+    cartsClaim(contactId: string, sessionKey: string, targetCartId?: string): Promise<{}>;
     /**
      *
+     * @param {string} params.contactId - Owner of a newly created cart.
+     * @param {string} params.csv - Raw CSV content (alternative to payload for csv profiles).
+     * @param {string} params.name - Name for a newly created cart.
+     * @param {object} params.payload - The import payload: '{cart, items}' object, or a raw JSON/CSV string in the profile's format.
+     * @param {string} params.profileId - Import profile to run; ad-hoc import when omitted.
+     * @param {string} params.sessionKey - Guest owner of a newly created cart.
+     * @param {string} params.targetCartId - Existing active cart to import into.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    cartsImport(): Promise<{}>;
+    cartsImport(params?: {
+        contactId?: string;
+        csv?: string;
+        name?: string;
+        payload?: object;
+        profileId?: string;
+        sessionKey?: string;
+        targetCartId?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} contactId - Owner of a newly created cart.
+     * @param {string} csv - Raw CSV content (alternative to payload for csv profiles).
+     * @param {string} name - Name for a newly created cart.
+     * @param {object} payload - The import payload: '{cart, items}' object, or a raw JSON/CSV string in the profile's format.
+     * @param {string} profileId - Import profile to run; ad-hoc import when omitted.
+     * @param {string} sessionKey - Guest owner of a newly created cart.
+     * @param {string} targetCartId - Existing active cart to import into.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    cartsImport(contactId?: string, csv?: string, name?: string, payload?: object, profileId?: string, sessionKey?: string, targetCartId?: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}
@@ -35,10 +119,42 @@ export declare class Carts {
     cartsIoProfilesList(): Promise<{}>;
     /**
      *
+     * @param {CartIoDirection} params.direction -
+     * @param {string} params.name -
+     * @param {CartIoApplyMode} params.applyMode - Default 'insert'.
+     * @param {CartIoEntity} params.entity - Default 'carts'.
+     * @param {CartIoFormat} params.format - Default 'json'.
+     * @param {boolean} params.isTemplate -
+     * @param {object} params.mapping - Column mapping (Baseline-IO-compatible).
+     * @param {object} params.options -
      * @throws {RevenexxException}
      * @returns {Promise<Models.IoProfile>}
      */
-    cartsIoProfilesCreate(): Promise<Models.IoProfile>;
+    cartsIoProfilesCreate(params: {
+        direction: CartIoDirection;
+        name: string;
+        applyMode?: CartIoApplyMode;
+        entity?: CartIoEntity;
+        format?: CartIoFormat;
+        isTemplate?: boolean;
+        mapping?: object;
+        options?: object;
+    }): Promise<Models.IoProfile>;
+    /**
+     *
+     * @param {CartIoDirection} direction -
+     * @param {string} name -
+     * @param {CartIoApplyMode} applyMode - Default 'insert'.
+     * @param {CartIoEntity} entity - Default 'carts'.
+     * @param {CartIoFormat} format - Default 'json'.
+     * @param {boolean} isTemplate -
+     * @param {object} mapping - Column mapping (Baseline-IO-compatible).
+     * @param {object} options -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.IoProfile>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    cartsIoProfilesCreate(direction: CartIoDirection, name: string, applyMode?: CartIoApplyMode, entity?: CartIoEntity, format?: CartIoFormat, isTemplate?: boolean, mapping?: object, options?: object): Promise<Models.IoProfile>;
     /**
      *
      * @throws {RevenexxException}
@@ -82,26 +198,64 @@ export declare class Carts {
     /**
      *
      * @param {string} params.id -
+     * @param {CartIoApplyMode} params.applyMode - Default 'insert'.
+     * @param {CartIoDirection} params.direction -
+     * @param {CartIoEntity} params.entity - Default 'carts'.
+     * @param {CartIoFormat} params.format - Default 'json'.
+     * @param {boolean} params.isTemplate -
+     * @param {object} params.mapping - Column mapping (Baseline-IO-compatible).
+     * @param {string} params.name -
+     * @param {object} params.options -
      * @throws {RevenexxException}
      * @returns {Promise<Models.IoProfile>}
      */
     cartsIoProfilesUpdate(params: {
         id: string;
+        applyMode?: CartIoApplyMode;
+        direction?: CartIoDirection;
+        entity?: CartIoEntity;
+        format?: CartIoFormat;
+        isTemplate?: boolean;
+        mapping?: object;
+        name?: string;
+        options?: object;
     }): Promise<Models.IoProfile>;
     /**
      *
      * @param {string} id -
+     * @param {CartIoApplyMode} applyMode - Default 'insert'.
+     * @param {CartIoDirection} direction -
+     * @param {CartIoEntity} entity - Default 'carts'.
+     * @param {CartIoFormat} format - Default 'json'.
+     * @param {boolean} isTemplate -
+     * @param {object} mapping - Column mapping (Baseline-IO-compatible).
+     * @param {string} name -
+     * @param {object} options -
      * @throws {RevenexxException}
      * @returns {Promise<Models.IoProfile>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsIoProfilesUpdate(id: string): Promise<Models.IoProfile>;
+    cartsIoProfilesUpdate(id: string, applyMode?: CartIoApplyMode, direction?: CartIoDirection, entity?: CartIoEntity, format?: CartIoFormat, isTemplate?: boolean, mapping?: object, name?: string, options?: object): Promise<Models.IoProfile>;
+    /**
+     *
+     * @param {string} params.sourceCartId - Cart whose lines move into the target (becomes status merged).
+     * @param {string} params.targetCartId - Receiving cart (must be active).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    cartsMerge(params: {
+        sourceCartId: string;
+        targetCartId: string;
+    }): Promise<{}>;
     /**
      *
+     * @param {string} sourceCartId - Cart whose lines move into the target (becomes status merged).
+     * @param {string} targetCartId - Receiving cart (must be active).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsMerge(): Promise<{}>;
+    cartsMerge(sourceCartId: string, targetCartId: string): Promise<{}>;
     /**
      *
      * @param {string} params.cartId -
@@ -122,37 +276,79 @@ export declare class Carts {
     /**
      *
      * @param {string} params.cartId -
+     * @param {object} params.configuration - Free-form configuration — configured lines never merge.
+     * @param {string} params.currency - Defaults to the cart's currency.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name - Falls back to 'sku' when omitted.
+     * @param {number} params.position -
+     * @param {string} params.productId -
+     * @param {number} params.quantity - Default 1.
+     * @param {string} params.sku -
+     * @param {object} params.snapshot - Loose product snapshot at add-time (price, name, image, …).
+     * @param {number} params.taxRate -
+     * @param {CartItemType} params.type - Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
+     * @param {string} params.unit -
+     * @param {number} params.unitPrice - Per-unit net price — line_total is always derived.
      * @throws {RevenexxException}
      * @returns {Promise<Models.CartItem>}
      */
     cartsItemsCreate(params: {
         cartId: string;
+        configuration?: object;
+        currency?: string;
+        metadata?: object;
+        name?: string;
+        position?: number;
+        productId?: string;
+        quantity?: number;
+        sku?: string;
+        snapshot?: object;
+        taxRate?: number;
+        type?: CartItemType;
+        unit?: string;
+        unitPrice?: number;
     }): Promise<Models.CartItem>;
     /**
      *
      * @param {string} cartId -
+     * @param {object} configuration - Free-form configuration — configured lines never merge.
+     * @param {string} currency - Defaults to the cart's currency.
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name - Falls back to 'sku' when omitted.
+     * @param {number} position -
+     * @param {string} productId -
+     * @param {number} quantity - Default 1.
+     * @param {string} sku -
+     * @param {object} snapshot - Loose product snapshot at add-time (price, name, image, …).
+     * @param {number} taxRate -
+     * @param {CartItemType} type - Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
+     * @param {string} unit -
+     * @param {number} unitPrice - Per-unit net price — line_total is always derived.
      * @throws {RevenexxException}
      * @returns {Promise<Models.CartItem>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsItemsCreate(cartId: string): Promise<Models.CartItem>;
+    cartsItemsCreate(cartId: string, configuration?: object, currency?: string, metadata?: object, name?: string, position?: number, productId?: string, quantity?: number, sku?: string, snapshot?: object, taxRate?: number, type?: CartItemType, unit?: string, unitPrice?: number): Promise<Models.CartItem>;
     /**
      *
      * @param {string} params.cartId -
+     * @param {Models.CartItemCreateRequest[]} params.items - The complete new item set (set semantics).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     cartsItemsReplace(params: {
         cartId: string;
+        items: Models.CartItemCreateRequest[];
     }): Promise<{}>;
     /**
      *
      * @param {string} cartId -
+     * @param {Models.CartItemCreateRequest[]} items - The complete new item set (set semantics).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsItemsReplace(cartId: string): Promise<{}>;
+    cartsItemsReplace(cartId: string, items: Models.CartItemCreateRequest[]): Promise<{}>;
     /**
      *
      * @param {string} params.cartId -
@@ -197,22 +393,61 @@ export declare class Carts {
      *
      * @param {string} params.cartId -
      * @param {string} params.id -
+     * @param {object} params.configuration - Free-form configuration — configured lines never merge.
+     * @param {string} params.currency - Defaults to the cart's currency.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name - Falls back to 'sku' when omitted.
+     * @param {number} params.position -
+     * @param {string} params.productId -
+     * @param {number} params.quantity - Default 1.
+     * @param {string} params.sku -
+     * @param {object} params.snapshot - Loose product snapshot at add-time (price, name, image, …).
+     * @param {number} params.taxRate -
+     * @param {CartItemType} params.type - Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
+     * @param {string} params.unit -
+     * @param {number} params.unitPrice - Per-unit net price — line_total is always derived.
      * @throws {RevenexxException}
      * @returns {Promise<Models.CartItem>}
      */
     cartsItemsUpdate(params: {
         cartId: string;
         id: string;
+        configuration?: object;
+        currency?: string;
+        metadata?: object;
+        name?: string;
+        position?: number;
+        productId?: string;
+        quantity?: number;
+        sku?: string;
+        snapshot?: object;
+        taxRate?: number;
+        type?: CartItemType;
+        unit?: string;
+        unitPrice?: number;
     }): Promise<Models.CartItem>;
     /**
      *
      * @param {string} cartId -
      * @param {string} id -
+     * @param {object} configuration - Free-form configuration — configured lines never merge.
+     * @param {string} currency - Defaults to the cart's currency.
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name - Falls back to 'sku' when omitted.
+     * @param {number} position -
+     * @param {string} productId -
+     * @param {number} quantity - Default 1.
+     * @param {string} sku -
+     * @param {object} snapshot - Loose product snapshot at add-time (price, name, image, …).
+     * @param {number} taxRate -
+     * @param {CartItemType} type - Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
+     * @param {string} unit -
+     * @param {number} unitPrice - Per-unit net price — line_total is always derived.
      * @throws {RevenexxException}
      * @returns {Promise<Models.CartItem>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsItemsUpdate(cartId: string, id: string): Promise<Models.CartItem>;
+    cartsItemsUpdate(cartId: string, id: string, configuration?: object, currency?: string, metadata?: object, name?: string, position?: number, productId?: string, quantity?: number, sku?: string, snapshot?: object, taxRate?: number, type?: CartItemType, unit?: string, unitPrice?: number): Promise<Models.CartItem>;
     /**
      *
      * @param {string} params.id -
@@ -250,20 +485,35 @@ export declare class Carts {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.channelId -
+     * @param {string} params.currency - ISO 4217 code.
+     * @param {string} params.marketId -
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name -
      * @throws {RevenexxException}
      * @returns {Promise<Models.Cart>}
      */
     cartsUpdate(params: {
         id: string;
+        channelId?: string;
+        currency?: string;
+        marketId?: string;
+        metadata?: object;
+        name?: string;
     }): Promise<Models.Cart>;
     /**
      *
      * @param {string} id -
+     * @param {string} channelId -
+     * @param {string} currency - ISO 4217 code.
+     * @param {string} marketId -
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name -
      * @throws {RevenexxException}
      * @returns {Promise<Models.Cart>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsUpdate(id: string): Promise<Models.Cart>;
+    cartsUpdate(id: string, channelId?: string, currency?: string, marketId?: string, metadata?: object, name?: string): Promise<Models.Cart>;
     /**
      *
      * @param {string} params.id -
@@ -301,37 +551,46 @@ export declare class Carts {
     /**
      *
      * @param {string} params.id -
+     * @param {CartExportFormat} params.format - Ad-hoc export format (only without profile_id).
+     * @param {string} params.profileId - Export profile to run; ad-hoc JSON/CSV export when omitted.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
     cartsExport(params: {
         id: string;
+        format?: CartExportFormat;
+        profileId?: string;
     }): Promise<{}>;
     /**
      *
      * @param {string} id -
+     * @param {CartExportFormat} format - Ad-hoc export format (only without profile_id).
+     * @param {string} profileId - Export profile to run; ad-hoc JSON/CSV export when omitted.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsExport(id: string): Promise<{}>;
+    cartsExport(id: string, format?: CartExportFormat, profileId?: string): Promise<{}>;
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.orderRef - External order reference from order management.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Cart>}
      */
     cartsOrder(params: {
         id: string;
+        orderRef?: string;
     }): Promise<Models.Cart>;
     /**
      *
      * @param {string} id -
+     * @param {string} orderRef - External order reference from order management.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Cart>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    cartsOrder(id: string): Promise<Models.Cart>;
+    cartsOrder(id: string, orderRef?: string): Promise<Models.Cart>;
     /**
      *
      * @param {string} params.id -

package/types/services/channels.d.ts

@@ -1,5 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { ChannelStatus } from '../enums/channel-status';
+import { ChannelType } from '../enums/channel-type';
 export declare class Channels {
     client: Client;
     constructor(client: Client);
@@ -11,10 +13,39 @@ export declare class Channels {
     channelsList(): Promise<{}>;
     /**
      *
+     * @param {string} params.code - Stable channel code, unique per tenant (e.g. shop, punchout-acme).
+     * @param {string} params.name - Display name.
+     * @param {boolean} params.isDefault - Mark as the default channel (default false).
+     * @param {object} params.labels - Localized display names keyed by locale.
+     * @param {number} params.position - Sort position (default 0).
+     * @param {ChannelStatus} params.status - Lifecycle status (default 'active').
+     * @param {ChannelType} params.type - Where business happens (default 'storefront').
      * @throws {RevenexxException}
      * @returns {Promise<Models.Channel>}
      */
-    channelsCreate(): Promise<Models.Channel>;
+    channelsCreate(params: {
+        code: string;
+        name: string;
+        isDefault?: boolean;
+        labels?: object;
+        position?: number;
+        status?: ChannelStatus;
+        type?: ChannelType;
+    }): Promise<Models.Channel>;
+    /**
+     *
+     * @param {string} code - Stable channel code, unique per tenant (e.g. shop, punchout-acme).
+     * @param {string} name - Display name.
+     * @param {boolean} isDefault - Mark as the default channel (default false).
+     * @param {object} labels - Localized display names keyed by locale.
+     * @param {number} position - Sort position (default 0).
+     * @param {ChannelStatus} status - Lifecycle status (default 'active').
+     * @param {ChannelType} type - Where business happens (default 'storefront').
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Channel>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    channelsCreate(code: string, name: string, isDefault?: boolean, labels?: object, position?: number, status?: ChannelStatus, type?: ChannelType): Promise<Models.Channel>;
     /**
      *
      * @throws {RevenexxException}
@@ -58,18 +89,39 @@ export declare class Channels {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.code - Stable channel code, unique per tenant (e.g. shop, punchout-acme).
+     * @param {boolean} params.isDefault - Mark as the default channel (default false).
+     * @param {object} params.labels - Localized display names keyed by locale.
+     * @param {string} params.name - Display name.
+     * @param {number} params.position - Sort position (default 0).
+     * @param {ChannelStatus} params.status - Lifecycle status (default 'active').
+     * @param {ChannelType} params.type - Where business happens (default 'storefront').
      * @throws {RevenexxException}
      * @returns {Promise<Models.Channel>}
      */
     channelsUpdate(params: {
         id: string;
+        code?: string;
+        isDefault?: boolean;
+        labels?: object;
+        name?: string;
+        position?: number;
+        status?: ChannelStatus;
+        type?: ChannelType;
     }): Promise<Models.Channel>;
     /**
      *
      * @param {string} id -
+     * @param {string} code - Stable channel code, unique per tenant (e.g. shop, punchout-acme).
+     * @param {boolean} isDefault - Mark as the default channel (default false).
+     * @param {object} labels - Localized display names keyed by locale.
+     * @param {string} name - Display name.
+     * @param {number} position - Sort position (default 0).
+     * @param {ChannelStatus} status - Lifecycle status (default 'active').
+     * @param {ChannelType} type - Where business happens (default 'storefront').
      * @throws {RevenexxException}
      * @returns {Promise<Models.Channel>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    channelsUpdate(id: string): Promise<Models.Channel>;
+    channelsUpdate(id: string, code?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, status?: ChannelStatus, type?: ChannelType): Promise<Models.Channel>;
 }