cityworks 1.0.6 → 2.0.0

package/dist/inspection.d.ts

@@ -1,349 +0,0 @@
-export declare class Inspection {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Inspection Administration methods
-     */
-    admin?: any;
-    /**
-     * Inspection Administration methods
-     */
-    attachments?: any;
-    /**
-     * Inspection Costing methods
-     */
-    costs: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Create new inspection
-     *
-     * @category Inspections
-     * @param {Object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance
-     * @return {Object} Returns Promise that represents an object describing the newly-created inspection
-     */
-    create(insp_data: Object): Promise<unknown>;
-    /**
-     * Create inspections from an array of entities
-     *
-     * @category Inspections
-     * @param {Object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance
-     * @return {Object} Returns Promise that represents a collection of objects describing the newly-created inspections
-     */
-    createFromEntities(insp_data: Object): Promise<unknown>;
-    /**
-     * Create an inspection from a parent inspection (TODO: what parent!?)
-     *
-     * @category Inspections
-     * @param {object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance
-     * @return {Object} Returns object that represents an object describing the newly-created inspection
-     */
-    createFromParent(insp_data: Object): Promise<unknown>;
-    /**
-     * Create an inspection from a service request
-     *
-     * @category Inspections
-     * @param {object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance
-     * @return {Object} Returns object that represents an object describing the newly-created inspection
-     */
-    createFromServiceRequest(insp_data: Object): Promise<unknown>;
-    /**
-     * Create an inspection from a WorkOrder
-     *
-     * @category Inspections
-     * @param {object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on your Cityworks instance
-     * @return {Object} Returns object that represents an object describing the newly-created inspection
-     */
-    createFromWorkOrder(insp_data: Object): Promise<unknown>;
-    /**
-     * Update an inspection
-     *
-     * @category Inspections
-     * @param {object} insp_data - See /{subdirectory}/apidocs/#/data-type-infodataType=InspectionBase on the Cityworks instance
-     * @return {Object} Returns Promise that represents an object describing the updated inspection
-     */
-    update(insp_data: Object): Promise<unknown>;
-    /**
-     * Get an inspection by ID
-     *
-     * @category Inspections
-     * @param {number} inspectionId - The inspection ID to retrieve
-     * @return {Object} Returns Promise that represents an object describing the inspection
-     */
-    getById(inspectionId: number): Promise<unknown>;
-    /**
-     * Get inspections by array of IDs
-     *
-     * @category Inspections
-     * @param {Array<number>} inspectionIds - The inspection IDs to retrieve
-     * @return {Object} Returns Promise that represents a collection of Objects describing the inspections
-     */
-    getByIds(inspectionIds: Array<number>): Promise<unknown>;
-    /**
-     * Cancel inspections
-     *
-     * @category Inspections
-     * @param {Array<number>} inspectionIds - An array of the IDs to cancel the matched inspections
-     * @param {string} [cancelReason] - A reason for cancelling the inspection(s)
-     * @param {datetime} [dateCancelled] - The date/time that it should be indicated the inspection was cancelled
-     * @return {Object} Returns object that represents a collection of inspections
-     */
-    cancel(inspectionIds: Array<number>, cancelReason?: string, dateCancelled?: Date): Promise<unknown>;
-    /**
-     * Uncancel inspections
-     *
-     * @category Requests
-     * @param {Array<number>} inspectionIds - An array of the IDs to uncancel the matched requests
-     * @return {Object} Returns object that represents a collection of requests
-     */
-    uncancel(inspectionIds: Array<number>): Promise<unknown>;
-    /**
-     * Close inspections
-     *
-     * @category Inspections
-     * @param {Array<number>} inspectionIds - An array of the IDs to close the matched inspections
-     * @return {Object} Returns object that represents a collection of inspections
-     */
-    close(inspectionIds: Array<number>): Promise<unknown>;
-    /**
-     * Reopen closed inspections
-     *
-     * @category Inspections
-     * @param {Array<number>} inspectionIds - An array of the IDs to reopen the matched inspections
-     * @return {Object} Returns object that represents a collection of inspections
-     */
-    reopen(inspectionIds: Array<number>): Promise<unknown>;
-    /**
-     * Delete inspections
-     *
-     * @category Inspections
-     * @param {Array<number>} inspectionIds - An array of the IDs to delete the matched inspections
-     * @return {Object} Returns object that represents a collection of inspection Ids which have been deleted
-     */
-    delete(inspectionIds: Array<number>): Promise<unknown>;
-    /**
-     * Search for inspections
-     *
-     * @category Inspection Search
-     * @param {Object} searchData - The search information to retrieve matched inspections, see instance docs: /{subdirectory}/apidocs/#/service-info/Ams/Inspection
-     * @return {Object} Returns Promise that represents an array of the matching inspection IDs
-     */
-    search(searchData: Object): Promise<unknown>;
-    /**
-     * Get the records on the basis of inspectionId, only populates InspectionId, InspTemplateName, and Location properties
-     *
-     * @category Inspection Object Search
-     * @param {string} inspectionId - ???, see instance docs: /{subdirectory}/apidocs/#/service-info/Ams/Inspection
-     * @return {Object} Returns Promise that represents a collection of the matching (limited) inspection objects
-     */
-    searchObject(inspectionId: string): Promise<unknown>;
-    /**
-     * Get list of statuses
-     *
-     * @category Inspection Options
-     * @return {Object} Returns object that represents an array of all possible statuses for an Inspection
-     */
-    statuses(): Promise<unknown>;
-    /**
-     * Get inspection submit to list
-     *
-     * @category Inspection Options
-     * @param {boolean} [includeInactiveEmployees] - whether to include inactive employees in the return. Defaults to false.
-     * @param {boolean} [domainIds] - which domains to include in the return, default to All domains
-     * @return {Object} Returns object that represents a collection of all possible employees for an Inspection's SubmitTo
-     */
-    submitTos(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Add an entity to an existing inspection
-     * This method requires an Entity/Asset to be specified. You can either specify the Entity Type and its UID or a WorkOrderEntityBase Object.
-     *
-     * @category Inspections
-     * @param {Object} entity - Either of two attribute combinations are valid: entityType & entityUid OR Entity as a fully-inflated WorkOrderEntity (WorkOrderEntityBase) object.
-     * @param {number} inspectionId - An Inspection ID to attach the entity/asset to.
-     * @param {boolean} updateXY - Provide a boolean to whether the inspection's X/Y coordinates should be updated. Default is true.
-     * @param {Object} facility - Add Facility_Id for the Facility Identifier and Level_id for the Facility Level Identifier. Defaults to empty so that no facility is specified.
-     * @return {Object} Returns object that represents an object which describes an Inspection Entity
-     */
-    connectAsset(entity: {
-        EntityType?: string;
-        EntityUid?: string;
-        Entity?: Object;
-    }, inspectionId: number, updateXY?: boolean, facility?: {
-        Facility_Id?: string;
-        Level_Id?: string;
-    }): Promise<unknown>;
-    /**
-     * Get the answers for inspections
-     *
-     * @category Inspections
-     * @param {Array<number>} inspections - An Array of one or more Inspection IDs
-     * @return {Object} Returns Promise that represents a collection of Inspection Answers
-     */
-    getAnswers(inspections: Array<number>): Promise<unknown>;
-    /**
-     * Get the audit log for a specific Inspection
-     *
-     * @category Inspections
-     * @param {number} inspectionId - An Inspection ID to get the audit log for
-     * @return {Object} Returns Promise that represents a collection of Cityworks Metadata Objects
-     */
-    getAuditLog(inspectionId: number): Promise<unknown>;
-    /**
-     * Create a search definition. Save the definition by setting SaveDefinition = true and supplying a SearchName.
-     *
-     * @category Inspections
-     * @param {Object} searchData - Search data variables. See /{subdirectory}/apidocs/#/service-info/Ams/Inspection
-     * @param {number} [searchName] - What to name your search (if it should be saved)
-     * @param {number} [sharedWithin] - What group or domain to share the search to.
-     * @param {boolean} saveDefinition - Whether or not to save the search definition. Defaults to true when a search name is specified.
-     * @param {boolean} enableEurl - Whether or not to enable EURL for the saved search. Defaults to true.
-     * @return {Object} Returns Promise that represents a collection of Cityworks Metadata Objects
-     */
-    createSearchDefinition(searchData: Object, searchName?: string, sharedWithin?: number, saveDefinition?: boolean, enableEurl?: boolean): Promise<unknown>;
-    /**
-     * Get cycle from
-     *
-     * @category Inspection Options
-     * @return {Object} Returns Promise that represents ... I have no idea what this endpoint does
-     */
-    getCycleFrom(): Promise<unknown>;
-    /**
-     * Get cycle intervals
-     *
-     * @category Inspection Options
-     * @return {Object} Returns Promise that represents a Dictionary of the cycle intervals available
-     */
-    getCycleIntervals(): Promise<unknown>;
-    /**
-     * Get cycle types
-     *
-     * @category Inspection Options
-     * @return {Object} Returns Promise that represents a Dictionary of the cycle types available
-     */
-    getCycleTypes(): Promise<unknown>;
-    /**
-     * Get districts
-     *
-     * @category Inspection Options
-     * @return {Object} Returns Promise that represents an Array of the districts
-     */
-    getDistricts(): Promise<unknown>;
-    /**
-     * Get Inspection Employee lists. Abstraction done here, though only one employee list field, AFAIK.
-     *
-     * @category Inspection Options
-     * @param {string} listType - Which list (endpoint) to get. Includes only SubmitTos.
-     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
-     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
-     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
-     */
-    getEmployeeLists(listType: string, includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Get SubmitTo list
-     *
-     * @category WorkOrder Options
-     * @param {boolean} includeInactiveEmployees - Whether to include inactive employees in the returned list. Defaults to false.
-     * @param {Array<number>} [domainIds] - Filter to certain domains within the Cityworks instance.
-     * @return {Object} Returns Promise that represents a collection of employees. See: /{subdirectory}/apidocs/#/data-type-info;dataType=EmployeeNameId
-     */
-    getSubmitTos(includeInactiveEmployees?: boolean, domainIds?: Array<number>): Promise<unknown>;
-    /**
-     * Move inspection by InspectionId. Must provide well known id (WKID) or well known text (WKT)
-     *
-     * @category Inspections
-     * @param {number} inspectionId - The ID of the inspection that should be moved
-     * @param {number} x - The X coordinate for the move
-     * @param {number} y - The Y coordinate for the move
-     * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
-     * @param {number} [z] - the optional Z coordinate for the move
-     * @return {Object} Returns Promise that represents an object describing the updated GISPoint
-     */
-    move(inspectionId: number, x: number, y: number, projection: {
-        WKID?: string;
-        WKT?: string;
-        VcsWKID?: string;
-    }, z?: number): Promise<unknown>;
-    /**
-     * Get inspection templates
-     *
-     * @category Inspection Templates
-     * @param {Array<string>} [entityTypes] - The Entity Type(s) to return potential inspections for
-     * @param {boolean} [canCreate] - If true, only return templates the user can create, ignored if false or null, default is true
-     * @param {Object} [options] - An object which can include: [IncludeInactive]: boolean, MaximumDateModified: Date, MinimumDateModified: Date, TemplateIds: Array<number>
-     * @return {Object} Returns Promise that represents a collection of all Inspections matching the provided parameters
-     */
-    getTemplates(entityTypes?: Array<string>, canCreate?: boolean, options?: {
-        IncludeInactive?: boolean;
-        MaximumDateModified?: Date;
-        MinimumDateModified?: Date;
-        TemplateIds?: Array<number>;
-    }): Promise<unknown>;
-    /**
-     * Get a list of templates by IDs
-     *
-     * @category Inspection Templates
-     * @param {Array<number>} inspectionIds - An array of the IDs to retrieve the matched inspections
-     * @param {Object} [options] - An object which can include: [IncludeInactive]: boolean, MaximumDateModified: Date, MinimumDateModified: Date, TemplateIds: Array<number>
-     * @return {Object} Returns object that represents an object describing the inspection
-     */
-    getTemplatesByIds(inspTemplateIds: Array<number>, options?: {
-        MaximumDateModified?: Date;
-        MinimumDateModified?: Date;
-    }): Promise<unknown>;
-    /**
-     * Get entity types for inspection template(s)
-     *
-     * @category Inspection Templates
-     * @param {Array<number>} inspTemplateIds - An array of the IDs to reopen the matched inspections
-     * @return {Object} Returns object that represents an array of Entity Types
-     */
-    getTemplateEntityTypes(inspTemplateIds: Array<number>): Promise<unknown>;
-    /**
-    * Get the questions and answers for inspection template(s)
-    *
-    * @category Inspection Templates
-    * @param {Array<number>} inspTemplateIds - An array of the IDs to reopen the matched inspections
-    * @return {Object} Returns object that represents an array which contains a list of InspQuestionPanel for the template
-    */
-    getQA(inspTemplateIds: Array<number>): Promise<unknown>;
-    /**
-     * Get inspection template question conditions
-     *
-     * @category Inspection Templates
-     * @param {Array<number>} inspTemplateIds - An array of template IDs to get the matched inspection template Question conditions for
-     * @return {Object} Returns object that represents an array which contains a dictionary of InspQuestion IDs to configs
-     */
-    getQConditions(inspTemplateIds: Array<number>): Promise<unknown>;
-    /**
-     * Get Map Layer Fields
-     *
-     * @category Inspections
-     * @param {number} requestId - The inspection ID to get the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the inspections
-     */
-    getMLFs(requestId: number): Promise<unknown>;
-    /**
-     * Update Map Layer Fields
-     *
-     * @category Inspections
-     * @param {number} requestId - The inspection ID to get the map layer fields for.
-     * @param {number} x
-     * @param {number} y
-     * @param {number} domainId - Domain ID
-     * @param {number} [z] - Optional Z coordinate
-     * @return {Object} Returns Promise that represents a ...
-     */
-    updateMLFs(requestId: number, x?: number, y?: number, domainId?: number, z?: number): Promise<unknown>;
-    /**
-     * Delete Map Layer Fields
-     *
-     * @category Inspections
-     * @param {number} inspectionId - The inspection ID to delete the map layer fields for.
-     * @return {Object} Returns Promise that represents a collection of Objects describing the workorders
-     */
-    deleteMLFs(inspectionId: number): Promise<unknown>;
-}

package/dist/inspection_admin.d.ts

@@ -1,25 +0,0 @@
-export declare class InspectionAdmin {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get inspection templates
-     *
-     * @category Inspection Templates
-     * @param {Array<string>} [entityTypes] - The Entity Type(s) to return potential inspections for
-     * @param {boolean} [canCreate] - If true, only return templates the user can create, ignored if false or null, default is true
-     * @param {Object} [options] - An object which can include: [IncludeInactive]: boolean, MaximumDateModified: Date, MinimumDateModified: Date, TemplateIds: Array<number>
-     * @return {Object} Returns Promise that represents a collection of all Inspections matching the provided parameters
-     */
-    getTemplates(entityTypes?: Array<string>, canCreate?: boolean, options?: {
-        IncludeInactive?: boolean;
-        MaximumDateModified?: Date;
-        MinimumDateModified?: Date;
-        TemplateIds?: Array<number>;
-    }): Promise<unknown>;
-}

package/dist/inspection_costs.d.ts

@@ -1,86 +0,0 @@
-export declare class InspectionCosts {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Storage of object's active activityType
-     */
-    currentActivityType: string;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Get Cost Codes
-     *
-     * @category Labor Costs
-     * @param {Array<number>} employeeSids - A list of Employee IDs for which to get the job codes.
-     * @param {boolean} commonOnly - Set to true to get the Cost Codes that are common to ALL employees in the list, otherwise get all job codes that apply to at least one employee in the list.
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    getCodes(employeeSids: Object, commonOnly?: boolean): Promise<unknown>;
-    /**
-     * Get Job Codes
-     *
-     * @category Labor Costs
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    getJobCodes(): Promise<unknown>;
-    /**
-     * Add Inspection Labor Costs
-     *
-     * @category Inspection Costs
-     * @param {number} inspectionId - Inspection ID to add labor costs to
-     * @param {number} hours - The hours to add to the inspection
-     * @param {Object} options - Additional settings for hours setting
-     * @param {boolean} estimated - Boolean, get estimated or real costs, defaults to false (get real by default)
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    addLabor(inspectionId: number, hours: number, options?: object, estimated?: boolean): Promise<unknown>;
-    /**
-    * Get Labor Costs for a specific list of Inspections
-    *
-    * @category Inspection Costs
-    * @param {Array<int>} inspectionIds - An array of inspection IDs to get associated costs for.
-    * @param {boolean} estimated - Boolean, get estimated or real costs, defaults to false (get real by default)
-    * @return {Object} Returns Promise that represents an object describing
-    */
-    getLabor(inspectionIds: Array<number>, estimated?: boolean): Promise<unknown>;
-    /**
-     * Delete Inspection Labor Costs
-     *
-     * @category Inspection Costs
-     * @param {Array<int>} laborCostIds - An array of inspection labor cost IDs to delete
-     * @param {boolean} estimated - Boolean, delete estimated or real costs, defaults to false (delete real by default)
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    deleteLabor(laborCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
-    /**
-   * Add Inspection Equipment Costs
-   *
-   * @category Inspection Costs
-   * @param {Object} inspectionId - the inspection to add the equipment costs to
-   * @param {Object} options - additional options
-   * @return {Object} Returns Promise that represents an object describing
-   */
-    addEquipment(inspectionId: number, options: Object): Promise<unknown>;
-    /**
-    * Get Equipment Costs for Inspection(s)
-    *
-    * @category Inspection Costs
-    * @param {Array<number>} inspectionIds - the inspection to get the equipment costs for.
-    * @param {Object} estimated - get estimated equipment costs. Defaults to false.
-    * @return {Object} Returns Promise that represents an object describing
-    */
-    getEquipment(inspectionIds: number, estimated?: boolean): Promise<unknown>;
-    /**
-     * Delete Inspection Equipment Costs
-     *
-     * @category Inspection Costs
-     * @param {Array<number>} equipmentCostIds - the equipment cost IDs to delete.
-     * @param {Object} estimated - delete estimated equipment costs. Defaults to false.
-     * @return {Object} Returns Promise that represents an object describing
-     */
-    deleteEquipment(equipmentCostIds: Array<number>, estimated?: boolean): Promise<unknown>;
-}

package/dist/message_queue.d.ts

@@ -1,73 +0,0 @@
-export declare class MessageQueue {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * Statuses -
-     * Pending: 0,
-     * Processing: 1,
-     * Complete: 2,
-     * Failed: 3
-     */
-    status: Object;
-    /**
-     * Hook Types -
-     * Unknown: 0,
-     * ActivityUpdate: 1,
-     * Email: 2,
-     * WebHook: 3
-     */
-    hook_types: Object;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Process Webhook MessageQueue records by MessageQueueId
-     *
-     * @param {Array<number>} [ids] - List of MessageQueueId values
-     * @param {boolean} [delete_successful] - automatically delete messages that complete with successful execution, default is false
-     * @return {Array<>} Returns Promise object that represents a collection of QueueMessages which have been processed
-     */
-    processMessages(ids: Array<number>, delete_successful?: boolean): Promise<unknown>;
-    /**
-     * Get Messages specified in list of MessageQueueIds
-     *
-     * @param {Array<number>} ids - List of MessageQueueId values
-     * @param {string} status -
-     * @param {number} [maxcount] - Maximum number returned. Defaults to 15
-     * @return {Array<>} Returns Promise object that represents a collection of QueueMessages which have been processed
-     */
-    get(ids: Array<number>, status: string, maxcount?: number): Promise<unknown>;
-    /**
-     * Delete Messages specified in list of MessageQueueIds
-     *
-     * @param {Array<number>} ids - List of MessageQueueId values
-     * @param {string} status - automatically delete messages that complete with successful execution, default is false
-     * @param {number} [hours_to_keep] - utomatically delete messages that complete with successful execution, default is false
-     * @return {Array<>} Returns Promise object that represents a collection of QueueMessages which have been processed
-     */
-    delete(ids: Array<number>, status: string, hours_to_keep?: number): Promise<unknown>;
-    preferences(): Promise<unknown>;
-    search(parameters: any, max_results?: number): Promise<unknown>;
-    /**
-     * Update queue message
-     *
-     * @param {Object} parameters - Provide allowed parameters:
-     *
-     *      {
-     *        HookId: number,
-     *        Id: number,
-     *        Packet: string,
-     *        Result: string,
-     *        Status: string, // Available options: Pending, Processing, Complete, Failed
-     *        HookType: string // Available options: Unknown, ActivityUpdate, Email, WebHook
-     *      }
-     *
-     * @return {Object} Returns Promise object that represents an Object with the desired GIS service definitions
-     */
-    update(parameters: any): Promise<unknown>;
-    updateMessageStatus(ids: number[], status: string, hours_to_keep?: number): Promise<unknown>;
-    getWebooks(hook_ids: any): Promise<unknown>;
-}

package/dist/query.d.ts

@@ -1,108 +0,0 @@
-interface DynamicVariableMap {
-    [key: string]: any;
-}
-interface DynamicResponseDefinition {
-    [key: string]: any;
-}
-export declare class Query {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * Build a query using query language syntax or by specifying a saved query ID
-     *
-     * @category Query
-     * @param {number} query - Query to run (specify syntax or queryID)
-     * @param {Object} options - Other options. See: /{subdirectory}/apidocs/#/service-info/General/Query
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    build(query: number | string, options?: {
-        Page?: number;
-        PageSize?: number;
-        SortDescending?: boolean;
-        SortField?: string;
-        Variables?: DynamicVariableMap;
-    }, domainId?: number): Promise<unknown>;
-    /**
-     * Get available query types
-     *
-     * @category Query
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    getTypes(): Promise<unknown>;
-    /**
-     * Get info about query types
-     *
-     * @category Query
-     * @param {boolean} includeDefaultSchemasInclude - Include schemas (Work Order, Service Request, etc), default is true.
-     * @param {boolean} includeGisSchemas - Include gis schemas, ddefault is true.
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    getTypesInfo(includeDefaultSchemasInclude?: boolean, includeGisSchemas?: boolean, domainId?: number): Promise<unknown>;
-    /**
-     * Validate a query string
-     *
-     * @category Query
-     * @param {string} query - The query to validate
-     * @param {DynamicVariableMap} variables - Required if the query includes variables
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    validateQuery(query: string, variables: DynamicVariableMap, domainId?: number): Promise<unknown>;
-    /**
-     * Validate a query response definition
-     *
-     * @category Query
-     * @param {string} queryType - The query to validate
-     * @param {DynamicResponseDefinition} responseDefinition - Required if the query includes variables
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    validateResponseDefinition(queryType: string, responseDefinition: DynamicResponseDefinition, domainId?: number): Promise<unknown>;
-    /**
-     * Get schema for specified query type
-     *
-     * @category Query
-     * @param {string} queryType - Specify Query Type
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain. Used to determine query field configuration for the schema fields.
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    getSchema(queryType: string, domainId?: number): Promise<unknown>;
-    /**
-     * Run a query using query language syntax
-     *
-     * @category Query
-     * @param {number} query - Query syntax string or saved query ID to run. If you want to append addt'l query items to a saved query, add QueryValue in the options
-     * @param {Object} options - Other options. See: /{subdirectory}/apidocs/#/service-info/General/Query
-     * @return {Object} Returns Promise object that represents a list of Objects
-     */
-    run(query: string, options?: {
-        QueryValue?: string;
-        Page?: number;
-        PageSize?: number;
-        ResponseFields?: any;
-        SortDescending?: boolean;
-        SortField?: string;
-        Variables?: DynamicVariableMap;
-    }): Promise<unknown>;
-    /**
-     * Get a list of the saved queries the current user can access.
-     *
-     * @category Query
-     * @param {Array<string>} queryTypes - Get the saved queries for a particular type, default is all types
-     * @param {boolean} createdOnly - Get only queries created by the current user, default is get all queries current user can access
-     * @param {boolean} includeQuery - Restrict GIS searches to specified entity types
-     * @param {boolean} [visibleToMobile] - Filter visibility to mobile. Default ignore visibility to mobile.
-     * @param {number} [domainId] - The domain ID of the domain to search, defaut is authenticated user's current domain
-     * @return {Object} Returns Promise object that represents a collection of SavedQueries
-     */
-    getSaved(queryTypes?: Array<string>, createdOnly?: boolean, includeQuery?: boolean, visibleToMobile?: boolean, domainId?: number): Promise<unknown>;
-}
-export {};