@revenexx/sdk 0.0.11 → 0.0.13

package/types/services/markets.d.ts

@@ -6,10 +6,27 @@ export declare class Markets {
     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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    marketsList(): 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 {RevenexxException}
+     * @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).
@@ -137,20 +154,29 @@ export declare class Markets {
     /**
      *
      * @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 {RevenexxException}
      * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    marketsCurrenciesList(marketId: string): Promise<{}>;
+    marketsCurrenciesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.marketId -
@@ -249,20 +275,29 @@ export declare class Markets {
     /**
      *
      * @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 {RevenexxException}
      * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    marketsLocalesList(marketId: string): Promise<{}>;
+    marketsLocalesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.marketId -
@@ -373,20 +408,29 @@ export declare class Markets {
     /**
      *
      * @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 {RevenexxException}
      * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    marketsTaxClassesList(marketId: string): Promise<{}>;
+    marketsTaxClassesList(marketId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.marketId -

package/types/services/orders.d.ts

@@ -56,10 +56,27 @@ export declare class Orders {
     ordersList(status?: OrderStatus, paymentStatus?: OrderPaymentStatus, fulfillmentStatus?: OrderFulfillmentStatus, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
+     * @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 {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    ordersNumberRangesList(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 {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    ordersNumberRangesList(): Promise<{}>;
+    ordersNumberRangesList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.code - Range key drawn by the app ('order', 'delivery', 'return') — unique per tenant.

package/types/services/pages.d.ts

@@ -18,10 +18,27 @@ export declare class Pages {
     pagesDeliveryPage(): Promise<Models.DeliveryPage>;
     /**
      *
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    pagesDeliveryPages(): Promise<{}>;
+    pagesDeliveryPages(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesDeliveryPages(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.token -
@@ -518,10 +535,27 @@ export declare class Pages {
     pagesEditorUnschedule(pageId: string): Promise<{}>;
     /**
      *
+     * @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 {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesLibraryList(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 {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesLibraryList(): Promise<{}>;
+    pagesLibraryList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.id -
@@ -584,10 +618,27 @@ export declare class Pages {
     pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.LibraryItem>;
     /**
      *
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    pagesMenusList(): Promise<{}>;
+    pagesMenusList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesMenusList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.label -
@@ -670,10 +721,27 @@ export declare class Pages {
     pagesMenusUpdate(id: string, items?: object[], label?: string): Promise<Models.Menu>;
     /**
      *
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    pagesPagesList(): Promise<{}>;
+    pagesPagesList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pagesPagesList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.title -
@@ -775,20 +843,29 @@ export declare class Pages {
     /**
      *
      * @param {string} params.id -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
     pagesPagesRevisions(params: {
         id: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
     }): Promise<{}>;
     /**
      *
      * @param {string} id -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesPagesRevisions(id: string): Promise<{}>;
+    pagesPagesRevisions(id: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {object[]} params.menus -
@@ -811,10 +888,27 @@ export declare class Pages {
     pagesSeed(menus?: object[], pages?: object[]): Promise<{}>;
     /**
      *
+     * @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 {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    pagesTemplatesList(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 {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pagesTemplatesList(): Promise<{}>;
+    pagesTemplatesList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.id -

package/types/services/payments.d.ts

@@ -7,10 +7,27 @@ export declare class Payments {
     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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    paymentsList(): Promise<{}>;
+    paymentsList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    paymentsList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {number} params.amount - Order amount — 0 is legal (free orders), negative is not.
@@ -57,10 +74,27 @@ export declare class Payments {
     paymentsCreate(amount: number, methodCode: string, cartId?: string, contactId?: string, country?: string, currency?: string, idempotencyKey?: string, metadata?: object, orderRef?: string, returnUrl?: string): Promise<Models.Payment>;
     /**
      *
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    paymentsMethodsList(): Promise<{}>;
+    paymentsMethodsList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    paymentsMethodsList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.code - Stable method code (unique per tenant, e.g. 'invoice', 'card').
@@ -253,10 +287,27 @@ export declare class Payments {
     paymentsMethodsUpdate(id: string, code?: string, countries?: string[], description?: string, enabled?: boolean, feeAmount?: number, feeCurrency?: string, feeType?: PaymentFeeType, kind?: PaymentMethodKind, labels?: object, maxOrderValue?: number, metadata?: object, minOrderValue?: number, name?: string, position?: number, provider?: string, providerMethod?: string): Promise<Models.PaymentMethod>;
     /**
      *
+     * @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 {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    paymentsProvidersList(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 {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    paymentsProvidersList(): Promise<{}>;
+    paymentsProvidersList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.provider - Provider code — must exist in the catalog (GET /payments/providers/catalog).

package/types/services/prices.d.ts

@@ -7,10 +7,27 @@ export declare class Prices {
     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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    pricesListsList(): Promise<{}>;
+    pricesListsList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    pricesListsList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.code - Unique list code per tenant.
@@ -181,20 +198,29 @@ export declare class Prices {
     /**
      *
      * @param {string} params.listId -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
     pricesEntriesList(params: {
         listId: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
     }): Promise<{}>;
     /**
      *
      * @param {string} listId -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    pricesEntriesList(listId: string): Promise<{}>;
+    pricesEntriesList(listId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.listId -

package/types/services/shipping.d.ts

@@ -7,10 +7,27 @@ export declare class Shipping {
     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 {RevenexxException}
      * @returns {Promise<{}>}
      */
-    shippingMethodsList(): Promise<{}>;
+    shippingMethodsList(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 {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    shippingMethodsList(limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.code - Stable method code, unique per tenant (e.g. standard, express).
@@ -187,20 +204,29 @@ export declare class Shipping {
     /**
      *
      * @param {string} params.methodId -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      */
     shippingTiersList(params: {
         methodId: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
     }): Promise<{}>;
     /**
      *
      * @param {string} methodId -
+     * @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 {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    shippingTiersList(methodId: string): Promise<{}>;
+    shippingTiersList(methodId: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @param {string} params.methodId -