cityworks 0.0.32 → 0.0.36

package/README.md

@@ -4,11 +4,11 @@ This API wrapper for Cityworks follows the Cityworks release schedule as closely
 
 Require the class:
 
-      const Cityworks = require('cityworks');
+      const Cityworks = require('cityworks')
 
 Instantiate the Class for the instance of Cityworks available given a domain:
 
-      let cw = new Cityworks(CW_DOMAIN)
+      let cw = new Cityworks('cw.domain.tld', {path: 'cityworks'})
 
 ## Authentication
 
@@ -17,17 +17,17 @@ Authenticate with the Cityworks install:
       cw.authenticate('myuser', 'mypassword').then(resp => {
 
       }).catch(error => {
-        console.log(error.message);
-      });
+        console.log(error.message)
+      })
 
 
 Get the currently valid token in order to store it in a session or cookie:
 
-      cityworks.getToken();
+      cityworks.getToken()
 
 Provide a saved token instead of the standard u/p auth:
 
-      cityworks.setToken('mytoken');
+      cityworks.setToken('mytoken')
 
 ## Main method calls
 
@@ -78,7 +78,7 @@ Some of the methods are general or top-level, and so, are accessed separately ar
 
       })
 
-## Case finnacials, data details, and admin
+## 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:
 

package/dist/case.d.ts

