cityworks 1.0.6 → 2.1.0

package/dist/case_people.d.ts

@@ -0,0 +1,79 @@
+export declare class CasePeople {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: Object);
+    /**
+     * Add a people record to a case
+     *
+     * @category Case People
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the person
+     * @param {number} name - The name of the person to add to the case.
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CasePeople for more options.
+     * @return {Object} Returns Promise that represents an object describing the newly-added person. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPeopleItemBase
+     */
+    add(caObjectId: number, name: string, options?: Object): Promise<unknown>;
+    /**
+     * Get all the people roles available
+     *
+     * @category Case People
+     * @return {Object} Returns Promise that represents an collection of configured People Roles
+     */
+    getRoles(): Promise<unknown>;
+    /**
+     * Get people records attached to a specific case
+     *
+     * @category Case People
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the person
+     * @return {Object} Returns Promise that represents an object describing the newly-added person. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPeopleItemBase
+     */
+    get(caObjectId: number): Promise<unknown>;
+    /**
+     * Delete specific people records
+     *
+     * @category Case People
+     * @param {number} caPeopleId - The Case Object ID for the case to which to add the person
+     * @return {Object} Returns Promise that represents the result of the delete operation.
+     */
+    delete(caPeopleId: number): Promise<unknown>;
+    /**
+     * Delete all people records attached to a specific case
+     *
+     * @category Case People
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the person
+     * @return {Object} Returns Promise that represents the result of the delete operation.
+     */
+    deleteAll(caObjectId: number): Promise<unknown>;
+    /**
+     * Search for people records
+     *
+     * @category Case People
+     * @param {number} searchOptions - Where you specify search options that assume a logical 'and' operation
+     * @param {boolean} idsOnly - If you only wants the IDs of the people records that match the search criteria, set this to true. Otherwise, set it to false.
+     * @return {Object} Returns Promise that represents an array of people record IDs that match the search criteria.
+     */
+    search(searchOptions: {
+        AddressLine1: string;
+        AddressLine2: string;
+        CaObjectId: number;
+        CaPeopleId: number;
+        CityName: string;
+        CountryCode: string;
+        CountryName: string;
+        Email: string;
+        Name: string;
+        PhoneHome: string;
+        PhoneMobile: string;
+        PhoneWork: string;
+        RoleCode: string;
+        RoleDesc: string;
+        RoleId: number;
+        StateCode: string;
+        StateName: string;
+        ZipCode: string;
+    }, idsOnly?: boolean): Promise<unknown>;
+}

package/dist/case_workflow.d.ts

