cityworks 1.0.6 → 2.1.0

package/dist/error.d.ts

@@ -1,57 +1,57 @@
-export interface CWErrorMsgs {
-    MessageType: number;
-    Code: number;
-    Service: string;
-    Name: string;
-    DebugDetails: string;
-    DisplayText: string;
-    InnerMessage: string | null;
-}
-/**
- * CWErrorInt interface definition for implementation by CWError
- *
- * `{name: string, code: number, message: string, info?: string}`
- *
- */
-export interface CWErrorInt {
-    name: string;
-    code: number;
-    message: string;
-    error_messages?: Array<CWErrorMsgs>;
-    info?: string;
-}
-/**
- * CWError implements a custom error class for this codebase with additional information
- *
- */
-export declare class CWError implements CWErrorInt {
-    /**
-     * Just statically set to "Cityworks Exception" for now
-     */
-    name: string;
-    /**
-     * Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
-     */
-    code: number;
-    /**
-     * The error message
-     */
-    message: string;
-    /**
-     * The error message
-     */
-    error_messages: Array<CWErrorMsgs>;
-    /**
-     * Object stuffed with any other information one wishes to include in the thrown error
-     */
-    info?: string;
-    /**
-     * CWError implements a custom error class for this codebase with additional information
-     *
-     * @param {number} code - Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
-     * @param {string} message - The error message
-     * @param {Object} info - Object stuffed with any other information one wishes to include in the thrown error
-     * @return {Object} Returns instance of CWError object
-     */
-    constructor(code: number, message: string, info?: any);
-}
+export interface CWErrorMsgs {
+    MessageType: number;
+    Code: number;
+    Service: string;
+    Name: string;
+    DebugDetails: string;
+    DisplayText: string;
+    InnerMessage: string | null;
+}
+/**
+ * CWErrorInt interface definition for implementation by CWError
+ *
+ * `{name: string, code: number, message: string, info?: string}`
+ *
+ */
+export interface CWErrorInt {
+    name: string;
+    code: number;
+    message: string;
+    error_messages?: Array<CWErrorMsgs>;
+    info?: string;
+}
+/**
+ * CWError implements a custom error class for this codebase with additional information
+ *
+ */
+export declare class CWError implements CWErrorInt {
+    /**
+     * Just statically set to "Cityworks Exception" for now
+     */
+    name: string;
+    /**
+     * Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
+     */
+    code: number;
+    /**
+     * The error message
+     */
+    message: string;
+    /**
+     * The error message
+     */
+    error_messages: Array<CWErrorMsgs>;
+    /**
+     * Object stuffed with any other information one wishes to include in the thrown error
+     */
+    info?: string;
+    /**
+     * CWError implements a custom error class for this codebase with additional information
+     *
+     * @param {number} code - Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
+     * @param {string} message - The error message
+     * @param {Object} info - Object stuffed with any other information one wishes to include in the thrown error
+     * @return {Object} Returns instance of CWError object
+     */
+    constructor(code: number, message: string, info?: any);
+}

package/dist/general.d.ts