@@ -7,6 +7,10 @@ export declare class Case {
      * Data Detail methods
      */
     data?: Object;
+    /**
+     * Asset (Address) methods
+     */
+    asset?: Object;
     /**
      * Workflow & task methods
      */

package/dist/case_assets.d.ts

@@ -0,0 +1,88 @@
+export declare class CaseAssets {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Attach asset to case
+     *
+     * @category Case Assets
+     * @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 attaching the asset. Defaults to true.
+     * @param {Object} [options] - Options for CaseDataGroup including Address, AddressId, AssetId, AssetObjectId, AssetType, CityName, CrossStreet, DateExpired, ExpiredFlag, Facility_Id, FeatureAssetId, FeatureClass, FeatureObjectId, LegacyId, Level_Id, LndObjectId, Location, MasterFlag, ObjectId, StateCode, StreetDirection, StreetFraction, StreetName, StreetNumber, StreetPostDir, StreetType, Suite, TileNo, UpdateCaseData, XCoord, YCoord, ZCoord, and ZipCode
+     * @return {Object} Returns Promise that represents an object describing CaAddress.
+     */
+    attach(caObjectId: number, updateXY?: boolean, options?: {
+        Address?: string;
+        AddressId?: number;
+        AssetId?: string;
+        AssetObjectId?: number;
+        AssetType?: string;
+        CityName?: string;
+        CrossStreet?: string;
+        DateExpired?: string;
+        ExpiredFlag?: string;
+        Facility_Id?: string;
+        FeatureAssetId?: string;
+        FeatureClass?: string;
+        FeatureObjectId?: number;
+        LegacyId?: string;
+        Level_Id?: string;
+        LndObjectId?: number;
+        Location?: string;
+        MasterFlag?: string;
+        ObjectId?: string;
+        StateCode?: string;
+        StreetDirection?: string;
+        StreetFraction?: string;
+        StreetName?: string;
+        StreetNumber?: number;
+        StreetPostDir?: string;
+        StreetType?: string;
+        Suite?: string;
+        TileNo?: string;
+        UpdateCaseData?: boolean;
+        XCoord?: number;
+        YCoord?: number;
+        ZCoord?: number;
+        ZipCode?: string;
+    }): Promise<unknown>;
+    /**
+     * Detach specific asset from case
+     *
+     * @category Case Assets
+     * @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 assets. Defaults to true.
+     * @return {Object} Returns Promise that represents a collection of the default CaDataGroupItemBases.
+     */
+    detach(caAddressId: number, updateXY?: boolean): Promise<unknown>;
+    /**
+     * Detach all assets from case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object to detach the assets from.
+     * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the asset(s). Defaults to false.
+     * @return {Object} Returns Promise that represents a collection of detached CaAddressIds.
+     */
+    detachAll(caObjectId: number, updateXY?: boolean): Promise<unknown>;
+    /**
+     * Get assets attached to a specific case
+     *
+     * @category Case Assets
+     * @param {number} caObjectId - The Case Object from which to get attached assets
+     * @return {Object} Returns Promise that represents a collection of the default CaAddresses.
+     */
+    getForCase(caObjectId: number): Promise<unknown>;
+    /**
+     * Search for Case Assets. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Case Assets
+     * @param {Object} filters - The parameters to search by. (AssetType, CaAddressId, CaObjectId, CityName, ExpiredFlag, StateCode, StateName, StreetName, StreetNumber, Suite, ZipCode)
+     * @return {Object} Returns Promise that represents an Array of resulting CaAddresses
+     */
+    search(filters?: Object): Promise<unknown>;
+}

package/dist/case_data.d.ts

@@ -157,7 +157,7 @@ export declare class CaseData {
      * Search for List Value Objects. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
      *
      * @category Data List Values
-     * @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue)
+     * @param {Object} filters - The parameters to search by. (CaDataDetailId, CaDataListId, ListValue, CaDataGroupId)
      * @return {Object} Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
      */
     searchForListValueObjects(filters?: Object): Promise<unknown>;

package/dist/case_workflow.d.ts

@@ -156,4 +156,32 @@ export declare class CaseWorkflow {
      * @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/cityworks.d.ts

@@ -1 +1,239 @@
+/**
+ * Core interface Citywork which defines the access vars for many of the functions and the connection settings
+ */
+interface Citywork {
+    base_url: any;
+    settings: Object;
+    login?: string;
+    password?: string;
+    Token?: string;
+    gisToken?: string;
+    gisTokenUrl?: string;
+    default_domain?: any;
+    general?: Object;
+    search?: Object;
+    activity_link?: Object;
+    message_queue?: Object;
+    gis?: Object;
+    inspection?: Object;
+    workorder?: Object;
+    request?: Object;
+    case?: Object;
+    extensions: Object;
+    features: Object;
+}
+/**
+ * Core class Cityworks with most of the authentication and install capabilities functions
+ */
+export default class Cityworks implements Citywork {
+    /**
+     * The domain of the cityworks install. Defaults to Cityworks Online
+     */
+    base_url: string;
+    /**
+     * Stores the currently in use authentication token
+     */
+    Token?: string;
+    /**
+     * Stores the login username
+     */
+    login?: string;
+    /**
+     * Holds the login password
+     */
+    password?: string;
+    /**
+     * Holds the GIS Token for GIS-based Authentication (Portal)
+     */
+    gisToken?: string;
+    /**
+     * Holds the GIS Token URL for GIS-based Authentication (Portal)
+     */
+    gisTokenUrl?: string;
+    /**
+     * Stores settings including path (defaults to "cityworks"), secure (defaults to true), expires (defaults to null - does not expire), default_domain
+     */
+    settings: {
+        path: string;
+        secure: boolean;
+        expires: any;
+        default_domain?: any;
+    };
+    error?: Object;
+    general?: Object;
+    search?: Object;
+    activity_link?: Object;
+    message_queue?: Object;
+    gis?: Object;
+    request?: Object;
+    inspection?: Object;
+    workorder?: Object;
+    case?: Object;
+    extensions: Object;
+    features: Object;
+    potential_loads: Array<string>;
+    /**
+       * Contructor for a new cityworks instance's object, allows one to optionally configure the domain and other settings right from the get-go
+       * @param {string} [base_url] - The first color, in hexadecimal format.
+       * @param {object} [settings] - The second color, in hexadecimal format.
+       * @param {array} [load] - allows user to choose which modules to load and make available. Full availability array: ['general', 'activity_link', 'message_queue', 'gis', 'workorder', 'inspection', 'request', 'case']
+       */
+    constructor(base_url?: string, settings?: Object, load?: Array<string>);
+    /**
+       * Configure a new cityworks instance's domain and other settings
+       *
+       * @param {string} [base_url] - The first color, in hexadecimal format.
+       * @param {object} [settings] - The second color, in hexadecimal format.
+       * @param {array} [load] - allows user to choose which modules to load and make available. Full availability array: ['general', 'activity_link', 'message_queue', 'gis', 'search', 'workorder', 'inspection', 'request', 'case']
+       * @return {boolean} Returns true if successful, otherwise, throws error
+       */
+    configure(base_url?: string, settings?: Object, load?: Array<string>): void;
+    /**
+       * Send a request to the Cityworks API
+       *
+       * If one ever needs to access or call an unimplemented API endpoint of a Cityworks install, one can call this method directly with the path and data payload:
+       *
+       * `cityworks.runRequest(path, data)`
+       *
+       * @param {string} path - The path to the particular endpoint
+       * @param {Object} data - The data object to be sent to the Cityworks API
+       * @param {any} file - The file to send in binary to the Cityworks API
+       * @return {Object} Returns Promise object that represents the json object returned from the Cityworks API
+       */
+    runRequest(path: any, data?: any, file?: any): Promise<unknown>;
+    /**
+       * Authenticate with the Cityworks API and store an access token for use. Stores the token on cityworks.Token.
+       * @param {string} login - User's login name
+       * @param {password} password - User's password
+       * @return {Object} Returns Promise object that represents a boolean which tells you the login succeeded (true) or failed (false).
+       */
+    authenticate(login: string, password: string): Promise<unknown>;
+    /**
+       * Authenticate a username with a GIS Token
+       * @param {login} - Gis user name, should match a Cityworks employee login name
+       * @param {string} gisToken - Gis Oauth2 access token
+       * @param {string} gisTokenUrl - Base url to GIS server (not the '/generateToken' endpoint)
+       * @param {number} [expires] - Authenticate to Cityworks for a specified number of milliseconds, defaults to 2 weeks
+       */
+    authenticateWithGISToken(login: string, gisToken: string, gisTokenUrl: string, expires?: number): Promise<unknown>;
+    /**
+       * Validate provided token
+       * @param {string} token - User's login name
+       * @param {boolean} [set] - Set a valid token as the cityworks instance's active token
+       * @return {Object} Returns Promise object that represents a boolean which apprises one of the token's validity and that is was set (true) or throws an error if was not valid (and not set).
+       */
+    validateToken(token: string, set?: boolean): Promise<unknown>;
+    /**
+       * Set a token you've retrieved from your storage system as the active token for the cityworks instance. Note that this doesn't check the token for validity.
+       * @param {token} token - The token string to set as the active token.
+       * @return {boolean} Returns a boolean which apprises one that the token was set (true) or not set (false).
+       */
+    setToken(token: any): boolean;
+    /**
+       * Get currently set, valid token
+       * @param {token} token - The token string to set as the active token.
+       * @return {string} Returns a string which is the currently-set token or the boolean false value if no (valid) token set
+       */
+    getToken(): string | false;
+    /**
+       * Revoke all current user's tokens or only tokens created before a particular date and time.
+       * @param {number} [revokeBefore] - Datetime as an Epoch integer (number), if you wish to revoke only tokens created before a particular datetime
+       * @return {Object} Returns Promise object that represents a boolean which apprises one of the revocation outcome's success (true) or failure (false)
+       */
+    revokeToken(revokeBefore?: number): Promise<unknown>;
+    /**
+       * Get the localization settings for current Cityworks install
+       * @return {Object} Returns Promise object that represents an Object which contains all the localization settings for the current Cityworks install
+       */
+    getLocalizationSettings(): Promise<unknown>;
+    /**
+       * Get the system timezone options for current Cityworks install
+       * @return {Object} Returns Promise object that represents an Object which contains all the timezone settings for the currentCityworks install
+       */
+    getTimezoneOptions(): Promise<unknown>;
+    /**
+       * Get the current install's location information
+       * @return {Object} Returns Promise object that represents an Object which contains the location information
+       */
+    getCurrentLocation(): Promise<unknown>;
+    /**
+       * Check if a particular license is available to the currently-authenticated user
+       * @param {string} area - Area of access
+       * @param {string} service - Service to access
+       * @return {boolean} Returns Promise object that represents a boolean which informs access is granted (true) or denied (false)
+       */
+    licensedApiCheck(area: string, service: string): Promise<unknown>;
+    /**
+       * Check if a current Cityworks install is licensed to use a particular extension
+       *
+       * Possible extensions currently include: "UnknownExtension", "CwAnalytics", "WebHooks", "PLLPublicApp", "ActivityUpdate", "SingleSignOn"
+       *
+       * @param {string} extension - Extension name
+       * @return {boolean} Returns Promise object that represents a boolean which informs extension is licensed (true) or not (false)
+       */
+    licensedExtensionCheck(extension: string): Promise<unknown>;
+    /**
+       * Check a whole list to see if current Cityworks install is licensed to use extensions
+       *
+       * Possible extensions currently include: "UnknownExtension", "CwAnalytics", "WebHooks", "PLLPublicApp", "ActivityUpdate", "SingleSignOn"
+       *
+       * @param {Array<string>} extension - Extension names
+       * @return {Object} Returns Promise object that represents a boolean which informs extension is licensed (true) or not (false)
+       */
+    licensedExtensionsCheck(extensions: Array<string>): Promise<unknown>;
+    /**
+       * Check if current user is licensed to use a feature:
+       *
+       * "UnknownFeature", "ViewInspections", "EditInspections", "ViewServiceRequest", "EditServiceRequest", "ViewWorkOrder", "EditWorkOrder", "EquipmentCheckOut", "OfficeField", "Respond", "Eurl", "PaverInterface", "Contracts", "Storeroom", "PLL", "Cw4XL", "TableEditor", "CCTVInterface", "MobileAndroid", "MobileiOS", "PerformanceBudgeting", "Insights", "RespondCase", "RespondInspection", "RespondServiceRequest", "RespondTaskManager", "RespondWorkOrder", "Workload", "OpX", "TrimbleUnityMobile", "TrimbleVegetationManager"
+       *
+       * @param {string} [feature] - Feature to check to see if ciurrently authenticated user can utilize
+       * @return {Object} Returns Promise object that represents a boolean which communicates license state as licensed (true) or not (false)
+       */
+    licensedFeatureCheck(feature: string): Promise<unknown>;
+    /**
+       * Check if current user is licensed to use features:
+       *
+       * "UnknownFeature", "ViewInspections", "EditInspections", "ViewServiceRequest", "EditServiceRequest", "ViewWorkOrder", "EditWorkOrder", "EquipmentCheckOut", "OfficeField", "Respond", "Eurl", "PaverInterface", "Contracts", "Storeroom", "PLL", "Cw4XL", "TableEditor", "CCTVInterface", "MobileAndroid", "MobileiOS", "PerformanceBudgeting", "Insights", "RespondCase", "RespondInspection", "RespondServiceRequest", "RespondTaskManager", "RespondWorkOrder", "Workload", "OpX", "TrimbleUnityMobile", "TrimbleVegetationManager"
+       *
+       * @param {Array<string>} [feature] - Features to check to see if currently authenticated user can utilize
+       * @return {Object} Returns Promise object that represents a boolean which communicates license state as licensed (true) or not (false)
+       */
+    licensedFeaturesCheck(features: Array<string>): Promise<unknown>;
+    /**
+       * Check if current user is licensed to use services. List req ServicesList of 'Area/Service', i.e.:
+       *
+       * ['AMS/Inspection','AMS/WorkOrder','PLL/Case']
+       *
+       * @param {Array<string>} [services] - Services to check to see if currently authenticated user can utilize
+       * @return {Object} Returns Promise object that represents a boolean which communicates license state as licensed (true) or not (false)
+       */
+    licensedServicesCheck(services: Array<string>): Promise<unknown>;
+    /**
+       * Get a list of CityworksOnline sites for this user
+       *
+       * @param {string} [login] - Login Name to use when checking. Defaults to previously-stored login name.
+       * @param {string} [password] - Password to use when checking. Defaults to previously-stored password.
+       * @return {Object} Returns Promise object that represents an array of cityworks online sites available to this user.
+       */
+    cityworksOnlineSites(login?: string, password?: string): Promise<unknown>;
+    /**
+       * Get a list of Domains (not tld, but organizations) in the currently-connected Cityworks install
+       *
+       * @return {Object} Returns Promise object that represents a collection of the configured domains.
+       */
+    domains(): Promise<unknown>;
+    /**
+       * Get a list of Domains (not tld, but organizations) in the currently-connected Cityworks install
+       *
+       * @param {string} [login] - Optional login name to get user information for. Defaults to currently-set user name used for login.
+       * @return {Object} Returns Promise object that represents an Object with the user information
+       */
+    user(login?: string): Promise<unknown>;
+    /**
+       * Get the software version number of the currently-connected Cityworks install
+       *
+       * @return {Object} Returns Promise object that represents a string of the version number
+       */
+    version(): Promise<unknown>;
+}
 export {};

package/dist/comments.d.ts

@@ -18,9 +18,9 @@ export declare class Comments {
     /**
      * @hidden
      */
-    constructor(cw: any, activityType: any);
+    constructor(cw: any, activityType: string);
     /**
-     * Add a comment
+     * 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

package/dist/general.d.ts

@@ -39,14 +39,14 @@ export declare class General {
      */
     getHistory(): Promise<unknown>;
     /**
-     * Get cost summary for work order entities
+     * Get cost summary for WorkOrder entities
      *
      * @param {Array<number>} ObjectIds
      * @return {Object} Returns Promise object that represents a
      */
     getWOEntityCostSummary(object_ids: Array<number>): Promise<unknown>;
     /**
-     * Get cost summary for work order entities selected through a search definition
+     * Get cost summary for WorkOrder entities selected through a search definition
      *
      * @param {number} SearchId - Search Definition Id
      * @return {Object} Returns Promise object that represents a

package/dist/gis.d.ts

@@ -40,7 +40,7 @@ export declare class Gis {
     /**
      * Get service request gis services
      *
-     * @param {number} requestId - The work order to check against.
+     * @param {number} requestId - The WorkOrder to check against.
      * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
      * @return {Object} Returns Promise object that represents an Object with the specified request's entit(y|ies)
      */
@@ -48,7 +48,7 @@ export declare class Gis {
     /**
        * Get inspection gis services
        *
-       * @param {number} inspectionId - The work order to check against.
+       * @param {number} inspectionId - The WorkOrder to check against.
        * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
        * @return {Object} Returns Promise object that represents an Object with the specified inspection's entity
        */
@@ -56,9 +56,9 @@ export declare class Gis {
     /**
        * Get workorder gis services
        *
-       * @param {number} workOrderSid - The work order to check against.
+       * @param {number} workOrderSid - The WorkOrder to check against.
        * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
-       * @return {Object} Returns Promise object that represents an Object with the specified work order's entit(y|ies)
+       * @return {Object} Returns Promise object that represents an Object with the specified WorkOrder's entit(y|ies)
        */
     workOrder(workOrderSid: any, getGisData?: boolean): Promise<unknown>;
     /**