repzo 1.0.22 → 1.0.23

package/changelog.md

@@ -16,6 +16,7 @@
 - update payment.listOfAcceptedKeys @maramalshen
 - add Service: BankList @maramalshen
 - Update JoinActionsWeHook.JoinData @maramalshen
+- Patch Action @maramalshen
 
 ### Changed
 

package/lib/index.d.ts

@@ -304,4 +304,9 @@ export default class Repzo {
             addDetail(detail: string, meta?: any): any;
         };
     };
+    patchAction: {
+        _path: string;
+        create: (body: Service.PatchAction.Create.Body, params?: Service.PatchAction.Create.Params) => Promise<Service.PatchAction.Create.Result>;
+        update: (body: Service.PatchAction.Update.Body) => Promise<Service.PatchAction.Update.Result>;
+    };
 }

package/lib/index.js

@@ -614,6 +614,17 @@ export default class Repzo {
                 return res;
             },
         };
+        this.patchAction = {
+            _path: "/patch-action",
+            create: async (body, params) => {
+                const res = await this._create(this.svAPIEndpoint, this.patchAction._path, body, params);
+                return res;
+            },
+            update: async (body) => {
+                const res = await this._update(this.svAPIEndpoint, this.patchAction._path, body);
+                return res;
+            },
+        };
         this.svAPIEndpoint =
             !options?.env || options?.env == "production"
                 ? "https://sv.api.repzo.me"

package/lib/types/index.d.ts

@@ -2871,11 +2871,14 @@ export declare namespace Service {
                 origin_warehouse?: string[] | string;
                 custom_status?: string[] | string;
                 status?: InvoiceStatus | InvoiceStatus[];
-                is_void: false;
+                is_void?: false;
                 has_return?: boolean;
                 [key: string]: any;
                 populatedKeys?: PopulatedKeys[];
                 sortPage?: SortingKeys;
+                "serial_number.formatted"?: string[] | string;
+                "return_serial_number.formatted"?: string[] | string;
+                returned_from?: string[] | string;
             };
             interface Result extends DefaultPaginationResult {
                 data: InvoiceSchemaWithPopulatedKeys[];
@@ -4261,7 +4264,89 @@ export declare namespace Service {
         };
         app_category: string;
     }
+    namespace PatchAction {
+        type ReadOperator = "lte" | "lt" | "gte" | "gt" | "eq" | "ne" | "in" | "nin" | "search";
+        type WriteOperator = "set" | "addToSet" | "pull";
+        type Slug = "client" | "product" | "availability-msl" | "product-category" | "product-sub-category" | "product-brand" | "variant" | "product-group" | "msl" | "rep" | "line-classification" | "line" | "activity-storecheck" | "measureunits" | "promotions" | "tax" | "tag" | "warehouse" | "client-channel" | "measureunit-family" | "paymentterms";
+        interface ReadQuery {
+            /**
+             *  @type {string} filed to filter by
+             */
+            key: string;
+            value: string | string[] | [] | null | number | boolean | number[] | boolean[] | null[];
+            /**
+             * @type {string} Operator value set according to filter document and of enum type set according to each corresponding key
+             * @example {<"eq">}
+             */
+            operator: ReadOperator;
+        }
+        interface WriteQuery {
+            /**
+             *  @type {string} filed to filter by
+             */
+            key: string;
+            value: any;
+            /**
+             * @type {string} command value set according to filter document and of enum type set according to each corresponding key
+             * @example {<"addToSet">}
+             */
+            command: WriteOperator;
+        }
+        interface FormattedWriteQuery {
+            /**
+             *  @type {string} update $command key
+             */
+            [key: string]: {
+                /**
+                 *  @type {string }  update field key and update value
+                 */
+                [key: string]: any;
+            };
+        }
+        interface CreateBody {
+            /**
+             * @type {string} name of model (an enum value) as specified in patch-filter schema
+             */
+            slug: Slug;
+            /**
+             * @type {ReadQuery} an array of objects key sent in body to include read-filter keys, values and operators
+             * @example {<[ {key: "field_test", value: "ex_1", "operator": "eq"}, {key: "second_field", value: ["ex_2"], "operator": "in"} ]>}
+             */
+            readQuery: ReadQuery[];
+        }
+        interface UpdateBody {
+            /**
+             * @type {string} name of model (an enum value) as specified in patch-filter schema
+             */
+            slug: Slug;
+            /**
+             * @type {ReadQuery} an array of objects key sent in body to include read-filter keys, values and operators
+             * @example {<[ {key: "field_test", value: "ex_1", "operator": "eq"}, {key: "second_field", value: ["ex_2"], "operator": "in"} ]>}
+             */
+            readQuery: ReadQuery[];
+            /**
+             * @type {WriteQuery} an object sent in body to include write-filter key, value and an update command accordingly
+             * @example {<{ key: "field_test", value: "ex_1", "command": "set" }>}
+             */
+            writeQuery: WriteQuery | FormattedWriteQuery;
+        }
+        export namespace Create {
+            type Params = DefaultPaginationQueryParams & {
+                [key: string]: any;
+            };
+            type Body = CreateBody;
+            type Result = DefaultPaginationResult;
+        }
+        export namespace Update {
+            type Body = UpdateBody;
+            type Result = {
+                nFound: number;
+                nModified: number;
+            };
+        }
+        export {};
+    }
 }
