cityworks 2.1.4 → 2.2.0

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/briefcase.d.ts

@@ -89,6 +89,10 @@ export declare class Briefcase {
      * Asset (Address) methods
      */
     asset?: any;
+    /**
+     * Flag methods
+     */
+    flag?: any;
     /**
      * Asset (Address) methods
      */

package/dist/case_assets.d.ts

@@ -11,7 +11,7 @@ export declare class CaseAssets {
      * Attach asset to case
      *
      * @category Case Assets
-     * @param {number} caObjectId - The Case Object to attach the data group to.
+     * @param {number} caObjectId - The Case Object to attach the asset 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.

package/dist/case_flags.d.ts

@@ -0,0 +1,60 @@
+export declare class CaseFlags {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Add flag to case
+     *
+     * @category Case Flags
+     * @param {number} caObjectId - The Case Object to add the flag to.
+     * @param {number} flagId - The flag ID
+     * @param {string} severity - The severity of the flag
+     * @param {number} appliedBy - Which userID is applying the flag
+     * @param {DateTime} DateApplied - The date that the flag should be applied
+     * @param {Object} [options] - Options for CaseFlags includes Notes, DisciplineId, CompletedBy, DateCompleted
+     * @return {Object} Returns Promise that represents an object describing CaFlag.
+     */
+    add(caObjectId: number, flagId: number, severity: string, appliedBy: number, DateApplied: Date, options?: {
+        Notes?: string;
+        DisciplineId?: number;
+        CompletedBy?: number;
+        DateCompleted?: Date;
+    }): Promise<unknown>;
+    /**
+     * Delete specific flag from case
+     *
+     * @category Case Flags
+     * @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>;
+    /**
+     * Delete all flags from case
+     *
+     * @category Case Flags
+     * @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>;
+    /**
+     * Get flags attached to a specific case
+     *
+     * @category Case Flags
+     * @param {number} caObjectId - The Case Object from which to get attached flags
+     * @return {Object} Returns Promise that represents a collection of the default CaFlags.
+     */
+    getForCase(caObjectId: number): Promise<unknown>;
+    /**
+     * Search for Case Flags. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
+     *
+     * @category Case Flags
+     * @param {Object} filters - The parameters to search by. (CaFlagId, Flag, FlagDesc)
+     * @return {Object} Returns Promise that represents an Array of resulting Flags
+     */
+    search(filters?: Object): 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 };