@@ -1,187 +1,187 @@
-export declare class CaseWorkflow {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Task sub-methods
-     */
-    task: Object;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Adds a task to the case specified by the CaObectId.
-     *
-     * @category Tasks
-     * @param {number} caObjectId - The Case Object to attach the task to
-     * @param {number} taskId - The task ID to add to the case workflow
-     * @param {number} startPoint - The start point in the workflow for the task
-     * @param {number} endPoint - The end point in the workflow for the task
-     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
-     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
-     */
-    addTask(caObjectId: number, taskId: number, startPoint: number, endPoint: number, options?: Object): Promise<unknown>;
-    /**
-     * Add Task Result
-     *
-     * @category Task Results
-     * @param {number} caObjectId - The Case Object to attach the task to
-     * @param {number} caTaskId - The Case task ID to add the result to
-     * @param {number} resultCode - The result Code
-     * @param {number} resultID - The result ID
-     * @param {number} resultSetID - The result set ID
-     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
-     * @return {Object} Returns Promise that represents an object describing CaTaskResultsItem.
-     */
-    addTaskResult(caObjectId: number, caTaskId: number, resultCode: number, resultID: number, resultSetID: number, options?: Object): Promise<unknown>;
-    /**
-     * Add Task Comment
-     *
-     * @category Comments
-     * @param {number} caTaskId - The Case task ID of the task to add the comment to
-     * @param {string} comment - The comment text
-     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
-     */
-    addTaskComment(caTaskId: number, comment: string): Promise<unknown>;
-    /**
-     * Get tasks by CaObjectId
-     *
-     * @category Tasks
-     * @param {number} caObjectId - The Case Object to get the attached tasks
-     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
-     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
-     */
-    getTasksByCaseId(caObjectId: number, checkRelatedItems?: boolean): Promise<unknown>;
-    /**
-     * Get tasks by TaskIds
-     *
-     * @category Tasks
-     * @param {Array<number>} caTaskIds - The IDs of the tasks to retrieve
-     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
-     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
-     */
-    getTasksById(caTaskIds: Array<number>, checkRelatedItems?: boolean): Promise<unknown>;
-    /**
-     * Get CaTaskResultsItem by CaTaskIds
-     *
-     * @category Task Results
-     * @param {Array<number>} caTaskIds - The IDs of the tasks for which to retrieve results
-     * @return {Object} Returns Promise that represents a collection of CaTaskResultsItems.
-     */
-    getResultsByTaskId(caTaskIds: Array<number>): Promise<unknown>;
-    /**
-     * Search for CaseTaskComments by CaTaskId
-     *
-     * @category Comments
-     * @param {number} caTaskId - The task ID for which to retrieve attached comments
-     * @return {Object} Returns Promise that represents a collection of CommentRecords.
-     */
-    getCommentsForTask(caTaskId: number): Promise<unknown>;
-    /**
-     * Search for CaseTaskComments by CaTaskId
-     *
-     * @category Comments
-     * @param {Array<number>} caTaskIds - The task IDs for which to retrieve attached comments
-     * @return {Object} Returns Promise that represents a collection of CaTaskCommentsItemBase.
-     */
-    getCommentsForTasks(caTaskIds: Array<number>): Promise<unknown>;
-    /**
-     * Updates a task
-     *
-     * @category Tasks
-     * @param {number} caTaskId - The Case Object to attach the task to
-     * @param {Object} [options] - Options for Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
-     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
-     */
-    updateTask(caTaskId: number, options?: Object): Promise<unknown>;
-    /**
-     * Update Task Comment
-     *
-     * @category Comments
-     * @param {number} caTaskCommentId - The Case task ID of the task to add the comment to
-     * @param {string} comment - The comment text
-     * @param {number} commentId - Probably unnecessary?
-     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
-     */
-    updateTaskComment(caTaskCommentId: number, comment: string, commentId?: number): Promise<unknown>;
-    /**
-     * Updates a task
-     *
-     * @category Tasks
-     * @param {number} caTaskId - The Case Object to attach the task to
-     * @param {string} resultCode - The result code to set for the specified Task
-     * @param {Object} [options] - Options for Task. Specify either or both TaskCompletedBy & TaskCompleteDate. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
-     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
-     */
-    setTaskResult(caTaskId: number, resultCode: string, options?: Object): Promise<unknown>;
-    /**
-     * Deletes a task by TaskID
-     *
-     * @category Tasks
-     * @param {number} caTaskId - The caTaskId for the task which should be deleted
-     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
-     */
-    deleteTask(caTaskId: number): Promise<unknown>;
-    /**
-     * Deletes a task by TaskID
-     *
-     * @category Tasks
-     * @param {number} caTaskId - The caTaskId for the task which should be deleted
-     * @return {Object} Returns Promise that represents the number of the CaObjectID
-     */
-    deleteTasksOnCase(caObjectId: number): Promise<unknown>;
-    /**
-     * Deletes tasks by TaskID
-     *
-     * @category Comments
-     * @param {Array<number>} caTaskCommentIds - The comments to delete
-     * @return {Object} Returns Promise that represents a dictionary of comment IDs.
-     */
-    deleteTaskComments(caTaskCommentIds: Array<number>): Promise<unknown>;
-    /**
-     * Search for Case Tasks. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
-     *
-     * @category Tasks
-     * @param {Object} filters - The parameters to search by. (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType)
-     * @return {Object} Returns Promise that represents a collection of resulting CaTaskIDs
-     */
-    searchForTasks(filters?: Object): Promise<unknown>;
-    /**
-     * Search for CaseTaskResults Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
-     *
-     * @category Task Results
-     * @param {Object} filters - The parameters to search by. See: /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
-     * @return {Object} Returns Promise that represents a collection of resulting CaTaskResultsItem
-     */
-    searchForTaskResults(filters?: Object): Promise<unknown>;
-    /**
-       * Adds a task to the case specified by the CaObectId.
-       *
-       * @category Task Attachments
-       * @param {number} caTaskId - The Task ID to attach the document to
-       * @param {number} caObjectId - The Case Object ID
-       * @param {string} docName - The file name as it should display in the system
-       * @param {string} locationType - The location of the file...leave blank
-       * @param {any} file - The binary string for the file
-       * @return {Object} Returns Promise that represents an object describing added Attachment
-       */
-    addTaskAttachment(caTaskId: number, caObjectId: number, docName: number, file: any, locationType?: string): Promise<unknown>;
-    /**
-       * Gets each Document Attached to the specified Task
-       *
-       * @category Task Attachments
-       * @param {number} caTaskId - The Task ID to attach the document to
-       * @return {Object} Returns Promise that represents a collection of objects describing each Attachment on the provided task
-       */
-    getTaskAttachments(caTaskId: number): Promise<unknown>;
-    /**
-     * Deletes a task attachment by caRelDocId (Related Case Document ID). Same as RelDocs delete for case.
-     *
-     * @category Task Attachments
-     * @param {number} caRelDocId - The caRelDocId for the related document which should be deleted
-     * @return {Object} Returns Promise that represents the an object describing the deleted document.
-     */
-    deleteTaskAttachment(caRelDocId: number): Promise<unknown>;
-}
+export declare class CaseWorkflow {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Task sub-methods
+     */
+    task: Object;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Adds a task to the case specified by the CaObectId.
+     *
+     * @category Tasks
+     * @param {number} caObjectId - The Case Object to attach the task to
+     * @param {number} taskId - The task ID to add to the case workflow
+     * @param {number} startPoint - The start point in the workflow for the task
+     * @param {number} endPoint - The end point in the workflow for the task
+     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    addTask(caObjectId: number, taskId: number, startPoint: number, endPoint: number, options?: Object): Promise<unknown>;
+    /**
+     * Add Task Result
+     *
+     * @category Task Results
+     * @param {number} caObjectId - The Case Object to attach the task to
+     * @param {number} caTaskId - The Case task ID to add the result to
+     * @param {number} resultCode - The result Code
+     * @param {number} resultID - The result ID
+     * @param {number} resultSetID - The result set ID
+     * @param {Object} [options] - Options for the Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
+     * @return {Object} Returns Promise that represents an object describing CaTaskResultsItem.
+     */
+    addTaskResult(caObjectId: number, caTaskId: number, resultCode: number, resultID: number, resultSetID: number, options?: Object): Promise<unknown>;
+    /**
+     * Add Task Comment
+     *
+     * @category Comments
+     * @param {number} caTaskId - The Case task ID of the task to add the comment to
+     * @param {string} comment - The comment text
+     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
+     */
+    addTaskComment(caTaskId: number, comment: string): Promise<unknown>;
+    /**
+     * Get tasks by CaObjectId
+     *
+     * @category Tasks
+     * @param {number} caObjectId - The Case Object to get the attached tasks
+     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
+     */
+    getTasksByCaseId(caObjectId: number, checkRelatedItems?: boolean): Promise<unknown>;
+    /**
+     * Get tasks by TaskIds
+     *
+     * @category Tasks
+     * @param {Array<number>} caTaskIds - The IDs of the tasks to retrieve
+     * @param {boolean} checkRelatedItems - Wherther to check related items. Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of the CaTaskItemBases.
+     */
+    getTasksById(caTaskIds: Array<number>, checkRelatedItems?: boolean): Promise<unknown>;
+    /**
+     * Get CaTaskResultsItem by CaTaskIds
+     *
+     * @category Task Results
+     * @param {Array<number>} caTaskIds - The IDs of the tasks for which to retrieve results
+     * @return {Object} Returns Promise that represents a collection of CaTaskResultsItems.
+     */
+    getResultsByTaskId(caTaskIds: Array<number>): Promise<unknown>;
+    /**
+     * Search for CaseTaskComments by CaTaskId
+     *
+     * @category Comments
+     * @param {number} caTaskId - The task ID for which to retrieve attached comments
+     * @return {Object} Returns Promise that represents a collection of CommentRecords.
+     */
+    getCommentsForTask(caTaskId: number): Promise<unknown>;
+    /**
+     * Search for CaseTaskComments by CaTaskId
+     *
+     * @category Comments
+     * @param {Array<number>} caTaskIds - The task IDs for which to retrieve attached comments
+     * @return {Object} Returns Promise that represents a collection of CaTaskCommentsItemBase.
+     */
+    getCommentsForTasks(caTaskIds: Array<number>): Promise<unknown>;
+    /**
+     * Updates a task
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The Case Object to attach the task to
+     * @param {Object} [options] - Options for Task. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    updateTask(caTaskId: number, options?: Object): Promise<unknown>;
+    /**
+     * Update Task Comment
+     *
+     * @category Comments
+     * @param {number} caTaskCommentId - The Case task ID of the task to add the comment to
+     * @param {string} comment - The comment text
+     * @param {number} commentId - Probably unnecessary?
+     * @return {Object} Returns Promise that represents an object describing CaTaskCommentsItemBase.
+     */
+    updateTaskComment(caTaskCommentId: number, comment: string, commentId?: number): Promise<unknown>;
+    /**
+     * Updates a task
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The Case Object to attach the task to
+     * @param {string} resultCode - The result code to set for the specified Task
+     * @param {Object} [options] - Options for Task. Specify either or both TaskCompletedBy & TaskCompleteDate. See /{subdirectory}/apidocs/#/service-info/Pll/CaseTask
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    setTaskResult(caTaskId: number, resultCode: string, options?: Object): Promise<unknown>;
+    /**
+     * Deletes a task by TaskID
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The caTaskId for the task which should be deleted
+     * @return {Object} Returns Promise that represents an object describing CaTaskItemBase.
+     */
+    deleteTask(caTaskId: number): Promise<unknown>;
+    /**
+     * Deletes a task by TaskID
+     *
+     * @category Tasks
+     * @param {number} caTaskId - The caTaskId for the task which should be deleted
+     * @return {Object} Returns Promise that represents the number of the CaObjectID
+     */
+    deleteTasksOnCase(caObjectId: number): Promise<unknown>;
+    /**
+     * Deletes tasks by TaskID
+     *
+     * @category Comments
+     * @param {Array<number>} caTaskCommentIds - The comments to delete
+     * @return {Object} Returns Promise that represents a dictionary of comment IDs.
+     */
+    deleteTaskComments(caTaskCommentIds: Array<number>): Promise<unknown>;
+    /**
+     * Search for Case Tasks. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Tasks
+     * @param {Object} filters - The parameters to search by. (ResponsibleUserId, TaskAvailable, TaskComplete, TaskType)
+     * @return {Object} Returns Promise that represents a collection of resulting CaTaskIDs
+     */
+    searchForTasks(filters?: Object): Promise<unknown>;
+    /**
+     * Search for CaseTaskResults Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Task Results
+     * @param {Object} filters - The parameters to search by. See: /{subdirectory}/apidocs/#/service-info/Pll/CaseTaskResults
+     * @return {Object} Returns Promise that represents a collection of resulting CaTaskResultsItem
+     */
+    searchForTaskResults(filters?: Object): Promise<unknown>;
+    /**
+       * Adds a task to the case specified by the CaObectId.
+       *
+       * @category Task Attachments
+       * @param {number} caTaskId - The Task ID to attach the document to
+       * @param {number} caObjectId - The Case Object ID
+       * @param {string} docName - The file name as it should display in the system
+       * @param {string} locationType - The location of the file...leave blank
+       * @param {any} file - The binary string for the file
+       * @return {Object} Returns Promise that represents an object describing added Attachment
+       */
+    addTaskAttachment(caTaskId: number, caObjectId: number, docName: number, file: any, locationType?: string): Promise<unknown>;
+    /**
+       * Gets each Document Attached to the specified Task
+       *
+       * @category Task Attachments
+       * @param {number} caTaskId - The Task ID to attach the document to
+       * @return {Object} Returns Promise that represents a collection of objects describing each Attachment on the provided task
+       */
+    getTaskAttachments(caTaskId: number): Promise<unknown>;
+    /**
+     * Deletes a task attachment by caRelDocId (Related Case Document ID). Same as RelDocs delete for case.
+     *
+     * @category Task Attachments
+     * @param {number} caRelDocId - The caRelDocId for the related document which should be deleted
+     * @return {Object} Returns Promise that represents the an object describing the deleted document.
+     */
+    deleteTaskAttachment(caRelDocId: number): Promise<unknown>;
+}

