repzo 1.0.121 → 1.0.122

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/types/index.d.ts

@@ -112,6 +112,8 @@ interface ClientLocationPopulated {
 }
 interface FormPopulated {
   name: string;
+  _id: StringId;
+  local_name?: string;
 }
 interface VisitMeta {
   geo_fence_setting_visit_start: boolean;
@@ -5414,6 +5416,225 @@ export declare namespace Service {
     }
     export {};
   }
+  namespace WorkorderPortal {
+    interface Accepted_system_fields {
+      field: "clients" | "clientLocation" | "asset" | "assetUnit";
+      is_required: true;
+      is_name_visible: Boolean;
+    }
+    type Default_Priority_human = "none" | "low" | "medium" | "high";
+    type Default_Priority = 0 | 1 | 2 | 3;
+    export interface Data {
+      creator: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      teams?: string[];
+      company_namespace: string[];
+      allow_media_upload: "optional" | "required" | "hidden";
+      allow_signature: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: string[];
+      accepted_system_fields: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      createdAt?: Date;
+      updatedAt?: Date;
+      editor?: AdminOrRep;
+      _id: StringId;
+      disabled: boolean;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+    export interface CreateBody {
+      creator?: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      customFields?: {
+        [key: string]: any;
+      };
+      teams?: StringId[];
+      allow_media_upload?: "optional" | "required" | "hidden";
+      allow_signature?: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: StringId[];
+      accepted_system_fields?: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+    export interface UpdateBody {
+      name?: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      teams?: StringId[];
+      allow_media_upload?: "optional" | "required" | "hidden";
+      allow_signature?: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: StringId[];
+      accepted_system_fields?: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      editor?: AdminOrRep;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal?: boolean;
+      activate_sales_order_portal?: boolean;
+      activate_workorder_request_portal?: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle: string;
+        url: string;
+        account_type: string;
+      }[];
+    }
+    export interface PopulatedDoc {
+      creator: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      default_workorder_categories_populated?: WorkorderCategoryPopulated[];
+      teams?: string[];
+      company_namespace: string[];
+      allow_media_upload: "optional" | "required" | "hidden";
+      allow_signature: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: string[];
+      accepted_custom_fields_populated?: {
+        [key: string]: string | number | boolean;
+      }[];
+      accepted_system_fields: Accepted_system_fields[];
+      header_logo?: string;
+      header_logo_populated?: PopulatedMediaStorage[];
+      footer_logo?: string;
+      footer_logo_populated?: PopulatedMediaStorage[];
+      createdAt?: Date;
+      updatedAt?: Date;
+      editor?: AdminOrRep;
+      _id: StringId;
+      disabled: boolean;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      formV2_populated?: FormPopulated[];
+      product_groups?: Pick<
+        ProductGroup.ProductGroupSchema,
+        "_id" | "name" | "local_name"
+      >[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+    type SortingKeys = "default_priority" | "updatedAt" | "createdAt";
+    type PopulatedKeys =
+      | "default_workorder_categories"
+      | "header_logo"
+      | "footer_logo"
+      | "accepted_custom_fields"
+      | "formV2"
+      | "product_groups";
+    export namespace Find {
+      type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        name?: string | string[];
+        default_priority?: Default_Priority | Default_Priority[];
+        default_priority_human?:
+          | Default_Priority_human
+          | Default_Priority_human[];
+        default_workorder_categories?: StringId | StringId[];
+        formV2?: StringId | StringId[];
+        product_groups?: StringId | StringId[];
+        activate_formV2_portal?: boolean;
+        activate_sales_order_portal?: boolean;
+        activate_workorder_request_portal?: boolean;
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        disabled?: boolean;
+        search?: string;
+        populatedKeys?: PopulatedKeys | PopulatedKeys[];
+        sortBy?: {
+          field: SortingKeys;
+          type: "asc" | "desc";
+        }[];
+      };
+      interface Result extends DefaultPaginationResult {
+        data: Data[] | PopulatedDoc[];
+      }
+    }
+    export namespace Get {
+      type ID = string;
+      interface Params {
+        populatedKeys?: PopulatedKeys[];
+      }
+      type Result = Data | PopulatedDoc;
+    }
+    export namespace Create {
+      type Body = CreateBody;
+      type Result = Data;
+    }
+    export namespace Update {
+      type ID = string;
+      type Body = UpdateBody;
+      type Result = Data;
+    }
+    export namespace Remove {
+      type ID = string;
+      type Result = Data;
+    }
+    export {};
+  }
   namespace QuickConvertToPdf {
     export interface QuickConvertToPdfSchema {
       _id?: string;

package/package.json

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

package/src/index.ts

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

package/src/types/index.ts

@@ -115,6 +115,8 @@ interface ClientLocationPopulated {
 }
 interface FormPopulated {
   name: string;
+  _id: StringId;
+  local_name?: string;
 }
 interface VisitMeta {
   geo_fence_setting_visit_start: boolean;
@@ -5426,6 +5428,222 @@ export namespace Service {
     }
   }
 
+  export namespace WorkorderPortal {
+    interface Accepted_system_fields {
+      field: "clients" | "clientLocation" | "asset" | "assetUnit";
+      is_required: true;
+      is_name_visible: Boolean;
+    }
+    type Default_Priority_human = "none" | "low" | "medium" | "high";
+    type Default_Priority = 0 | 1 | 2 | 3;
+    export interface Data {
+      creator: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      teams?: string[];
+      company_namespace: string[];
+      allow_media_upload: "optional" | "required" | "hidden";
+      allow_signature: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: string[];
+      accepted_system_fields: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      createdAt?: Date;
+      updatedAt?: Date;
+      editor?: AdminOrRep;
+      _id: StringId;
+      disabled: boolean;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+    export interface CreateBody {
+      creator?: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      customFields?: { [key: string]: any };
+      teams?: StringId[];
+      allow_media_upload?: "optional" | "required" | "hidden";
+      allow_signature?: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: StringId[];
+      accepted_system_fields?: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+    export interface UpdateBody {
+      name?: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      teams?: StringId[];
+      allow_media_upload?: "optional" | "required" | "hidden";
+      allow_signature?: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: StringId[];
+      accepted_system_fields?: Accepted_system_fields[];
+      header_logo?: string;
+      footer_logo?: string;
+      editor?: AdminOrRep;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal?: boolean;
+      activate_sales_order_portal?: boolean;
+      activate_workorder_request_portal?: boolean;
+      formV2?: StringId[];
+      product_groups?: StringId[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle: string;
+        url: string;
+        account_type: string;
+      }[];
+    }
+    export interface PopulatedDoc {
+      creator: AdminOrRep;
+      name: string;
+      description?: string;
+      default_priority_human?: Default_Priority_human;
+      default_priority?: Default_Priority;
+      default_workorder_categories?: StringId[];
+      default_workorder_categories_populated?: WorkorderCategoryPopulated[];
+      teams?: string[];
+      company_namespace: string[];
+      allow_media_upload: "optional" | "required" | "hidden";
+      allow_signature: "optional" | "required" | "hidden";
+      header?: string;
+      footer?: string;
+      accepted_custom_fields?: string[];
+      accepted_custom_fields_populated?: {
+        [key: string]: string | number | boolean;
+      }[];
+      accepted_system_fields: Accepted_system_fields[];
+      header_logo?: string;
+      header_logo_populated?: PopulatedMediaStorage[];
+      footer_logo?: string;
+      footer_logo_populated?: PopulatedMediaStorage[];
+      createdAt?: Date;
+      updatedAt?: Date;
+      editor?: AdminOrRep;
+      _id: StringId;
+      disabled: boolean;
+      website?: string;
+      cover_photo?: StringId;
+      activate_formV2_portal: boolean;
+      activate_sales_order_portal: boolean;
+      activate_workorder_request_portal: boolean;
+      formV2?: StringId[];
+      formV2_populated?: FormPopulated[];
+      product_groups?: Pick<
+        ProductGroup.ProductGroupSchema,
+        "_id" | "name" | "local_name"
+      >[];
+      geoPoint?: GeoPoint;
+      location_name?: string;
+      social_media_platforms?: {
+        platform: StringId;
+        handle?: string;
+        url?: string;
+        account_type: string;
+      }[];
+    }
+
+    type SortingKeys = "default_priority" | "updatedAt" | "createdAt";
+    type PopulatedKeys =
+      | "default_workorder_categories"
+      | "header_logo"
+      | "footer_logo"
+      | "accepted_custom_fields"
+      | "formV2"
+      | "product_groups";
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        name?: string | string[];
+        default_priority?: Default_Priority | Default_Priority[];
+        default_priority_human?:
+          | Default_Priority_human
+          | Default_Priority_human[];
+        default_workorder_categories?: StringId | StringId[];
+        formV2?: StringId | StringId[];
+        product_groups?: StringId | StringId[];
+        activate_formV2_portal?: boolean;
+        activate_sales_order_portal?: boolean;
+        activate_workorder_request_portal?: boolean;
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        disabled?: boolean;
+        search?: string;
+        populatedKeys?: PopulatedKeys | PopulatedKeys[];
+        sortBy?: { field: SortingKeys; type: "asc" | "desc" }[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[] | PopulatedDoc[];
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export interface Params {
+        populatedKeys?: PopulatedKeys[];
+      }
+      export type Result = Data | PopulatedDoc;
+    }
+    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 QuickConvertToPdf {
     export interface QuickConvertToPdfSchema {
       _id?: string;