@@ -1,78 +1,78 @@
-/**
- * A plugin that contains "general" methods for a Cityworks install
- */
-export declare class General {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get notifications for currently authenticated user
-     *
-     * @return {Object} Returns Promise object that represents a collection of available notifications
-     */
-    notifications(): Promise<unknown>;
-    /**
-     * Find out if the current user is watching a particular activity (case, task, null [as a string])
-     *
-     * @param {string} activityType - which activity type the following ID will be for.
-     * @param {number} activityId - activity Case or CaseTask (task instance) ID to check
-     * @return {Object} Returns Promise object that represents a boolean indicating the currently authenticated user is watching the provided activity
-     */
-    amIWatching(activityType: any, activityId: number): Promise<unknown>;
-    /**
-     * Get CwMetatData by Type and CwSid
-     *
-     * @param {Array<number>} Ids
-     * @param {string} TableName - INSPECTION, REQUEST, WORKORDER require View permission on the activities
-     * @return {Object} Returns Promise object that represents a
-     */
-    getActivityMetadataByIds(ids: Array<number>, table: string): Promise<unknown>;
-    /**
-     * Get recent history for authenticated user
-     *
-     * @return {Object} Returns Promise object that represents a collection of RecentActivity objects
-     */
-    getHistory(): Promise<unknown>;
-    /**
-     * 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 WorkOrder entities selected through a search definition
-     *
-     * @param {number} SearchId - Search Definition Id
-     * @return {Object} Returns Promise object that represents a
-     */
-    searchWOEntityCostSummary(search_id: number): Promise<unknown>;
-    /**
-     * Get Holidays
-     *
-     * @param {Date} startDate - Date to search for Holidays, including this date.
-     * @param {Date} [endDate] - If not specified, Holidays _on_ startDate are returned. If specified, Holidays on startDate up to, but not including endDate are returned.
-     * @return {Object} Returns Promise object that represents a list of the holiday(s) found
-     */
-    getHolidays(startDate: Date, endDate?: Date): Promise<unknown>;
-    /**
-     * Add Holidays
-     *
-     * @param {Date} holiday - The holiday's date
-     * @param {string} description - The holiday's name/description
-     * @return {Object} Returns Promise object that represents a
-     */
-    addHolidays(holiday: Date, description: string): Promise<unknown>;
-    /**
-     * Delete Holidays
-     *
-     * @param {Array<Date>} holidays - List of datetimes which should have holidays deleted
-     * @return {Object} Returns Promise object that represents a
-     */
-    deleteHolidays(holidays: Array<Date>): Promise<unknown>;
-}
+/**
+ * A plugin that contains "general" methods for a Cityworks install
+ */
+export declare class General {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Get notifications for currently authenticated user
+     *
+     * @return {Object} Returns Promise object that represents a collection of available notifications
+     */
+    notifications(): Promise<unknown>;
+    /**
+     * Find out if the current user is watching a particular activity (case, task, null [as a string])
+     *
+     * @param {string} activityType - which activity type the following ID will be for.
+     * @param {number} activityId - activity Case or CaseTask (task instance) ID to check
+     * @return {Object} Returns Promise object that represents a boolean indicating the currently authenticated user is watching the provided activity
+     */
+    amIWatching(activityType: any, activityId: number): Promise<unknown>;
+    /**
+     * Get CwMetatData by Type and CwSid
+     *
+     * @param {Array<number>} Ids
+     * @param {string} TableName - INSPECTION, REQUEST, WORKORDER require View permission on the activities
+     * @return {Object} Returns Promise object that represents a
+     */
+    getActivityMetadataByIds(ids: Array<number>, table: string): Promise<unknown>;
+    /**
+     * Get recent history for authenticated user
+     *
+     * @return {Object} Returns Promise object that represents a collection of RecentActivity objects
+     */
+    getHistory(): Promise<unknown>;
+    /**
+     * 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 WorkOrder entities selected through a search definition
+     *
+     * @param {number} SearchId - Search Definition Id
+     * @return {Object} Returns Promise object that represents a
+     */
+    searchWOEntityCostSummary(search_id: number): Promise<unknown>;
+    /**
+     * Get Holidays
+     *
+     * @param {Date} startDate - Date to search for Holidays, including this date.
+     * @param {Date} [endDate] - If not specified, Holidays _on_ startDate are returned. If specified, Holidays on startDate up to, but not including endDate are returned.
+     * @return {Object} Returns Promise object that represents a list of the holiday(s) found
+     */
+    getHolidays(startDate: Date, endDate?: Date): Promise<unknown>;
+    /**
+     * Add Holidays
+     *
+     * @param {Date} holiday - The holiday's date
+     * @param {string} description - The holiday's name/description
+     * @return {Object} Returns Promise object that represents a
+     */
+    addHolidays(holiday: Date, description: string): Promise<unknown>;
+    /**
+     * Delete Holidays
+     *
+     * @param {Array<Date>} holidays - List of datetimes which should have holidays deleted
+     * @return {Object} Returns Promise object that represents a
+     */
+    deleteHolidays(holidays: Array<Date>): Promise<unknown>;
+}

package/dist/gis.d.ts

