@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
50 lines • 1.61 kB
TypeScript
import type { CustomersClient } from '../client';
type ExecuteRequest = CustomersClient['executeRequest'];
/**
* Creates the shipTo resource methods
* OpenAPI Path: /ship-to → shipTo.*
* @description Ship-to refresh operations
*/
export declare function createShipToResource(executeRequest: ExecuteRequest): {
/**
* Ship-to refresh endpoint - OpenAPI Path: /ship-to/refresh (GET)
* @fullPath api.customers.shipTo.refresh
* @description Refreshes ship-to data from source system
* @service customers
* @domain data-refresh
* @dataMethod shipToData.refresh.get
* @discoverable true
*/
refresh: {
get: () => Promise<{
params: Record<string, unknown> | unknown[];
data: {
message: string;
timestamp: string;
jobId: string;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
};
/**
* Creates the shipToData resource methods (data-only versions)
*/
export declare function createShipToDataResource(shipTo: ReturnType<typeof createShipToResource>): {
refresh: {
get: () => Promise<{
message: string;
timestamp: string;
jobId: string;
}>;
};
};
export type ShipToResource = ReturnType<typeof createShipToResource>;
export type ShipToDataResource = ReturnType<typeof createShipToDataResource>;
export {};
//# sourceMappingURL=ship-to.d.ts.map