cityworks 1.0.6 → 2.1.0

package/dist/briefcase.d.ts

@@ -1,241 +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;
-    /**
-     * PLL Administration methods
-     */
-    admin?: any;
-    /**
-     * @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<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>;
-}
+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>;
+}