repzo 1.0.23 → 1.0.25

package/changelog.md

@@ -17,6 +17,7 @@
 - add Service: BankList @maramalshen
 - Update JoinActionsWeHook.JoinData @maramalshen
 - Patch Action @maramalshen
+- UpdateIntegrationMeta @maramalshen
 
 ### Changed
 

package/lib/index.d.ts

@@ -181,6 +181,11 @@ export default class Repzo {
         update: (id: Service.CustomStatus.Update.ID, body: Service.CustomStatus.Update.Body) => Promise<Service.CustomStatus.Update.Result>;
         remove: (id: Service.CustomStatus.Remove.ID) => Promise<Service.CustomStatus.Remove.Result>;
     };
+    workorder: {
+        _path: string;
+        find: (params?: Service.Workorder.Find.Params) => Promise<Service.Workorder.Find.Result>;
+        get: (id: Service.Workorder.Get.ID, params?: Service.Workorder.Get.Params) => Promise<Service.Workorder.Get.Result>;
+    };
     invoice: {
         _path: string;
         find: (params?: Service.FullInvoice.Find.Params) => Promise<Service.FullInvoice.Find.Result>;
@@ -309,4 +314,8 @@ export default class Repzo {
         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>;
     };
+    updateIntegrationMeta: {
+        _path: string;
+        create: (body: Service.UpdateIntegrationMeta.Create.Body, params?: Service.UpdateIntegrationMeta.Create.Params) => Promise<Service.UpdateIntegrationMeta.Create.Result>;
+    };
 }

package/lib/index.js

@@ -478,6 +478,16 @@ export default class Repzo {
                 return res;
             },
         };
+        this.workorder = {
+            _path: "/workorder",
+            find: async (params) => {
+                let res = await this._fetch(this.svAPIEndpoint, this.workorder._path, params);
+                return res;
+            },
+            get: async (id, params) => {
+                return await this._fetch(this.svAPIEndpoint, this.workorder._path + `/${id}`, params);
+            },
+        };
         this.invoice = {
             _path: "/fullinvoices",
             find: async (params) => {
@@ -625,6 +635,13 @@ export default class Repzo {
                 return res;
             },
         };
+        this.updateIntegrationMeta = {
+            _path: "/update-integration-meta",
+            create: async (body, params) => {
+                let res = await this._create(this.svAPIEndpoint, this.updateIntegrationMeta._path, body, params);
+                return res;
+            },
+        };
         this.svAPIEndpoint =
             !options?.env || options?.env == "production"
                 ? "https://sv.api.repzo.me"

package/lib/types/index.d.ts

@@ -71,12 +71,57 @@ interface Check {
     };
     disabled?: boolean;
 }
+interface AssetUnitsPopulated {
+    name: string;
+    cover_photo: MediaPopulated;
+}
+interface AssetsPopulated {
+    name: string;
+    cover_photo: MediaPopulated;
+}
+interface RepresentativesPopulated {
+    name: string;
+    _id: string;
+}
+interface ClientLocationPopulated {
+    name: string;
+}
+interface FormPopulated {
+    name: string;
+}
+interface thumbnailStoragePopulated {
+    _id: string;
+    createdAt: string;
+    ContentType: string;
+    mime_type: string;
+    publicUrl: string;
+    type_name: "FileAttachment" | "ImageAttachment";
+    file_name: string;
+    media_id: string;
+    media_type: "csv" | "json" | "image" | "pdf" | " ppt" | "pptx" | "xls" | "xlsx" | "doc" | "docx" | " images" | "zip";
+}
+interface MediaPopulated {
+    _id: string;
+    media_type: "csv" | "json" | "image" | "pdf" | " ppt" | "pptx" | "xls" | "xlsx" | "doc" | "docx" | " images" | "zip";
+    mime_type: string;
+    publicUrl: string;
+    file_name: string;
+    type_name: "FileAttachment" | "ImageAttachment";
+    media_id: string;
+    ContentType: string;
+    createdAt: string;
+    updatedAt: string;
+    thumbnails: thumbnailStoragePopulated;
+}
 export interface DefaultPaginationQueryParams {
     per_page?: number;
     page?: number;
     sort?: string;
     sortPageOrder?: "asc" | "dsc";
 }
