repzo 1.0.30 → 1.0.31

package/lib/index.d.ts

@@ -193,6 +193,13 @@ export default class Repzo {
         create: (body: Service.QuickConvertToPdf.Create.Body) => Promise<Service.QuickConvertToPdf.Create.Result>;
         remove: (id: Service.QuickConvertToPdf.Remove.ID) => Promise<Service.QuickConvertToPdf.Remove.Result>;
     };
+    visit: {
+        _path: string;
+        find: (params?: Service.Visit.Find.Params) => Promise<Service.Visit.Find.Result>;
+        get: (id: Service.Visit.Get.ID, params?: Service.Visit.Get.Params) => Promise<Service.Visit.Get.Result>;
+        create: (body: Service.Visit.Create.Body) => Promise<Service.Visit.Create.Result>;
+        update: (id: Service.Visit.Update.ID, body: Service.Visit.Update.Body) => Promise<Service.Visit.Update.Result>;
+    };
     invoice: {
         _path: string;
         find: (params?: Service.FullInvoice.Find.Params) => Promise<Service.FullInvoice.Find.Result>;

package/lib/index.js

@@ -506,6 +506,24 @@ export default class Repzo {
                 return res;
             },
         };
+        this.visit = {
+            _path: "/visit",
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.visit._path, params);
+                return res;
+            },
+            get: async (id, params) => {
+                return await this._fetch(this.svAPIEndpoint, this.visit._path + `/${id}`, params);
+            },
+            create: async (body) => {
+                let res = await this._create(this.svAPIEndpoint, this.visit._path, body);
+                return res;
+            },
+            update: async (id, body) => {
+                let res = await this._update(this.svAPIEndpoint, this.visit._path + `/${id}`, body);
+                return res;
+            },
+        };
         this.invoice = {
             _path: "/fullinvoices",
             find: async (params) => {

package/lib/types/index.d.ts

@@ -16,6 +16,13 @@ export interface Headers {
     Accept: string;
     [key: string]: string;
 }
+interface ActivityComment {
+    time: number;
+    user_name: string;
+    user_id: string;
+    user_type: string;
+    comment: string;
+}
 interface AdminCreator {
     _id: string;
     type: "admin";
@@ -89,6 +96,15 @@ interface ClientLocationPopulated {
 interface FormPopulated {
     name: string;
 }
+interface VisitMeta {
+    geo_fence_setting_visit_start: boolean;
+    geo_fence_setting_visit_end: boolean;
+    geo_fence_setting_radius: number;
+    offline_mode: boolean;
+    start_visit_in_fence: boolean;
+    end_visit_in_fence: boolean;
+    client_verified: boolean;
+}
 interface thumbnailStoragePopulated {
     _id: string;
     createdAt: string;
@@ -224,6 +240,11 @@ export interface MediaDoc {
     region: string;
     time: number;
 }
+export interface GeoTag {
+    lat: number;
+    lng: number;
+    formatted_address: string;
+}
 export declare namespace Service {
     namespace Client {
         interface Financials {
@@ -2471,6 +2492,313 @@ export declare namespace Service {
         }
         export {};
     }
+    namespace Visit {
+        export interface VisitSchema {
+            geoPoint: {
+                type: "Point";
+                coordinates: number[];
+            };
+            start_geo_tag: GeoTag;
+            end_geo_tag: GeoTag;
+            route: string;
+            time: number;
+            user: Rep.RepSchema;
+            tags: Tag.TagBody[];
+            client: string;
+            client_name: string;
+            client_location_verified?: boolean;
+            user_name?: string;
+            visit_id: string;
+            sync_id?: string;
+            start_time: number;
+            end_time: number;
+            business_day_rep?: string;
+            business_day: string;
+            call_start_time?: number;
+            call_end_time?: number;
+            call_total_time?: number;
+            total_time: number;
+            platform: string;
+            version_name: string;
+            battery_level: number;
+            device_brand?: string;
+            device_os?: string;
+            device_os_version?: string;
+            device_model?: string;
+            time_zone?: string;
+            identifier?: number;
+            device_id?: string;
+            device_unique_id?: string;
+            type?: string;
+            notes?: string[];
+            photos?: string[];
+            forms?: string[];
+            teams?: string[];
+            tasks?: string[];
+            audits?: string[];
+            network_state?: number;
+            distance?: number;
+            start_distance?: number;
+            end_distance?: number;
+            delta_distance?: number;
+            start_out_of_geofence?: boolean;
+            end_out_of_geofence?: boolean;
+            start_accuracy?: number;
+            end_accuracy?: number;
+            closed_by_system?: boolean;
+            meta: VisitMeta;
+            lines?: string[];
+            client_geo_location: {
+                type: {
+                    lat: Number;
+                    lng: Number;
+                };
+            };
+            geofencing_radius?: number;
+            availability?: string[];
+            selected_product_lines: Line.LineSchema[];
+            workorder: Workorder.WorkorderSchema;
+            asset?: string;
+            asset_unit?: string;
+            auto_closed_by_geofence?: boolean;
+            auto_closed_by_geofence_reason: "out_of_geofence" | "low_accuracy" | "location_turned_off";
+            company_namespace: string[];
+        }
+        export interface CreateBody {
+            geoPoint: {
+                type: "Point";
+                coordinates: number[];
+            };
+            start_geo_tag: GeoTag;
+            route: string;
+            time: number;
+            user: Rep.RepSchema;
+            tags: Tag.TagBody[];
+            client: string;
+            client_name: string;
+            client_location_verified?: boolean;
+            user_name?: string;
+            visit_id: string;
+            sync_id?: string;
+            start_time: number;
+            business_day_rep?: string;
+            business_day: string;
+            platform: string;
+            version_name: string;
+            battery_level: number;
+            device_brand?: string;
+            device_os?: string;
+            device_os_version?: string;
+            device_model?: string;
+            time_zone?: string;
+            identifier?: number;
+            device_id?: string;
+            device_unique_id?: string;
+            type?: string;
+            network_state?: number;
+            distance?: number;
+            start_distance?: number;
+            start_accuracy?: number;
+            meta: VisitMeta;
+            lines?: string[];
+            client_geo_location: {
+                type: {
+                    lat: Number;
+                    lng: Number;
+                };
+            };
+            geofencing_radius?: number;
+            availability?: string[];
+            workorder: Workorder.WorkorderSchema;
+            asset?: string;
+            asset_unit?: string;
+            company_namespace: string[];
+        }
+        export interface UpdateBody {
+            geoPoint?: {
+                type: "Point";
+                coordinates: number[];
+            };
+            end_geo_tag?: GeoTag;
+            route?: string;
+            time?: number;
+            user?: Rep.RepSchema;
+            tags?: Tag.TagBody[];
+            client?: string;
+            client_name?: string;
+            client_location_verified?: boolean;
+            user_name?: string;
+            visit_id?: string;
+            sync_id?: string;
+            end_time?: number;
+            business_day_rep?: string;
+            business_day?: string;
+            call_start_time?: number;
+            call_end_time?: number;
+            call_total_time?: number;
+            total_time?: number;
+            platform?: string;
+            version_name?: string;
+            battery_level?: number;
+            device_brand?: string;
+            device_os?: string;
+            device_os_version?: string;
+            device_model?: string;
+            time_zone?: string;
+            identifier?: number;
+            device_id?: string;
+            device_unique_id?: string;
+            type?: string;
+            notes?: string[];
+            photos?: string[];
+            forms?: string[];
+            teams?: string[];
+            tasks?: string[];
+            audits?: string[];
+            network_state?: number;
+            distance?: number;
+            end_distance?: number;
+            delta_distance?: number;
+            end_out_of_geofence?: boolean;
+            end_accuracy?: number;
+            closed_by_system?: boolean;
+            meta: VisitMeta;
+            lines?: string[];
+            client_geo_location?: {
+                type: {
+                    lat: Number;
+                    lng: Number;
+                };
+            };
+            geofencing_radius?: number;
+            availability?: string[];
+            selected_product_lines?: Line.LineSchema[];
+            workorder?: Workorder.WorkorderSchema;
+            asset?: string;
+            asset_unit?: string;
+            auto_closed_by_geofence?: boolean;
+            auto_closed_by_geofence_reason?: "out_of_geofence" | "low_accuracy" | "location_turned_off";
+            company_namespace: string[];
+        }
+        type VisitSchemaWithPopulatedKeys = {
+            notes: {
+                content: string;
+                geo_tag: GeoTag;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                comments: ActivityComment[];
+            };
+            tasks: {
+                start_photo: string;
+                end_photo: string;
+                start_media: MediaDoc;
+                end_media: MediaDoc;
+                geo_tag: GeoTag;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                start_time: number;
+                end_time: number;
+                total_time: number;
+                comments: ActivityComment[];
+            };
+            photos: {
+                photo: string;
+                media: MediaDoc;
+                geo_tag: GeoTag;
+                caption: string;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                comments: ActivityComment[];
+            };
+            forms: {
+                results: {
+                    [key: string]: any;
+                };
+                form_id: string;
+                geo_tag: GeoTag;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                comments: ActivityComment[];
+            };
+            audits: {
+                audits: {
+                    inventories: {
+                        media: MediaDoc;
+                    };
+                };
+                geo_tag: GeoTag;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                comments: ActivityComment[];
+            };
+            availability: {
+                products_available: {
+                    product_id: Pick<Product.ProductSchema, "_id">;
+                    available: boolean;
+                };
+                media: MediaDoc;
+                geo_tag: GeoTag;
+                time: number;
+                platform: string;
+                version_name: string;
+                battery_level: number;
+                comment: ActivityComment[];
+            };
+            tags: string | Tag.TagSchema;
+        };
+        export namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                user?: string;
+                from_time?: number;
+                to_time?: number;
+                client?: string;
+                route?: string;
+                teams?: string[];
+                company_namespace?: string;
+                tags?: string[];
+                CLIENT_TAGS?: string[];
+                AREA_TAGS?: string;
+                availability?: string[];
+                visit_id?: string;
+                from_total_time?: number;
+                to_total_time?: number;
+                closed_by_system?: boolean;
+            };
+            interface Result extends DefaultPaginationResult {
+                data: VisitSchema[];
+                absolute_total: number;
+                page_total: number;
+            }
+        }
+        type PopulatedKeys = "notes" | "tasks" | "photos" | "forms" | "audits" | "tags" | "availability";
+        export namespace Create {
+            type Body = CreateBody;
+            type Result = VisitSchema;
+        }
+        export namespace Get {
+            type ID = string;
+            interface Params {
+                populatedKeys?: PopulatedKeys[];
+            }
+            type Result = VisitSchemaWithPopulatedKeys;
+        }
+        export namespace Update {
+            type ID = string;
+            type Body = UpdateBody;
+            type Result = VisitSchema;
+        }
+        export {};
+    }
     namespace Workorder {
         export interface WorkorderSchema {
             _id: string;

package/package.json

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

package/src/index.ts

@@ -1259,6 +1259,7 @@ export default class Repzo {
       );
     },
   };
+
   quickConvertToPdf = {
     _path: "/quick-convert-to-pdf",
     find: async (
@@ -1301,6 +1302,47 @@ export default class Repzo {
       return res;
     },
   };
+  visit = {
+    _path: "/visit",
+    find: async (
+      params?: Service.Visit.Find.Params
+    ): Promise<Service.Visit.Find.Result> => {
+      let res: Service.Visit.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.visit._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Visit.Get.ID,
+      params?: Service.Visit.Get.Params
+    ): Promise<Service.Visit.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.visit._path + `/${id}`,
+        params
+      );
+    },
+    create: async (
+      body: Service.Visit.Create.Body
+    ): Promise<Service.Visit.Create.Result> => {
+      let res = await this._create(this.svAPIEndpoint, this.visit._path, body);
+      return res;
+    },
+
+    update: async (
+      id: Service.Visit.Update.ID,
+      body: Service.Visit.Update.Body
+    ): Promise<Service.Visit.Update.Result> => {
+      let res: Service.Visit.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.visit._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+  };
   invoice = {
     _path: "/fullinvoices",
     find: async (

package/src/types/index.ts

@@ -16,6 +16,14 @@ export interface Headers {
   [key: string]: string;
 }
 
+interface ActivityComment {
+  time: number;
+  user_name: string;
+  user_id: string;
+  user_type: string;
+  comment: string;
+}
+
 interface AdminCreator {
   _id: string;
   type: "admin";
@@ -90,6 +98,15 @@ interface ClientLocationPopulated {
 interface FormPopulated {
   name: string;
 }
+interface VisitMeta {
+  geo_fence_setting_visit_start: boolean;
+  geo_fence_setting_visit_end: boolean;
+  geo_fence_setting_radius: number;
+  offline_mode: boolean;
+  start_visit_in_fence: boolean;
+  end_visit_in_fence: boolean;
+  client_verified: boolean;
+}
 interface thumbnailStoragePopulated {
   _id: string;
   createdAt: string;
@@ -113,6 +130,7 @@ interface thumbnailStoragePopulated {
     | " images"
     | "zip";
 }
+
 interface MediaPopulated {
   _id: string;
   media_type:
@@ -342,6 +360,12 @@ export interface MediaDoc {
   region: string;
   time: number;
 }
+
+export interface GeoTag {
+  lat: number;
+  lng: number;
+  formatted_address: string;
+}
 // <reference path = "vehicle.ts" />
 export namespace Service {
   export namespace Client {
@@ -2708,6 +2732,324 @@ export namespace Service {
     }
   }
 
+  export namespace Visit {
+    export interface VisitSchema {
+      geoPoint: {
+        type: "Point";
+        coordinates: number[];
+      };
+      start_geo_tag: GeoTag;
+      end_geo_tag: GeoTag;
+      route: string;
+      time: number;
+      user: Rep.RepSchema;
+      tags: Tag.TagBody[];
+      client: string;
+      client_name: string;
+      client_location_verified?: boolean;
+      user_name?: string;
+      visit_id: string;
+      sync_id?: string;
+      start_time: number;
+      end_time: number;
+      business_day_rep?: string;
+      business_day: string;
+      call_start_time?: number;
+      call_end_time?: number;
+      call_total_time?: number;
+      total_time: number;
+      platform: string;
+      version_name: string;
+      battery_level: number;
+      device_brand?: string;
+      device_os?: string;
+      device_os_version?: string;
+      device_model?: string;
+      time_zone?: string;
+      identifier?: number;
+      device_id?: string;
+      device_unique_id?: string;
+      type?: string;
+      notes?: string[];
+      photos?: string[];
+      forms?: string[];
+      teams?: string[];
+      tasks?: string[];
+      audits?: string[];
+      network_state?: number;
+      distance?: number;
+      start_distance?: number;
+      end_distance?: number;
+      delta_distance?: number;
+      start_out_of_geofence?: boolean;
+      end_out_of_geofence?: boolean;
+      start_accuracy?: number;
+      end_accuracy?: number;
+      closed_by_system?: boolean;
+      meta: VisitMeta;
+      lines?: string[];
+      client_geo_location: {
+        type: {
+          lat: Number;
+          lng: Number;
+        };
+      };
+      geofencing_radius?: number;
+      availability?: string[];
+      selected_product_lines: Line.LineSchema[];
+      workorder: Workorder.WorkorderSchema;
+      asset?: string;
+      asset_unit?: string;
+      auto_closed_by_geofence?: boolean;
+      auto_closed_by_geofence_reason:
+        | "out_of_geofence"
+        | "low_accuracy"
+        | "location_turned_off";
+      company_namespace: string[];
+    }
+    export interface CreateBody {
+      geoPoint: {
+        type: "Point";
+        coordinates: number[];
+      };
+      start_geo_tag: GeoTag;
+      route: string;
+      time: number;
+      user: Rep.RepSchema;
+      tags: Tag.TagBody[];
+      client: string;
+      client_name: string;
+      client_location_verified?: boolean;
+      user_name?: string;
+      visit_id: string;
+      sync_id?: string;
+      start_time: number;
+      business_day_rep?: string;
+      business_day: string;
+      platform: string;
+      version_name: string;
+      battery_level: number;
+      device_brand?: string;
+      device_os?: string;
+      device_os_version?: string;
+      device_model?: string;
+      time_zone?: string;
+      identifier?: number;
+      device_id?: string;
+      device_unique_id?: string;
+      type?: string;
+      network_state?: number;
+      distance?: number;
+      start_distance?: number;
+      start_accuracy?: number;
+      meta: VisitMeta;
+      lines?: string[];
+      client_geo_location: {
+        type: {
+          lat: Number;
+          lng: Number;
+        };
+      };
+      geofencing_radius?: number;
+      availability?: string[];
+      workorder: Workorder.WorkorderSchema;
+      asset?: string;
+      asset_unit?: string;
+      company_namespace: string[];
+    }
+    export interface UpdateBody {
+      geoPoint?: {
+        type: "Point";
+        coordinates: number[];
+      };
+      end_geo_tag?: GeoTag;
+      route?: string;
+      time?: number;
+      user?: Rep.RepSchema;
+      tags?: Tag.TagBody[];
+      client?: string;
+      client_name?: string;
+      client_location_verified?: boolean;
+      user_name?: string;
+      visit_id?: string;
+      sync_id?: string;
+      end_time?: number;
+      business_day_rep?: string;
+      business_day?: string;
+      call_start_time?: number;
+      call_end_time?: number;
+      call_total_time?: number;
+      total_time?: number;
+      platform?: string;
+      version_name?: string;
+      battery_level?: number;
+      device_brand?: string;
+      device_os?: string;
+      device_os_version?: string;
+      device_model?: string;
+      time_zone?: string;
+      identifier?: number;
+      device_id?: string;
+      device_unique_id?: string;
+      type?: string;
+      notes?: string[];
+      photos?: string[];
+      forms?: string[];
+      teams?: string[];
+      tasks?: string[];
+      audits?: string[];
+      network_state?: number;
+      distance?: number;
+      end_distance?: number;
+      delta_distance?: number;
+      end_out_of_geofence?: boolean;
+      end_accuracy?: number;
+      closed_by_system?: boolean;
+      meta: VisitMeta;
+      lines?: string[];
+      client_geo_location?: {
+        type: {
+          lat: Number;
+          lng: Number;
+        };
+      };
+      geofencing_radius?: number;
+      availability?: string[];
+      selected_product_lines?: Line.LineSchema[];
+      workorder?: Workorder.WorkorderSchema;
+      asset?: string;
+      asset_unit?: string;
+      auto_closed_by_geofence?: boolean;
+      auto_closed_by_geofence_reason?:
+        | "out_of_geofence"
+        | "low_accuracy"
+        | "location_turned_off";
+      company_namespace: string[];
+    }
+    type VisitSchemaWithPopulatedKeys = {
+      notes: {
+        content: string;
+        geo_tag: GeoTag;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        comments: ActivityComment[];
+      };
+      tasks: {
+        start_photo: string;
+        end_photo: string;
+        start_media: MediaDoc;
+        end_media: MediaDoc;
+        geo_tag: GeoTag;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        start_time: number;
+        end_time: number;
+        total_time: number;
+        comments: ActivityComment[];
+      };
+      photos: {
+        photo: string;
+        media: MediaDoc;
+        geo_tag: GeoTag;
+        caption: string;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        comments: ActivityComment[];
+      };
+      forms: {
+        results: { [key: string]: any };
+        form_id: string;
+        geo_tag: GeoTag;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        comments: ActivityComment[];
+      };
+      audits: {
+        audits: {
+          inventories: {
+            media: MediaDoc;
+          };
+        };
+        geo_tag: GeoTag;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        comments: ActivityComment[];
+      };
+      availability: {
+        products_available: {
+          product_id: Pick<Product.ProductSchema, "_id">;
+          available: boolean;
+        };
+        media: MediaDoc;
+        geo_tag: GeoTag;
+        time: number;
+        platform: string;
+        version_name: string;
+        battery_level: number;
+        comment: ActivityComment[];
+      };
+      tags: string | Tag.TagSchema;
+    };
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        user?: string;
+        from_time?: number;
+        to_time?: number;
+        client?: string;
+        route?: string;
+        teams?: string[];
+        company_namespace?: string;
+        tags?: string[];
+        CLIENT_TAGS?: string[];
+        AREA_TAGS?: string;
+        availability?: string[];
+        visit_id?: string;
+        from_total_time?: number;
+        to_total_time?: number;
+        closed_by_system?: boolean;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: VisitSchema[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+    type PopulatedKeys =
+      | "notes"
+      | "tasks"
+      | "photos"
+      | "forms"
+      | "audits"
+      | "tags"
+      | "availability";
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = VisitSchema;
+    }
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        populatedKeys?: PopulatedKeys[];
+      }
+      export type Result = VisitSchemaWithPopulatedKeys;
+    }
+    export namespace Update {
+      export type ID = string;
+      export type Body = UpdateBody;
+      export type Result = VisitSchema;
+    }
+  }
+
   export namespace Workorder {
     export interface WorkorderSchema {
       _id: string;

package/test.ts

@@ -0,0 +1,8 @@
+import Repzo from "./src/index.js";
+let repzo = new Repzo("");
+let clients = repzo.client.find({ search: "Mecca" });
+console.log(clients);
+repzo.client.create({ name: "kf" });
+repzo.headers["ho"] = "faf";
+repzo.client.update("", {});
+// repzo.

package/test.js

@@ -1,11 +0,0 @@
-import Repzo from "./lib/index.js";
-// import Repzo from "repzo"
-let repzo = new Repzo("qOIWZDYSjObf5W1Pti3efUM1D6S9vaqk8I_GoxOLnas");
-let workorders = await repzo.workorder.get("63832c86180e66bcde05a49c")
-console.log(workorders);
-// let clients = repzo.client.find({ search: "Mecca" });
-// console.log(clients);
-// repzo.client.create({ name: "kf" });
-// repzo.headers["ho"] = "faf";
-// repzo.client.update("", {});
-// repzo.