package/dist/comments.d.ts

@@ -1,53 +1,53 @@
-import ReversibleMap from 'reversible-map';
-/**
- * A plugin that contains "comments" methods
- */
-export declare class Comments {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Storage of all potential activity types which comments can be attached to: Unknown, Request, WorkOrder, CaTask, CaObject, CaCorrection, Project, Contract
-     */
-    activityTypes: ReversibleMap<string, number>;
-    /**
-     * Storage of object's active activityType
-     */
-    currentActivityType: string;
-    /**
-     * @hidden
-     */
-    constructor(cw: any, activityType: string);
-    /**
-     * Add a comment - for adding a comment to an object when the object is already known. Always call comment.add from request, case, workorder, or inspection.
-     *
-     * @param {number} sid - The SID of the activity to which the comment should be attached
-     * @param {string} comment - The text for the comment
-     * @return {Object} Returns a Promise which represents a CommentRecord object
-     */
-    add(sid: number, comment: string): Promise<unknown>;
-    /**
-     * Update a comment
-     *
-     * @param {number} id - The ID of the comment which should be updated
-     * @param {string} comment - The new text for the updated comment
-     * @return {Object} Returns a Promise which represents a CommentRecord object
-     */
-    update(id: number, comment: string): Promise<unknown>;
-    /**
-     * Get comments for activity items
-     *
-     * @param {Array<number>} sids - The options SIDs to get comments for.
-     * @return {Object} Returns Promise object that represents a collection of available comments
-     */
-    get(sids: Array<number>): Promise<unknown>;
-    /**
-     * Get pre-defined comments for activityTypes
-     *
-     * @param {number} problemSid - The ProblemSid if currentActivityType is (Service) Request
-     * @param {string} [category] - Only applies to WorkOrder and ServiceRequest category comments.
-     * @return {Object} Returns Promise object that represents a collection of available comment templates.
-     */
-    getPredefined(problemSid?: number, category?: string): Promise<unknown>;
-}
+import ReversibleMap from 'reversible-map';
+/**
+ * A plugin that contains "comments" methods
+ */
+export declare class Comments {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of all potential activity types which comments can be attached to: Unknown, Request, WorkOrder, CaTask, CaObject, CaCorrection, Project, Contract
+     */
+    activityTypes: ReversibleMap<string, number>;
+    /**
+     * Storage of object's active activityType
+     */
+    currentActivityType: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any, activityType: string);
+    /**
+     * Add a comment - for adding a comment to an object when the object is already known. Always call comment.add from request, case, workorder, or inspection.
+     *
+     * @param {number} sid - The SID of the activity to which the comment should be attached
+     * @param {string} comment - The text for the comment
+     * @return {Object} Returns a Promise which represents a CommentRecord object
+     */
+    add(sid: number, comment: string): Promise<unknown>;
+    /**
+     * Update a comment
+     *
+     * @param {number} id - The ID of the comment which should be updated
+     * @param {string} comment - The new text for the updated comment
+     * @return {Object} Returns a Promise which represents a CommentRecord object
+     */
+    update(id: number, comment: string): Promise<unknown>;
+    /**
+     * Get comments for activity items
+     *
+     * @param {Array<number>} sids - The options SIDs to get comments for.
+     * @return {Object} Returns Promise object that represents a collection of available comments
+     */
+    get(sids: Array<number>): Promise<unknown>;
+    /**
+     * Get pre-defined comments for activityTypes
+     *
+     * @param {number} problemSid - The ProblemSid if currentActivityType is (Service) Request
+     * @param {string} [category] - Only applies to WorkOrder and ServiceRequest category comments.
+     * @return {Object} Returns Promise object that represents a collection of available comment templates.
+     */
+    getPredefined(problemSid?: number, category?: string): Promise<unknown>;
+}