@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
50 lines • 1.87 kB
TypeScript
import type { BaseResponse } from '../../../core/base-client';
import type { P21CoreClient } from '../client';
import type { LocationListParams } from '../schemas';
type ExecuteRequest = P21CoreClient['executeRequest'];
/**
* Creates the location resource methods
* OpenAPI Path: /location → location.*
* @description Location management operations for warehouse and distribution
*/
export declare function createLocationResource(executeRequest: ExecuteRequest, createListMethod: P21CoreClient['createListMethod']): {
/**
* List locations with filtering
* @fullPath api.p21Core.location.list
* @service p21-core
* @domain location-and-warehouse-management
* @dataMethod locationData.list
* @discoverable true
*/
list: (params?: {
limit?: number | undefined;
offset?: number | undefined;
q?: string | undefined;
orderBy?: string | undefined;
deleteFlag?: string | undefined;
} | undefined) => Promise<BaseResponse<unknown[]>>;
/**
* Get location details by ID
* @fullPath api.p21Core.location.get
* @service p21-core
* @domain location-and-warehouse-management
* @dataMethod locationData.get
* @discoverable true
*/
get: (params: {
locationId: number;
}) => Promise<BaseResponse<unknown>>;
};
/**
* Creates the locationData resource methods (data-only versions)
*/
export declare function createLocationDataResource(location: ReturnType<typeof createLocationResource>): {
list: (params?: LocationListParams) => Promise<unknown[]>;
get: (params: {
locationId: number;
}) => Promise<unknown>;
};
export type LocationResource = ReturnType<typeof createLocationResource>;
export type LocationDataResource = ReturnType<typeof createLocationDataResource>;
export {};
//# sourceMappingURL=location.d.ts.map