cityworks 2.0.0 → 2.1.0

package/dist/activity_link.d.ts

@@ -0,0 +1,84 @@
+import ReversibleMap from 'reversible-map';
+/**
+ * ActivityLink interface for ActivityLinks
+ *
+ */
+export interface ActivityLink {
+    linkTypes: ReversibleMap<string, number>;
+    activityTypes: ReversibleMap<string, number>;
+    cw: any;
+}
+/**
+ * ActivityLinks implements the activity link functions via using the ActivityLink interface
+ *
+ */
+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"
+     */
+    activityTypes: ReversibleMap<string, number>;
+    /**
+     * Link types to map string to number for internal use. Link types available are: "null", "parent", "related"
+     */
+    linkTypes: ReversibleMap<string, number>;
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    private setActivityTypes;
+    private setLinkTypes;
+    private validateType;
+    private transformLinksData;
+    private runRequest;
+    /**
+     * Create a new activity link between two items.
+     *
+     * @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 {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"
+     * @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 {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
+     */
+    get(type: string, sids: Array<number>): Promise<unknown>;
+    /**
+     * Clone a current activity link.
+     *
+     * @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 {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
+     */
+    clone(source_type: string, source_sid: number, destination_type: string, destination_sid: number): Promise<unknown>;
+    /**
+     * Delete an activity link by ID
+     *
+     * @param {number} activity_link_id - The ID of the activity link one wishes to delete
+     * @return {Object} Returns Promise object that represents a
+     */
+    delete(activity_link_id: number): Promise<unknown>;
+    /**
+     * Remove a link by specifying everything.
+     *
+     * @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 {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"
+     * @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/attachments.d.ts

@@ -0,0 +1,134 @@
+export declare class Attachments {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * Storage of object's active activityType
+     */
+    currentActivityType: string;
+    /**
+     * @hidden
+     */
+    constructor(cw: any, current_type: any);
+    /**
+     * Add attachments (doesn't handle URL or Signature type attachments properly, currently)
+     *
+     * @category Attachments
+     * @param {number} id - The ID of the node to add the attachment to (CA_OBJECT_ID, REQUESTID, WORKORDERSID, WORKORDERID, INSPECTIONID). If WORKORDERID, you _must_ feed in as a string.
+     * @param {string} the_file - The loca path of the file to upload to the Cityworks instance
+     * @param {number} [task_id] - ID of WorkOrder task, if current activity is a work order and the attachment should be on the task
+     * @param {string} [filename] - The filename for the attachment
+     * @param {string} [attachment_type] - The filename for the attachment, values: attachment, signature, url
+     * @param {string} [comments] - The filename for the attachment
+     * @param {string} [label] - The label to apply to the  (PLL only)
+     * @return {Object} Returns object that represents a boolean for action resolution
+     */
+    add(node_id: number | string, the_file: string, filename?: string, attachment_type?: string, task_id?: number, comments?: string, label?: string): Promise<unknown>;
+    /**
+     * Update attachment
+     *
+     * @category Attachments
+     * @param {number} id - The ID of the node to add the attachment to (CA_OBJECT_ID, REQUESTID, WORKORDERSID, WORKORDERID, INSPECTIONID). If WORKORDERID, you _must_ feed in as a string.
+     * @param {string} [title] - The filename for the attachment
+     * @param {string} [description] - The filename for the attachment
+     * @param {string} [label] - The label to apply to the  (PLL only)
+     * @return {Object} Returns object that represents a boolean for action resolution
+     */
+    update(attachment_id: number, title?: string, description?: string, label?: string): Promise<unknown>;
+    /**
+     * Delete inspection attachments
+     *
+     * @category Inspection Attachments
+     * @param {Array<number>|number} attachmentIds - An array of attachment IDs or a single attachment ID to delete.
+     * @return {Object} Returns object that represents a boolean for action resolution
+     */
+    delete(attachmentIds: Array<number> | number): Promise<unknown>;
+    /**
+     * Get attachment URLs in array
+     *
+     * @category Attachments
+     * @return {Object} Returns array of attachment URLs
+     */
+    static downloadUrls(): string[];
+    /**
+     * Download an attachment
+     *
+     * @category Attachments
+     * @param {number} attachmentId - ID of an attachment to download
+     * @return {Object} Returns object that represents a file stream
+     */
+    download(attachmentId: number): Promise<unknown>;
+    /**
+     * Get attachment by ID (not implemented)
+     *
+     * @category Attachments
+     * @param {number} attachmentId - An attachment ID to get info for
+     * @return {Object} Returns object that represents an object that describes the matched inspection attachment
+     */
+    getById(attachmentId: number): Promise<unknown>;
+    /**
+     * Get attachments related to Inspection, WorkOrder, or Request
+     *
+     * @category Attachments
+     * @param {Array<number>|number} ids - An array of IDs or a single ID (inspectionIds, WorkOrderSids, WorkOrderIds, or RequestIds) for which to get attachments. Only one node (Inspection, WorkOrder, Request, or Case) type at a time. Don't mix-and-match WorkOrderIds with WorkOrderSids.
+     * @return {Object} Returns Promise that represents a collection of attachments from the matched inspections, service requests, or work orders
+     */
+    getAttachments(ids: Array<number> | number): Promise<unknown>;
+    /**
+     * Get Related Documents from Case
+     *
+     * @category Attachments
+     * @param {number} id - An array of CaseIDs or a single CaseID for which to get related documents.
+     * @return {Object} Returns Promise that represents a collection of related documents from the matched cases
+     */
+    getRelatedDocs(id: number): Promise<unknown>;
+    /**
+     * Get attachment by node (Inspection, WorkOrder, Request, or Case) IDs
+     *
+     * @category Attachments
+     * @param {Array<number>|number} ids - An array of IDs or a single ID (inspectionIds, WorkOrderSids, WorkOrderIds, RequestIds, or CaseIds) to get attachments for. Only one node (Inspection, WorkOrder, Request, or Case) type at a time. Don't mix-and-match WorkOrderIds with WorkOrderSids.
+     * @return {Object} Returns Promise that represents a collection of attachments from the matched inspections
+     */
+    getByNodesId(ids: Array<number> | number): Promise<unknown>;
+    /**
+     * Get Tags available with which to tag attachments
+     *
+     * @category Attachments
+     * @return {Object} Returns Promise that represents a collection of tags that can be added to attachments
+     */
+    getTags(): Promise<unknown>;
+    private syncTags;
+    private loopSyncTags;
+    /**
+     * Set Tags on an attachment
+     *
+     * @category Attachments
+     * @return {Object} Returns Promise that represents a collection of tags that can be added to attachments
+     */
+    setTags(attachmentId: number, tags: {
+        tagid: number;
+        tagtext: string;
+    }[], activityType: string): Promise<unknown>;
+    /**
+     * Set Tags on an many attachments
+     *
+     * @category Attachments
+     * @param {Array<number>|number} attachmentIds - An array of attachment IDs to add tags to.
+     * @param {Array<{tagid: number, tagtext: string}>} tags - An array of tag objects to add to the attachments
+     * @param {string} activityType - The type of activity to which the attachments belong
+     * @return {Object} Returns Promise that represents a collection of documents which have had their tags set
+     */
+    setTagsOnMany(attachmentIds: number[], tags: {
+        tagid: number;
+        tagtext: string;
+    }[]): Promise<unknown>;
+    /**
+     * Get Doc labels for a case template
+     *
+     * @category Attachments
+     * @param {number} busCaseId - The ID of the Business Case to get Document Labels for
+     * @return {Object} Returns Promise that represents a collection of tags that can be added to attachments
+     */
+    getDocLabels(busCaseId: number): Promise<unknown>;
+}

