repzo 1.0.131 → 1.0.133

package/package.json

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

package/src/index.ts

@@ -121,6 +121,9 @@ export default class Repzo {
     ACTIVITY_FEEDBACK: "activity-feedback",
     ACTIVITY_FEEDBACKV2: "activity-feedback-v2",
     FEEDBACK_OPTION: "feedback-options",
+    WORKORDER_CATEGORY: "workorder-category",
+    CONTRACT: "contract",
+    CONTRACT_INSTALLMENT: "contract-installment",
   } as const;
   public static get END_POINTS() {
     return Repzo._end_points;
@@ -4346,6 +4349,168 @@ export default class Repzo {
       return res;
     },
   };
+
+  workorderCategory = {
+    _path: Repzo._end_points.WORKORDER_CATEGORY,
+    find: async (
+      params?: Service.WorkorderCategory.Find.Params
+    ): Promise<Service.WorkorderCategory.Find.Result> => {
+      let res: Service.WorkorderCategory.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.workorderCategory._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.WorkorderCategory.Get.ID,
+      params?: Service.WorkorderCategory.Get.Params
+    ): Promise<Service.WorkorderCategory.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.workorderCategory._path + `/${id}`,
+        params
+      );
+    },
+    create: async (
+      body: Service.WorkorderCategory.Create.Body
+    ): Promise<Service.WorkorderCategory.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.workorderCategory._path,
+        body
+      );
+      return res;
+    },
+    update: async (
+      id: Service.WorkorderCategory.Update.ID,
+      body: Service.WorkorderCategory.Update.Body
+    ): Promise<Service.WorkorderCategory.Update.Result> => {
+      let res: Service.WorkorderCategory.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.workorderCategory._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.WorkorderCategory.Remove.ID
+    ): Promise<Service.WorkorderCategory.Remove.Result> => {
+      let res: Service.WorkorderCategory.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.workorderCategory._path + `/${id}`
+      );
+      return res;
+    },
+  };
+
+  contract = {
+    _path: Repzo._end_points.CONTRACT,
+    find: async (
+      params?: Service.Contract.Find.Params
+    ): Promise<Service.Contract.Find.Result> => {
+      let res: Service.Contract.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.contract._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.Contract.Get.ID,
+      params?: Service.Contract.Get.Params
+    ): Promise<Service.Contract.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.contract._path + `/${id}`,
+        params
+      );
+    },
+    create: async (
+      body: Service.Contract.Create.Body
+    ): Promise<Service.Contract.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.contract._path,
+        body
+      );
+      return res;
+    },
+    update: async (
+      id: Service.Contract.Update.ID,
+      body: Service.Contract.Update.Body
+    ): Promise<Service.Contract.Update.Result> => {
+      let res: Service.Contract.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.contract._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.Contract.Remove.ID
+    ): Promise<Service.Contract.Remove.Result> => {
+      let res: Service.Contract.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.contract._path + `/${id}`
+      );
+      return res;
+    },
+  };
+
+  contractInstallment = {
+    _path: Repzo._end_points.CONTRACT_INSTALLMENT,
+    find: async (
+      params?: Service.ContractInstallment.Find.Params
+    ): Promise<Service.ContractInstallment.Find.Result> => {
+      let res: Service.ContractInstallment.Find.Result = await this._fetch(
+        this.svAPIEndpoint,
+        this.contractInstallment._path,
+        params
+      );
+      return res;
+    },
+    get: async (
+      id: Service.ContractInstallment.Get.ID,
+      params?: Service.ContractInstallment.Get.Params
+    ): Promise<Service.ContractInstallment.Get.Result> => {
+      return await this._fetch(
+        this.svAPIEndpoint,
+        this.contractInstallment._path + `/${id}`,
+        params
+      );
+    },
+    create: async (
+      body: Service.ContractInstallment.Create.Body
+    ): Promise<Service.ContractInstallment.Create.Result> => {
+      let res = await this._create(
+        this.svAPIEndpoint,
+        this.contractInstallment._path,
+        body
+      );
+      return res;
+    },
+    update: async (
+      id: Service.ContractInstallment.Update.ID,
+      body: Service.ContractInstallment.Update.Body
+    ): Promise<Service.ContractInstallment.Update.Result> => {
+      let res: Service.ContractInstallment.Update.Result = await this._update(
+        this.svAPIEndpoint,
+        this.contractInstallment._path + `/${id}`,
+        body
+      );
+      return res;
+    },
+    remove: async (
+      id: Service.ContractInstallment.Remove.ID
+    ): Promise<Service.ContractInstallment.Remove.Result> => {
+      let res: Service.ContractInstallment.Remove.Result = await this._delete(
+        this.svAPIEndpoint,
+        this.contractInstallment._path + `/${id}`
+      );
+      return res;
+    },
+  };
 }
 
 function normalizeParams(params: Params): { [key: string]: any } {

package/src/types/index.ts

@@ -5442,6 +5442,8 @@ export namespace Service {
         assignedToMe?: boolean;
         search?: string;
         populatedKeys?: PopulatedKeys | PopulatedKeys[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         sortBy?: { field: SortingKeys; type: "asc" | "desc" }[];
         [key: string]: any; // integration_meta.
       };
@@ -5620,6 +5622,8 @@ export namespace Service {
         "creator._id"?: StringId | StringId[];
         search?: string;
         populatedKeys?: PopulatedKeys | PopulatedKeys[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         sortBy?: { field: SortingKeys; type: "asc" | "desc" }[];
         [key: string]: any; // integration_meta.
       };
@@ -9552,6 +9556,9 @@ export namespace Service {
         disabled?: boolean;
         from_updatedAt?: number;
         to_updatedAt?: number;
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
+        sortBy?: { field: "_id"; type: "asc" | "desc" }[];
         [key: string]: any; // integration_meta.
       };
       export interface Result extends DefaultPaginationResult {
@@ -9704,6 +9711,8 @@ export namespace Service {
             | "updatedAt";
           type: "asc" | "desc";
         }[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         [key: string]: any; // integration_meta.
       };
       export interface Result extends DefaultPaginationResult {
@@ -9952,6 +9961,8 @@ export namespace Service {
         "creator._id"?: StringId[] | StringId;
         creator_type?: string | string[];
         "creator.type"?: string | string[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         [key: string]: any; // integration_meta.
       };
       export interface Result extends DefaultPaginationResult {
@@ -13234,9 +13245,11 @@ export namespace Service {
         _id?: StringId | StringId[];
         search?: string;
         name?: string | string[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         from_updatedAt?: number;
         to_updatedAt?: number;
-        sortBy?: { field: "color" | "name"; type: "asc" | "desc" }[];
+        sortBy?: { field: "color" | "name" | "_id"; type: "asc" | "desc" }[];
       };
       export interface Result extends DefaultPaginationResult {
         data: Data[];
@@ -13371,8 +13384,10 @@ export namespace Service {
         from_createdAt?: number;
         to_createdAt?: number;
         search?: string;
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         sortBy?: {
-          field: "barcode" | "name" | "model";
+          field: "barcode" | "name" | "model" | "_id";
           type: "asc" | "desc";
         }[];
         populatedKeys?: PopulatedKeys[];
@@ -13420,7 +13435,7 @@ export namespace Service {
       integration_meta?: { [key: string]: any };
       media?: StringId[];
       cover_photo?: StringId;
-      comany_namespace: string[];
+      company_namespace: string[];
       createdAt: string;
       updatedAt: string;
     }
@@ -13489,7 +13504,7 @@ export namespace Service {
       integration_meta?: { [key: string]: any };
       media?: StringId[] | PopulatedMediaStorage[];
       cover_photo?: StringId | PopulatedMediaStorage;
-      comany_namespace: string[];
+      company_namespace: string[];
       createdAt: string;
       updatedAt: string;
     }
@@ -13515,10 +13530,9 @@ export namespace Service {
         from_createdAt?: number;
         to_createdAt?: number;
         search?: string;
-        sortBy?: {
-          field: "asset" | "name";
-          type: "asc" | "desc";
-        }[];
+        sortBy?: { field: "asset" | "name" | "_id"; type: "asc" | "desc" }[];
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
         populatedKeys?: PopulatedKeys[];
       };
       export interface Result extends DefaultPaginationResult {
@@ -13547,6 +13561,374 @@ export namespace Service {
       export type Result = Data;
     }
   }
+
+  export namespace WorkorderCategory {
+    export interface Data {
+      _id: StringId;
+      creator: AdminOrRep;
+      editor?: AdminOrRep;
+      name: string;
+      local_name?: string;
+      description?: string;
+      disabled: boolean;
+      integration_meta?: { [key: string]: any };
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+    }
+
+    export interface CreateBody {
+      creator?: AdminOrRep;
+      name: string;
+      local_name?: string;
+      description?: string;
+      disabled?: boolean;
+      integration_meta?: { [key: string]: any };
+      company_namespace?: string[];
+    }
+    export interface UpdateBody {
+      _id?: StringId;
+      creator?: AdminOrRep;
+      editor?: AdminOrRep;
+      name?: string;
+      local_name?: string;
+      description?: string;
+      disabled?: boolean;
+      integration_meta?: { [key: string]: any };
+      company_namespace?: string[];
+    }
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        name?: string | string[];
+        _id?: StringId | StringId[];
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
+        search?: string;
+        sortBy?: { field: "_id" | "name"; type: "asc" | "desc" }[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[];
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export type Params = {};
+      export type Result = Data;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = string;
+      export type Params = {};
+      export type Result = Data;
+    }
+  }
+
+  export namespace Contract {
+    export type ContractStatus = "open" | "closed" | "canceled";
+    export interface Data {
+      _id: StringId;
+      creator: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id: string;
+      title?: string;
+      serial_number: SerialNumber;
+      external_serial_number?: string;
+      start_time: number;
+      end_time: number;
+      amount?: number;
+      client: StringId;
+      status?: ContractStatus;
+      disabled: boolean;
+      locations?: {
+        _id: StringId;
+        assets?: StringId[];
+        asset_units?: StringId[];
+      }[];
+      media?: StringId[];
+      renewed_from?: StringId;
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+    }
+    export interface CreateBody {
+      sync_id: string;
+      creator?: AdminOrRep;
+      title?: string;
+      serial_number?: SerialNumber;
+      external_serial_number?: string;
+      start_time: number;
+      end_time: number;
+      amount?: number;
+      client: StringId;
+      status?: ContractStatus;
+      disabled?: boolean;
+      locations?: {
+        _id: StringId;
+        assets?: StringId[];
+        asset_units?: StringId[];
+      }[];
+      media?: StringId[];
+      renewed_from?: StringId;
+      company_namespace?: string[];
+    }
+    export interface UpdateBody {
+      _id?: StringId;
+      creator?: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id?: string;
+      title?: string;
+      serial_number?: SerialNumber;
+      external_serial_number?: string;
+      start_time?: number;
+      end_time?: number;
+      amount?: number;
+      client?: StringId;
+      status?: ContractStatus;
+      disabled?: boolean;
+      locations?: {
+        _id: StringId;
+        assets?: StringId[];
+        asset_units?: StringId[];
+      }[];
+      media?: StringId[];
+      renewed_from?: StringId;
+      company_namespace?: string[];
+      createdAt?: string;
+      updatedAt?: string;
+    }
+    export interface PopulatedDoc {
+      _id: StringId;
+      creator: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id: string;
+      title?: string;
+      serial_number: SerialNumber;
+      external_serial_number?: string;
+      start_time: number;
+      end_time: number;
+      amount?: number;
+      client: StringId;
+      client_populated?: Pick<
+        Client.ClientSchema,
+        "name" | "client_code" | "_id" | "local_name"
+      >;
+      status?: ContractStatus;
+      disabled: boolean;
+      locations?: {
+        _id:
+          | StringId
+          | Pick<ClientLocation.Data, "name" | "_id" | "cover_photo">;
+        assets?:
+          | StringId[]
+          | Pick<Asset.Data, "name" | "_id" | "cover_photo">[];
+        asset_units?:
+          | StringId[]
+          | Pick<AssetUnit.Data, "name" | "_id" | "cover_photo">[];
+      }[];
+      media?: StringId[];
+      media_populated?: PopulatedMediaStorage[];
+      renewed_from?: StringId;
+      renewed_from_populated?: Data;
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+    }
+
+    type PopulatedKeys =
+      | "locations.asset_units"
+      | "locations.assets"
+      | "locations._id"
+      | "client"
+      | "media"
+      | "renewed_from";
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
+        search?: string; // "serial_number.formatted"
+        sortBy?: { field: "_id"; type: "asc" | "desc" }[];
+        status?: ContractStatus | ContractStatus[];
+        client?: StringId | StringId[];
+        from_start_time?: number;
+        to_start_time?: number;
+        from_end_time?: number;
+        to_end_time?: number;
+        from_amount?: number;
+        to_amount?: number;
+        renewed_from?: StringId | StringId[];
+        populatedKeys?: PopulatedKeys[];
+        expired?: boolean;
+        near_expiry?: boolean;
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[] & PopulatedDoc[];
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export type Params = { populatedKeys?: PopulatedKeys[] };
+      export type Result = Data & PopulatedDoc;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = string;
+      export type Params = {};
+      export type Result = Data;
+    }
+  }
+
+  export namespace ContractInstallment {
+    export type ContractInstallmentStatus = "paid" | "unpaid";
+    export interface Data {
+      _id: StringId;
+      creator: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id: string;
+      media?: StringId[];
+      serial_number: SerialNumber;
+      external_serial_number?: string;
+      due_time: number;
+      pay_time?: number;
+      amount?: number;
+      contract: StringId;
+      status: ContractInstallmentStatus;
+      disabled: boolean;
+      is_renewed?: boolean;
+      bulk_uuid?: string;
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+    }
+    export interface CreateBody {
+      sync_id: string;
+      creator?: AdminOrRep;
+      serial_number?: SerialNumber;
+      external_serial_number?: string;
+      due_time: number;
+      pay_time?: number;
+      amount?: number;
+      contract: StringId;
+      status?: ContractInstallmentStatus;
+      disabled?: boolean;
+      is_renewed?: boolean;
+      bulk_uuid?: string;
+      media?: StringId[];
+      company_namespace?: string[];
+    }
+    export interface UpdateBody {
+      _id?: StringId;
+      creator?: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id?: string;
+      media?: StringId[];
+      serial_number?: SerialNumber;
+      external_serial_number?: string;
+      due_time?: number;
+      pay_time?: number;
+      amount?: number;
+      contract?: StringId;
+      status?: ContractInstallmentStatus;
+      disabled?: boolean;
+      is_renewed?: boolean;
+      bulk_uuid?: string;
+      company_namespace?: string[];
+      createdAt?: string;
+      updatedAt?: string;
+    }
+    export interface PopulatedDoc {
+      _id: StringId;
+      creator: AdminOrRep;
+      editor?: AdminOrRep;
+      sync_id: string;
+      media?: StringId[];
+      serial_number: SerialNumber;
+      external_serial_number?: string;
+      due_time: number;
+      pay_time?: number;
+      amount?: number;
+      contract: StringId;
+      status: ContractInstallmentStatus;
+      disabled: boolean;
+      is_renewed?: boolean;
+      bulk_uuid?: string;
+      company_namespace: string[];
+      createdAt: string;
+      updatedAt: string;
+      media_populated?: PopulatedMediaStorage[];
+      contract_populated?: Pick<Contract.Data, "serial_number" | "_id">;
+    }
+
+    type PopulatedKeys = "contract" | "media";
+
+    export namespace Find {
+      export type Params = DefaultPaginationQueryParams & {
+        _id?: StringId | StringId[];
+        from_updatedAt?: number;
+        to_updatedAt?: number;
+        from_createdAt?: number;
+        to_createdAt?: number;
+        from__id?: StringId | StringId[];
+        to__id?: StringId | StringId[];
+        search?: string; // "serial_number.formatted"
+        sortBy?: { field: "_id"; type: "asc" | "desc" }[];
+        status?: ContractInstallmentStatus | ContractInstallmentStatus[];
+        contract?: StringId | StringId[];
+        from_due_time?: number;
+        to_due_time?: number;
+        due_time?: number;
+        populatedKeys?: PopulatedKeys[];
+      };
+      export interface Result extends DefaultPaginationResult {
+        data: Data[] & PopulatedDoc[];
+      }
+    }
+    export namespace Get {
+      export type ID = string;
+      export type Params = { populatedKeys?: PopulatedKeys[] };
+      export type Result = Data & PopulatedDoc;
+    }
+    export namespace Update {
+      export type ID = StringId;
+      export type Body = UpdateBody;
+      export type Result = Data;
+    }
+    export namespace Create {
+      export type Body = CreateBody;
+      export type Result = Data;
+    }
+    export namespace Remove {
+      export type ID = string;
+      export type Params = {};
+      export type Result = Data;
+    }
+  }
 }
 
 export type StringId = string;