@simpleapps-com/augur-api/dist/cjs/services/items/resources/locations.d.ts

TypeScript client library for Augur microservices API endpoints

import { LocationsBinsParams } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the locations resource methods
 * OpenAPI Path: /locations → locations.*
 * @description Methods for managing locations
 */
export declare function createLocationsResource(executeRequest: ExecuteRequest): {
    /**
     * OpenAPI Path: /locations/{locationId}/bins → locations.bins.*
     * @description Nested path for location bins
     */
    bins: {
        /**
         * List location bins
         * @description Get bins for a specific location
         * @fullPath api.items.locations.bins.list
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        list: (locationId: string, params?: LocationsBinsParams) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Get location bin
         * @description Get specific bin for a location
         * @fullPath api.items.locations.bins.get
         * @service items
         * @domain inventory-management
         * @discoverable true
         */
        get: (locationId: string, bin: string) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[];
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
};
/**
 * Creates the locationsData resource methods (data-only versions)
 */
export declare function createLocationsDataResource(locations: ReturnType<typeof createLocationsResource>): {
    bins: {
        list: (locationId: string, params?: LocationsBinsParams) => Promise<import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
        get: (locationId: string, bin: string) => Promise<import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">[]>;
    };
};
export type LocationsResource = ReturnType<typeof createLocationsResource>;
export type LocationsDataResource = ReturnType<typeof createLocationsDataResource>;
export {};
//# sourceMappingURL=locations.d.ts.map