+interface WorkorderCategoryPopulated {
+    name: string;
+}
 export interface DefaultPaginationResult {
     total_result: number;
     current_count: number;
@@ -90,6 +135,64 @@ export interface DefaultPaginationResult {
     path: string;
     data: any[];
 }
+export interface List {
+    client: string | {
+        _id: string;
+    };
+    note?: string;
+    route?: string;
+    calendar: string;
+}
+export interface Build {
+    day: string;
+    list: List[];
+    start_date?: number | undefined;
+}
+export type Calendar = CalendarWeekly | CalendarWeeklyGroup;
+export interface Route {
+    disabled: boolean;
+    list: List[];
+    _id: string;
+}
+export type Priority = 0 | 1 | 2 | 3;
+export type WorkorderStatus = "open" | "done" | "cancelled" | "inprogress" | "onhold";
+export type Priority_human = "none" | "low" | "medium" | "high";
+export type Day = "Sun" | "Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat" | string;
+export interface WeeklyDetails {
+    every: number;
+    days: Day[];
+}
+export interface CalendarWeekly {
+    type: "weekly";
+    disabled: boolean;
+    startsAt: string;
+    endsAt: string;
+    details: WeeklyDetails;
+    occurrences: number;
+    routes: Route[];
+    clients: string[] | string;
+    note?: string;
+    _id: string;
+}
+export interface DaysGroup {
+    days: Day[];
+}
+export interface WeeklyGroupDetails {
+    daysGroups: DaysGroup[];
+    groupSize: number;
+}
+export interface CalendarWeeklyGroup {
+    type: "weeklyGroup";
+    disabled: boolean;
+    startsAt: string;
+    endsAt: string;
+    details: WeeklyGroupDetails;
+    occurrences: number;
+    routes: Route[];
+    clients: string[] | string;
+    note?: string;
+    _id: string;
+}
 export declare namespace Service {
     namespace Client {
         interface Financials {
@@ -2331,6 +2434,111 @@ export declare namespace Service {
         }
         export {};
     }
+    namespace Workorder {
+        export interface WorkorderSchema {
+            _id: string;
+            creator?: AdminCreator | RepCreator | ClientCreator;
+            editor?: AdminCreator | RepCreator | ClientCreator;
+            name?: string;
+            local_name?: string;
+            description?: string;
+            disabled: boolean;
+            integration_meta?: {
+                [key: string]: any;
+            };
+            status: WorkorderStatus;
+            assets?: string[];
+            asset_units?: string[];
+            workorder_categories: string[];
+            due_date?: number;
+            start_date?: number;
+            client_location: string;
+            priority?: Priority;
+            priority_human?: Priority_human;
+            client: string;
+            client_name: string;
+            workorder_request?: string;
+            createdAt?: Date;
+            updatedAt?: Date;
+            company_namespace: string[];
+            serial_number?: SerialNumber;
+            assigned_to?: string[];
+            forms?: string[];
+            time: number;
+            is_overdue: boolean;
+            opened_at: number;
+            done_at: number;
+            cancelled_at: number;
+            inprogress_at: number;
+            done_by?: AdminCreator | RepCreator | ClientCreator;
+            cancelled_by?: AdminCreator | RepCreator | ClientCreator;
+            opened_by?: AdminCreator | RepCreator | ClientCreator;
+            inprogress_by?: AdminCreator | RepCreator | ClientCreator;
+            build: Build[];
+            calendars: Calendar[];
+            builtAt: number;
+            due_date_day: string;
+            last_done_at: number;
+            last_done_by: AdminCreator | RepCreator | ClientCreator;
+            resolve_time: number;
+            sync_id: string;
+            startsAt: string;
+            endsAt: string;
+            teams_populated?: Pick<Team.TeamSchema, "name">;
+            client_populated?: Pick<Client.ClientSchema, "client_code" | "name">;
+            asset_units_populated?: AssetUnitsPopulated[];
+            assets_populated?: AssetsPopulated[];
+            assigned_to_populated?: RepresentativesPopulated;
+            client_location_populated?: ClientLocationPopulated;
+            workorder_categories_populated?: WorkorderCategoryPopulated[];
+            forms_populated?: FormPopulated[];
+            media_populated?: MediaPopulated;
+            cover_photo_populated?: MediaPopulated;
+        }
+        type SortingKeys = "due_date" | "priority" | "updatedAt" | "createdAt" | "from_updatedAt" | "to_updatedAt" | "_id";
+        type PopulatedKeys = "client" | "asset_units" | "assets" | "assigned_to" | "client_location" | "workorder_categories" | "forms" | "media" | "cover_photo" | "teams";
+        export namespace Find {
+            type Params = DefaultPaginationQueryParams & {
+                name?: string;
+                _id?: string;
+                assigned_to?: string[];
+                priority?: Priority;
+                priority_human?: Priority_human;
+                status?: WorkorderStatus;
+                workorder_categories?: string[];
+                client_location?: string;
+                client?: string;
+                assets?: string[];
+                asset_units?: string[];
+                due_date?: number;
+                start_date?: number;
+                forms?: string[];
+                from_createdAt?: number;
+                to_createdAt?: number;
+                from_updatedAt?: number;
+                to_updatedAt?: number;
+                from_start_date?: number;
+                to_start_date?: number;
+                from_due_date?: number;
+                to_due_date?: number;
+                teams?: string[];
+            };
+            interface Result extends DefaultPaginationResult {
+                data: WorkorderSchema[];
+                absolute_total: number;
+                page_total: number;
+            }
+        }
+        export namespace Get {
+            type ID = string;
+            interface Params {
+                populatedKeys?: PopulatedKeys[];
+                sortPage?: SortingKeys;
+            }
+            type Result = WorkorderSchema;
+        }
+        export {};
+    }
     namespace FullInvoice {
         export interface InvoiceSchema {
             _id: string;
@@ -4346,6 +4554,26 @@ export declare namespace Service {
         }
         export {};
     }
+    namespace UpdateIntegrationMeta {
+        namespace Create {
+            type Params = DefaultPaginationQueryParams & {
+                _id: string;
+                type: string;
+            };
+            type Body = {
+                key: string;
+                value: any;
+            }[] | {
+                integration_meta_keys: {
+                    key: string;
+                    value: any;
+                }[];
+            };
+            interface Result {
+                [key: string]: any;
+            }
+        }
+    }
 }
 export type StringId = string;
 export type NameSpaces = string[];

package/package.json

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

package/src/index.ts

@@ -1236,7 +1236,29 @@ export default class Repzo {
       return res;
     },
   };
-
+  workorder = {
+    _path: "/workorder",
+    find: async (
+      params?: Service.Workorder.Find.Params
+    ): Promise<Service.Workorder.Find.Result> => {
+      let res: Service.Workorder.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.workorder._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Workorder.Get.ID,
+      params?: Service.Workorder.Get.Params
+    ): Promise<Service.Workorder.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.workorder._path + `/${id}`,
+        params
+      );
+    },
+  };
   invoice = {
     _path: "/fullinvoices",
     find: async (
@@ -1934,4 +1956,20 @@ export default class Repzo {
       return res;
     },
   };
+
+  updateIntegrationMeta = {
+    _path: "/update-integration-meta",
+    create: async (
+      body: Service.UpdateIntegrationMeta.Create.Body,
+      params?: Service.UpdateIntegrationMeta.Create.Params
+    ): Promise<Service.UpdateIntegrationMeta.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.updateIntegrationMeta._path,
+        body,
+        params
+      );
+      return res;
+    },
+  };
 }

