@revenexx/sdk 0.0.2 → 0.0.5

package/types/services/shipping.d.ts

@@ -0,0 +1,351 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { ShippingMethodMatrixBasis } from '../enums/shipping-method-matrix-basis';
+import { ShippingMethodPricingType } from '../enums/shipping-method-pricing-type';
+export declare class Shipping {
+    client: Client;
+    constructor(client: Client);
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingMethodsList(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.code - Stable method code, unique per tenant (e.g. standard, express).
+     * @param {string} params.name - Display name.
+     * @param {string} params.carrier - Carrier anchor for the upcoming carrier connect (dynamic rates, tracking links).
+     * @param {string[]} params.countries - Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide.
+     * @param {string} params.currency - ISO 4217 code (default EUR).
+     * @param {string} params.description -
+     * @param {boolean} params.enabled - Only enabled methods appear in rate responses (default false).
+     * @param {number} params.etaDaysMax - Delivery-time estimate for the checkout (days, upper bound).
+     * @param {number} params.etaDaysMin - Delivery-time estimate for the checkout (days, lower bound).
+     * @param {number} params.freeAbove - Free shipping at or above this order value — wins over every pricing model.
+     * @param {object} params.labels - Localized display names keyed by locale (e.g. {de, en}).
+     * @param {string} params.matrixAttribute - Attribute name for matrix_basis 'attribute'.
+     * @param {ShippingMethodMatrixBasis} params.matrixBasis - The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.position - Sort order in the checkout (default 0).
+     * @param {number} params.price - The fixed price (default 0) — ignored for 'free' and 'matrix'.
+     * @param {ShippingMethodPricingType} params.pricingType - Pricing model (default 'fixed'): one price, no price, or tiered over a measure.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     */
+    shippingMethodsCreate(params: {
+        code: string;
+        name: string;
+        carrier?: string;
+        countries?: string[];
+        currency?: string;
+        description?: string;
+        enabled?: boolean;
+        etaDaysMax?: number;
+        etaDaysMin?: number;
+        freeAbove?: number;
+        labels?: object;
+        matrixAttribute?: string;
+        matrixBasis?: ShippingMethodMatrixBasis;
+        metadata?: object;
+        position?: number;
+        price?: number;
+        pricingType?: ShippingMethodPricingType;
+    }): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @param {string} code - Stable method code, unique per tenant (e.g. standard, express).
+     * @param {string} name - Display name.
+     * @param {string} carrier - Carrier anchor for the upcoming carrier connect (dynamic rates, tracking links).
+     * @param {string[]} countries - Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide.
+     * @param {string} currency - ISO 4217 code (default EUR).
+     * @param {string} description -
+     * @param {boolean} enabled - Only enabled methods appear in rate responses (default false).
+     * @param {number} etaDaysMax - Delivery-time estimate for the checkout (days, upper bound).
+     * @param {number} etaDaysMin - Delivery-time estimate for the checkout (days, lower bound).
+     * @param {number} freeAbove - Free shipping at or above this order value — wins over every pricing model.
+     * @param {object} labels - Localized display names keyed by locale (e.g. {de, en}).
+     * @param {string} matrixAttribute - Attribute name for matrix_basis 'attribute'.
+     * @param {ShippingMethodMatrixBasis} matrixBasis - The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request.
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} position - Sort order in the checkout (default 0).
+     * @param {number} price - The fixed price (default 0) — ignored for 'free' and 'matrix'.
+     * @param {ShippingMethodPricingType} pricingType - Pricing model (default 'fixed'): one price, no price, or tiered over a measure.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingMethodsCreate(code: string, name: string, carrier?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, position?: number, price?: number, pricingType?: ShippingMethodPricingType): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingMethodsDefaults(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingMethodsDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingMethodsDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     */
+    shippingMethodsGet(params: {
+        id: string;
+    }): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingMethodsGet(id: string): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @param {string} params.id -
+     * @param {string} params.carrier - Carrier anchor for the upcoming carrier connect (dynamic rates, tracking links).
+     * @param {string} params.code - Stable method code, unique per tenant (e.g. standard, express).
+     * @param {string[]} params.countries - Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide.
+     * @param {string} params.currency - ISO 4217 code (default EUR).
+     * @param {string} params.description -
+     * @param {boolean} params.enabled - Only enabled methods appear in rate responses (default false).
+     * @param {number} params.etaDaysMax - Delivery-time estimate for the checkout (days, upper bound).
+     * @param {number} params.etaDaysMin - Delivery-time estimate for the checkout (days, lower bound).
+     * @param {number} params.freeAbove - Free shipping at or above this order value — wins over every pricing model.
+     * @param {object} params.labels - Localized display names keyed by locale (e.g. {de, en}).
+     * @param {string} params.matrixAttribute - Attribute name for matrix_basis 'attribute'.
+     * @param {ShippingMethodMatrixBasis} params.matrixBasis - The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name - Display name.
+     * @param {number} params.position - Sort order in the checkout (default 0).
+     * @param {number} params.price - The fixed price (default 0) — ignored for 'free' and 'matrix'.
+     * @param {ShippingMethodPricingType} params.pricingType - Pricing model (default 'fixed'): one price, no price, or tiered over a measure.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     */
+    shippingMethodsUpdate(params: {
+        id: string;
+        carrier?: string;
+        code?: string;
+        countries?: string[];
+        currency?: string;
+        description?: string;
+        enabled?: boolean;
+        etaDaysMax?: number;
+        etaDaysMin?: number;
+        freeAbove?: number;
+        labels?: object;
+        matrixAttribute?: string;
+        matrixBasis?: ShippingMethodMatrixBasis;
+        metadata?: object;
+        name?: string;
+        position?: number;
+        price?: number;
+        pricingType?: ShippingMethodPricingType;
+    }): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @param {string} id -
+     * @param {string} carrier - Carrier anchor for the upcoming carrier connect (dynamic rates, tracking links).
+     * @param {string} code - Stable method code, unique per tenant (e.g. standard, express).
+     * @param {string[]} countries - Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide.
+     * @param {string} currency - ISO 4217 code (default EUR).
+     * @param {string} description -
+     * @param {boolean} enabled - Only enabled methods appear in rate responses (default false).
+     * @param {number} etaDaysMax - Delivery-time estimate for the checkout (days, upper bound).
+     * @param {number} etaDaysMin - Delivery-time estimate for the checkout (days, lower bound).
+     * @param {number} freeAbove - Free shipping at or above this order value — wins over every pricing model.
+     * @param {object} labels - Localized display names keyed by locale (e.g. {de, en}).
+     * @param {string} matrixAttribute - Attribute name for matrix_basis 'attribute'.
+     * @param {ShippingMethodMatrixBasis} matrixBasis - The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request.
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name - Display name.
+     * @param {number} position - Sort order in the checkout (default 0).
+     * @param {number} price - The fixed price (default 0) — ignored for 'free' and 'matrix'.
+     * @param {ShippingMethodPricingType} pricingType - Pricing model (default 'fixed'): one price, no price, or tiered over a measure.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingMethod>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingMethodsUpdate(id: string, carrier?: string, code?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, name?: string, position?: number, price?: number, pricingType?: ShippingMethodPricingType): Promise<Models.ShippingMethod>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingTiersList(params: {
+        methodId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} methodId -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersList(methodId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @param {number} params.fromValue - Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins.
+     * @param {number} params.position - Sort order (default 0; bulk replace derives it from the array index).
+     * @param {number} params.price - Price of this tier (default 0).
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     */
+    shippingTiersCreate(params: {
+        methodId: string;
+        fromValue?: number;
+        position?: number;
+        price?: number;
+    }): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {string} methodId -
+     * @param {number} fromValue - Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins.
+     * @param {number} position - Sort order (default 0; bulk replace derives it from the array index).
+     * @param {number} price - Price of this tier (default 0).
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersCreate(methodId: string, fromValue?: number, position?: number, price?: number): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @param {Models.ShippingRateTierCreateRequest[]} params.tiers - The complete new tier set (set semantics) — positions are derived from the array order.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingTiersReplace(params: {
+        methodId: string;
+        tiers: Models.ShippingRateTierCreateRequest[];
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} methodId -
+     * @param {Models.ShippingRateTierCreateRequest[]} tiers - The complete new tier set (set semantics) — positions are derived from the array order.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersReplace(methodId: string, tiers: Models.ShippingRateTierCreateRequest[]): Promise<{}>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingTiersDelete(params: {
+        methodId: string;
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} methodId -
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersDelete(methodId: string, id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @param {string} params.id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     */
+    shippingTiersGet(params: {
+        methodId: string;
+        id: string;
+    }): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {string} methodId -
+     * @param {string} id -
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersGet(methodId: string, id: string): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {string} params.methodId -
+     * @param {string} params.id -
+     * @param {number} params.fromValue - Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins.
+     * @param {number} params.position - Sort order (default 0; bulk replace derives it from the array index).
+     * @param {number} params.price - Price of this tier (default 0).
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     */
+    shippingTiersUpdate(params: {
+        methodId: string;
+        id: string;
+        fromValue?: number;
+        position?: number;
+        price?: number;
+    }): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {string} methodId -
+     * @param {string} id -
+     * @param {number} fromValue - Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins.
+     * @param {number} position - Sort order (default 0; bulk replace derives it from the array index).
+     * @param {number} price - Price of this tier (default 0).
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ShippingRateTier>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingTiersUpdate(methodId: string, id: string, fromValue?: number, position?: number, price?: number): Promise<Models.ShippingRateTier>;
+    /**
+     *
+     * @param {object} params.attributes - Measure values for attribute matrices, keyed by attribute name.
+     * @param {string} params.country - Destination ISO 3166-1 alpha-2 code — checked against method country restrictions.
+     * @param {string} params.currency - Echoed into the rates (default 'EUR').
+     * @param {number} params.orderValue - Order value (default 0) — drives free-above thresholds and order_value matrices.
+     * @param {number} params.quantity - Total quantity — measure for quantity matrices.
+     * @param {number} params.weight - Total weight — measure for weight matrices.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    shippingRates(params?: {
+        attributes?: object;
+        country?: string;
+        currency?: string;
+        orderValue?: number;
+        quantity?: number;
+        weight?: number;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {object} attributes - Measure values for attribute matrices, keyed by attribute name.
+     * @param {string} country - Destination ISO 3166-1 alpha-2 code — checked against method country restrictions.
+     * @param {string} currency - Echoed into the rates (default 'EUR').
+     * @param {number} orderValue - Order value (default 0) — drives free-above thresholds and order_value matrices.
+     * @param {number} quantity - Total quantity — measure for quantity matrices.
+     * @param {number} weight - Total weight — measure for weight matrices.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingRates(attributes?: object, country?: string, currency?: string, orderValue?: number, quantity?: number, weight?: number): Promise<{}>;
+}