@revenexx/node 0.0.1 → 0.0.2

package/dist/services/markets.d.ts

@@ -0,0 +1,618 @@
+import { Client } from '../client.js';
+import { Models } from '../models.js';
+import { MarketStatus } from '../enums/market-status.js';
+import '../query.js';
+import '../enums/address-type.js';
+import '../enums/cart-export-format.js';
+import '../enums/cart-item-type.js';
+import '../enums/channel-status.js';
+import '../enums/channel-type.js';
+import '../enums/contact-role.js';
+import '../enums/contact-status.js';
+import '../enums/cart-io-apply-mode.js';
+import '../enums/cart-io-direction.js';
+import '../enums/cart-io-entity.js';
+import '../enums/cart-io-format.js';
+import '../enums/location-type.js';
+import '../enums/order-comment-visibility.js';
+import '../enums/order-item-type.js';
+import '../enums/order-list-kind.js';
+import '../enums/order-payment-status.js';
+import '../enums/organization-status.js';
+import '../enums/page-status.js';
+import '../enums/payment-fee-type.js';
+import '../enums/payment-method-kind.js';
+import '../enums/price-entry-type.js';
+import '../enums/price-list-status.js';
+import '../enums/shipping-method-matrix-basis.js';
+import '../enums/shipping-method-pricing-type.js';
+import '../enums/store-asset-request-visibility.js';
+import '../enums/attribute-boolean-status.js';
+import '../enums/attribute-datetime-status.js';
+import '../enums/attribute-email-status.js';
+import '../enums/attribute-enum-status.js';
+import '../enums/attribute-float-status.js';
+import '../enums/attribute-integer-status.js';
+import '../enums/attribute-ip-status.js';
+import '../enums/attribute-line-status.js';
+import '../enums/attribute-longtext-status.js';
+import '../enums/attribute-mediumtext-status.js';
+import '../enums/attribute-point-status.js';
+import '../enums/attribute-polygon-status.js';
+import '../enums/attribute-relationship-status.js';
+import '../enums/attribute-string-status.js';
+import '../enums/attribute-text-status.js';
+import '../enums/attribute-url-status.js';
+import '../enums/attribute-varchar-status.js';
+import '../enums/column-boolean-status.js';
+import '../enums/column-datetime-status.js';
+import '../enums/column-email-status.js';
+import '../enums/column-enum-status.js';
+import '../enums/column-float-status.js';
+import '../enums/column-integer-status.js';
+import '../enums/column-ip-status.js';
+import '../enums/column-line-status.js';
+import '../enums/column-longtext-status.js';
+import '../enums/column-mediumtext-status.js';
+import '../enums/column-point-status.js';
+import '../enums/column-polygon-status.js';
+import '../enums/column-relationship-status.js';
+import '../enums/column-string-status.js';
+import '../enums/column-text-status.js';
+import '../enums/column-url-status.js';
+import '../enums/column-varchar-status.js';
+import '../enums/database-type.js';
+import '../enums/deployment-status.js';
+import '../enums/execution-status.js';
+import '../enums/execution-trigger.js';
+import '../enums/health-antivirus-status.js';
+import '../enums/health-status-status.js';
+import '../enums/index-status.js';
+import '../enums/message-status.js';
+
+declare class Markets {
+    client: Client;
+    constructor(client: Client);
+    /**
+     *
+     * @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<{}>}
+     */
+    marketsList(params?: {
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @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.
+     */
+    marketsList(limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.code - Market code (unique per tenant).
+     * @param {string} params.name -
+     * @param {string} params.currency - ISO 4217 code (default 'EUR').
+     * @param {boolean} params.isDefault -
+     * @param {object} params.labels - Localized display names ({locale: label}).
+     * @param {number} params.position - Sort position (default 0).
+     * @param {MarketStatus} params.status - Default 'active'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     */
+    marketsCreate(params: {
+        code: string;
+        name: string;
+        currency?: string;
+        isDefault?: boolean;
+        labels?: object;
+        position?: number;
+        status?: MarketStatus;
+    }): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} code - Market code (unique per tenant).
+     * @param {string} name -
+     * @param {string} currency - ISO 4217 code (default 'EUR').
+     * @param {boolean} isDefault -
+     * @param {object} labels - Localized display names ({locale: label}).
+     * @param {number} position - Sort position (default 0).
+     * @param {MarketStatus} status - Default 'active'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsCreate(code: string, name: string, currency?: string, isDefault?: boolean, labels?: object, position?: number, status?: MarketStatus): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    marketsDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     */
+    marketsGet(params: {
+        id: string;
+    }): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsGet(id: string): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} params.id -
+     * @param {string} params.code - Market code (unique per tenant).
+     * @param {string} params.currency - ISO 4217 code (default 'EUR').
+     * @param {boolean} params.isDefault -
+     * @param {object} params.labels - Localized display names ({locale: label}).
+     * @param {string} params.name -
+     * @param {number} params.position - Sort position (default 0).
+     * @param {MarketStatus} params.status - Default 'active'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     */
+    marketsUpdate(params: {
+        id: string;
+        code?: string;
+        currency?: string;
+        isDefault?: boolean;
+        labels?: object;
+        name?: string;
+        position?: number;
+        status?: MarketStatus;
+    }): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} id -
+     * @param {string} code - Market code (unique per tenant).
+     * @param {string} currency - ISO 4217 code (default 'EUR').
+     * @param {boolean} isDefault -
+     * @param {object} labels - Localized display names ({locale: label}).
+     * @param {string} name -
+     * @param {number} position - Sort position (default 0).
+     * @param {MarketStatus} status - Default 'active'.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Market>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsUpdate(id: string, code?: string, currency?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, status?: MarketStatus): Promise<Models.Market>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketContext>}
+     */
+    marketsContext(params: {
+        id: string;
+    }): Promise<Models.MarketContext>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketContext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsContext(id: string): Promise<Models.MarketContext>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @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<{}>}
+     */
+    marketsCurrenciesList(params: {
+        marketId: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @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.
+     */
+    marketsCurrenciesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.code - ISO 4217 code, e.g. EUR (unique per market).
+     * @param {boolean} params.isDefault -
+     * @param {number} params.position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     */
+    marketsCurrenciesCreate(params: {
+        marketId: string;
+        code: string;
+        isDefault?: boolean;
+        position?: number;
+    }): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} code - ISO 4217 code, e.g. EUR (unique per market).
+     * @param {boolean} isDefault -
+     * @param {number} position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsCurrenciesCreate(marketId: string, code: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    marketsCurrenciesDelete(params: {
+        marketId: string;
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsCurrenciesDelete(marketId: string, id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     */
+    marketsCurrenciesGet(params: {
+        marketId: string;
+        id: string;
+    }): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsCurrenciesGet(marketId: string, id: string): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @param {string} params.code - ISO 4217 code, e.g. EUR (unique per market).
+     * @param {boolean} params.isDefault -
+     * @param {number} params.position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     */
+    marketsCurrenciesUpdate(params: {
+        marketId: string;
+        id: string;
+        code?: string;
+        isDefault?: boolean;
+        position?: number;
+    }): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @param {string} code - ISO 4217 code, e.g. EUR (unique per market).
+     * @param {boolean} isDefault -
+     * @param {number} position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketCurrency>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsCurrenciesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @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<{}>}
+     */
+    marketsLocalesList(params: {
+        marketId: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @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.
+     */
+    marketsLocalesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.code - Locale code, e.g. 'de-DE' (unique per market).
+     * @param {string} params.country - ISO 3166-1 alpha-2 country code.
+     * @param {string} params.language - ISO 639-1 language code.
+     * @param {boolean} params.isDefault -
+     * @param {number} params.position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     */
+    marketsLocalesCreate(params: {
+        marketId: string;
+        code: string;
+        country: string;
+        language: string;
+        isDefault?: boolean;
+        position?: number;
+    }): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} code - Locale code, e.g. 'de-DE' (unique per market).
+     * @param {string} country - ISO 3166-1 alpha-2 country code.
+     * @param {string} language - ISO 639-1 language code.
+     * @param {boolean} isDefault -
+     * @param {number} position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsLocalesCreate(marketId: string, code: string, country: string, language: string, isDefault?: boolean, position?: number): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    marketsLocalesDelete(params: {
+        marketId: string;
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsLocalesDelete(marketId: string, id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     */
+    marketsLocalesGet(params: {
+        marketId: string;
+        id: string;
+    }): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsLocalesGet(marketId: string, id: string): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @param {string} params.code - Locale code, e.g. 'de-DE' (unique per market).
+     * @param {string} params.country - ISO 3166-1 alpha-2 country code.
+     * @param {boolean} params.isDefault -
+     * @param {string} params.language - ISO 639-1 language code.
+     * @param {number} params.position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     */
+    marketsLocalesUpdate(params: {
+        marketId: string;
+        id: string;
+        code?: string;
+        country?: string;
+        isDefault?: boolean;
+        language?: string;
+        position?: number;
+    }): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @param {string} code - Locale code, e.g. 'de-DE' (unique per market).
+     * @param {string} country - ISO 3166-1 alpha-2 country code.
+     * @param {boolean} isDefault -
+     * @param {string} language - ISO 639-1 language code.
+     * @param {number} position - Sort position (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketLocale>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsLocalesUpdate(marketId: string, id: string, code?: string, country?: string, isDefault?: boolean, language?: string, position?: number): Promise<Models.MarketLocale>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @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<{}>}
+     */
+    marketsTaxClassesList(params: {
+        marketId: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @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.
+     */
+    marketsTaxClassesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.code - Tax class code (unique per market).
+     * @param {string} params.name -
+     * @param {boolean} params.isDefault -
+     * @param {object} params.labels - Localized display names ({locale: label}).
+     * @param {number} params.position - Sort position (default 0).
+     * @param {number} params.rate - Tax rate in percent, 0–100 (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     */
+    marketsTaxClassesCreate(params: {
+        marketId: string;
+        code: string;
+        name: string;
+        isDefault?: boolean;
+        labels?: object;
+        position?: number;
+        rate?: number;
+    }): Promise<Models.MarketTaxClass>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} code - Tax class code (unique per market).
+     * @param {string} name -
+     * @param {boolean} isDefault -
+     * @param {object} labels - Localized display names ({locale: label}).
+     * @param {number} position - Sort position (default 0).
+     * @param {number} rate - Tax rate in percent, 0–100 (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsTaxClassesCreate(marketId: string, code: string, name: string, isDefault?: boolean, labels?: object, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    marketsTaxClassesDelete(params: {
+        marketId: string;
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsTaxClassesDelete(marketId: string, id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     */
+    marketsTaxClassesGet(params: {
+        marketId: string;
+        id: string;
+    }): Promise<Models.MarketTaxClass>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsTaxClassesGet(marketId: string, id: string): Promise<Models.MarketTaxClass>;
+    /**
+     *
+     * @param {string} params.marketId -
+     * @param {string} params.id -
+     * @param {string} params.code - Tax class code (unique per market).
+     * @param {boolean} params.isDefault -
+     * @param {object} params.labels - Localized display names ({locale: label}).
+     * @param {string} params.name -
+     * @param {number} params.position - Sort position (default 0).
+     * @param {number} params.rate - Tax rate in percent, 0–100 (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     */
+    marketsTaxClassesUpdate(params: {
+        marketId: string;
+        id: string;
+        code?: string;
+        isDefault?: boolean;
+        labels?: object;
+        name?: string;
+        position?: number;
+        rate?: number;
+    }): Promise<Models.MarketTaxClass>;
+    /**
+     *
+     * @param {string} marketId -
+     * @param {string} id -
+     * @param {string} code - Tax class code (unique per market).
+     * @param {boolean} isDefault -
+     * @param {object} labels - Localized display names ({locale: label}).
+     * @param {string} name -
+     * @param {number} position - Sort position (default 0).
+     * @param {number} rate - Tax rate in percent, 0–100 (default 0).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.MarketTaxClass>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    marketsTaxClassesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
+}
+
+export { Markets };