cityworks 2.1.5 → 2.2.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Walker Hamilton <3987+walker@users.noreply.github.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Walker Hamilton <3987+walker@users.noreply.github.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,119 +1,119 @@
-# Cityworks node.js API wrapper
-
-This API wrapper for Cityworks follows the Cityworks release schedule as closely as possible. Functionality may be missing depending on necessity or use.
-
-Require the class:
-
-      const cw = require('cityworks')
-
-or
-
-      import * as cw from 'cityworks'
-
-Instantiate the Class for the instance of Cityworks available given a domain:
-
-      cw.Cityworks.configure('cwoffice.domain.tld', {path: 'cityworks', version: 15})
-
-or 
-
-      cw.Cityworks.configure('cw.domain.tld', {path: 'cityworks', version: 23});
-
-
-## Authentication
-
-Authenticate with the Cityworks install:
-
-      cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {}).catch(error => {
-        console.log(error.message)
-      })
-
-
-Get the currently valid token in order to store it in a session or cookie:
-
-      cw.Cityworks.getToken()
-
-Provide a saved token instead of the standard u/p auth:
-
-      cw.Cityworks.setToken('mytoken')
-
-## Main method calls
-
-Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [Service Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Briefcase.html) object libraries like so:
-
-      cw.inspection.methodHere().then(resp => {})
-      cw.workorder.methodHere().then(resp => {})
-      cw.request.methodHere().then(resp => {})
-      cw.briefcase.methodHere().then(resp => {})
-
-Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
-
-[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
-
-      cw.general.methodHere().then(resp => {})
-
-[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
-
-      cw.message_queue.methodHere().then(resp => {})
-
-[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
-
-      cw.activity_link.methodHere().then(resp => {})
-
-[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
-
-      cw.gis.methodHere().then(resp => {})
-
-[General query methods](https://walker.github.io/cityworks/classes/query.Query.html):
-
-      cw.query.methodHere().then(resp => {})
-
-[(Deprecated) General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
-
-      cw.search.methodHere().then(resp => {})
-
-## Case financials, data details, and admin
-
-For the sake of organizing some of the other methods needed by the primary and secondary libraries, there are also objects and methods accessed within those main libraries:
-
-For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
-
-      cw.briefcase.financial.methodHere().then(resp => {})
-
-For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
-
-      cw.briefcase.data.methodHere().then(resp => {})
-
-For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
-
-      cw.briefcase.workflow.methodHere().then(resp => {})
-
-For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
-
-      cw.briefcase.admin.methodHere().then(resp => {})
-
-## Commenting
-
-For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/comments.Comments.html) via the class the comment is to be made on:
-
-      cw.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {})
-
-      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {})
-
-      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {})
-
-## Attachments
-
-For any object in Cityworks which has attachments, (including cases as CaRelDocs), use the [Attachments class](https://walker.github.io/cityworks/modules/attachments.html) via the class the attachment is to be made on:
-
-      cw.briefcase.attachment.add(CaObjectIdGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.workorder.attachment.add(WorkOrderSIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.request.attachment.add(RequestIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-      cw.inspection.attachment.add(InspectionIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
-
-
-## Activity Links
-
-      cw.activity_link.add(source_type, source_sid, destination_type, destination_sid)
+# Cityworks node.js API wrapper
+
+This API wrapper for Cityworks follows the Cityworks release schedule as closely as possible. Functionality may be missing depending on necessity or use.
+
+Require the class:
+
+      const cw = require('cityworks')
+
+or
+
+      import * as cw from 'cityworks'
+
+Instantiate the Class for the instance of Cityworks available given a domain:
+
+      cw.Cityworks.configure('cwoffice.domain.tld', {path: 'cityworks', version: 15})
+
+or 
+
+      cw.Cityworks.configure('cw.domain.tld', {path: 'cityworks', version: 23});
+
+
+## Authentication
+
+Authenticate with the Cityworks install:
+
+      cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {}).catch(error => {
+        console.log(error.message)
+      })
+
+
+Get the currently valid token in order to store it in a session or cookie:
+
+      cw.Cityworks.getToken()
+
+Provide a saved token instead of the standard u/p auth:
+
+      cw.Cityworks.setToken('mytoken')
+
+## Main method calls
+
+Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [Service Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Briefcase.html) object libraries like so:
+
+      cw.inspection.methodHere().then(resp => {})
+      cw.workorder.methodHere().then(resp => {})
+      cw.request.methodHere().then(resp => {})
+      cw.briefcase.methodHere().then(resp => {})
+
+Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
+
+[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
+
+      cw.general.methodHere().then(resp => {})
+
+[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
+
+      cw.message_queue.methodHere().then(resp => {})
+
+[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
+
+      cw.activity_link.methodHere().then(resp => {})
+
+[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
+
+      cw.gis.methodHere().then(resp => {})
+
+[General query methods](https://walker.github.io/cityworks/classes/query.Query.html):
+
+      cw.query.methodHere().then(resp => {})
+
+[(Deprecated) General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
+
+      cw.search.methodHere().then(resp => {})
+
+## Case financials, data details, and admin
+
+For the sake of organizing some of the other methods needed by the primary and secondary libraries, there are also objects and methods accessed within those main libraries:
+
+For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
+
+      cw.briefcase.financial.methodHere().then(resp => {})
+
+For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
+
+      cw.briefcase.data.methodHere().then(resp => {})
+
+For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
+
+      cw.briefcase.workflow.methodHere().then(resp => {})
+
+For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
+
+      cw.briefcase.admin.methodHere().then(resp => {})
+
+## Commenting
+
+For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/comments.Comments.html) via the class the comment is to be made on:
+
+      cw.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {})
+
+      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {})
+
+      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {})
+
+## Attachments
+
+For any object in Cityworks which has attachments, (including cases as CaRelDocs), use the [Attachments class](https://walker.github.io/cityworks/modules/attachments.html) via the class the attachment is to be made on:
+
+      cw.briefcase.attachment.add(CaObjectIdGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.workorder.attachment.add(WorkOrderSIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.request.attachment.add(RequestIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+      cw.inspection.attachment.add(InspectionIDGoesHere, path.join('uploads', 'filename.pdf')).then(resp => {})
+
+
+## Activity Links
+
+      cw.activity_link.add(source_type, source_sid, destination_type, destination_sid)

package/dist/attachments.d.ts

@@ -45,12 +45,14 @@ export declare class Attachments {
      */
     delete(attachmentIds: Array<number> | number): Promise<unknown>;
     /**
-     * Get attachment URLs in array
-     *
-     * @category Attachments
-     * @return {Object} Returns array of attachment URLs
+     * @hidden
      */
-    static downloadUrls(): string[];
+    static downloadUrls(): {
+        case: string;
+        inspection: string;
+        request: string;
+        workorder: string;
+    };
     /**
      * Download an attachment
      *

package/dist/case_financial.d.ts

@@ -30,8 +30,8 @@ export declare class CaseFinancial {
      * Make a Payment. Adds a payment to the case fee(s) specified.
      *
      * @category Case Payments
-     * @param {Array<Array<string>>} payments - The Case Object ID for the case to which to add the fee
-     * @param {Array<number>} caseFees - Fees this payment should be applied to. Array of CaFeeIds values.
+     * @param {Array<Array<string>>} payments - A collection of Payments to add: [Payment Tender Type, Amount, Comment, Date Received, Reference String] (All as strings)
+     * @param {Array<number>} caseFees - The Ca Fee IDs to which to apply the payment.
      * @param {stringName:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,CityName?:string,CommentText?:string,Email?:string,FaxNumber?:string,PhoneHome?:string,PhoneMobile?:string,PhoneWork?:string,PhoneWorkExt?:string,StateCode?:string,WebSiteUrl?:string,ZipCode?:string,CountryCode?:string} payerInfo - Payer info for the payment being made.
      * @return {Object} Returns Promise that represents an object describing the newly-added payment.
      */
@@ -155,6 +155,28 @@ export declare class CaseFinancial {
      * @return {Object} Returns Promise that represents a collection of Case Payments.
      */
     getPayments(caObjectId: number): Promise<unknown>;
+    /**
+     * Get Receipts by Case ObjectId
+     *
+     * @category Case Payments
+     * @param {number} caObjectId - The Case Object ID for the case to get the payment receipts for
+     * @return {Object} Returns Promise that represents a collection of Case Receipts.
+     */
+    getReceipts(caObjectId: number): Promise<unknown>;
+    /**
+     * @hidden
+     */
+    static downloadUrls(): {
+        receipt: string;
+    };
+    /**
+     * Download a Receipt by Receipt Id or Receipt Name.
+     *
+     * @category Case Payments
+     * @param {string | number} receipt - The Receipt Name or Receipt ID for the receipt to download
+     * @return {Object} Returns Promise that represents the downloaded Receipt PDF and Filename.
+     */
+    downloadReceipt(receipt: string | number): Promise<unknown>;
     /**
      * Gets the instruments from the case specified by the CaObectId.
      *

package/dist/case_flags.d.ts

@@ -29,8 +29,7 @@ export declare class CaseFlags {
      * Delete specific flag from case
      *
      * @category Case Flags
-     * @param {number} caObjectId - The Case Object to attach the data group to.
-     * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the flags. Defaults to true.
+     * @param {number} caFlagId - The CaFlagId (case flag instance ID) that should be deleted
      * @return {Object} Returns Promise that represents the CaFlag that has been deleted.
      */
     delete(caFlagId: number): Promise<unknown>;
@@ -38,7 +37,7 @@ export declare class CaseFlags {
      * Delete all flags from case
      *
      * @category Case Flags
-     * @param {number} caObjectId - The Case Object to detach the flags from.
+     * @param {number} caObjectId - The Case Object to delete the flags from.
      * @return {Object} Returns Promise that represents the number of flags deleted from the case provided.
      */
     deleteAll(caObjectId: number): Promise<unknown>;

package/dist/error.d.ts

@@ -14,11 +14,11 @@ export interface CWErrorMsgs {
  *
  */
 export interface CWErrorInt {
-    name: string;
-    code: number;
-    message: string;
-    error_messages?: Array<CWErrorMsgs>;
-    info?: string;
+    Name: string;
+    Code: number;
+    Message: string;
+    Error_messages?: Array<CWErrorMsgs>;
+    Info?: string;
 }
 /**
  * CWError implements a custom error class for this codebase with additional information
@@ -28,23 +28,23 @@ export declare class CWError implements CWErrorInt {
     /**
      * Just statically set to "Cityworks Exception" for now
      */
-    name: string;
+    Name: string;
     /**
      * Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
      */
-    code: number;
+    Code: number;
     /**
      * The error message
      */
-    message: string;
+    Message: string;
     /**
      * The error message
      */
-    error_messages: Array<CWErrorMsgs>;
+    Error_messages: Array<CWErrorMsgs>;
     /**
      * Object stuffed with any other information one wishes to include in the thrown error
      */
-    info?: string;
+    Info?: string;
     /**
      * CWError implements a custom error class for this codebase with additional information
      *

package/dist/index.d.ts

@@ -222,10 +222,10 @@ declare const activity_link: ActivityLinks;
 declare const message_queue: MessageQueue;
 declare const search: Search;
 declare const query: Query;
-declare const report: Report;
 declare const gis: Gis;
 declare const request: Request;
 declare const inspection: Inspection;
 declare const workorder: WorkOrder;
 declare const briefcase: Briefcase;
+declare const report: Report;
 export { cw as Cityworks, general, activity_link, message_queue, search, query, gis, request, inspection, workorder, briefcase, report };