import { GeoscapeTypes, PointTypes, CivicaTypes, FormTypes, MiscTypes, APINSWTypes, SubmissionTypes } from '@oneblink/types'; /** * Search for geoscape addresses based on a partial address. * * #### Example * * ```js * const formId = 1 * const result = await formService.searchGeoscapeAddresses(formId, { * query: '123 N', * maxNumberOfResults: 10 * stateTerritory: 'NSW' * }) * ``` * * @param formId * @param queryParams * @param abortSignal * @returns */ export declare function searchGeoscapeAddresses(formId: number, queryParams: { query: string; maxNumberOfResults?: number; stateTerritory?: string; dataset?: string; addressType?: 'physical' | 'mailing' | 'all'; excludeAliases?: boolean; }, abortSignal?: AbortSignal): Promise; /** * Get the details for a single geoscape address based on the Id of a geoscape * address resource. * * #### Example * * ```js * const formId = 1 * const addressId = 'ABC123' * const result = await formService.getGeoscapeAddress(formId, addressId) * ``` * * @param formId * @param addressId * @param abortSignal * @returns */ export declare function getGeoscapeAddress(formId: number, addressId: string, abortSignal?: AbortSignal): Promise; /** * Get a geoscape address from a latitude and longitude * * #### Example * * ```js * const lat = 41.9475427 * const lng = -87.6562292 * const formId = 1 * const result = await formService.getGeoscapeReverseGeocoding({ * lat, * lng, * formId, * }) * ``` * * @param options * @returns */ export declare function getGeoscapeReverseGeocoding({ formId, lat, lng, abortSignal, }: { formId: number; lat: number; lng: number; abortSignal?: AbortSignal; }): Promise<{ reverseGeocodeResult: GeoscapeTypes.GeoscapeAddress; }>; /** * Search for Point addresses based on a partial address. * * #### Example * * ```js * const formId = 1 * const result = await formService.searchPointAddresses(formId, { * address: '123 N', * maxNumberOfResults: 10 * stateTerritory: 'NSW' * }) * ``` * * @param formId * @param queryParams * @param abortSignal * @returns */ export declare function searchPointAddresses(formId: number, queryParams: { address: string; maxNumberOfResults?: number; stateTerritory?: string; dataset?: string; addressType?: 'physical' | 'mailing' | 'all'; }, abortSignal?: AbortSignal): Promise; /** * Get the details for a single Point address based on the Id of a Point address * resource. * * #### Example * * ```js * const formId = 1 * const addressId = 'ABC123' * const result = await formService.getPointAddress(formId, addressId) * ``` * * @param formId * @param addressId * @param abortSignal * @returns */ export declare function getPointAddress(formId: number, addressId: string, abortSignal?: AbortSignal): Promise; /** * Get the details for a single NSW Point Cadastral Parcel record. * * #### Example * * ```js * const formId = 1 * const parcelId = '1/234567' * const result = await formService.getPointCadastralParcel( * formId, * addressId, * ) * ``` * * @param formId * @param parcelId * @param abortSignal * @returns */ export declare function getPointCadastralParcel(formId: number, parcelId: string, abortSignal?: AbortSignal): Promise; /** * Search for Point addresses v3 based on a partial address. * * #### Example * * - * * Const formId = 1 const result = await * formService.searchPointV3Addresses(formId, { address: '123 N', maxResults: 10 * stateFilter: 'NSW' }) * * @param formId * @param queryParams * @param abortSignal * @returns */ export declare function searchPointV3Addresses(formId: number, queryParams: { address: string; maxResults?: number; stateFilter?: string; dataset?: string; addressType?: 'physical' | 'mailing' | 'all'; excludeAliases?: boolean; }, abortSignal?: AbortSignal): Promise; /** * Get the details for a single Point address based on the Id of a Point address * resource. * * #### Example * * ```js * const formId = 1 * const result = await formService.getPointV3Address(formId, { * addressId: 'ABC123', * 'Accept-Crs': '', * }) * ``` * * @param formId * @param queryParams * @param abortSignal * @returns */ export declare function getPointV3Address(formId: number, queryParams: { addressId: string; 'Accept-Crs'?: string; }, abortSignal?: AbortSignal): Promise; /** * Search for street names in Civica * * #### Example * * ```js * const formId = 1 * const queryParams = { * search: '1 Station ', * top: 10, * } * const result = await formService.searchCivicaStreetNames( * formId, * queryParams, * ) * ``` * * @param formId * @param queryParams * @param abortSignal * @returns */ export declare function searchCivicaStreetNames(formId: number, queryParams: { search?: string; top?: number; }, abortSignal?: AbortSignal): Promise; /** * Get titles codes from Civica name register * * #### Example * * ```js * const formId = 1 * const results = await formService.getCivicaTitleCodes(formId) * ``` * * @param formId * @param abortSignal * @returns */ export declare function getCivicaTitleCodes(formId: number, abortSignal?: AbortSignal): Promise; /** * Get BSB record based on a BSB number codes from Civica name register * * #### Example * * ```js * const formId = 1 * const bsb = '123-321' * const results = await formService.getBSBRecord(formId, bsb) * ``` * * @param formId * @param bsb * @param abortSignal * @returns */ export declare function getBSBRecord(formId: number, bsb: string, abortSignal?: AbortSignal): Promise; /** * Search for API.NSW Liquor licences based on a partial text search. * * #### Example * * ```js * const result = await formService.searchAPINSWLiquorLicences({ * formId: 1, * search: 'SMITH', * }) * ``` * * @param options * @param abortSignal * @returns */ export declare function searchAPINSWLiquorLicences({ formId, searchText, }: { formId: number; searchText: string; }, abortSignal?: AbortSignal): Promise; /** * Get the details for a single API.NSW Liquor licence based on the licenceID. * * #### Example * * ```js * const formId = 1 * const licenceId = '1-RL22KV' * const result = await formService.getAPINSWLiquorLicence( * formId, * licenceId, * ) * ``` * * @param formId * @param licenceId * @param abortSignal * @returns */ export declare function getAPINSWLiquorLicence(formId: number, licenceId: string, abortSignal?: AbortSignal): Promise; /** * Change the status of a CivicPlus HCMS content item to published. * * @param options * @returns */ export declare function publishHCMSContentItem({ formsAppId, formId, contentId, abortSignal, }: { formsAppId: number; formId: number; contentId: string; abortSignal?: AbortSignal; }): Promise; /** * Change the status of a CivicPlus HCMS content item to draft. * * @param options * @returns */ export declare function draftHCMSContentItem({ formsAppId, formId, contentId, abortSignal, }: { formsAppId: number; formId: number; contentId: string; abortSignal?: AbortSignal; }): Promise; export type CivicPlusHCMSContentItemStatus = 'Draft' | 'Published'; export type CivicPlusHCMSContentItem = { id: string; createdBy: string; lastModifiedBy: string; data: { 'submission-json-v1'?: SubmissionTypes.S3SubmissionData & { originalExternalId?: string; }; }; /** ISO datetime string */ created: string; /** ISO datetime string */ lastModified: string; status: CivicPlusHCMSContentItemStatus; /** HEX colour */ statusColor: string; contentTypeName: string; contentTypeDisplayName: string; version: number; contentTypeId: string; }; export type CivicPlusHCMSContentItemsResult = { /** * Represents the total number of items based on the search. Can be used to * achieve paging or infinite scrolling to load more. */ total: number; /** The HCMS Content Type's items */ items: CivicPlusHCMSContentItem[]; }; /** * Search CivicPlus HCMS content items. * * @param options * @returns */ export declare function searchCivicPlusHCMSContentItems({ formsAppId, formId, $top, $skip, $search, $filter, $orderby, abortSignal, }: { /** The identifier for the Forms App to determine the HCMS Content Type. */ formsAppId: number; /** The identifier for the Form to determine the HCMS Content Type. */ formId: number; /** * How many items to return in the result. Can be used to achieve paging or * infinite scrolling to load more. */ $top?: number; /** * How many items to skip in the result. Can be used to achieve paging or * infinite scrolling to load more. */ $skip?: number; /** Optional OData full text search. */ $search?: string; /** Optional OData filter definition. */ $filter?: string; /** Optional OData order definition. */ $orderby?: string; /** Allows request to be aborted */ abortSignal?: AbortSignal; }): Promise; /** * Delete CivicPlus HCMS content item. * * @param options * @returns */ export declare function deleteCivicPlusHCMSContentItem({ formsAppId, formId, contentId, abortSignal, }: { /** The identifier for the Forms App to determine the HCMS Content Type. */ formsAppId: number; /** The identifier for the Form to determine the HCMS Content Type. */ formId: number; /** The identifier for the HCMS Content to be deleted */ contentId: string; /** Allows request to be aborted */ abortSignal?: AbortSignal; }): Promise;