cityworks 1.0.2 → 1.0.4

package/README.md

@@ -101,3 +101,8 @@ For any object in Cityworks which has attachments, (including cases as CaRelDocs
       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/activity_link.d.ts

@@ -14,15 +14,11 @@ export interface ActivityLink {
  */
 export declare class ActivityLinks implements ActivityLink {
     /**
-     * Activity types to map string to number for internal use. Activity types available are:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
+     * Activity types to map string to number for internal use. Activity types available are: "null", "case", "inspection", "request", "workorder", "wipcase"
      */
     activityTypes: ReversibleMap<string, number>;
     /**
-     * Link types to map string to number for internal use. Link types available are:
-     *
-     *      "null", "parent", "related"
+     * Link types to map string to number for internal use. Link types available are: "null", "parent", "related"
      */
     linkTypes: ReversibleMap<string, number>;
     /**
@@ -36,30 +32,18 @@ export declare class ActivityLinks implements ActivityLink {
     /**
      * Create a new activity link between two items.
      *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} source_type - Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} destination_type - Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-     *
-     *      "null", "parent", "related"
-     *
+     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options: "null", "parent", "related"
      * @return {Object} Returns Promise object that represents a
      */
     add(source_type: string, source_sid: number, destination_type: string, destination_sid: number, link_type?: string): Promise<unknown>;
     /**
      * Get the links for a particular node type by ID.
      *
-     * @param {string} type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} type - Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {Array<number>} sids - Array of numeric (S)IDs you wish to get of the specified type
      * @return {Object} Returns Promise object that represents a collection
      */
@@ -67,15 +51,9 @@ export declare class ActivityLinks implements ActivityLink {
     /**
      * Clone a current activity link.
      *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} source_type - Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} source_sid - Source SID (numeric ID) one wishes to clone a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} destination_type - Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} destination_sid - Destination SID (numeric ID) one wishes to clone a link between SID as destination and a particular source
      * @return {Object} Returns Promise object that represents a
      */
@@ -90,20 +68,11 @@ export declare class ActivityLinks implements ActivityLink {
     /**
      * Remove a link by specifying everything.
      *
-     * @param {string} source_type - Source type as string. Options:
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} source_type - Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-     * @param {string} destination_type - Destination type as string
-     *
-     *      "null", "case", "inspection", "request", "workorder", "wipcase"
-     *
+     * @param {string} destination_type - Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"
      * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-     *
-     *      "null", "parent", "related"
-     *
+     * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options: "null", "parent", "related"
      * @return {Object} Returns Promise object that represents a
      */
     remove(source_type: string, source_sid: number, destination_type: string, destination_sid: number, link_type?: string): Promise<unknown>;

package/dist/briefcase.d.ts

@@ -1,8 +1,86 @@
+export interface Briefcase {
+    TempTableName: string;
+    AnonymousFlag: string;
+    RegisteredFlag: string;
+    CreatedByLoginId: string;
+    TableName: string;
+    ModifiedByLoginId: number;
+    AcceptedByLoginId: number;
+    EnteredByLoginid: number;
+    WorkOrderId: string;
+    WorkOrderDesc: string;
+    WorkOrderStatus: string;
+    ServiceRequestId: number;
+    ServiceRequestDesc: string;
+    ServiceRequestStatus: string;
+    CloneCaseRelation: any | null;
+    PendingFlag: any | null;
+    CaseGroup: any | null;
+    ParentCaObjectId: number | null;
+    AmountDue: number | null;
+    GetViewColumns: Array<string>;
+    CaObjectId: number;
+    OrgId: number;
+    CaseTypeId: number;
+    CaseType: string;
+    CaseTypeDesc: string;
+    BusCaseDesc: string | null;
+    SubTypeId: number | null;
+    SubType: string | null;
+    SubTypeDesc: string | null;
+    CreatedBy: number;
+    DateAccepted: Date | null;
+    DateCreated: Date;
+    DateEntered: Date;
+    DateExpiration: Date | null;
+    DateIssued: Date | null;
+    DateModified: Date | null;
+    EnteredBy: number;
+    ExpiredFlag: string | null;
+    IssuedBy: number | null;
+    IssuedFlag: string | null;
+    ModifiedBy: number | null;
+    SubTypeDefaultText: string | null;
+    CaseNumber: string;
+    CaseStatusId: number;
+    CaseStatus: string;
+    ProjectSid: number | null;
+    ProjectId: string | null;
+    ProjectCode: string | null;
+    ProjectDesc: string | null;
+    PriorityLevel: string | null;
+    StatusCode: string;
+    CaseName: string;
+    AcceptedBy: number;
+    BLicenseFlag: string | null;
+    BusinessName: string | null;
+    BusCaseId: number | null;
+    BusinessOrgType: string | null;
+    BusinessCategory: string | null;
+    StateTaxId: string | null;
+    FedTaxId: string | null;
+    Location: string | null;
+    PACaseFlag: string | null;
+    ActiveFlag: string | null;
+    CX: number | null;
+    CY: number | null;
+    CZ: number | null;
+    AssignedTo: number | null;
+    AssignedToLoginId: string | null;
+    AssignedToFirstName: string | null;
+    AssignedToLastName: string | null;
+    Facility_Id: string | number | null;
+    Level_Id: string | number | null;
+}
 export declare class Briefcase {
     /**
      * @hidden
      */
     cw: any;
+    /**
+     * @hidden
+     */
+    current_case: number;
     /**
      * Data Detail methods
      */
@@ -44,7 +122,7 @@ export declare class Briefcase {
      * @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(caseTypeId: number, subTypeId: number, options?: Object): Promise<Briefcase>;
     /**
      * Create a child case
      *
@@ -54,7 +132,7 @@ export declare class Briefcase {
      * @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>;
+    createChild(busCaseId: number, parentCaObjectId: number, options?: Object): Promise<Briefcase>;
     /**
      * Create a case from a Service Request
      *
@@ -74,15 +152,15 @@ export declare class Briefcase {
      * @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>;
+    update(caObjectId: number, options?: Object): Promise<Briefcase>;
     /**
      * Get cases by IDs
      *
      * @category Cases
-     * @param {Array<number>} caObjectIds - The case Object ID to update
+     * @param {Array<number>} caObjectIds - The case Object ID to get
      * @return {Object} Returns Promise that represents a collection of objects describing the cases
      */
-    getByIds(caObjectIds: Array<number>): Promise<unknown>;
+    getByIds(caObjectIds: Array<number>): Promise<Array<Briefcase>>;
     /**
      * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
      *
@@ -90,7 +168,7 @@ export declare class Briefcase {
      * @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>;
+    search(filters: Object): Promise<Array<number>>;
     /**
      * Move a Case point
      *

package/dist/case_assets.d.ts

@@ -15,6 +15,7 @@ export declare class CaseAssets {
      * @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.
+     * // {"AddressId":OBJECTID,"AssetId":"GUID","AssetType":"ASSET_NAME","CaObjectId":CA_OBJECTID,"FeatureAssetId":"GUID","FeatureClass":"ASSET_NAME","FeatureObjectId":OBJECTID,"Location":"Address string","ObjectId":"OBJECTID","XCoord":,"YCoord":,"UpdateCaseData":false}
      */
     attach(caObjectId: number, updateXY?: boolean, options?: {
         Address?: string;

package/dist/case_data.d.ts

@@ -48,10 +48,10 @@ export declare class CaseData {
      * Get groups by CaObjectId
      *
      * @category Data Groups
-     * @param {number} caObjectId - The Case Object to get the attached data groups.
+     * @param {number} caseId - The Case Object to get the attached data groups.
      * @return {Object} Returns Promise that represents a collection of the CaDataGroupItemBases.
      */
-    getGroupsByCaseId(caObjectId: number): Promise<unknown>;
+    getGroupsByCaseId(caseId: number): Promise<unknown>;
     /**
      * Delete Case Data Groups by Case Object ID.
      *
@@ -67,7 +67,7 @@ export declare class CaseData {
      * @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
      * @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
      */
-    searchForGroups(filters?: Object): Promise<unknown>;
+    searchForGroups(filters?: Object): Promise<Array<any>>;
     /**
      * Get Case Data Groups by Case ObjectId
      *
@@ -116,7 +116,7 @@ export declare class CaseData {
      * Lock Case Data Detail
      *
      * @category Data Details
-     * @param {number} caDataDetailId - The Case Data Group ID to lock
+     * @param {number} caDataDetailId - The Case Data Detail ID to lock
      * @return {Object} Returns Promise which represents an object describing the CaDataDetailItem.
      */
     lockDetail(caDataDetailId: number): Promise<unknown>;
@@ -133,9 +133,9 @@ export declare class CaseData {
      *
      * @category Data Details
      * @param {Object} filters - The parameters to search by. (CaDataGroupId, CaseDataGroupId, GroupCode, GroupDesc, GroupSum, SumFlag)
-     * @return {Object} Returns Promise that represents a number that is the CaObjectId (?)
+     * @return {Object} Returns Promise that represents an object describing CaDataDetailItemBase.
      */
-    searchForDetails(filters?: Object): Promise<unknown>;
+    searchForDetails(filters?: Object): Promise<Array<any>>;
     /**
      * Adds a list of possible values to the data detail entry specified by the CaDataDetailId.
      *
@@ -169,4 +169,43 @@ export declare class CaseData {
      * @return {Object} Returns Promise that represents a collection of resulting CaDataListValuesItemBase objects
      */
     searchForListValueObjects(filters?: Object): Promise<unknown>;
+    /**
+     * Set a data detail item's value without needing to find the type
+     *
+     * @category Data Details
+     * @param dataDetailId - The data detail item's ID
+     * @param value - the value to set the data detail item to
+     * @returns Promise that represents
+     */
+    updateDetailItemValue(dataDetailId: number, value: any): Promise<unknown>;
+    /**
+     * Get the Case Data Details for a Case by Case ID
+     *
+     * @category Data Details
+     * @param {number} caseId - The case ID to get the details for
+     * @return {Object} Returns Promise that represents a collection of Case Data Detail Items
+     */
+    getAllDataDetails(caseId: number): Promise<Array<any>>;
+    /**
+     * Set Case Data Detail Items for a Case by GroupCode.ItemCode syntax reference
+     *
+     * @category Data Details
+     * @param {number} caseId - The case ID to get the details for
+     * @param {Object} items - The parameters to search by. (DataGroup/Item string, Value) (e.g. {code: 'GroupCode.ItemCode', value: 'Value goes here'})
+     * @return {Object} Returns Promise that represents a collection
+     */
+    setCaseData(caseId: number, items: Array<{
+        code: string;
+        value: any;
+    }>): Promise<unknown>;
+    /**
+     * Set Case Data Detail Item for a Case by GroupCode.ItemCode syntax reference
+     *
+     * @category Data Details
+     * @param {number} caseId - The Case ID to set the detail for
+     * @param {string} detailGroupAndItemCode - The parameters to search (e.g. 'GroupCode.ItemCode')
+     * @param {any} value - The value to set the specified detail to
+     * @return {Object} Returns Promise
+     */
+    setCaseDataItem(caseId: number, detailGroupAndItemCode: string, value: any): Promise<unknown>;
 }

package/dist/error.d.ts

@@ -1,3 +1,12 @@
+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
  *
@@ -8,6 +17,7 @@ export interface CWErrorInt {
     name: string;
     code: number;
     message: string;
+    error_messages?: Array<CWErrorMsgs>;
     info?: string;
 }
 /**
@@ -27,6 +37,10 @@ export declare class CWError implements CWErrorInt {
      * 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
      */
@@ -39,5 +53,5 @@ export declare class CWError implements CWErrorInt {
      * @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?: object);
+    constructor(code: number, message: string, info?: any);
 }