package/src/types/index.ts

@@ -72,13 +72,82 @@ interface Check {
   disabled?: boolean;
 }
 
+interface AssetUnitsPopulated {
+  name: string;
+  cover_photo: MediaPopulated;
+}
+interface AssetsPopulated {
+  name: string;
+  cover_photo: MediaPopulated;
+}
+interface RepresentativesPopulated {
+  name: string;
+  _id: string;
+}
+interface ClientLocationPopulated {
+  name: string;
+}
+interface FormPopulated {
+  name: string;
+}
+interface thumbnailStoragePopulated {
+  _id: string;
+  createdAt: string;
+  ContentType: string;
+  mime_type: string;
+  publicUrl: string;
+  type_name: "FileAttachment" | "ImageAttachment";
+  file_name: string;
+  media_id: string;
+  media_type:
+    | "csv"
+    | "json"
+    | "image"
+    | "pdf"
+    | " ppt"
+    | "pptx"
+    | "xls"
+    | "xlsx"
+    | "doc"
+    | "docx"
+    | " images"
+    | "zip";
+}
+interface MediaPopulated {
+  _id: string;
+  media_type:
+    | "csv"
+    | "json"
+    | "image"
+    | "pdf"
+    | " ppt"
+    | "pptx"
+    | "xls"
+    | "xlsx"
+    | "doc"
+    | "docx"
+    | " images"
+    | "zip";
+  mime_type: string;
+  publicUrl: string;
+  file_name: string;
+  type_name: "FileAttachment" | "ImageAttachment";
+  media_id: string;
+  ContentType: string;
+  createdAt: string;
+  updatedAt: string;
+  thumbnails: thumbnailStoragePopulated;
+}
+
 export interface DefaultPaginationQueryParams {
   per_page?: number;
   page?: number;
   sort?: string;
   sortPageOrder?: "asc" | "dsc";
 }
