@revenexx/sdk 0.0.6 → 0.0.9

package/types/services/orders.d.ts

@@ -7,10 +7,51 @@ export declare class Orders {
     constructor(client: Client);
     /**
      *
+     * @param {string} params.status - Filter by order status (exact match): pending | placed | in_fulfillment | completed | cancelled.
+     * @param {string} params.paymentStatus - Filter by payment status (exact match): open | pending | authorized | paid | partially_paid | refunded | failed.
+     * @param {string} params.fulfillmentStatus - Filter by fulfillment status (exact match): unfulfilled | partial | fulfilled.
+     * @param {string} params.contactId - Filter to one ordering contact.
+     * @param {string} params.organizationId - Filter to one B2B organization.
+     * @param {string} params.channelId - Filter to one sales channel.
+     * @param {string} params.marketId - Filter to one market.
+     * @param {string} params.number - Filter by exact order number.
+     * @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<{}>}
      */
-    ordersList(): Promise<{}>;
+    ordersList(params?: {
+        status?: string;
+        paymentStatus?: string;
+        fulfillmentStatus?: string;
+        contactId?: string;
+        organizationId?: string;
+        channelId?: string;
+        marketId?: string;
+        number?: string;
+        limit?: number;
+        offset?: number;
+        order?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} status - Filter by order status (exact match): pending | placed | in_fulfillment | completed | cancelled.
+     * @param {string} paymentStatus - Filter by payment status (exact match): open | pending | authorized | paid | partially_paid | refunded | failed.
+     * @param {string} fulfillmentStatus - Filter by fulfillment status (exact match): unfulfilled | partial | fulfilled.
+     * @param {string} contactId - Filter to one ordering contact.
+     * @param {string} organizationId - Filter to one B2B organization.
+     * @param {string} channelId - Filter to one sales channel.
+     * @param {string} marketId - Filter to one market.
+     * @param {string} number - Filter by exact order number.
+     * @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.
+     */
+    ordersList(status?: string, paymentStatus?: string, fulfillmentStatus?: string, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}