@revenexx/node 0.0.1 → 0.0.2

package/dist/services/orderlists.d.mts

@@ -0,0 +1,421 @@
+import { Client } from '../client.mjs';
+import { Models } from '../models.mjs';
+import { OrderListKind } from '../enums/order-list-kind.mjs';
+import '../query.mjs';
+import '../enums/address-type.mjs';
+import '../enums/cart-export-format.mjs';
+import '../enums/cart-item-type.mjs';
+import '../enums/channel-status.mjs';
+import '../enums/channel-type.mjs';
+import '../enums/contact-role.mjs';
+import '../enums/contact-status.mjs';
+import '../enums/cart-io-apply-mode.mjs';
+import '../enums/cart-io-direction.mjs';
+import '../enums/cart-io-entity.mjs';
+import '../enums/cart-io-format.mjs';
+import '../enums/location-type.mjs';
+import '../enums/market-status.mjs';
+import '../enums/order-comment-visibility.mjs';
+import '../enums/order-item-type.mjs';
+import '../enums/order-payment-status.mjs';
+import '../enums/organization-status.mjs';
+import '../enums/page-status.mjs';
+import '../enums/payment-fee-type.mjs';
+import '../enums/payment-method-kind.mjs';
+import '../enums/price-entry-type.mjs';
+import '../enums/price-list-status.mjs';
+import '../enums/shipping-method-matrix-basis.mjs';
+import '../enums/shipping-method-pricing-type.mjs';
+import '../enums/store-asset-request-visibility.mjs';
+import '../enums/attribute-boolean-status.mjs';
+import '../enums/attribute-datetime-status.mjs';
+import '../enums/attribute-email-status.mjs';
+import '../enums/attribute-enum-status.mjs';
+import '../enums/attribute-float-status.mjs';
+import '../enums/attribute-integer-status.mjs';
+import '../enums/attribute-ip-status.mjs';
+import '../enums/attribute-line-status.mjs';
+import '../enums/attribute-longtext-status.mjs';
+import '../enums/attribute-mediumtext-status.mjs';
+import '../enums/attribute-point-status.mjs';
+import '../enums/attribute-polygon-status.mjs';
+import '../enums/attribute-relationship-status.mjs';
+import '../enums/attribute-string-status.mjs';
+import '../enums/attribute-text-status.mjs';
+import '../enums/attribute-url-status.mjs';
+import '../enums/attribute-varchar-status.mjs';
+import '../enums/column-boolean-status.mjs';
+import '../enums/column-datetime-status.mjs';
+import '../enums/column-email-status.mjs';
+import '../enums/column-enum-status.mjs';
+import '../enums/column-float-status.mjs';
+import '../enums/column-integer-status.mjs';
+import '../enums/column-ip-status.mjs';
+import '../enums/column-line-status.mjs';
+import '../enums/column-longtext-status.mjs';
+import '../enums/column-mediumtext-status.mjs';
+import '../enums/column-point-status.mjs';
+import '../enums/column-polygon-status.mjs';
+import '../enums/column-relationship-status.mjs';
+import '../enums/column-string-status.mjs';
+import '../enums/column-text-status.mjs';
+import '../enums/column-url-status.mjs';
+import '../enums/column-varchar-status.mjs';
+import '../enums/database-type.mjs';
+import '../enums/deployment-status.mjs';
+import '../enums/execution-status.mjs';
+import '../enums/execution-trigger.mjs';
+import '../enums/health-antivirus-status.mjs';
+import '../enums/health-status-status.mjs';
+import '../enums/index-status.mjs';
+import '../enums/message-status.mjs';
+
+declare class Orderlists {
+    client: Client;
+    constructor(client: Client);
+    /**
+     *
+     * @param {string} params.ownerId - Filter to one owning contact.
+     * @param {string} params.organizationId - Filter to one organization.
+     * @param {string} params.kind - Filter by list kind (shopping | label).
+     * @param {number} params.limit - Page size (default 50, max 200).
+     * @param {number} params.offset - Row offset for pagination (default 0).
+     * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsList(params?: {
+        ownerId?: string;
+        organizationId?: string;
+        kind?: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} ownerId - Filter to one owning contact.
+     * @param {string} organizationId - Filter to one organization.
+     * @param {string} kind - Filter by list kind (shopping | label).
+     * @param {number} limit - Page size (default 50, max 200).
+     * @param {number} offset - Row offset for pagination (default 0).
+     * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsList(ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.name -
+     * @param {string} params.ownerId - Owning contact.
+     * @param {string} params.ownerName - Owner display name (snapshot).
+     * @param {Models.OrderListItemInput[]} params.items - Optional initial positions.
+     * @param {OrderListKind} params.kind - List kind (default 'shopping').
+     * @param {object} params.metadata -
+     * @param {string} params.organizationId - Owning organization (scopes public sharing).
+     * @param {boolean} params.shared - Shared read-only across the organization (default false).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     */
+    orderlistsCreate(params: {
+        name: string;
+        ownerId: string;
+        ownerName: string;
+        items?: Models.OrderListItemInput[];
+        kind?: OrderListKind;
+        metadata?: object;
+        organizationId?: string;
+        shared?: boolean;
+    }): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @param {string} name -
+     * @param {string} ownerId - Owning contact.
+     * @param {string} ownerName - Owner display name (snapshot).
+     * @param {Models.OrderListItemInput[]} items - Optional initial positions.
+     * @param {OrderListKind} kind - List kind (default 'shopping').
+     * @param {object} metadata -
+     * @param {string} organizationId - Owning organization (scopes public sharing).
+     * @param {boolean} shared - Shared read-only across the organization (default false).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsCreate(name: string, ownerId: string, ownerName: string, items?: Models.OrderListItemInput[], kind?: OrderListKind, metadata?: object, organizationId?: string, shared?: boolean): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsDefaults(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     */
+    orderlistsGet(params: {
+        id: string;
+    }): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsGet(id: string): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @param {string} params.id -
+     * @param {OrderListKind} params.kind - List kind (default 'shopping').
+     * @param {object} params.metadata -
+     * @param {string} params.name -
+     * @param {boolean} params.shared -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     */
+    orderlistsUpdate(params: {
+        id: string;
+        kind?: OrderListKind;
+        metadata?: object;
+        name?: string;
+        shared?: boolean;
+    }): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @param {string} id -
+     * @param {OrderListKind} kind - List kind (default 'shopping').
+     * @param {object} metadata -
+     * @param {string} name -
+     * @param {boolean} shared -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListWithItems>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsUpdate(id: string, kind?: OrderListKind, metadata?: object, name?: string, shared?: boolean): Promise<Models.OrderListWithItems>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsItemsList(params: {
+        listId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} listId -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsList(listId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @param {string} params.name - Display name (snapshot).
+     * @param {string} params.categorySlug -
+     * @param {string} params.costCenterId - Cost center reference (free-text).
+     * @param {string} params.customSku - Customer's own article number.
+     * @param {string} params.image -
+     * @param {object} params.metadata -
+     * @param {number} params.position - Sort order (assigned automatically when omitted).
+     * @param {string[]} params.positionTexts - Per-position notes.
+     * @param {number} params.price - Unit price snapshot.
+     * @param {string} params.productId - Catalog product (alternative to sku).
+     * @param {number} params.quantity - Default 1.
+     * @param {string} params.sku - Article SKU (alternative to product_id).
+     * @param {string} params.subcategorySlug -
+     * @param {number} params.taxRate -
+     * @param {string} params.unit -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     */
+    orderlistsItemsCreate(params: {
+        listId: string;
+        name: string;
+        categorySlug?: string;
+        costCenterId?: string;
+        customSku?: string;
+        image?: string;
+        metadata?: object;
+        position?: number;
+        positionTexts?: string[];
+        price?: number;
+        productId?: string;
+        quantity?: number;
+        sku?: string;
+        subcategorySlug?: string;
+        taxRate?: number;
+        unit?: string;
+    }): Promise<Models.OrderListItem>;
+    /**
+     *
+     * @param {string} listId -
+     * @param {string} name - Display name (snapshot).
+     * @param {string} categorySlug -
+     * @param {string} costCenterId - Cost center reference (free-text).
+     * @param {string} customSku - Customer's own article number.
+     * @param {string} image -
+     * @param {object} metadata -
+     * @param {number} position - Sort order (assigned automatically when omitted).
+     * @param {string[]} positionTexts - Per-position notes.
+     * @param {number} price - Unit price snapshot.
+     * @param {string} productId - Catalog product (alternative to sku).
+     * @param {number} quantity - Default 1.
+     * @param {string} sku - Article SKU (alternative to product_id).
+     * @param {string} subcategorySlug -
+     * @param {number} taxRate -
+     * @param {string} unit -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsCreate(listId: string, name: string, categorySlug?: string, costCenterId?: string, customSku?: string, image?: string, metadata?: object, position?: number, positionTexts?: string[], price?: number, productId?: string, quantity?: number, sku?: string, subcategorySlug?: string, taxRate?: number, unit?: string): Promise<Models.OrderListItem>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @param {Models.OrderListItemInput[]} params.items - The new full set of positions.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsItemsReplace(params: {
+        listId: string;
+        items: Models.OrderListItemInput[];
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} listId -
+     * @param {Models.OrderListItemInput[]} items - The new full set of positions.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsReplace(listId: string, items: Models.OrderListItemInput[]): Promise<{}>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    orderlistsItemsDelete(params: {
+        listId: string;
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} listId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsDelete(listId: string, id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     */
+    orderlistsItemsGet(params: {
+        listId: string;
+        id: string;
+    }): Promise<Models.OrderListItem>;
+    /**
+     *
+     * @param {string} listId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsGet(listId: string, id: string): Promise<Models.OrderListItem>;
+    /**
+     *
+     * @param {string} params.listId -
+     * @param {string} params.id -
+     * @param {string} params.categorySlug -
+     * @param {string} params.costCenterId - Cost center reference (free-text).
+     * @param {string} params.customSku - Customer's own article number.
+     * @param {string} params.image -
+     * @param {object} params.metadata -
+     * @param {string} params.name - Display name (snapshot).
+     * @param {number} params.position - Sort order (assigned automatically when omitted).
+     * @param {string[]} params.positionTexts - Per-position notes.
+     * @param {number} params.price - Unit price snapshot.
+     * @param {string} params.productId - Catalog product (alternative to sku).
+     * @param {number} params.quantity - Default 1.
+     * @param {string} params.sku - Article SKU (alternative to product_id).
+     * @param {string} params.subcategorySlug -
+     * @param {number} params.taxRate -
+     * @param {string} params.unit -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     */
+    orderlistsItemsUpdate(params: {
+        listId: string;
+        id: string;
+        categorySlug?: string;
+        costCenterId?: string;
+        customSku?: string;
+        image?: string;
+        metadata?: object;
+        name?: string;
+        position?: number;
+        positionTexts?: string[];
+        price?: number;
+        productId?: string;
+        quantity?: number;
+        sku?: string;
+        subcategorySlug?: string;
+        taxRate?: number;
+        unit?: string;
+    }): Promise<Models.OrderListItem>;
+    /**
+     *
+     * @param {string} listId -
+     * @param {string} id -
+     * @param {string} categorySlug -
+     * @param {string} costCenterId - Cost center reference (free-text).
+     * @param {string} customSku - Customer's own article number.
+     * @param {string} image -
+     * @param {object} metadata -
+     * @param {string} name - Display name (snapshot).
+     * @param {number} position - Sort order (assigned automatically when omitted).
+     * @param {string[]} positionTexts - Per-position notes.
+     * @param {number} price - Unit price snapshot.
+     * @param {string} productId - Catalog product (alternative to sku).
+     * @param {number} quantity - Default 1.
+     * @param {string} sku - Article SKU (alternative to product_id).
+     * @param {string} subcategorySlug -
+     * @param {number} taxRate -
+     * @param {string} unit -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.OrderListItem>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    orderlistsItemsUpdate(listId: string, id: string, categorySlug?: string, costCenterId?: string, customSku?: string, image?: string, metadata?: object, name?: string, position?: number, positionTexts?: string[], price?: number, productId?: string, quantity?: number, sku?: string, subcategorySlug?: string, taxRate?: number, unit?: string): Promise<Models.OrderListItem>;
+}
+
+export { Orderlists };