repzo 1.0.122 → 1.0.124

package/changelog.md

@@ -9,6 +9,7 @@
 - update FullInvoice with ubl keys @maramalshen
 - add: approval-request @maramalshen
 - add: workorder-request @maramalshen
+- add: approval @maramalshen
 
 ### Changed
 

package/lib/index.d.ts

@@ -93,6 +93,7 @@ export default class Repzo {
     readonly ASSET: "asset";
     readonly ASSET_UNIT: "asset-unit";
     readonly WORKORDER_PORTAL: "workorder-portal";
+    readonly APPROVAL: "approvals";
   };
   private _fetch;
   private _create;
@@ -1475,4 +1476,24 @@ export default class Repzo {
       id: Service.WorkorderPortal.Update.ID
     ) => Promise<Service.WorkorderPortal.Remove.Result>;
   };
+  approval: {
+    _path: "approvals";
+    find: (
+      params?: Service.Approval.Find.Params
+    ) => Promise<Service.Approval.Find.Result>;
+    get: (
+      id: Service.Approval.Get.ID,
+      params?: Service.Approval.Get.Params
+    ) => Promise<Service.Approval.Get.Result>;
+    create: (
+      body: Service.Approval.Create.Body
+    ) => Promise<Service.Approval.Create.Result>;
+    update: (
+      id: Service.Approval.Update.ID,
+      body: Service.Approval.Update.Body
+    ) => Promise<Service.Approval.Update.Result>;
+    remove: (
+      id: Service.Approval.Remove.ID
+    ) => Promise<Service.Approval.Remove.Result>;
+  };
 }

package/lib/index.js

@@ -82,6 +82,7 @@ export default class Repzo {
       ASSET: "asset",
       ASSET_UNIT: "asset-unit",
       WORKORDER_PORTAL: "workorder-portal",
+      APPROVAL: "approvals",
     };
     this.END_POINTS = this._end_points;
     this.client = {
@@ -2734,6 +2735,47 @@ export default class Repzo {
         return res;
       },
     };
+    this.approval = {
+      _path: this._end_points.APPROVAL,
+      find: async (params) => {
+        let res = await this._fetch(
+          this.svAPIEndpoint,
+          this.approval._path,
+          params
+        );
+        return res;
+      },
+      get: async (id, params) => {
+        return await this._fetch(
+          this.svAPIEndpoint,
+          this.approval._path + `/${id}`,
+          params
+        );
+      },
+      create: async (body) => {
+        let res = await this._create(
+          this.svAPIEndpoint,
+          this.approval._path,
+          body
+        );
+        return res;
+      },
+      update: async (id, body) => {
+        let res = await this._update(
+          this.svAPIEndpoint,
+          this.approval._path + `/${id}`,
+          body
+        );
+        return res;
+      },
+      remove: async (id) => {
+        let res = await this._delete(
+          this.svAPIEndpoint,
+          this.approval._path + `/${id}`
+        );
+        return res;
+      },
+    };
     this.svAPIEndpoint =
       !options?.env || options?.env == "production"
         ? "https://sv.api.repzo.me"

package/lib/types/index.d.ts

@@ -115,6 +115,10 @@ interface FormPopulated {
   _id: StringId;
   local_name?: string;
 }
