@revenexx/sdk 0.0.10 → 0.0.12

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.10",
+  "version": "0.0.12",
   "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.10',
+        'x-sdk-version': '0.0.12',
     };
 
     /**

package/src/services/carts.ts

@@ -18,13 +18,76 @@ export class Carts {
 
     /**
      *
+     * @param {string} params.contactId - Filter to one owning contact.
+     * @param {string} params.sessionKey - Filter to one guest session.
+     * @param {string} params.status - Filter by cart status (e.g. active).
+     * @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<{}>}
      */
-    cartsList(): Promise<{}> {
+    cartsList(params?: { contactId?: string, sessionKey?: string, status?: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
+    /**
+     *
+     * @param {string} contactId - Filter to one owning contact.
+     * @param {string} sessionKey - Filter to one guest session.
+     * @param {string} status - Filter by cart status (e.g. active).
+     * @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.
+     */
+    cartsList(contactId?: string, sessionKey?: string, status?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    cartsList(
+        paramsOrFirst?: { contactId?: string, sessionKey?: string, status?: string, limit?: number, offset?: number, order?: string } | string,
+        ...rest: [(string)?, (string)?, (number)?, (number)?, (string)?]    
+    ): Promise<{}> {
+        let params: { contactId?: string, sessionKey?: string, status?: string, limit?: number, offset?: number, order?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { contactId?: string, sessionKey?: string, status?: string, limit?: number, offset?: number, order?: string };
+        } else {
+            params = {
+                contactId: paramsOrFirst as string,
+                sessionKey: rest[0] as string,
+                status: rest[1] as string,
+                limit: rest[2] as number,
+                offset: rest[3] as number,
+                order: rest[4] as string            
+            };
+        }
+        
+        const contactId = params.contactId;
+        const sessionKey = params.sessionKey;
+        const status = params.status;
+        const limit = params.limit;
+        const offset = params.offset;
+        const order = params.order;
+
 
         const apiPath = '/v1/carts';
         const apiPayload: Payload = {};
+        if (typeof contactId !== 'undefined') {
+            apiPayload['contact_id'] = contactId;
+        }
+        if (typeof sessionKey !== 'undefined') {
+            apiPayload['session_key'] = sessionKey;
+        }
+        if (typeof status !== 'undefined') {
+            apiPayload['status'] = status;
+        }
+        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/src/services/customers.ts

@@ -16,13 +16,69 @@ export class Customers {
 
     /**
      *
+     * @param {string} params.contactId - Filter to one owning contact.
+     * @param {string} params.organizationId - Filter to one organization.
+     * @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<{}>}
      */
-    customersAddressesList(): Promise<{}> {
+    customersAddressesList(params?: { contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
+    /**
+     *
+     * @param {string} contactId - Filter to one owning contact.
+     * @param {string} organizationId - Filter to one organization.
+     * @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.
+     */
+    customersAddressesList(contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    customersAddressesList(
+        paramsOrFirst?: { contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string } | string,
+        ...rest: [(string)?, (number)?, (number)?, (string)?]    
+    ): Promise<{}> {
+        let params: { contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { contactId?: string, organizationId?: string, limit?: number, offset?: number, order?: string };
+        } else {
+            params = {
+                contactId: paramsOrFirst as string,
+                organizationId: rest[0] as string,
+                limit: rest[1] as number,
+                offset: rest[2] as number,
+                order: rest[3] as string            
+            };
+        }
+        
+        const contactId = params.contactId;
+        const organizationId = params.organizationId;
+        const limit = params.limit;
+        const offset = params.offset;
+        const order = params.order;
+
 
         const apiPath = '/v1/customers/addresses';
         const apiPayload: Payload = {};
+        if (typeof contactId !== 'undefined') {
+            apiPayload['contact_id'] = contactId;
+        }
+        if (typeof organizationId !== 'undefined') {
+            apiPayload['organization_id'] = organizationId;
+        }
+        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 } = {
@@ -851,13 +907,83 @@ export class Customers {
 
     /**
      *
+     * @param {string} params.organizationId - Filter to one organization.
+     * @param {string} params.role - Filter by role (buyer | approver | admin | requester).
+     * @param {string} params.status - Filter by status (invited | active | blocked).
+     * @param {string} params.email - Filter by exact email.
+     * @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<{}>}
+     */
+    customersContactsList(params?: { organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
+    /**
+     *
+     * @param {string} organizationId - Filter to one organization.
+     * @param {string} role - Filter by role (buyer | approver | admin | requester).
+     * @param {string} status - Filter by status (invited | active | blocked).
+     * @param {string} email - Filter by exact email.
+     * @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.
      */
-    customersContactsList(): Promise<{}> {
+    customersContactsList(organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    customersContactsList(
+        paramsOrFirst?: { organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string } | string,
+        ...rest: [(string)?, (string)?, (string)?, (number)?, (number)?, (string)?]    
+    ): Promise<{}> {
+        let params: { organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { organizationId?: string, role?: string, status?: string, email?: string, limit?: number, offset?: number, order?: string };
+        } else {
+            params = {
+                organizationId: paramsOrFirst as string,
+                role: rest[0] as string,
+                status: rest[1] as string,
+                email: rest[2] as string,
+                limit: rest[3] as number,
+                offset: rest[4] as number,
+                order: rest[5] as string            
+            };
+        }
+        
+        const organizationId = params.organizationId;
+        const role = params.role;
+        const status = params.status;
+        const email = params.email;
+        const limit = params.limit;
+        const offset = params.offset;
+        const order = params.order;
+
 
         const apiPath = '/v1/customers/contacts';
         const apiPayload: Payload = {};
+        if (typeof organizationId !== 'undefined') {
+            apiPayload['organization_id'] = organizationId;
+        }
+        if (typeof role !== 'undefined') {
+            apiPayload['role'] = role;
+        }
+        if (typeof status !== 'undefined') {
+            apiPayload['status'] = status;
+        }
+        if (typeof email !== 'undefined') {
+            apiPayload['email'] = email;
+        }
+        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/src/services/orderlists.ts

@@ -13,13 +13,76 @@ export class Orderlists {
 
     /**
      *
+     * @param {string} params.ownerId - Filter to one owning contact.
+     * @param {string} params.organizationId - Filter to one organization.
+     * @param {string} params.kind - Filter by list kind (shopping | label).
+     * @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<{}>}
      */
-    orderlistsList(): Promise<{}> {
+    orderlistsList(params?: { ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string }): Promise<{}>;
+    /**
+     *
+     * @param {string} ownerId - Filter to one owning contact.
+     * @param {string} organizationId - Filter to one organization.
+     * @param {string} kind - Filter by list kind (shopping | label).
+     * @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.
+     */
+    orderlistsList(ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
+    orderlistsList(
+        paramsOrFirst?: { ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string } | string,
+        ...rest: [(string)?, (string)?, (number)?, (number)?, (string)?]    
+    ): Promise<{}> {
+        let params: { ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string };
+        
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { ownerId?: string, organizationId?: string, kind?: string, limit?: number, offset?: number, order?: string };
+        } else {
+            params = {
+                ownerId: paramsOrFirst as string,
+                organizationId: rest[0] as string,
+                kind: rest[1] as string,
+                limit: rest[2] as number,
+                offset: rest[3] as number,
+                order: rest[4] as string            
+            };
+        }
+        
+        const ownerId = params.ownerId;
+        const organizationId = params.organizationId;
+        const kind = params.kind;
+        const limit = params.limit;
+        const offset = params.offset;
+        const order = params.order;
+
 
         const apiPath = '/v1/orderlists';
         const apiPayload: Payload = {};
+        if (typeof ownerId !== 'undefined') {
+            apiPayload['owner_id'] = ownerId;
+        }
+        if (typeof organizationId !== 'undefined') {
+            apiPayload['organization_id'] = organizationId;
+        }
+        if (typeof kind !== 'undefined') {
+            apiPayload['kind'] = kind;
+        }
+        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 } = {