cityworks 1.0.5 → 2.0.0

package/dist/workorder.d.ts

@@ -1,328 +0,0 @@
-export declare class WorkOrder {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * WorkOrder Administration methods
-     */
-    admin: any;
-    /**
-     * WorkOrder Costing methods
-     */
-    costs: any;
-    /**
-     * WorkOrder Comments methods
-     */
-    comment: any;
-    /**
-     * WorkOrder Comments methods
-     */
-    attachments: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Create new workorders, including linkin to Requests & Inspections (optionally)
-     *
-     * @category WorkOrders
-     * @param {Object} wo_data - See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
-     * @param {Array<number>} [inspectionIds] - The inspection IDs which the workorder should be linked to.
-     * @param {Array<number>} [requestIds] - The inspection IDs which the workorder should be linked to.
-     * @return {Object} Returns Promise that represents an object describing the newly-created workorder
-     */
-    create(wo_data: Object, inspectionIds?: Array<number>, requestIds?: Array<number>): Promise<unknown>;
-    /**
-     * Create new workorder linked to parent workorder
-     *
-     * @category WorkOrders
-     * @param {Object} wo_data - See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
-     * @param {string|number} workOrderSId - The workorder S/ID which the entities should be added to. # for SID, string for ID.
-     * @return {Object} Returns Promise that represents an object describing the newly-created workorder
-     */
-    createFromParent(wo_data: Object, workOrderSId: string | number, s?: boolean): Promise<unknown>;
-    /**
-     * Update a WorkOrder
-     *
-     * @category WorkOrders
-     * @param {object} wo_data - See /{subdirectory}/apidocs/#/data-type-infodataType=WorkOrder on the Cityworks instance
-     * @return {Object} Returns Promise that represents an object describing the updated workorder
-     */
-    update(wo_data: Object): Promise<unknown>;
-    /**
-     * Combine WorkOrders
-     *
-     * @category WorkOrders
-     * @param {Array<string>} fromWorkOrderIds - The workorder IDs which should be combined.
-     * @param {string} toWorkOrderId - The WorkOrder ID for the single WorkOrder that should contain the info/entities from the other WorkOrders
-     * @param {boolean} cancelCombinedWorkOrders - If the WorkOrders combined into the single should then be canceled, default is true.
-     * @return {Object} Returns object that represents a collection of WorkOrders
-     */
-    combine(fromWorkOrderIds: Array<string>, toWorkOrderId: string, cancelCombinedWorkOrders?: boolean): Promise<unknown>;
-    /**
-     * Move a workorder's point
-     *
-     * @category WorkOrders
-     * @param {string} workOrderId
-     * @param {number} x
-     * @param {number} y
-     * @param {Object} projection - Should include WKT or WKID attribute. Can also include VcsWKID attribute.
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents an object describing the updated workorder
-     */
-    move(workOrderId: string, x: number, y: number, projection: Object, z?: number): Promise<unknown>;
-    /**
-     * Get a workorder by S/ID
-     *
-     * @category WorkOrders
-     * @param {string|number} workOrderSId - The S/ID of the workorder to retrieve. # for SID, string for ID.
-     * @param {boolean} s - Whether first argument is an SID (true) or an ID (false). Defaults to true.
-     * @return {Object} Returns Promise that represents an object describing the workorder
-     */
-    getById(workOrderSId: string | number, s?: boolean): Promise<unknown>;
-    /**
-     * Get workorders by an array of S/IDs
-     *
-     * @category WorkOrders
-     * @param {Array<string|number>} workOrderSIds - The workorder S/IDs to retrieve. If providing WorkOrderID, should be all strings, else provide all numbers for WorkOrderSID
-     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
-     */
-    getByIds(workOrderSIds: Array<string | number>): Promise<unknown>;
-    /**
-     * Get instructions by an array of workorders S/IDs
-     *
-     * @category WorkOrders
-     * @param {Array<string|number>} workOrderSIds - The workorder S/IDs to retrieve. If providing WorkOrderID, should be all strings, else provide all numbers for WorkOrderSID
-     * @return {Object} Returns Promise that represents an array of String, String describing the workorder instructions
-     */
-    getInstructions(workOrderSIds: Array<string | number>): Promise<unknown>;
-    /**
-     * Get the audit log for a specific workorder
-     *
-     * @category WorkOrders
-     * @param {number} workOrderSId - A WorkOrder S/ID to get the audit log for. SID is default.
-     * @return {Object} Returns Promise that represents a collection of Cityworks Metadata Objects
-     */
-    getAuditLog(workOrderSId: number): Promise<unknown>;
-    /**
-     * Get custom field values for the workorder S/IDs
-     *
-     * @category WorkOrders
-     * @param {Array<string|number>} workOrderSIds - The workorder S/IDs to retrieve. #s for SID, strings for ID.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
-     */
-    getCustomFieldValues(workOrderSIds: Array<string | number>): Promise<unknown>;
-    /**
-     * Get entities on an existing WorkOrder
-     *
-     * @category WorkOrders
-     * @param {Array<string|number>} workOrderSIds - The workorder S/IDs which the entities should be added to. # for SID, string for ID.
-     * @param {boolean} getGisData - Query gis to populate Entity.Attributes with current gis data. Defaults to true.
-     * @return {Object} Returns object that represents a list of entities removed.
-     */
-    getEntities(workOrderSIds: Array<string | number>, getGisData?: boolean): Promise<unknown>;
-    /**
-     * Add entities to an existing WorkOrder
-     *
-     * @category WorkOrders
-     * @param {string|number} workOrderSId - The workorder S/ID which the entities should be added to. # for SID, string for ID.
-     * @param {Object} entityInfo - Entity info object including: (req) EntityType: {string}, (req) EntityUids: {Array<string>}, Facility_Id: {string}, Level_Id: {string}
-     * @param {boolean} updateXY - Update WorkOrder xy after adding entit(y|ies), default is true.
-     * @return {Object} Returns object that represents a list of entities removed.
-     */
-    addEntities(workOrderSId: string | number, entityInfo: Object, updateXY?: boolean): Promise<unknown>;
-    /**
-     * Update a WorkOrder entity
-     *
-     * @category WorkOrders
-     * @param {string|number} workOrderSId - The workorder S/ID which the entities should be added to. # for SID, string for ID.
-     * @param {Object} entityInfo - Entity info object including: (req) EntityType: {string}, (req) EntityUid: {string}, Facility_Id: {string}, Level_Id: {string}
-     * @param {boolean} workComplete - Update WorkOrder completeness, default is true.
-     * @return {Object} Returns object that represents a list of entities removed.
-     */
-    updateEntity(workOrderSId: string | number, entityInfo: Object, workComplete?: boolean): Promise<unknown>;
-    /**
-     * Remove entities from a WorkOrder. Provide WorkOrderId and either ObjectIds or EntityType and EntityUids
-     *
-     * @category WorkOrders
-     * @param {number} workOrderSId - The workorder S/ID which the entities should be removed from. # for SID, string for ID.
-     * @param {Object} entityInfo - Remove entities by WorkOrderEntity.ObjectId (not gis objectId).
-     * @param {boolean} updateXY - Update WorkOrder xy after removing entities, default is true.
-     * @return {Object} Returns object that represents a list of entities removed.
-     */
-    removeEntities(workOrderSId: string | number, entityInfo: Object, updateXY?: boolean): Promise<unknown>;
-    /**
-     * Cancel workorders
-     *
-     * @category WorkOrders
-     * @param {Array<number>} workOrderIds - An array of the IDs to cancel the matched workorders
-     * @param {string} [cancelReason] - A reason for cancelling the workorder(s)
-     * @param {datetime} [dateCancelled] - The date/time that it should be indicated the workorder was cancelled
-     * @return {Object} Returns object that represents a collection of workorders
-     */
-    cancel(workOrderIds: Array<number>, cancelReason?: string, dateCancelled?: Date): Promise<unknown>;
-    /**
-     * Uncancel workorders
-     *
-     * @category WorkOrders
-     * @param {Array<number>} workOrderIds - An array of the IDs to uncancel the matched workorders
-     * @return {Object} Returns object that represents a collection of workorders
-     */
-    uncancel(workOrderIds: Array<number>): Promise<unknown>;
-    /**
-     * Close WorkOrders
-     *
-     * @category WorkOrders
-     * @param {Array<number>} workOrderIds - An array of the IDs to close the matched WorkOrders
-     * @return {Object} Returns object that represents a collection of WorkOrders
-     */
-    close(workOrderIds: Array<number>): Promise<unknown>;
-    /**
-     * Reopen closed WorkOrders
-     *
-     * @category WorkOrders
-     * @param {Array<number>} workOrderIds - An array of the IDs to reopen the matched WorkOrders
-     * @return {Object} Returns object that represents a collection of WorkOrders
-     */
-    reopen(workOrderIds: Array<number>): Promise<unknown>;
-    /**
-     * Delete WorkOrders
-     *
-     * @category WorkOrders
-     * @param {Array<number>} workOrderIds - An array of the IDs to delete the matched WorkOrders
-     * @return {Object} Returns object that represents a collection of WorkOrder Ids which have been deleted
-     */
-    delete(workOrderIds: Array<number>): Promise<unknown>;
-    /**
-     * Get WorkOrderS/IDs connected to provided entities
-     *
-     * @category WorkOrder Search
-     * @param {string} entityType - The entity type to find connected WorkOrders
-     * @param {Array<string>} entityUIDs - The list of entities to search for connected WorkOrders
-     * @param {boolean} s - Get WorkOrderSids. Defaults to true. When false, returned list is WorkOrderIds
-     * @param {Object} [search] - Any additional search properties of the WorkOrder (open/closed, etc)
-     * @return {Object} Returns Promise that represents an array of WorkOrderS/IDs
-     */
-    getWOsByEntities(entityType: string, entityUids: Array<string>, search?: Array<string | number>, s?: boolean): Promise<unknown>;
-    /**
-     * Get WorkOrderSid and description for provided WorkOrderId
-     *
-     * @category WorkOrder Search
-     * @param {string} workOrderId - The WorkOrderId for which to get the WorkOrderSid and description
-     * @return {Object} Returns Promise that represents an object with WorkOrderS/IDs & Description
-     */
-    getSearchList(workOrderId: string): Promise<unknown>;
-    /**
-     * Get WorkOrder Employee lists
-     *
-     * @category WorkOrder Options
-     * @param {string} listType - Which list (endpoint) to get. Includes Supervisors & SubmitTos.
-     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
-     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
-     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
-     */
-    getEmployeeLists(listType: string, includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Get SubmitTo list
-     *
-     * @category WorkOrder Options
-     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
-     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
-     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
-     */
-    getSubmitTos(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Get Supervisors list
-     *
-     * @category WorkOrder Options
-     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
-     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
-     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
-     */
-    getSupervisors(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Get Status Options
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents a collection of codes. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CodeDesc
-     */
-    getStatuses(): Promise<unknown>;
-    /**
-     * Get Categories
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of configured workorder category code descriptions
-     */
-    getCategories(): Promise<unknown>;
-    /**
-     * Get Priorities
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of configured workorder priorities
-     */
-    getPriorities(): Promise<unknown>;
-    /**
-     * Get Cycle From
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of string/string Cycle From options for workorders
-     */
-    getCycleFrom(): Promise<unknown>;
-    /**
-     * Get Cycle Intervals
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of string/string Cycle Interval options for workorders
-     */
-    getCycleIntervals(): Promise<unknown>;
-    /**
-     * Get Cycle Types
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of string/string Cycle Type options for workorders
-     */
-    getCycleTypes(): Promise<unknown>;
-    /**
-     * Get WorkOrder Stages
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of string/string Stage options for WorkOrders
-     */
-    getStages(): Promise<unknown>;
-    /**
-     * Get Expense Types
-     *
-     * @category WorkOrder Options
-     * @return {Object} Returns Promise that represents an array of string/string Expense Type options for workorders
-     */
-    getExpenseTypes(): Promise<unknown>;
-    /**
-     * Get Map Layer Fields
-     *
-     * @category WorkOrders
-     * @param {string} workOrderSId - The workorder S/ID to get the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
-     */
-    getMLFs(workOrderSId: string): Promise<unknown>;
-    /**
-     * Update Map Layer Fields
-     *
-     * @category WorkOrders
-     * @param {string} workOrderSId - The workorder S/ID to get the map layer fields for.
-     * @param {number} x
-     * @param {number} y
-     * @param {number} domainId - Should include WKT or WKID attribute. Can also include VcsWKID attribute.
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents a ...
-     */
-    updateMLFs(workOrderSId: string, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
-    /**
-     * Delete Map Layer Fields
-     *
-     * @category WorkOrders
-     * @param {string} workOrderSId - The workorder S/ID to delete the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
-     */
-    deleteMLFs(workOrderSId: string): Promise<unknown>;
-}

package/dist/workorder_admin.d.ts

@@ -1,111 +0,0 @@
-export declare class WorkOrderAdmin {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get entity groups
-     *
-     * @category WorkOrders Admin
-     * @return {Object} Returns Promise that represents a collection of all entity groups
-     */
-    getEntityGroups(): Promise<unknown>;
-    /**
-     * Get entity types
-     *
-     * @category WorkOrders Admin
-     * @return {Object} Returns Promise that represents a collection of all GIS WorkOrder entity types
-     */
-    getEntityTypes(entityGroups: Array<string>): Promise<unknown>;
-    /**
-     * Get WorkOrder templates
-     *
-     * @category WorkOrders Admin
-     * @return {Object} Returns Promise that represents a collection of all WorkOrder templates
-     */
-    getTemplates(entityType: string, includeComments?: boolean, includeInstructions?: boolean): Promise<unknown>;
-    /**
-     * Update WorkOrder template
-     *
-     * @category WorkOrders Admin
-     * @param {Object} wOTemplate - Obect that describes the WorkOrder Template
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    updateTemplate(wOTemplate: Object): Promise<unknown>;
-    /**
-     * Get template group rights for provided WorkOrder Templates
-     *
-     * @category WorkOrders Admin
-     * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateGroupRights(wOTemplateIds: Array<number>): Promise<unknown>;
-    /**
-     * Get template activity services for provided WorkOrder Templates
-     *
-     * @category WorkOrders Admin
-     * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateActivity(wOTemplateIds: Array<number>): Promise<unknown>;
-    /**
-     * Get fields which will be updated when provided WorkOrder Template instance closes
-     *
-     * @category WorkOrders Admin
-     * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getUpdateFields(wOTemplateIds: Array<number>): Promise<unknown>;
-    /**
-     * Get equipment
-     *
-     * @category WorkOrders Admin
-     * @param {Array<number>} wOTemplateIds - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateEquipment(wOTemplateId: number): Promise<unknown>;
-    /**
-     * Get labor
-     *
-     * @category WorkOrders Admin
-     * @param {Array<number>} wOTemplateIds - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateLabor(wOTemplateId: number): Promise<unknown>;
-    /**
-     * Get material
-     *
-     * @category WorkOrders Admin
-     * @param {number} wOTemplateId - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateMaterial(wOTemplateId: number): Promise<unknown>;
-    /**
-     * Get map layer fields configured for provided WorkOrder template
-     *
-     * @category WorkOrders Admin
-     * @param {number} wOTemplateId - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all
-     */
-    getTemplateMapLayerFields(wOTemplateId: number): Promise<unknown>;
-    /**
-     * Get tasks configured for provided WorkOrder template
-     *
-     * @category WorkOrders Admin
-     * @param {number} wOTemplateId - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder template
-     */
-    getTemplateTasks(wOTemplateId: number): Promise<unknown>;
-    /**
-     * Get inspections connected to provided WorkOrder template
-     *
-     * @category WorkOrders Admin
-     * @param {number} wOTemplateId - WorkOrder Template ID
-     * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder template
-     */
-    getRelatedInspectionTemplates(wOTemplateId: number): Promise<unknown>;
-}

package/dist/workorder_costs.d.ts

@@ -1,113 +0,0 @@
-export declare class WorkOrderCosts {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Storage of object's active activityType
-     */
-    currentActivityType: string;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get Cost Codes
-     *
-     * @category Labor Costs
-     * @param {Array<number>} employeeSids - A list of Employee IDs for which to get the job codes.
-     * @param {boolean} commonOnly - Set to true to get the Cost Codes that are common to ALL employees in the list, otherwise get all job codes that apply to at least one employee in the list.
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    getCodes(employeeSids: Object, commonOnly?: boolean): Promise<unknown>;
-    /**
-     * Get Job Codes
-     *
-     * @category Labor Costs
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    getJobCodes(): Promise<unknown>;
-    /**
-     * Add WorkOrder Labor Costs
-     *
-     * @category WorkOrder Costs
-     * @param {number} workOrderSid - Array of inspection labor costings
-     * @param {number} hours - Number of hours to add
-     * @param {Object} options - options for the work order
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    addLabor(workOrderSid: number, hours: number, options: Object): Promise<unknown>;
-    /**
-    * Get Labor Costs for WorkOrder(s)
-    *
-    * @category WorkOrder Costs
-    * @param {Array<number>} workOrderSids - Array of request Ids to get costs for
-    * @param {boolean} estimated - Whether to get estimates or actuals (defaults to false -- get actuals)
-    * @return {Object} Returns Promise that represents an object describing
-    */
-    getLabor(workOrderSids: Array<number>, estimated?: boolean): Promise<unknown>;
-    /**
-     * Delete WorkOrder Labor Costs
-     *
-     * @category WorkOrder Costs
-     * @param {Array<number>} laborCostIds - List of labor cost IDs to delete
-     * @param {boolean} estimated - Whether to delete estimates or actuals (defaults to false -- delete actuals)
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    deleteLabor(laborCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
-    /**
-     * Add WorkOrder Equipment Costs
-     *
-     * @category WorkOrder Costs
-     * @param {Object} workOrderSid - the work order to add the equipment costs to
-     * @param {Object} options - additional options
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    addEquipment(workOrderSid: number, options: Object): Promise<unknown>;
-    /**
-    * Get Equipment Costs for WorkOrder(s)
-    *
-    * @category WorkOrder Costs
-    * @param {number} workOrderSid - the work order to add the equipment costs to
-    * @param {boolean} estimated - true to get estimated costs. defaults to false
-    * @return {Object} Returns Promise that represents an object describing
-    */
-    getEquipment(workOrderSid: number, estimated?: boolean): Promise<unknown>;
-    /**
-     * Delete WorkOrder Equipment Costs
-     *
-     * @category WorkOrder Costs
-     * @param {Object}
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    deleteEquipment(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
-    /**
-     * Add WorkOrder Material Costs
-     *
-     * @category WorkOrder Costs
-     * @param {number} workOrderSid - Work Order SID number to add the material to
-     * @param {number} units - Decimal units for material
-     * @param {Object} options - Additional work order options
-     * @param {boolean} combineIssuesByMaterialSid - Combine issues with the same MaterialSid into a single commit, default is true
-     * @return {Object} Returns Promise that represents a collection describing the work order material costs
-     */
-    addMaterial(workOrderSid: number, units: number, options: Object, combineIssuesByMaterialSid?: boolean): Promise<unknown>;
-    /**
-     * Get Material Costs for WorkOrder(s)
-     *
-     * @category WorkOrder Costs
-     * @param {number} workOrderSid - the work order to add the equipment costs to
-     * @param {boolean} estimated - true to get estimated costs. defaults to false and gets actuals.
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    getMaterial(workOrderSid: number, estimated?: boolean): Promise<unknown>;
-    /**
-     * Delete WorkOrder Material Costs
-     *
-     * @category WorkOrder Costs
-     * @param {Array<number>} materialCostIds - list of material cost IDs to delete
-     * @param {boolean} estimated - true to delete the estimated costs. defaults to false and deletes actuals.
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    deleteMaterial(materialCostIds: number, estimated?: boolean): Promise<unknown>;
-}