+interface RetailExecutionTemplatePopulated {
+  _id: StringId;
+  name: string;
+}
 interface VisitMeta {
   geo_fence_setting_visit_start: boolean;
   geo_fence_setting_visit_end: boolean;
@@ -514,6 +518,8 @@ export declare namespace Service {
       enable_payment_terms_grace_period_days?: boolean;
       is_simplified?: boolean;
       last_login_time?: number;
+      assigned_forms_v2_templates?: string[];
+      retail_execution_templates?: string[];
       createdAt: string;
       updatedAt: string;
       __v: number;
@@ -585,6 +591,8 @@ export declare namespace Service {
       enable_payment_terms_grace_period_days?: boolean;
       is_simplified?: boolean;
       last_login_time?: number;
+      assigned_forms_v2_templates?: string[];
+      retail_execution_templates?: string[];
     }
     export type PopulatedKeys =
       | "tags"
@@ -601,7 +609,9 @@ export declare namespace Service {
       | "assigned_product_groups"
       | "speciality"
       | "teams"
-      | "contacts";
+      | "contacts"
+      | "retail_execution_templates"
+      | "assigned_forms_v2_templates";
     type ClientSchemaWithPopulatedKeys = ClientSchema & {
       assigned_products?:
         | string[]
@@ -621,6 +631,10 @@ export declare namespace Service {
         | string
         | Pick<Client.ClientSchema, "_id" | "name" | "client_code">;
       channel?: string | Channel.ChannelSchema;
+      assigned_forms_v2_templates?: string[] | FormPopulated[];
+      retail_execution_templates?:
+        | string[]
+        | RetailExecutionTemplatePopulated[];
     };
     export namespace Find {
       type Params = DefaultPaginationQueryParams & {
@@ -8107,6 +8121,184 @@ export declare namespace Service {
       type Result = SupplierSchema;
     }
   }
+  namespace Approval {
+    interface Data {
+      _id: StringId;
+      creator: AdminCreator;
+      name: string;
+      disabled: boolean;
+      company_namespace: string[];
+      type:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      position?: number;
+      description?: string;
+      rules: {
+        index: number;
+        name: string;
+        permissions: {
+          can_edit: boolean;
+        };
+        admins: {
+          _id: StringId;
+          name?: string;
+          type: "admin";
+        }[];
+        reps: {
+          _id: StringId;
+          name?: string;
+          type: "rep";
+        }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+      createdAt: Date;
+      updatedAt: Date;
+      __v: number;
+    }
+    interface CreateBody {
+      name: string;
+      type:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      creator?: AdminCreator;
+      disabled?: boolean;
+      company_namespace?: string[];
+      position?: number;
+      description?: string;
+      rules: {
+        index: number;
+        name: string;
+        permissions?: {
+          can_edit: boolean;
+        };
+        admins?: {
+          _id: StringId;
+          name?: string;
+          type: "admin";
+        }[];
+        reps?: {
+          _id: StringId;
+          name?: string;
+          type: "rep";
+        }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+    }
+    interface UpdateBody {
+      _id?: StringId;
+      creator?: AdminCreator;
+      name?: string;
+      disabled?: boolean;
+      company_namespace?: string[];
+      type?:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      position?: number;
+      description?: string;
+      rules?: {
+        index: number;
+        name: string;
+        permissions?: {
+          can_edit: boolean;
+        };
+        admins?: {
+          _id: StringId;
+          name?: string;
+          type: "admin";
+        }[];
+        reps?: {
+          _id: StringId;
+          name?: string;
+          type: "rep";
+        }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+      createdAt?: Date;
+      updatedAt?: Date;
+      __v?: number;
+    }
+    namespace Find {
+      type Params = DefaultPaginationQueryParams & {
+        _id?: StringId[] | StringId;
+        search?: string;
+        name?: string[] | string;
+        disabled?: boolean;
+        sortBy?: {
+          field: "_id" | "position" | "updatedAt";
+          type: "asc" | "desc";
+        }[];
+        [key: string]: any;
+      };
+      interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    namespace Get {
+      type ID = string;
+      type Params = {
+        [key: string]: any;
+      };
+      type Result = Data;
+    }
+    namespace Create {
+      type Body = CreateBody;
+      type Result = Data;
+    }
+    namespace Update {
+      type ID = string;
+      type Body = UpdateBody;
+      type Result = Data;
+    }
+    namespace Remove {
+      type ID = string;
+      type Result = Data;
+    }
+  }
   namespace Cycle {
     type CycleStatus = "pending" | "approved" | "processing" | "rejected";
     export interface Schema {
@@ -12915,6 +13107,11 @@ export declare namespace Service {
       createdAt: Date;
       updatedAt: Date;
     }
+    export type PopulatedDoc = Data & {
+      cycle?: Cycle.Schema & {
+        approval?: string | Approval.Data;
+      };
+    };
     export interface CreateBody {
       document_id?: StringId;
       document_type: "client" | "visit";
@@ -13119,10 +13316,12 @@ export declare namespace Service {
           field: "_id";
           type: "asc" | "desc";
         }[];
+        withCycle?: boolean;
+        populatedKeys?: ["approval"];
         [key: string]: any;
       };
       interface Result extends DefaultPaginationResult {
-        data: Data[];
+        data: Data[] | PopulatedDoc[];
       }
     }
     export namespace Get {
@@ -13132,10 +13331,13 @@ export declare namespace Service {
         validityCheck?: boolean;
         originalDoc_populatedKeys?: PopulatedKeys[];
         withOriginalDoc?: boolean;
+        populatedKeys?: ["approval"];
         [key: string]: any;
       };
       type Result = Data & {
-        cycle?: Cycle.Schema;
+        cycle?: Cycle.Schema & {
+          approval?: string | Approval.Data;
+        };
         original_doc?: Client.ClientSchema | Visit.VisitSchema;
       };
     }

package/package.json

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

package/src/index.ts

@@ -117,6 +117,7 @@ export default class Repzo {
     ASSET: "asset",
     ASSET_UNIT: "asset-unit",
     WORKORDER_PORTAL: "workorder-portal",
+    APPROVAL: "approvals",
   } as const;
   public END_POINTS = this._end_points;
   private async _fetch(baseUrl: string, path: string, params?: Params) {
@@ -4147,6 +4148,60 @@ export default class Repzo {
       return res;
     },
   };
+
+  approval = {
+    _path: this._end_points.APPROVAL,
+    find: async (
+      params?: Service.Approval.Find.Params
+    ): Promise<Service.Approval.Find.Result> => {
+      let res: Service.Approval.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.approval._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Approval.Get.ID,
+      params?: Service.Approval.Get.Params
+    ): Promise<Service.Approval.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.approval._path + `/${id}`,
+        params
+      );
+    },
+    create: async (
+      body: Service.Approval.Create.Body
+    ): Promise<Service.Approval.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.approval._path,
+        body
+      );
+      return res;
+    },
+    update: async (
+      id: Service.Approval.Update.ID,
+      body: Service.Approval.Update.Body
+    ): Promise<Service.Approval.Update.Result> => {
+      let res: Service.Approval.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.approval._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.Approval.Remove.ID
+    ): Promise<Service.Approval.Remove.Result> => {
+      let res: Service.Approval.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.approval._path + `/${id}`
+      );
+      return res;
+    },
+  };
 }
 
 function normalizeParams(params: Params): { [key: string]: any } {

package/src/types/index.ts

@@ -118,6 +118,10 @@ interface FormPopulated {
   _id: StringId;
   local_name?: string;
 }
+interface RetailExecutionTemplatePopulated {
+  _id: StringId;
+  name: string;
+}
 interface VisitMeta {
   geo_fence_setting_visit_start: boolean;
   geo_fence_setting_visit_end: boolean;
@@ -518,6 +522,8 @@ export namespace Service {
       enable_payment_terms_grace_period_days?: boolean;
       is_simplified?: boolean;
       last_login_time?: number;
+      assigned_forms_v2_templates?: string[];
+      retail_execution_templates?: string[];
       createdAt: string;
       updatedAt: string;
       __v: number;
@@ -585,6 +591,8 @@ export namespace Service {
       enable_payment_terms_grace_period_days?: boolean;
       is_simplified?: boolean;
       last_login_time?: number;
+      assigned_forms_v2_templates?: string[];
+      retail_execution_templates?: string[];
     }
     export type PopulatedKeys =
       | "tags"
@@ -601,7 +609,9 @@ export namespace Service {
       | "assigned_product_groups"
       | "speciality"
       | "teams"
-      | "contacts";
+      | "contacts"
+      | "retail_execution_templates"
+      | "assigned_forms_v2_templates";
 
     type ClientSchemaWithPopulatedKeys = ClientSchema & {
       assigned_products?:
@@ -622,6 +632,10 @@ export namespace Service {
         | string
         | Pick<Client.ClientSchema, "_id" | "name" | "client_code">;
       channel?: string | Channel.ChannelSchema;
+      assigned_forms_v2_templates?: string[] | FormPopulated[];
+      retail_execution_templates?:
+        | string[]
+        | RetailExecutionTemplatePopulated[];
     };
 
     export namespace Find {
@@ -7986,6 +8000,155 @@ export namespace Service {
     }
   }
 
+  export namespace Approval {
+    export interface Data {
+      _id: StringId;
+      creator: AdminCreator;
+      name: string;
+      disabled: boolean;
+      company_namespace: string[];
+      type:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      position?: number;
+      description?: string;
+      rules: {
+        index: number;
+        name: string;
+        permissions: { can_edit: boolean };
+        admins: { _id: StringId; name?: string; type: "admin" }[];
+        reps: { _id: StringId; name?: string; type: "rep" }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+      createdAt: Date;
+      updatedAt: Date;
+      __v: number;
+    }
+
+    export interface CreateBody {
+      name: string;
+      type:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      creator?: AdminCreator;
+      disabled?: boolean;
+      company_namespace?: string[];
+      position?: number;
+      description?: string;
+      rules: {
+        index: number;
+        name: string;
+        permissions?: { can_edit: boolean };
+        admins?: { _id: StringId; name?: string; type: "admin" }[];
+        reps?: { _id: StringId; name?: string; type: "rep" }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+    }
+    export interface UpdateBody {
+      _id?: StringId;
+      creator?: AdminCreator;
+      name?: string;
+      disabled?: boolean;
+      company_namespace?: string[];
+      type?:
+        | "proforma"
+        | "transfer"
+        | "approval-request"
+        | "receiving-material"
+        | "asset-part-transfer"
+        | "adjust-inventory"
+        | "return-asset-part-unit"
+        | "store-asset-part-unit";
+      position?: number;
+      description?: string;
+      rules?: {
+        index: number;
+        name: string;
+        permissions?: { can_edit: boolean };
+        admins?: { _id: StringId; name?: string; type: "admin" }[];
+        reps?: { _id: StringId; name?: string; type: "rep" }[];
+        append_creator?: boolean;
+        append_assigned_origin_warehouse_rep?: boolean;
+        append_assigned_destination_warehouse_rep?: boolean;
+        send_email?: boolean;
+      }[];
+      filters?: {
+        key: string;
+        operator: "eq" | "ne" | "in" | "nin" | "gt" | "gte" | "lt" | "lte";
+        value: any[];
+        manipulator_function?: string;
+      }[];
+      createdAt?: Date;
+      updatedAt?: Date;
+      __v?: number;
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId[] | StringId;
+        search?: string;
+        name?: string[] | string;
+        disabled?: boolean;
+        sortBy?: {
+          field: "_id" | "position" | "updatedAt";
+          type: "asc" | "desc";
+        }[];
+        [key: string]: any; // integration_meta.
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export type Params = { [key: string]: any };
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = string;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = string;
+      export type Result = Data;
+    }
+  }
+
   export namespace Cycle {
     type CycleStatus = "pending" | "approved" | "processing" | "rejected";
     export interface Schema {
@@ -12451,7 +12614,9 @@ export namespace Service {
       createdAt: Date;
       updatedAt: Date;
     }
-
+    export type PopulatedDoc = Data & {
+      cycle?: Cycle.Schema & { approval?: string | Approval.Data };
+    };
     export interface CreateBody {
       document_id?: StringId;
       document_type: "client" | "visit";
@@ -12645,10 +12810,12 @@ export namespace Service {
         "meta.business_day": string | string[];
         "meta.form._id": StringId | StringId[];
         sortBy?: { field: "_id"; type: "asc" | "desc" }[];
+        withCycle?: boolean;
+        populatedKeys?: ["approval"];
         [key: string]: any; // integration_meta.
       };
       export interface Result extends DefaultPaginationResult {
-        data: Data[];
+        data: Data[] | PopulatedDoc[];
       }
     }
     export namespace Get {
@@ -12658,10 +12825,11 @@ export namespace Service {
         validityCheck?: boolean;
         originalDoc_populatedKeys?: PopulatedKeys[];
         withOriginalDoc?: boolean;
+        populatedKeys?: ["approval"];
         [key: string]: any; // integration_meta.
       };
       export type Result = Data & {
-        cycle?: Cycle.Schema;
+        cycle?: Cycle.Schema & { approval?: string | Approval.Data };
         original_doc?: Client.ClientSchema | Visit.VisitSchema;
       };
     }