-export declare type StringId = string;
-export declare type NameSpaces = string[];
+export type StringId = string;
+export type NameSpaces = string[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repzo",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "Repzo TypeScript SDK",
   "main": "./lib/index.js",
   "type": "module",

package/src/index.ts

@@ -1907,4 +1907,31 @@ export default class Repzo {
       return this;
     }
   };
+
+  patchAction = {
+    _path: "/patch-action",
+    create: async (
+      body: Service.PatchAction.Create.Body,
+      params?: Service.PatchAction.Create.Params
+    ): Promise<Service.PatchAction.Create.Result> => {
+      const res: Service.PatchAction.Create.Result = await this._create(
+        this.svAPIEndpoint,
+        this.patchAction._path,
+        body,
+        params
+      );
+      return res;
+    },
+
+    update: async (
+      body: Service.PatchAction.Update.Body
+    ): Promise<Service.PatchAction.Update.Result> => {
+      const res: Service.PatchAction.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.patchAction._path,
+        body
+      );
+      return res;
+    },
+  };
 }

package/src/types/index.ts

@@ -2962,11 +2962,14 @@ export namespace Service {
         origin_warehouse?: string[] | string;
         custom_status?: string[] | string;
         status?: InvoiceStatus | InvoiceStatus[];
-        is_void: false;
+        is_void?: false;
         has_return?: boolean;
         [key: string]: any; // integration_meta.
         populatedKeys?: PopulatedKeys[];
         sortPage?: SortingKeys;
+        "serial_number.formatted"?: string[] | string;
+        "return_serial_number.formatted"?: string[] | string;
+        returned_from?: string[] | string;
       };
       export interface Result extends DefaultPaginationResult {
         data: InvoiceSchemaWithPopulatedKeys[];
@@ -4333,6 +4336,129 @@ export namespace Service {
     app_settings: { repo: string; serviceEndPoint: string; meta: {} };
     app_category: string;
   }
+
+  export namespace PatchAction {
+    type ReadOperator =
+      | "lte"
+      | "lt"
+      | "gte"
+      | "gt"
+      | "eq"
+      | "ne"
+      | "in"
+      | "nin"
+      | "search";
+    type WriteOperator = "set" | "addToSet" | "pull";
+    type Slug =
+      | "client"
+      | "product"
+      | "availability-msl"
+      | "product-category"
+      | "product-sub-category"
+      | "product-brand"
+      | "variant"
+      | "product-group"
+      | "msl"
+      | "rep"
+      | "line-classification"
+      | "line"
+      | "activity-storecheck"
+      | "measureunits"
+      | "promotions"
+      | "tax"
+      | "tag"
+      | "warehouse"
+      | "client-channel"
+      | "measureunit-family"
+      | "paymentterms";
+
+    interface ReadQuery {
+      /**
+       *  @type {string} filed to filter by
+       */
+      key: string;
+      value:
+        | string
+        | string[]
+        | []
+        | null
+        | number
+        | boolean
+        | number[]
+        | boolean[]
+        | null[];
+      /**
+       * @type {string} Operator value set according to filter document and of enum type set according to each corresponding key
+       * @example {<"eq">}
+       */
+      operator: ReadOperator;
+    }
+    interface WriteQuery {
+      /**
+       *  @type {string} filed to filter by
+       */
+      key: string;
+      value: any;
+      /**
+       * @type {string} command value set according to filter document and of enum type set according to each corresponding key
+       * @example {<"addToSet">}
+       */
+      command: WriteOperator;
+    }
+    interface FormattedWriteQuery {
+      /**
+       *  @type {string} update $command key
+       */
+      [key: string]: {
+        /**
+         *  @type {string }  update field key and update value
+         */
+        [key: string]: any;
+      };
+    }
+    interface CreateBody {
+      /**
+       * @type {string} name of model (an enum value) as specified in patch-filter schema
+       */
+      slug: Slug;
+      /**
+       * @type {ReadQuery} an array of objects key sent in body to include read-filter keys, values and operators
+       * @example {<[ {key: "field_test", value: "ex_1", "operator": "eq"}, {key: "second_field", value: ["ex_2"], "operator": "in"} ]>}
+       */
+      readQuery: ReadQuery[];
+    }
+    interface UpdateBody {
+      /**
+       * @type {string} name of model (an enum value) as specified in patch-filter schema
+       */
+      slug: Slug;
+      /**
+       * @type {ReadQuery} an array of objects key sent in body to include read-filter keys, values and operators
+       * @example {<[ {key: "field_test", value: "ex_1", "operator": "eq"}, {key: "second_field", value: ["ex_2"], "operator": "in"} ]>}
+       */
+      readQuery: ReadQuery[];
+      /**
+       * @type {WriteQuery} an object sent in body to include write-filter key, value and an update command accordingly
+       * @example {<{ key: "field_test", value: "ex_1", "command": "set" }>}
+       */
+      writeQuery: WriteQuery | FormattedWriteQuery;
+    }
+
+    export namespace Create {
+      export type Params = DefaultPaginationQueryParams & {
+        [key: string]: any;
+      };
+      export type Body = CreateBody;
+      export type Result = DefaultPaginationResult;
+    }
+    export namespace Update {
+      export type Body = UpdateBody;
+      export type Result = {
+        nFound: number;
+        nModified: number;
+      };
+    }
+  }
 }
 
 export type StringId = string;