@i2fnsb/property-search-client-ts 1.0.92

package/dist/esm/models/ZoneInfoResponse.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ZoneSegmentFromJSON, ZoneSegmentToJSON, } from './ZoneSegment.js';
+/**
+ * Check if a given object implements the ZoneInfoResponse interface.
+ */
+export function instanceOfZoneInfoResponse(value) {
+    if (!('communityPlanningZones' in value) || value['communityPlanningZones'] === undefined)
+        return false;
+    if (!('floodZones' in value) || value['floodZones'] === undefined)
+        return false;
+    return true;
+}
+export function ZoneInfoResponseFromJSON(json) {
+    return ZoneInfoResponseFromJSONTyped(json, false);
+}
+export function ZoneInfoResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'communityPlanningZones': (json['communityPlanningZones'].map(ZoneSegmentFromJSON)),
+        'floodZones': (json['floodZones'].map(ZoneSegmentFromJSON)),
+    };
+}
+export function ZoneInfoResponseToJSON(json) {
+    return ZoneInfoResponseToJSONTyped(json, false);
+}
+export function ZoneInfoResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'communityPlanningZones': (value['communityPlanningZones'].map(ZoneSegmentToJSON)),
+        'floodZones': (value['floodZones'].map(ZoneSegmentToJSON)),
+    };
+}

package/dist/esm/models/ZoneInfoResponseApiResponse.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ApiError } from './ApiError.js';
+import type { ZoneInfoResponse } from './ZoneInfoResponse.js';
+/**
+ *
+ * @export
+ * @interface ZoneInfoResponseApiResponse
+ */
+export interface ZoneInfoResponseApiResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ZoneInfoResponseApiResponse
+     */
+    ok?: boolean;
+    /**
+     *
+     * @type {ZoneInfoResponse}
+     * @memberof ZoneInfoResponseApiResponse
+     */
+    result?: ZoneInfoResponse;
+    /**
+     *
+     * @type {ApiError}
+     * @memberof ZoneInfoResponseApiResponse
+     */
+    error?: ApiError;
+    /**
+     *
+     * @type {string}
+     * @memberof ZoneInfoResponseApiResponse
+     */
+    requestId?: string;
+}
+/**
+ * Check if a given object implements the ZoneInfoResponseApiResponse interface.
+ */
+export declare function instanceOfZoneInfoResponseApiResponse(value: object): value is ZoneInfoResponseApiResponse;
+export declare function ZoneInfoResponseApiResponseFromJSON(json: any): ZoneInfoResponseApiResponse;
+export declare function ZoneInfoResponseApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZoneInfoResponseApiResponse;
+export declare function ZoneInfoResponseApiResponseToJSON(json: any): ZoneInfoResponseApiResponse;
+export declare function ZoneInfoResponseApiResponseToJSONTyped(value?: ZoneInfoResponseApiResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZoneInfoResponseApiResponse.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApiErrorFromJSON, ApiErrorToJSON, } from './ApiError.js';
+import { ZoneInfoResponseFromJSON, ZoneInfoResponseToJSON, } from './ZoneInfoResponse.js';
+/**
+ * Check if a given object implements the ZoneInfoResponseApiResponse interface.
+ */
+export function instanceOfZoneInfoResponseApiResponse(value) {
+    return true;
+}
+export function ZoneInfoResponseApiResponseFromJSON(json) {
+    return ZoneInfoResponseApiResponseFromJSONTyped(json, false);
+}
+export function ZoneInfoResponseApiResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'] == null ? undefined : json['ok'],
+        'result': json['result'] == null ? undefined : ZoneInfoResponseFromJSON(json['result']),
+        'error': json['error'] == null ? undefined : ApiErrorFromJSON(json['error']),
+        'requestId': json['requestId'] == null ? undefined : json['requestId'],
+    };
+}
+export function ZoneInfoResponseApiResponseToJSON(json) {
+    return ZoneInfoResponseApiResponseToJSONTyped(json, false);
+}
+export function ZoneInfoResponseApiResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'result': ZoneInfoResponseToJSON(value['result']),
+        'error': ApiErrorToJSON(value['error']),
+        'requestId': value['requestId'],
+    };
+}

