@simpleapps-com/augur-api/dist/cjs/services/legacy/resources/state.d.ts

TypeScript client library for Augur microservices API endpoints

import type { LegacyClient } from '../client';
type CreateListMethod = LegacyClient['createListMethod'];
type CreateGetMethod = LegacyClient['createGetMethod'];
type CreateCreateMethod = LegacyClient['createCreateMethod'];
type CreateUpdateMethod = LegacyClient['createUpdateMethod'];
type CreateDeleteMethod = LegacyClient['createDeleteMethod'];
/**
 * Creates the state resource methods (under legacy namespace)
 * OpenAPI Path: /legacy/state → legacy.state.*
 * @description State management endpoints for US states and provinces with tax information
 */
export declare function createStateResource(createListMethod: CreateListMethod, createGetMethod: CreateGetMethod, createCreateMethod: CreateCreateMethod, createUpdateMethod: CreateUpdateMethod, createDeleteMethod: CreateDeleteMethod): {
    /**
     * List states with optional filtering and pagination
     * @fullPath api.legacy.legacy.state.list
     * @service legacy
     * @domain geographic-data
     * @dataMethod stateData.list
     * @discoverable true
     */
    list: (params?: {
        limit?: number | undefined;
        offset?: number | undefined;
        edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
        q?: string | undefined;
        orderBy?: string | undefined;
    } | undefined) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: import("zod").objectInputType<{
            stateUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get state details by UID
     * @fullPath api.legacy.legacy.state.get
     * @service legacy
     * @domain geographic-data
     * @dataMethod stateData.get
     * @discoverable true
     */
    get: (id: string | number, params?: {
        edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
    } | undefined) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            stateUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Create a new state record
     * @fullPath api.legacy.legacy.state.create
     * @service legacy
     * @domain geographic-data
     * @dataMethod stateData.create
     * @discoverable true
     */
    create: (data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            stateUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update an existing state record
     * @fullPath api.legacy.legacy.state.update
     * @service legacy
     * @domain geographic-data
     * @dataMethod stateData.update
     * @discoverable true
     */
    update: (id: string | number, data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            stateUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Delete a state record
     * @fullPath api.legacy.legacy.state.delete
     * @service legacy
     * @domain geographic-data
     * @dataMethod stateData.delete
     * @discoverable true
     */
    delete: (id: string | number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            message: string;
            deleted: boolean;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the stateData resource methods (data-only versions)
 */
export declare function createStateDataResource(state: ReturnType<typeof createStateResource>): {
    list: (params?: Parameters<typeof state.list>[0]) => Promise<import("zod").objectInputType<{
        stateUid: import("zod").ZodNumber;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    get: (id: number, params?: Parameters<typeof state.get>[1]) => Promise<{
        stateUid: number;
    } & {
        [k: string]: unknown;
    }>;
    create: (data: Parameters<typeof state.create>[0]) => Promise<{
        stateUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (id: number, data: Parameters<typeof state.update>[1]) => Promise<{
        stateUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (id: number) => Promise<{
        message: string;
        deleted: boolean;
    }>;
};
export type StateResource = ReturnType<typeof createStateResource>;
export type StateDataResource = ReturnType<typeof createStateDataResource>;
export {};
//# sourceMappingURL=state.d.ts.map