@revenexx/sdk 0.0.7 → 0.0.9

package/dist/iife/sdk.js

@@ -4415,7 +4415,7 @@
 	    'x-sdk-name': 'Revenexx Web',
 	    'x-sdk-platform': '',
 	    'x-sdk-language': 'web',
-	    'x-sdk-version': '0.0.7'
+	    'x-sdk-version': '0.0.9'
 	  };
 
 	  /**
@@ -16346,12 +16346,104 @@
 
 	  /**
 	   *
+	   * @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() {
+
+	  /**
+	   *
+	   * @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(paramsOrFirst, ...rest) {
+	    let params;
+	    if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst)) {
+	      params = paramsOrFirst || {};
+	    } else {
+	      params = {
+	        status: paramsOrFirst,
+	        paymentStatus: rest[0],
+	        fulfillmentStatus: rest[1],
+	        contactId: rest[2],
+	        organizationId: rest[3],
+	        channelId: rest[4],
+	        marketId: rest[5],
+	        number: rest[6],
+	        limit: rest[7],
+	        offset: rest[8],
+	        order: rest[9]
+	      };
+	    }
+	    const status = params.status;
+	    const paymentStatus = params.paymentStatus;
+	    const fulfillmentStatus = params.fulfillmentStatus;
+	    const contactId = params.contactId;
+	    const organizationId = params.organizationId;
+	    const channelId = params.channelId;
+	    const marketId = params.marketId;
+	    const number = params.number;
+	    const limit = params.limit;
+	    const offset = params.offset;
+	    const order = params.order;
 	    const apiPath = '/v1/orders';
 	    const apiPayload = {};
+	    if (typeof status !== 'undefined') {
+	      apiPayload['status'] = status;
+	    }
+	    if (typeof paymentStatus !== 'undefined') {
+	      apiPayload['payment_status'] = paymentStatus;
+	    }
+	    if (typeof fulfillmentStatus !== 'undefined') {
+	      apiPayload['fulfillment_status'] = fulfillmentStatus;
+	    }
+	    if (typeof contactId !== 'undefined') {
+	      apiPayload['contact_id'] = contactId;
+	    }
+	    if (typeof organizationId !== 'undefined') {
+	      apiPayload['organization_id'] = organizationId;
+	    }
+	    if (typeof channelId !== 'undefined') {
+	      apiPayload['channel_id'] = channelId;
+	    }
+	    if (typeof marketId !== 'undefined') {
+	      apiPayload['market_id'] = marketId;
+	    }
+	    if (typeof number !== 'undefined') {
+	      apiPayload['number'] = number;
+	    }
+	    if (typeof limit !== 'undefined') {
+	      apiPayload['limit'] = limit;
+	    }
+	    if (typeof offset !== 'undefined') {
+	      apiPayload['offset'] = offset;
+	    }
+	    if (typeof order !== 'undefined') {
+	      apiPayload['order'] = order;
+	    }
 	    const uri = new URL(this.client.config.endpoint + apiPath);
 	    const apiHeaders = {};
 	    return this.client.call('get', uri, apiHeaders, apiPayload);

package/package.json

@@ -2,7 +2,7 @@
   "name": "@revenexx/sdk",
   "homepage": "https://revenexx.com",
   "description": "Revenexx Web SDK for browsers and SSR frameworks.",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "license": "MIT",
   "files": [
     "dist",

package/src/client.ts

@@ -388,7 +388,7 @@ class Client {
         'x-sdk-name': 'Revenexx Web',
         'x-sdk-platform': '',
         'x-sdk-language': 'web',
-        'x-sdk-version': '0.0.7',
+        'x-sdk-version': '0.0.9',
     };
 
     /**

package/src/enums/fulfillment-status.ts

@@ -0,0 +1,5 @@
+export enum FulfillmentStatus {
+    Unfulfilled = 'unfulfilled',
+    Partial = 'partial',
+    Fulfilled = 'fulfilled',
+}

package/src/enums/payment-status.ts

@@ -0,0 +1,9 @@
+export enum PaymentStatus {
+    Open = 'open',
+    Pending = 'pending',
+    Authorized = 'authorized',
+    Paid = 'paid',
+    PartiallyPaid = 'partially_paid',
+    Refunded = 'refunded',
+    Failed = 'failed',
+}

package/src/enums/status.ts

@@ -0,0 +1,7 @@
+export enum Status {
+    Pending = 'pending',
+    Placed = 'placed',
+    InFulfillment = 'in_fulfillment',
+    Completed = 'completed',
+    Cancelled = 'cancelled',
+}

package/src/services/orders.ts

@@ -14,13 +14,111 @@ export class Orders {
 
     /**
      *
+     * @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<{}>;
+    ordersList(
+        paramsOrFirst?: { status?: string, paymentStatus?: string, fulfillmentStatus?: string, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string } | string,
+        ...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?, (number)?, (string)?]    
+    ): Promise<{}> {
+        let params: { status?: string, paymentStatus?: string, fulfillmentStatus?: string, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { status?: string, paymentStatus?: string, fulfillmentStatus?: string, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string };
+        } else {
+            params = {
+                status: paramsOrFirst as string,
+                paymentStatus: rest[0] as string,
+                fulfillmentStatus: rest[1] as string,
+                contactId: rest[2] as string,
+                organizationId: rest[3] as string,
+                channelId: rest[4] as string,
+                marketId: rest[5] as string,
+                number: rest[6] as string,
+                limit: rest[7] as number,
+                offset: rest[8] as number,
+                order: rest[9] as string            
+            };
+        }
+        
+        const status = params.status;
+        const paymentStatus = params.paymentStatus;
+        const fulfillmentStatus = params.fulfillmentStatus;
+        const contactId = params.contactId;
+        const organizationId = params.organizationId;
+        const channelId = params.channelId;
+        const marketId = params.marketId;
+        const number = params.number;
+        const limit = params.limit;
+        const offset = params.offset;
+        const order = params.order;
+
 
         const apiPath = '/v1/orders';
         const apiPayload: Payload = {};
+        if (typeof status !== 'undefined') {
+            apiPayload['status'] = status;
+        }
+        if (typeof paymentStatus !== 'undefined') {
+            apiPayload['payment_status'] = paymentStatus;
+        }
+        if (typeof fulfillmentStatus !== 'undefined') {
+            apiPayload['fulfillment_status'] = fulfillmentStatus;
+        }
+        if (typeof contactId !== 'undefined') {
+            apiPayload['contact_id'] = contactId;
+        }
+        if (typeof organizationId !== 'undefined') {
+            apiPayload['organization_id'] = organizationId;
+        }
+        if (typeof channelId !== 'undefined') {
+            apiPayload['channel_id'] = channelId;
+        }
+        if (typeof marketId !== 'undefined') {
+            apiPayload['market_id'] = marketId;
+        }
+        if (typeof number !== 'undefined') {
+            apiPayload['number'] = number;
+        }
+        if (typeof limit !== 'undefined') {
+            apiPayload['limit'] = limit;
+        }
+        if (typeof offset !== 'undefined') {
+            apiPayload['offset'] = offset;
+        }
+        if (typeof order !== 'undefined') {
+            apiPayload['order'] = order;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {

package/types/enums/fulfillment-status.d.ts

@@ -0,0 +1,5 @@
+export declare enum FulfillmentStatus {
+    Unfulfilled = "unfulfilled",
+    Partial = "partial",
+    Fulfilled = "fulfilled"
+}

package/types/enums/payment-status.d.ts

@@ -0,0 +1,9 @@
+export declare enum PaymentStatus {
+    Open = "open",
+    Pending = "pending",
+    Authorized = "authorized",
+    Paid = "paid",
+    PartiallyPaid = "partially_paid",
+    Refunded = "refunded",
+    Failed = "failed"
+}

package/types/enums/status.d.ts

@@ -0,0 +1,7 @@
+export declare enum Status {
+    Pending = "pending",
+    Placed = "placed",
+    InFulfillment = "in_fulfillment",
+    Completed = "completed",
+    Cancelled = "cancelled"
+}

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}