cityworks 0.0.42 → 0.0.44

package/README.md

@@ -6,17 +6,17 @@ Require the class:
 
       const Cityworks = require('cityworks')
 
-      import { Cityworks } from 'cityworks'
+      import * as cw from 'cityworks'
 
 Instantiate the Class for the instance of Cityworks available given a domain:
 
-      let cw = new Cityworks('cw.domain.tld', {path: 'cityworks'})
+      cw.Cityworks.configure('cw.domain.tld', {path: 'cityworks'})
 
 ## Authentication
 
 Authenticate with the Cityworks install:
 
-      cw.authenticate('myuser', 'mypassword').then(resp => {
+      cw.Cityworks.authenticate('myuser', 'mypassword').then(resp => {
 
       }).catch(error => {
         console.log(error.message)
@@ -25,26 +25,26 @@ Authenticate with the Cityworks install:
 
 Get the currently valid token in order to store it in a session or cookie:
 
-      cw.getToken()
+      cw.Cityworks.getToken()
 
 Provide a saved token instead of the standard u/p auth:
 
-      cw.setToken('mytoken')
+      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.Case.html) object libraries like so:
+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.Cityworks.inspection.methodHere().then(resp => {
 
       })
-      cw.workorder.methodHere().then(resp => {
+      cw.Cityworks.workorder.methodHere().then(resp => {
 
       })
-      cw.request.methodHere().then(resp => {
+      cw.Cityworks.request.methodHere().then(resp => {
 
       })
-      cw.case.methodHere().then(resp => {
+      cw.Cityworks.briefcase.methodHere().then(resp => {
 
       })
 
@@ -52,31 +52,31 @@ Some of the methods are general or top-level, and so, are accessed separately ar
 
 [General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
 
-      cw.general.methodHere().then(resp => {
+      cw.Cityworks.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 => {
+      cw.Cityworks.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 => {
+      cw.Cityworks.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 => {
+      cw.Cityworks.gis.methodHere().then(resp => {
 
       })
 
 [General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
 
-      cityworks.search.methodHere().then(resp => {
+      cw.Cityworks.search.methodHere().then(resp => {
 
       })
 
@@ -86,40 +86,40 @@ For the sake of organizing some of the other methods needed by the primary and s
 
 For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
 
-      cw.case.financial.methodHere().then(resp => {
+      cw.Cityworks.briefcase.financial.methodHere().then(resp => {
 
       })
 
 For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
 
-      cw.case.data.methodHere().then(resp => {
+      cw.Cityworks.briefcase.data.methodHere().then(resp => {
 
       })
 
 For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
 
-      cw.case.workflow.methodHere().then(resp => {
+      cw.Cityworks.briefcase.workflow.methodHere().then(resp => {
 
       })
 
 For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
 
-      cw.case.admin.methodHere().then(resp => {
+      cw.Cityworks.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/case_admin.CaseAdmin.html) via the class the comment is to be made on:
+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.case.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {
+      cw.Cityworks.briefcase.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {
 
       })
 
-      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {
+      cw.Cityworks.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {
 
       })
 
-      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {
+      cw.Cityworks.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {
 
       })

package/dist/briefcase.d.ts

@@ -0,0 +1,114 @@
+export declare class Briefcase {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Data Detail methods
+     */
+    data?: Object;
+    /**
+     * Asset (Address) methods
+     */
+    asset?: Object;
+    /**
+     * Workflow & task methods
+     */
+    workflow?: Object;
+    /**
+     * Payment, Receipt, & Fee methods
+     */
+    financial?: Object;
+    /**
+     * Commenting methods
+     */
+    comment?: Object;
+    /**
+     * PLL Administration methods
+     */
+    admin?: Object;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Create new case
+     *
+     * @category Cases
+     * @param {number} caseTypeId - The case Type ID
+     * @param {number} subTypeId - The case subType ID
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+     * @return {Object} Returns Promise that represents an object describing the newly-created case
+     */
+    create(caseTypeId: number, subTypeId: number, options?: Object): Promise<unknown>;
+    /**
+     * Create a child case
+     *
+     * @category Cases
+     * @param {number} busCaseId - The case Type ID
+     * @param {number} parentCaObjectId - The case subType ID
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+     * @return {Object} Returns Promise that represents an object describing the newly-created case
+     */
+    createChild(busCaseId: number, parentCaObjectId: number, options?: Object): Promise<unknown>;
+    /**
+     * Create a case from a Service Request
+     *
+     * @category Cases
+     * @param {number} caseTypeId - The case Type ID
+     * @param {number} subTypeId - The case subType ID
+     * @param {number} requestId - The service request ID
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+     * @return {Object} Returns Promise that represents an object describing the newly-created case
+     */
+    createFromRequest(caseTypeId: number, subTypeId: number, requestId: number, options?: Object): Promise<unknown>;
+    /**
+     * Update a case
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case Object ID to update
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
+     * @return {Object} Returns Promise that represents an object describing the updated case
+     */
+    update(caObjectId: number, options?: Object): Promise<unknown>;
+    /**
+     * Get cases by IDs
+     *
+     * @category Cases
+     * @param {Array<number>} caObjectIds - The case Object ID to update
+     * @return {Object} Returns Promise that represents a collection of objects describing the cases
+     */
+    getByIds(caObjectIds: Array<number>): Promise<unknown>;
+    /**
+     * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Cases
+     * @param {Object} filters - The parameter(s) to search by
+     * @return {Object} Returns Promise that represents an Array of case Object IDs
+     */
+    search(filters: Object): Promise<unknown>;
+    /**
+     * Move a Case point
+     *
+     * @category Cases
+     * @param {string} caObjectId
+     * @param {number} x
+     * @param {number} y
+     * @param {Object} projection - Should include at least 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 GISPoint
+     */
+    move(caObjectId: number, x: number, y: number, projection: {
+        WKID?: string;
+        WKT?: string;
+        VcsWKID?: string;
+    }, z?: number): Promise<unknown>;
+    /**
+     * Delete case
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case Object ID
+     * @return {Object} Returns Promise that represents an object describing the deleted case
+     */
+    delete(caObjectId: number): Promise<unknown>;
+}

package/dist/index.d.ts

@@ -1,11 +1,222 @@
-export { Cityworks } from './cityworks';
-export { CWError } from './error';
-export { General } from './general';
-export { ActivityLinks } from './activity_link';
-export { Gis } from './gis';
-export { MessageQueue } from './message_queue';
-export { Search } from './search';
-export { Request } from './request';
-export { Inspection } from './inspection';
-export { WorkOrder } from './workorder';
-export { Case } from './case';
+import { General } from './general';
+import { ActivityLinks } from './activity_link';
+import { Gis } from './gis';
+import { MessageQueue } from './message_queue';
+import { Search } from './search';
+import { Request } from './request';
+import { Inspection } from './inspection';
+import { WorkOrder } from './workorder';
+import { Briefcase } from './briefcase';
+interface Citywork {
+}
+/**
+ * Core class Cityworks with most of the authentication and install capabilities functions
+ */
+declare class Cityworks implements Citywork {
+    /**
+     * The domain of the cityworks install. Defaults to Cityworks Online
+     */
+    private base_url;
+    /**
+     * Stores the currently in use authentication token
+     */
+    private Token?;
+    /**
+     * Stores the login username
+     */
+    private login?;
+    /**
+     * Holds the login password
+     */
+    private password?;
+    /**
+     * Holds the GIS Token for GIS-based Authentication (Portal)
+     */
+    private gisToken?;
+    /**
+     * Holds the GIS Token URL for GIS-based Authentication (Portal)
+     */
+    private gisTokenUrl?;
+    /**
+     * Stores settings including path (defaults to "cityworks"), secure (defaults to true), expires (defaults to null - does not expire), default_domain
+     */
+    private settings;
+    error?: any;
+    private extensions;
+    private features;
+    private potential_loads;
+    /**
+       * 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>;
+}
+declare const cw: Cityworks;
+declare const general: General;
+declare const activity_link: ActivityLinks;
+declare const message_queue: MessageQueue;
+declare const search: Search;
+declare const gis: Gis;
+declare const request: Request;
+declare const inspection: Inspection;
+declare const workorder: WorkOrder;
+declare const briefcase: Briefcase;
+export { cw as Cityworks, general, activity_link, message_queue, search, gis, request, inspection, workorder, briefcase };