package/dist/briefcase.d.ts

@@ -0,0 +1,274 @@
+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
+     */
+    data?: any;
+    /**
+     * Asset (Address) methods
+     */
+    asset?: any;
+    /**
+     * Asset (Address) methods
+     */
+    attachments?: any;
+    /**
+     * Workflow & task methods
+     */
+    workflow?: any;
+    /**
+     * Payment, Receipt, & Fee methods
+     */
+    financial?: any;
+    /**
+     * Commenting methods
+     */
+    comment?: any;
+    /**
+     * Payment, Receipt, & Fee methods
+     */
+    people?: any;
+    /**
+     * PLL Administration methods
+     */
+    admin?: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: any);
+    /**
+     * Get Required items for case by case template id (BusCaseId)
+     *
+     * @category Cases
+     * @param {number} busCaseId - The case tmeplate ID (BusCaseId)
+     * @return {Object} Returns Promise that represents a collection of objects describing the requirements of the case template
+     */
+    getRequirements(busCaseId: number): Promise<Briefcase>;
+    /**
+     * 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<Briefcase>;
+    /**
+     * 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<Briefcase>;
+    /**
+     * 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<Briefcase>;
+    /**
+     * Get cases by IDs
+     *
+     * @category Cases
+     * @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<Array<Briefcase>>;
+    /**
+     * 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<Array<number>>;
+    /**
+     * 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>;
+    /**
+     * Get Map Layer Fields
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case object ID to get the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields
+     */
+    getMLFs(caObjectId: number): Promise<unknown>;
+    /**
+     * Update Map Layer Fields
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case object ID to get the map layer fields for.
+     * @param {number} x
+     * @param {number} y
+     * @param {number} domainId - The domain ID for the case in question
+     * @param {number} [z] - Optional Z coordinate
+     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields
+     */
+    updateMLFs(caObjectId: number, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
+    /**
+     * Delete Map Layer Fields
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case object ID to delete the map layer fields for.
+     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields deleted
+     */
+    deleteMLFs(caObjectId: number): Promise<unknown>;
+    /**
+     * Reports available for Case
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case object ID to get the report (print template) list for
+     * @return {Object} Returns Promise that represents a collection of Objects describing the reports (print templates) available for this case
+     */
+    getPrintTemplates(caObjectId: number): Promise<unknown>;
+    /**
+     * Print Case
+     *
+     * @category Cases
+     * @param {number} caObjectId - The case object ID to delete the map layer fields for.
+     * @param {string} fileName - the filename of the report from the getPrintTemplates method, but w/out the extension
+     * @return {Object} Returns Promise that represents a collection of Objects describing the case object map layer fields deleted
+     */
+    print(caObjectId: number, fileName: string, callback: any): Promise<unknown>;
+    /**
+     * Get the configured zip codes for the install
+     *
+     * @category Cases
+     * @return {Object} Returns Promise that represents a collection of zip codes configured for the install
+     */
+    getZips(): Promise<unknown>;
+    /**
+     * Get the configured states for the install
+     *
+     * @category Cases
+     * @return {Object} Returns Promise that represents a collection of states configured for the install
+     */
+    getStates(): Promise<unknown>;
+    /**
+     * Get the configured countries for the install
+     *
+     * @category Cases
+     * @return {Object} Returns Promise that represents a collection of countries configured for the install
+     */
+    getCountries(): Promise<unknown>;
+}