@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
89 lines • 3.17 kB
TypeScript
import type { CommerceClient } from '../client';
import type { CartHdrListParams, CartHdrLookupParams, CartHdrLookupResponse, AlsoBoughtParams, AlsoBoughtResponse } from '../schemas';
type ExecuteRequest = CommerceClient['executeRequest'];
/**
* Creates the cartHdr resource methods
* OpenAPI Path: /cart-hdr → cartHdr.*
* @description Cart header management and session tracking functionality
*/
export declare function createCartHdrResource(executeRequest: ExecuteRequest): {
/**
* List Operations
*/
list: {
/**
* Retrieve a list of cart headers for a specific user
* @fullPath api.commerce.cartHdr.list.get
* @service commerce
* @domain cart-management
* @dataMethod cartHdrData.list.get
* @discoverable true
*/
get: (params: CartHdrListParams) => Promise<{
params: Record<string, unknown> | unknown[];
data: import("zod").objectInputType<{
cartHdrUid: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
/**
* Lookup Operations
*/
lookup: {
/**
* Lookup an existing cart or create a new one
* @fullPath api.commerce.cartHdr.lookup.get
* @service commerce
* @domain cart-management
* @dataMethod cartHdrData.lookup.get
* @discoverable true
*/
get: (params: CartHdrLookupParams) => Promise<CartHdrLookupResponse>;
};
/**
* Also Bought Operations
*/
alsoBought: {
/**
* Get product recommendations based on cart contents
* @fullPath api.commerce.cartHdr.alsoBought.get
* @service commerce
* @domain recommendation-engine
* @dataMethod cartHdrData.alsoBought.get
* @discoverable true
*/
get: (cartHdrUid: number, params?: AlsoBoughtParams) => Promise<AlsoBoughtResponse>;
};
};
/**
* Creates the cartHdrData resource methods (data-only versions)
*/
export declare function createCartHdrDataResource(cartHdr: ReturnType<typeof createCartHdrResource>): {
list: {
get: (params: CartHdrListParams) => Promise<import("zod").objectInputType<{
cartHdrUid: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[]>;
};
lookup: {
get: (params: CartHdrLookupParams) => Promise<{
cartHdrUid: number;
} & {
[k: string]: unknown;
}>;
};
alsoBought: {
get: (cartHdrUid: number, params?: AlsoBoughtParams) => Promise<import("zod").objectOutputType<{
invMastUid: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[]>;
};
};
export type CartHdrResource = ReturnType<typeof createCartHdrResource>;
export type CartHdrDataResource = ReturnType<typeof createCartHdrDataResource>;
export {};
//# sourceMappingURL=cart-hdr.d.ts.map