@revenexx/sdk 0.0.9 → 0.0.11

package/src/services/search.ts

@@ -328,7 +328,7 @@ export class Search {
         const apiPath = '/v1/search/multi_search';
         const apiPayload: Payload = {};
         if (typeof searches !== 'undefined') {
-            apiPayload['searches'] = searches;
+            apiPayload['searches'] = Client.toWireKeys(searches, {"facetBy":{"wire":"facet_by","children":null},"filterBy":{"wire":"filter_by","children":null},"perPage":{"wire":"per_page","children":null},"queryBy":{"wire":"query_by","children":null},"sortBy":{"wire":"sort_by","children":null}});
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 

package/src/services/shipping.ts

@@ -659,7 +659,7 @@ export class Shipping {
         const apiPath = '/v1/shipping/methods/{method_id}/tiers'.replace('{method_id}', methodId);
         const apiPayload: Payload = {};
         if (typeof tiers !== 'undefined') {
-            apiPayload['tiers'] = tiers;
+            apiPayload['tiers'] = Client.toWireKeys(tiers, {"fromValue":{"wire":"from_value","children":null}});
         }
         const uri = new URL(this.client.config.endpoint + apiPath);
 

package/types/client.d.ts

@@ -202,6 +202,17 @@ declare class Client {
     chunkedUpload(method: string, url: URL, headers: Headers | undefined, originalPayload: Payload | undefined, onProgress: (progress: UploadProgress) => void): Promise<any>;
     ping(): Promise<string>;
     call(method: string, url: URL, headers?: Headers, params?: Payload, responseType?: string): Promise<any>;
+    /**
+     * Recursively renames an argument's DECLARED keys to their snake_case wire
+     * names, using a map generated from the API contract. Free-form subtrees
+     * (metadata / user_data — keys absent from the map, with no `children`) are
+     * passed through untouched, so user data is never mangled. For arrays the
+     * same element map is applied to every item.
+     */
+    static toWireKeys(value: any, map: Record<string, {
+        wire: string;
+        children: any;
+    }>): any;
     static flatten(data: Payload, prefix?: string): Payload;
 }
 export { Client, RevenexxException };

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

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

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

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

package/types/index.d.ts

@@ -64,8 +64,10 @@ export { LocationType } from './enums/location-type';
 export { MarketStatus } from './enums/market-status';
 export { Priority } from './enums/priority';
 export { OrderListKind } from './enums/order-list-kind';
-export { OrderCommentVisibility } from './enums/order-comment-visibility';
+export { OrderStatus } from './enums/order-status';
 export { OrderPaymentStatus } from './enums/order-payment-status';
+export { OrderFulfillmentStatus } from './enums/order-fulfillment-status';
+export { OrderCommentVisibility } from './enums/order-comment-visibility';
 export { PageStatus } from './enums/page-status';
 export { PaymentFeeType } from './enums/payment-fee-type';
 export { PaymentMethodKind } from './enums/payment-method-kind';

package/types/services/carts.d.ts

@@ -11,10 +11,36 @@ export declare class Carts {
     constructor(client: Client);
     /**
      *
+     * @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<{}>;
     /**
      *
      * @param {string} params.channelId -

package/types/services/customers.d.ts

@@ -9,10 +9,33 @@ export declare class Customers {
     constructor(client: Client);
     /**
      *
+     * @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<{}>;
     /**
      *
      * @param {string} params.city -

package/types/services/orderlists.d.ts

@@ -6,10 +6,36 @@ export declare class Orderlists {
     constructor(client: Client);
     /**
      *
+     * @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<{}>;
     /**
      *
      * @param {string} params.name -

package/types/services/orders.d.ts

@@ -1,15 +1,17 @@
 import { Client } from '../client';
 import type { Models } from '../models';
-import { OrderCommentVisibility } from '../enums/order-comment-visibility';
+import { OrderStatus } from '../enums/order-status';
 import { OrderPaymentStatus } from '../enums/order-payment-status';
+import { OrderFulfillmentStatus } from '../enums/order-fulfillment-status';
+import { OrderCommentVisibility } from '../enums/order-comment-visibility';
 export declare class Orders {
     client: Client;
     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 {OrderStatus} params.status - Filter by order status (exact match).
+     * @param {OrderPaymentStatus} params.paymentStatus - Filter by payment status (exact match).
+     * @param {OrderFulfillmentStatus} params.fulfillmentStatus - Filter by fulfillment status (exact match).
      * @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.
@@ -22,9 +24,9 @@ export declare class Orders {
      * @returns {Promise<{}>}
      */
     ordersList(params?: {
-        status?: string;
-        paymentStatus?: string;
-        fulfillmentStatus?: string;
+        status?: OrderStatus;
+        paymentStatus?: OrderPaymentStatus;
+        fulfillmentStatus?: OrderFulfillmentStatus;
         contactId?: string;
         organizationId?: string;
         channelId?: string;
@@ -36,9 +38,9 @@ export declare class Orders {
     }): 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 {OrderStatus} status - Filter by order status (exact match).
+     * @param {OrderPaymentStatus} paymentStatus - Filter by payment status (exact match).
+     * @param {OrderFulfillmentStatus} fulfillmentStatus - Filter by fulfillment status (exact match).
      * @param {string} contactId - Filter to one ordering contact.
      * @param {string} organizationId - Filter to one B2B organization.
      * @param {string} channelId - Filter to one sales channel.
@@ -51,7 +53,7 @@ export declare class Orders {
      * @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(status?: OrderStatus, paymentStatus?: OrderPaymentStatus, fulfillmentStatus?: OrderFulfillmentStatus, contactId?: string, organizationId?: string, channelId?: string, marketId?: string, number?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}