@@ -1,92 +1,92 @@
-export declare class Gis {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get gis service configuration for user, group, domain, or service id
-     *
-     * @param {string} [whichType] - domain, group, mapservice, or user
-     * @param {number} [whichId] - domain, group, mapservice, or user Id
-     * @param {number} [getGisData] - If true, check for feature server JSON data, default is true
-     * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
-     * @return {Object} Returns Promise object that represents an Object with the desired GIS service definitions
-     */
-    getConfig(whichType: any, whichId: any, getGisData?: boolean, context?: Array<string>): Promise<unknown>;
-    /**
-      * Get domain gis services
-      *
-      * @param {number} domainId - The mobile map cache Id to download
-      * @return {Object} Returns Promise object that represents an Object with the domain's default GIS services
-      */
-    domain(domainId: any, getGisData?: boolean): Promise<unknown>;
-    /**
-       * Download mobile map cache
-       *
-       * @param {number} cacheId - The mobile map cache Id to download
-       * @return {Object} Returns Promise object that represents a streaming download (?)
-       */
-    downloadMobile(cacheId: any, getGisData?: boolean): Promise<unknown>;
-    /**
-     * Get initial extent for user
-     *
-     * @return {Object} Returns Promise object that represents ... (?)
-     */
-    initialExtent(): Promise<unknown>;
-    /**
-     * Get service request gis services
-     *
-     * @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)
-     */
-    request(requestId: any, getGisData?: boolean): Promise<unknown>;
-    /**
-       * Get inspection gis services
-       *
-       * @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
-       */
-    inspection(inspectionId: any, getGisData?: boolean): Promise<unknown>;
-    /**
-       * Get workorder gis services
-       *
-       * @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 WorkOrder's entit(y|ies)
-       */
-    workOrder(workOrderSid: any, getGisData?: boolean): Promise<unknown>;
-    /**
-       * Get service request gis services
-       *
-       * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
-       * @param {boolean} [allDomains] services assigned to any domain the user belongs to, default is true
-       * @param {boolean} [allGroups] services assigned to any groups the user belongs to regardless of domain, default is true
-       * @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 user's GIS services
-       */
-    user(context?: Array<string>, allDomains?: boolean, allGroups?: boolean, getGisData?: boolean): Promise<unknown>;
-    /**
-     * Get Geocode server info by ServerId
-     *
-     * @param {number} ServiceId
-     * @return {Object} Returns Promise object that represents an object describing the provided Geocoder service configuration
-     */
-    /**
-       * Get currently selected entities from the Cityworks install's session for your user
-       * @return {Object} Returns Promise object that represents an Object with the currently-selected entities
-       */
-    selectedEntities(): Promise<unknown>;
-    /**
-       * Get attributes available for provided entity
-       *
-       * @param {string} entityType - The entity type to describe
-       * @return {Object} Returns Promise object that represents a collection of attribute description objects
-       */
-    getEntityAttributes(entityType: string): Promise<unknown>;
-}
+export declare class Gis {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Get gis service configuration for user, group, domain, or service id
+     *
+     * @param {string} [whichType] - domain, group, mapservice, or user
+     * @param {number} [whichId] - domain, group, mapservice, or user Id
+     * @param {number} [getGisData] - If true, check for feature server JSON data, default is true
+     * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
+     * @return {Object} Returns Promise object that represents an Object with the desired GIS service definitions
+     */
+    getConfig(whichType: any, whichId: any, getGisData?: boolean, context?: Array<string>): Promise<unknown>;
+    /**
+      * Get domain gis services
+      *
+      * @param {number} domainId - The mobile map cache Id to download
+      * @return {Object} Returns Promise object that represents an Object with the domain's default GIS services
+      */
+    domain(domainId: any, getGisData?: boolean): Promise<unknown>;
+    /**
+       * Download mobile map cache
+       *
+       * @param {number} cacheId - The mobile map cache Id to download
+       * @return {Object} Returns Promise object that represents a streaming download (?)
+       */
+    downloadMobile(cacheId: any, getGisData?: boolean): Promise<unknown>;
+    /**
+     * Get initial extent for user
+     *
+     * @return {Object} Returns Promise object that represents ... (?)
+     */
+    initialExtent(): Promise<unknown>;
+    /**
+     * Get service request gis services
+     *
+     * @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)
+     */
+    request(requestId: any, getGisData?: boolean): Promise<unknown>;
+    /**
+       * Get inspection gis services
+       *
+       * @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
+       */
+    inspection(inspectionId: any, getGisData?: boolean): Promise<unknown>;
+    /**
+       * Get workorder gis services
+       *
+       * @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 WorkOrder's entit(y|ies)
+       */
+    workOrder(workOrderSid: any, getGisData?: boolean): Promise<unknown>;
+    /**
+       * Get service request gis services
+       *
+       * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
+       * @param {boolean} [allDomains] services assigned to any domain the user belongs to, default is true
+       * @param {boolean} [allGroups] services assigned to any groups the user belongs to regardless of domain, default is true
+       * @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 user's GIS services
+       */
+    user(context?: Array<string>, allDomains?: boolean, allGroups?: boolean, getGisData?: boolean): Promise<unknown>;
+    /**
+     * Get Geocode server info by ServerId
+     *
+     * @param {number} ServiceId
+     * @return {Object} Returns Promise object that represents an object describing the provided Geocoder service configuration
+     */
+    /**
+       * Get currently selected entities from the Cityworks install's session for your user
+       * @return {Object} Returns Promise object that represents an Object with the currently-selected entities
+       */
+    selectedEntities(): Promise<unknown>;
+    /**
+       * Get attributes available for provided entity
+       *
+       * @param {string} entityType - The entity type to describe
+       * @return {Object} Returns Promise object that represents a collection of attribute description objects
+       */
+    getEntityAttributes(entityType: string): Promise<unknown>;
+}