khansama-api 1.70.0 → 1.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +73 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +66 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -489,6 +489,7 @@ export interface BodyCreatePantryItemPantryItemsPost {
|
|
|
489
489
|
notes?: BodyCreatePantryItemPantryItemsPostNotes;
|
|
490
490
|
icon_tint?: BodyCreatePantryItemPantryItemsPostIconTint;
|
|
491
491
|
ingredient_id?: BodyCreatePantryItemPantryItemsPostIngredientId;
|
|
492
|
+
is_staple?: boolean;
|
|
492
493
|
image?: BodyCreatePantryItemPantryItemsPostImage;
|
|
493
494
|
}
|
|
494
495
|
export interface BodyCreateRecipeRecipesPost {
|
|
@@ -548,6 +549,7 @@ export type BodyUpdatePantryItemPantryItemsItemIdPutLocationId = number | null;
|
|
|
548
549
|
export type BodyUpdatePantryItemPantryItemsItemIdPutNotes = string | null;
|
|
549
550
|
export type BodyUpdatePantryItemPantryItemsItemIdPutIconTint = string | null;
|
|
550
551
|
export type BodyUpdatePantryItemPantryItemsItemIdPutClearIconTint = string | null;
|
|
552
|
+
export type BodyUpdatePantryItemPantryItemsItemIdPutIsStaple = boolean | null;
|
|
551
553
|
export type BodyUpdatePantryItemPantryItemsItemIdPutImage = string | null;
|
|
552
554
|
export type BodyUpdatePantryItemPantryItemsItemIdPutClearImage = string | null;
|
|
553
555
|
export interface BodyUpdatePantryItemPantryItemsItemIdPut {
|
|
@@ -563,6 +565,7 @@ export interface BodyUpdatePantryItemPantryItemsItemIdPut {
|
|
|
563
565
|
notes?: BodyUpdatePantryItemPantryItemsItemIdPutNotes;
|
|
564
566
|
icon_tint?: BodyUpdatePantryItemPantryItemsItemIdPutIconTint;
|
|
565
567
|
clear_icon_tint?: BodyUpdatePantryItemPantryItemsItemIdPutClearIconTint;
|
|
568
|
+
is_staple?: BodyUpdatePantryItemPantryItemsItemIdPutIsStaple;
|
|
566
569
|
image?: BodyUpdatePantryItemPantryItemsItemIdPutImage;
|
|
567
570
|
clear_image?: BodyUpdatePantryItemPantryItemsItemIdPutClearImage;
|
|
568
571
|
}
|
|
@@ -2375,6 +2378,7 @@ export interface PantryItemResponse {
|
|
|
2375
2378
|
last_verified_at?: PantryItemResponseLastVerifiedAt;
|
|
2376
2379
|
quantity_level?: PantryItemResponseQuantityLevel;
|
|
2377
2380
|
icon_tint?: PantryItemResponseIconTint;
|
|
2381
|
+
is_staple?: boolean;
|
|
2378
2382
|
}
|
|
2379
2383
|
export type PantryPromptItemQuantity = number | null;
|
|
2380
2384
|
export type PantryPromptItemUnit = string | null;
|
|
@@ -3352,6 +3356,7 @@ export type ShoppingListItemResponseClientRef = string | null;
|
|
|
3352
3356
|
export type ShoppingListItemResponseNote = string | null;
|
|
3353
3357
|
export type ShoppingListItemResponseCategory = string | null;
|
|
3354
3358
|
export type ShoppingListItemResponseEstimatedPrice = number | null;
|
|
3359
|
+
export type ShoppingListItemResponseAisle = string | null;
|
|
3355
3360
|
export interface ShoppingListItemResponse {
|
|
3356
3361
|
id: number;
|
|
3357
3362
|
list_id: number;
|
|
@@ -3368,16 +3373,19 @@ export interface ShoppingListItemResponse {
|
|
|
3368
3373
|
created_at: string;
|
|
3369
3374
|
category?: ShoppingListItemResponseCategory;
|
|
3370
3375
|
estimated_price?: ShoppingListItemResponseEstimatedPrice;
|
|
3376
|
+
aisle?: ShoppingListItemResponseAisle;
|
|
3371
3377
|
}
|
|
3372
3378
|
export type ShoppingListItemUpdateChecked = boolean | null;
|
|
3373
3379
|
export type ShoppingListItemUpdateName = string | null;
|
|
3374
3380
|
export type ShoppingListItemUpdateQuantity = number | null;
|
|
3375
3381
|
export type ShoppingListItemUpdateUnit = string | null;
|
|
3382
|
+
export type ShoppingListItemUpdateAisle = string | null;
|
|
3376
3383
|
export interface ShoppingListItemUpdate {
|
|
3377
3384
|
checked?: ShoppingListItemUpdateChecked;
|
|
3378
3385
|
name?: ShoppingListItemUpdateName;
|
|
3379
3386
|
quantity?: ShoppingListItemUpdateQuantity;
|
|
3380
3387
|
unit?: ShoppingListItemUpdateUnit;
|
|
3388
|
+
aisle?: ShoppingListItemUpdateAisle;
|
|
3381
3389
|
}
|
|
3382
3390
|
export type ShoppingListItemUpdateResponseIngredientId = number | null;
|
|
3383
3391
|
export type ShoppingListItemUpdateResponseQuantity = number | null;
|
|
@@ -3388,6 +3396,7 @@ export type ShoppingListItemUpdateResponseClientRef = string | null;
|
|
|
3388
3396
|
export type ShoppingListItemUpdateResponseNote = string | null;
|
|
3389
3397
|
export type ShoppingListItemUpdateResponseCategory = string | null;
|
|
3390
3398
|
export type ShoppingListItemUpdateResponseEstimatedPrice = number | null;
|
|
3399
|
+
export type ShoppingListItemUpdateResponseAisle = string | null;
|
|
3391
3400
|
export interface ShoppingListItemUpdateResponse {
|
|
3392
3401
|
id: number;
|
|
3393
3402
|
list_id: number;
|
|
@@ -3404,6 +3413,7 @@ export interface ShoppingListItemUpdateResponse {
|
|
|
3404
3413
|
created_at: string;
|
|
3405
3414
|
category?: ShoppingListItemUpdateResponseCategory;
|
|
3406
3415
|
estimated_price?: ShoppingListItemUpdateResponseEstimatedPrice;
|
|
3416
|
+
aisle?: ShoppingListItemUpdateResponseAisle;
|
|
3407
3417
|
pantry_prompt?: PantryPromptItem[];
|
|
3408
3418
|
}
|
|
3409
3419
|
export type ShoppingListResponseCreatedByUserId = number | null;
|
|
@@ -3455,6 +3465,15 @@ export declare const SpiceLevelEnum: {
|
|
|
3455
3465
|
readonly medium: "medium";
|
|
3456
3466
|
readonly hot: "hot";
|
|
3457
3467
|
};
|
|
3468
|
+
/**
|
|
3469
|
+
* The Running low strip's one tap (PAN-565): the shopping row the tap
|
|
3470
|
+
produced — the row already waiting when the item was on the list — and
|
|
3471
|
+
whether it was already there.
|
|
3472
|
+
*/
|
|
3473
|
+
export interface StapleShoppingAddResponse {
|
|
3474
|
+
item: ShoppingListItemResponse;
|
|
3475
|
+
already_listed: boolean;
|
|
3476
|
+
}
|
|
3458
3477
|
export type StorageLocationCreateIcon = string | null;
|
|
3459
3478
|
export type StorageLocationCreateSortOrder = number | null;
|
|
3460
3479
|
export interface StorageLocationCreate {
|
|
@@ -4471,6 +4490,31 @@ export declare function useGetQuickCheckItemsPantryItemsQuickCheckGet<TData = Aw
|
|
|
4471
4490
|
}): UseQueryResult<TData, TError> & {
|
|
4472
4491
|
queryKey: QueryKey;
|
|
4473
4492
|
};
|
|
4493
|
+
/**
|
|
4494
|
+
* The household's staples that need restocking (PAN-565): used up,
|
|
4495
|
+
marked finished (low/gone level), or under the household's per-item
|
|
4496
|
+
minimum. Each one offers a one-tap add to the shopping list.
|
|
4497
|
+
* @summary Get Running Low Staples
|
|
4498
|
+
*/
|
|
4499
|
+
export declare const getRunningLowStaplesPantryItemsStaplesRunningLowGet: (options?: AxiosRequestConfig) => Promise<AxiosResponse<PantryItemResponse[]>>;
|
|
4500
|
+
export declare const getGetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryKey: () => readonly ["/pantry-items/staples/running-low"];
|
|
4501
|
+
export declare const getGetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryOptions: <TData = Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError = AxiosError<unknown>>(options?: {
|
|
4502
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData>;
|
|
4503
|
+
axios?: AxiosRequestConfig;
|
|
4504
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData> & {
|
|
4505
|
+
queryKey: QueryKey;
|
|
4506
|
+
};
|
|
4507
|
+
export type GetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>>;
|
|
4508
|
+
export type GetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryError = AxiosError<unknown>;
|
|
4509
|
+
/**
|
|
4510
|
+
* @summary Get Running Low Staples
|
|
4511
|
+
*/
|
|
4512
|
+
export declare function useGetRunningLowStaplesPantryItemsStaplesRunningLowGet<TData = Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError = AxiosError<unknown>>(options?: {
|
|
4513
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData>;
|
|
4514
|
+
axios?: AxiosRequestConfig;
|
|
4515
|
+
}): UseQueryResult<TData, TError> & {
|
|
4516
|
+
queryKey: QueryKey;
|
|
4517
|
+
};
|
|
4474
4518
|
/**
|
|
4475
4519
|
* @summary Get Inventory Events
|
|
4476
4520
|
*/
|
|
@@ -4697,6 +4741,35 @@ export declare const useUndoLevelLowStockPantryItemsItemIdLevelUndoPost: <TError
|
|
|
4697
4741
|
itemId: number;
|
|
4698
4742
|
data: LevelUndoRequest;
|
|
4699
4743
|
}, TContext>;
|
|
4744
|
+
/**
|
|
4745
|
+
* The Running low strip's one tap (PAN-565): put the staple on the
|
|
4746
|
+
household's shopping list, deduplicated — a tap never duplicates what is
|
|
4747
|
+
already waiting there. Deliberately not automatic: staples are excluded
|
|
4748
|
+
from the level change's auto-add.
|
|
4749
|
+
* @summary Add Running Low Staple
|
|
4750
|
+
*/
|
|
4751
|
+
export declare const addRunningLowStaplePantryItemsItemIdAddToShoppingListPost: (itemId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<StapleShoppingAddResponse>>;
|
|
4752
|
+
export declare const getAddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationOptions: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
4753
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4754
|
+
itemId: number;
|
|
4755
|
+
}, TContext>;
|
|
4756
|
+
axios?: AxiosRequestConfig;
|
|
4757
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4758
|
+
itemId: number;
|
|
4759
|
+
}, TContext>;
|
|
4760
|
+
export type AddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationResult = NonNullable<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>>;
|
|
4761
|
+
export type AddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationError = AxiosError<HTTPValidationError>;
|
|
4762
|
+
/**
|
|
4763
|
+
* @summary Add Running Low Staple
|
|
4764
|
+
*/
|
|
4765
|
+
export declare const useAddRunningLowStaplePantryItemsItemIdAddToShoppingListPost: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
4766
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4767
|
+
itemId: number;
|
|
4768
|
+
}, TContext>;
|
|
4769
|
+
axios?: AxiosRequestConfig;
|
|
4770
|
+
}) => UseMutationResult<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4771
|
+
itemId: number;
|
|
4772
|
+
}, TContext>;
|
|
4700
4773
|
/**
|
|
4701
4774
|
* Confirm an item is still there; optionally correct its expiry and level.
|
|
4702
4775
|
* @summary Verify Pantry Item
|