-
+interface WorkorderCategoryPopulated {
+  name: string;
+}
 export interface DefaultPaginationResult {
   total_result: number;
   current_count: number;
@@ -92,6 +161,76 @@ export interface DefaultPaginationResult {
   path: string;
   data: any[];
 }
+export interface List {
+  client: string | { _id: string };
+  note?: string;
+  route?: string;
+  calendar: string;
+}
+export interface Build {
+  day: string;
+  list: List[];
+  start_date?: number | undefined;
+}
+export type Calendar = CalendarWeekly | CalendarWeeklyGroup;
+export interface Route {
+  disabled: boolean;
+  list: List[];
+  _id: string;
+}
+export type Priority = 0 | 1 | 2 | 3;
+export type WorkorderStatus =
+  | "open"
+  | "done"
+  | "cancelled"
+  | "inprogress"
+  | "onhold";
+
+export type Priority_human = "none" | "low" | "medium" | "high";
+export type Day =
+  | "Sun"
+  | "Mon"
+  | "Tue"
+  | "Wed"
+  | "Thu"
+  | "Fri"
+  | "Sat"
+  | string;
+export interface WeeklyDetails {
+  every: number;
+  days: Day[];
+}
+export interface CalendarWeekly {
+  type: "weekly";
+  disabled: boolean;
+  startsAt: string;
+  endsAt: string;
+  details: WeeklyDetails;
+  occurrences: number;
+  routes: Route[];
+  clients: string[] | string;
+  note?: string;
+  _id: string;
+}
+export interface DaysGroup {
+  days: Day[];
+}
+export interface WeeklyGroupDetails {
+  daysGroups: DaysGroup[];
+  groupSize: number;
+}
+export interface CalendarWeeklyGroup {
+  type: "weeklyGroup";
+  disabled: boolean;
+  startsAt: string;
+  endsAt: string;
+  details: WeeklyGroupDetails;
+  occurrences: number;
+  routes: Route[];
+  clients: string[] | string;
+  note?: string;
+  _id: string;
+}
 
 // <reference path = "vehicle.ts" />
 export namespace Service {
@@ -2459,6 +2598,205 @@ export namespace Service {
     }
   }
 
+  export namespace Workorder {
+    export interface WorkorderSchema {
+      _id: string;
+      creator?: AdminCreator | RepCreator | ClientCreator;
+      editor?: AdminCreator | RepCreator | ClientCreator;
+      name?: string;
+      local_name?: string;
+      description?: string;
+      disabled: boolean;
+      integration_meta?: { [key: string]: any };
+      status: WorkorderStatus;
+      assets?: string[];
+      asset_units?: string[];
+      workorder_categories: string[];
+      due_date?: number;
+      start_date?: number;
+      client_location: string;
+      priority?: Priority;
+      priority_human?: Priority_human;
+      client: string;
+      client_name: string;
+      workorder_request?: string;
+      createdAt?: Date;
+      updatedAt?: Date;
+      company_namespace: string[];
+      serial_number?: SerialNumber;
+      assigned_to?: string[];
+      forms?: string[];
+      time: number;
+      is_overdue: boolean;
+      opened_at: number;
+      done_at: number;
+      cancelled_at: number;
+      inprogress_at: number;
+      done_by?: AdminCreator | RepCreator | ClientCreator;
+      cancelled_by?: AdminCreator | RepCreator | ClientCreator;
+      opened_by?: AdminCreator | RepCreator | ClientCreator;
+      inprogress_by?: AdminCreator | RepCreator | ClientCreator;
+      build: Build[];
+      calendars: Calendar[];
+      builtAt: number;
+      due_date_day: string;
+      last_done_at: number;
+      last_done_by: AdminCreator | RepCreator | ClientCreator;
+      resolve_time: number;
+      sync_id: string;
+      startsAt: string;
+      endsAt: string;
+      teams_populated?: Pick<Team.TeamSchema, "name">;
+      client_populated?: Pick<Client.ClientSchema, "client_code" | "name">;
+      asset_units_populated?: AssetUnitsPopulated[];
+      assets_populated?: AssetsPopulated[];
+      assigned_to_populated?: RepresentativesPopulated;
+      client_location_populated?: ClientLocationPopulated;
+      workorder_categories_populated?: WorkorderCategoryPopulated[];
+      forms_populated?: FormPopulated[];
+      media_populated?: MediaPopulated;
+      cover_photo_populated?: MediaPopulated;
+    }
+    interface CreateBody {
+      company_namespace: string[];
+      creator?: AdminCreator | RepCreator | ClientCreator;
+      name: string;
+      local_name?: string;
+      description?: string;
+      disabled?: boolean;
+      integration_meta?: { [key: string]: any };
+      status: WorkorderStatus;
+      assets?: string[];
+      asset_units?: string[];
+      workorder_categories: string[];
+      due_date?: number;
+      start_date?: number;
+      client_location: string;
+      priority?: Priority;
+      priority_human?: Priority_human;
+      client: string;
+      client_name?: string;
+      serial_number?: SerialNumber;
+      workorder_request?: string;
+      assigned_to?: string[];
+      forms?: string[];
+      calendars: Calendar[];
+      parent_repeating_workorder?: string;
+      due_date_day?: string;
+      last_done_at: number;
+      last_done_by: AdminCreator | RepCreator | ClientCreator;
+      resolve_time: number;
+      sync_id: string;
+      opened_at: number;
+      time: number;
+      opened_by: AdminCreator | RepCreator | ClientCreator;
+    }
+    interface UpdateBody {
+      company_namespace: string[];
+      _id?: string;
+      creator?: AdminCreator | RepCreator | ClientCreator;
+      editor?: AdminCreator | RepCreator | ClientCreator;
+      name?: string;
+      local_name?: string;
+      description?: string;
+      disabled?: boolean;
+      integration_meta?: { [key: string]: any };
+      status: WorkorderStatus;
+      assets?: string[];
+      asset_units?: string[];
+      workorder_categories: string[];
+      due_date?: number;
+      start_date?: number;
+      client_location: string;
+      priority?: Priority;
+      priority_human?: Priority_human;
+      client: string;
+      client_name?: string;
+      workorder_request?: string;
+      createdAt?: Date;
+      updatedAt?: Date;
+      serial_number?: SerialNumber;
+      assigned_to?: string[];
+      forms?: string[];
+      time: number;
+      is_overdue: boolean;
+      opened_at: number;
+      done_at: number;
+      cancelled_at: number;
+      inprogress_at: number;
+      done_by?: AdminCreator | RepCreator | ClientCreator;
+      cancelled_by?: AdminCreator | RepCreator | ClientCreator;
+      opened_by?: AdminCreator | RepCreator | ClientCreator;
+      inprogress_by?: AdminCreator | RepCreator | ClientCreator;
+      calendars: Calendar[];
+      parent_repeating_workorder?: string;
+      due_date_day?: string;
+      last_done_at: number;
+      last_done_by: AdminCreator | RepCreator | ClientCreator;
+      resolve_time: number;
+      sync_id?: string;
+    }
+    type SortingKeys =
+      | "due_date"
+      | "priority"
+      | "updatedAt"
+      | "createdAt"
+      | "from_updatedAt"
+      | "to_updatedAt"
+      | "_id";
+    type PopulatedKeys =
+      | "client"
+      | "asset_units"
+      | "assets"
+      | "assigned_to"
+      | "client_location"
+      | "workorder_categories"
+      | "forms"
+      | "media"
+      | "cover_photo"
+      | "teams";
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        name?: string;
+        _id?: string;
+        assigned_to?: string[];
+        priority?: Priority;
+        priority_human?: Priority_human;
+        status?: WorkorderStatus;
+        workorder_categories?: string[];
+        client_location?: string;
+        client?: string;
+        assets?: string[];
+        asset_units?: string[];
+        due_date?: number;
+        start_date?: number;
+        forms?: string[];
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_start_date?: number;
+        to_start_date?: number;
+        from_due_date?: number;
+        to_due_date?: number;
+        teams?: string[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: WorkorderSchema[];
+        absolute_total: number;
+        page_total: number;
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        populatedKeys?: PopulatedKeys[];
+        sortPage?: SortingKeys;
+      }
+      export type Result = WorkorderSchema;
+    }
+  }
+
   export namespace FullInvoice {
     export interface InvoiceSchema {
       _id: string;
@@ -4459,6 +4797,21 @@ export namespace Service {
       };
     }
   }
+
+  export namespace UpdateIntegrationMeta {
+    export namespace Create {
+      export type Params = DefaultPaginationQueryParams & {
+        _id: string;
+        type: string;
+      };
+      export type Body =
+        | { key: string; value: any }[]
+        | { integration_meta_keys: { key: string; value: any }[] };
+      export interface Result {
+        [key: string]: any;
+      }
+    }
+  }
 }
 
 export type StringId = string;