package/dist/esm/models/ZoneSegment.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ZoneSegment
+ */
+export interface ZoneSegment {
+    /**
+     *
+     * @type {string}
+     * @memberof ZoneSegment
+     */
+    zone: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZoneSegment
+     */
+    zoneDescription: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ZoneSegment
+     */
+    percentage: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ZoneSegment
+     */
+    areaAcres: number;
+}
+/**
+ * Check if a given object implements the ZoneSegment interface.
+ */
+export declare function instanceOfZoneSegment(value: object): value is ZoneSegment;
+export declare function ZoneSegmentFromJSON(json: any): ZoneSegment;
+export declare function ZoneSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZoneSegment;
+export declare function ZoneSegmentToJSON(json: any): ZoneSegment;
+export declare function ZoneSegmentToJSONTyped(value?: ZoneSegment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ZoneSegment.js

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ZoneSegment interface.
+ */
+export function instanceOfZoneSegment(value) {
+    if (!('zone' in value) || value['zone'] === undefined)
+        return false;
+    if (!('zoneDescription' in value) || value['zoneDescription'] === undefined)
+        return false;
+    if (!('percentage' in value) || value['percentage'] === undefined)
+        return false;
+    if (!('areaAcres' in value) || value['areaAcres'] === undefined)
+        return false;
+    return true;
+}
+export function ZoneSegmentFromJSON(json) {
+    return ZoneSegmentFromJSONTyped(json, false);
+}
+export function ZoneSegmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'zone': json['zone'],
+        'zoneDescription': json['zoneDescription'],
+        'percentage': json['percentage'],
+        'areaAcres': json['areaAcres'],
+    };
+}
+export function ZoneSegmentToJSON(json) {
+    return ZoneSegmentToJSONTyped(json, false);
+}
+export function ZoneSegmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'zone': value['zone'],
+        'zoneDescription': value['zoneDescription'],
+        'percentage': value['percentage'],
+        'areaAcres': value['areaAcres'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,72 @@
+export * from './Address.js';
+export * from './Amenity.js';
+export * from './ApiError.js';
+export * from './AssessingPhoto.js';
+export * from './AssessmentHistoryForYear.js';
+export * from './BatchedPermit.js';
+export * from './BlobStorageLinks.js';
+export * from './CEBusinessNames.js';
+export * from './CEComments.js';
+export * from './CENote.js';
+export * from './CodeEnforcementCase.js';
+export * from './CodeEnforcementDocument.js';
+export * from './ConfigChangeData.js';
+export * from './CppPermit.js';
+export * from './DeepParentChildRelationship.js';
+export * from './DeepRelationship.js';
+export * from './Document.js';
+export * from './DocumentDownloadResponse.js';
+export * from './DocumentDownloadResponseApiResponse.js';
+export * from './DocumentProcessingState.js';
+export * from './Exemption.js';
+export * from './Feature.js';
+export * from './FieldCard.js';
+export * from './FireServiceArea.js';
+export * from './FullPermit.js';
+export * from './General.js';
+export * from './GovtCodeComment.js';
+export * from './Int32ApiResponse.js';
+export * from './Land.js';
+export * from './MetadataComplanPermitFields.js';
+export * from './Owner.js';
+export * from './PansList.js';
+export * from './Permit.js';
+export * from './PermitAppealStatus.js';
+export * from './PermitDocumentExists.js';
+export * from './PermitSearchRequest.js';
+export * from './PermitStatus.js';
+export * from './PermitType.js';
+export * from './PlatFilenameAndDescription.js';
+export * from './PrimaryStructure.js';
+export * from './PropertyComment.js';
+export * from './PropertyOwner.js';
+export * from './PropertyRelation.js';
+export * from './PropertyResponse.js';
+export * from './PropertySearchConfig.js';
+export * from './PropertySearchConfigWithChangeData.js';
+export * from './PropertySections.js';
+export * from './RecentZoningPermit.js';
+export * from './RezoneHistory.js';
+export * from './SearchOptions.js';
+export * from './SearchRequest.js';
+export * from './SearchResult.js';
+export * from './SecondaryStructure.js';
+export * from './Section.js';
+export * from './Sections.js';
+export * from './ServiceAreas.js';
+export * from './SitusAddress.js';
+export * from './SortCategories.js';
+export * from './SortDirection.js';
+export * from './SpecialFieldInstruction.js';
+export * from './Structures.js';
+export * from './TaxArea.js';
+export * from './TaxAuthority.js';
+export * from './TaxDetailsBreakdown.js';
+export * from './TaxDetailsBreakdownArea.js';
+export * from './TaxExemption.js';
+export * from './TaxHistory.js';
+export * from './TaxationAreas.js';
+export * from './TentativeValue.js';
+export * from './ZoneInfoResponse.js';
+export * from './ZoneInfoResponseApiResponse.js';
+export * from './ZoneSegment.js';

package/dist/esm/models/index.js

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Address.js';
+export * from './Amenity.js';
+export * from './ApiError.js';
+export * from './AssessingPhoto.js';
+export * from './AssessmentHistoryForYear.js';
+export * from './BatchedPermit.js';
+export * from './BlobStorageLinks.js';
+export * from './CEBusinessNames.js';
+export * from './CEComments.js';
+export * from './CENote.js';
+export * from './CodeEnforcementCase.js';
+export * from './CodeEnforcementDocument.js';
+export * from './ConfigChangeData.js';
+export * from './CppPermit.js';
+export * from './DeepParentChildRelationship.js';
+export * from './DeepRelationship.js';
+export * from './Document.js';
+export * from './DocumentDownloadResponse.js';
+export * from './DocumentDownloadResponseApiResponse.js';
+export * from './DocumentProcessingState.js';
+export * from './Exemption.js';
+export * from './Feature.js';
+export * from './FieldCard.js';
+export * from './FireServiceArea.js';
+export * from './FullPermit.js';
+export * from './General.js';
+export * from './GovtCodeComment.js';
+export * from './Int32ApiResponse.js';
+export * from './Land.js';
+export * from './MetadataComplanPermitFields.js';
+export * from './Owner.js';
+export * from './PansList.js';
+export * from './Permit.js';
+export * from './PermitAppealStatus.js';
+export * from './PermitDocumentExists.js';
+export * from './PermitSearchRequest.js';
+export * from './PermitStatus.js';
+export * from './PermitType.js';
+export * from './PlatFilenameAndDescription.js';
+export * from './PrimaryStructure.js';
+export * from './PropertyComment.js';
+export * from './PropertyOwner.js';
+export * from './PropertyRelation.js';
+export * from './PropertyResponse.js';
+export * from './PropertySearchConfig.js';
+export * from './PropertySearchConfigWithChangeData.js';
+export * from './PropertySections.js';
+export * from './RecentZoningPermit.js';
+export * from './RezoneHistory.js';
+export * from './SearchOptions.js';
+export * from './SearchRequest.js';
+export * from './SearchResult.js';
+export * from './SecondaryStructure.js';
+export * from './Section.js';
+export * from './Sections.js';
+export * from './ServiceAreas.js';
+export * from './SitusAddress.js';
+export * from './SortCategories.js';
+export * from './SortDirection.js';
+export * from './SpecialFieldInstruction.js';
+export * from './Structures.js';
+export * from './TaxArea.js';
+export * from './TaxAuthority.js';
+export * from './TaxDetailsBreakdown.js';
+export * from './TaxDetailsBreakdownArea.js';
+export * from './TaxExemption.js';
+export * from './TaxHistory.js';
+export * from './TaxationAreas.js';
+export * from './TentativeValue.js';
+export * from './ZoneInfoResponse.js';
+export * from './ZoneInfoResponseApiResponse.js';
+export * from './ZoneSegment.js';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Property Search
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.92
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { type ApiError } from "./models";
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    apiError?: ApiError;
+    constructor(response: Response, msg?: string, json?: any);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}