@spree/storefront-api-v2-sdk
Version:
Node module to easily integrate your JavaScript or TypeScript application with Spree API V2. You can create an entirely custom Storefront in JS/TS with this package including one page checkout, Single Page Apps, PWAs and so on
43 lines (42 loc) • 1.19 kB
TypeScript
import { JsonApiDocument, JsonApiListResponse, JsonApiSingleResponse } from './JsonApi';
import { IQuery } from './Query';
import { IRelationships } from './Relationships';
import { ResultResponse } from './ResultResponse';
import { WithCommonOptions } from './WithCommonOptions';
export interface MenuAttr extends JsonApiDocument {
type: string;
id: string;
attributes: {
name: string;
location: 'header' | 'footer' | string;
locale: string;
};
relationships: IRelationships;
}
export interface Menu extends JsonApiSingleResponse {
data: MenuAttr;
}
export interface Menus extends JsonApiListResponse {
data: MenuAttr[];
}
export interface MenuResult extends ResultResponse<Menu> {
}
export interface MenusResult extends ResultResponse<Menus> {
}
/**
* @deprecated Use {@link ListOptions} instead.
*/
export interface MenusList extends IQuery {
locale?: string;
filter?: IQuery['filter'] & {
location?: string;
};
}
export declare type ListOptions = WithCommonOptions<{
suggestQuery: true;
}, MenusList>;
export declare type ShowOptions = WithCommonOptions<{
suggestQuery: true;
}, {
id: string;
}>;