khansama-api 1.69.1 → 1.71.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 +251 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +178 -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
|
}
|
|
@@ -1515,6 +1518,24 @@ export interface IngredientAutocompleteItem {
|
|
|
1515
1518
|
source: IngredientAutocompleteItemSource;
|
|
1516
1519
|
usage_count?: IngredientAutocompleteItemUsageCount;
|
|
1517
1520
|
}
|
|
1521
|
+
export type IngredientSubstituteOfferRatio = number | null;
|
|
1522
|
+
export type IngredientSubstituteOfferNote = string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* One stand-in for a recipe ingredient (PAN-556).
|
|
1525
|
+
|
|
1526
|
+
From the curated ``ingredient_substitution`` table: ``ratio`` is "1 unit
|
|
1527
|
+
of the original ≈ ``ratio`` units of the substitute" and the app scales it
|
|
1528
|
+
with the servings slider. ``in_pantry`` marks a substitute the household
|
|
1529
|
+
already holds (the app lists those first and badges them).
|
|
1530
|
+
*/
|
|
1531
|
+
export interface IngredientSubstituteOffer {
|
|
1532
|
+
ingredient_id: number;
|
|
1533
|
+
name: string;
|
|
1534
|
+
ratio?: IngredientSubstituteOfferRatio;
|
|
1535
|
+
note?: IngredientSubstituteOfferNote;
|
|
1536
|
+
context?: string;
|
|
1537
|
+
in_pantry?: boolean;
|
|
1538
|
+
}
|
|
1518
1539
|
export type InventoryEventKindEnum = typeof InventoryEventKindEnum[keyof typeof InventoryEventKindEnum];
|
|
1519
1540
|
export declare const InventoryEventKindEnum: {
|
|
1520
1541
|
readonly added: "added";
|
|
@@ -1689,6 +1710,7 @@ export type LibraryRecipeDetailImage = string | null;
|
|
|
1689
1710
|
export type LibraryRecipeDetailTotalMinutes = number | null;
|
|
1690
1711
|
export type LibraryRecipeDetailSource = RecipeSourceEnum | null;
|
|
1691
1712
|
export type LibraryRecipeDetailForkedFrom = number | null;
|
|
1713
|
+
export type LibraryRecipeDetailLastMadeAt = string | null;
|
|
1692
1714
|
/**
|
|
1693
1715
|
* GET /library/recipes/{kind}/{id}: the list item plus ingredients and steps.
|
|
1694
1716
|
*/
|
|
@@ -1705,6 +1727,8 @@ export interface LibraryRecipeDetail {
|
|
|
1705
1727
|
likes_count?: number;
|
|
1706
1728
|
saved_count?: number;
|
|
1707
1729
|
liked_by_me?: boolean;
|
|
1730
|
+
times_made?: number;
|
|
1731
|
+
last_made_at?: LibraryRecipeDetailLastMadeAt;
|
|
1708
1732
|
ingredients?: CatalogRecipeIngredientOut[];
|
|
1709
1733
|
steps?: string[];
|
|
1710
1734
|
}
|
|
@@ -1717,6 +1741,7 @@ export type LibraryRecipeSummaryImage = string | null;
|
|
|
1717
1741
|
export type LibraryRecipeSummaryTotalMinutes = number | null;
|
|
1718
1742
|
export type LibraryRecipeSummarySource = RecipeSourceEnum | null;
|
|
1719
1743
|
export type LibraryRecipeSummaryForkedFrom = number | null;
|
|
1744
|
+
export type LibraryRecipeSummaryLastMadeAt = string | null;
|
|
1720
1745
|
/**
|
|
1721
1746
|
* One recipe in the unified library (catalog or public user recipe).
|
|
1722
1747
|
*/
|
|
@@ -1733,6 +1758,8 @@ export interface LibraryRecipeSummary {
|
|
|
1733
1758
|
likes_count?: number;
|
|
1734
1759
|
saved_count?: number;
|
|
1735
1760
|
liked_by_me?: boolean;
|
|
1761
|
+
times_made?: number;
|
|
1762
|
+
last_made_at?: LibraryRecipeSummaryLastMadeAt;
|
|
1736
1763
|
}
|
|
1737
1764
|
/**
|
|
1738
1765
|
* !67 shelves — mutually exclusive with ``sort`` (title).
|
|
@@ -1889,6 +1916,7 @@ export declare const ListRecipeRefKind: {
|
|
|
1889
1916
|
export type ListRecipeRefImageUrl = string | null;
|
|
1890
1917
|
export type ListRecipeRefCuisine = string | null;
|
|
1891
1918
|
export type ListRecipeRefServings = number | null;
|
|
1919
|
+
export type ListRecipeRefLastMadeAt = string | null;
|
|
1892
1920
|
/**
|
|
1893
1921
|
* The recipe half of a list item (user recipe or catalog recipe).
|
|
1894
1922
|
*/
|
|
@@ -1899,6 +1927,8 @@ export interface ListRecipeRef {
|
|
|
1899
1927
|
image_url?: ListRecipeRefImageUrl;
|
|
1900
1928
|
cuisine?: ListRecipeRefCuisine;
|
|
1901
1929
|
servings?: ListRecipeRefServings;
|
|
1930
|
+
times_made?: number;
|
|
1931
|
+
last_made_at?: ListRecipeRefLastMadeAt;
|
|
1902
1932
|
}
|
|
1903
1933
|
/**
|
|
1904
1934
|
* Every item id of the list, in the wanted order.
|
|
@@ -2348,6 +2378,7 @@ export interface PantryItemResponse {
|
|
|
2348
2378
|
last_verified_at?: PantryItemResponseLastVerifiedAt;
|
|
2349
2379
|
quantity_level?: PantryItemResponseQuantityLevel;
|
|
2350
2380
|
icon_tint?: PantryItemResponseIconTint;
|
|
2381
|
+
is_staple?: boolean;
|
|
2351
2382
|
}
|
|
2352
2383
|
export type PantryPromptItemQuantity = number | null;
|
|
2353
2384
|
export type PantryPromptItemUnit = string | null;
|
|
@@ -2746,12 +2777,25 @@ export type RecipeIngredientResponseUnit = string | null;
|
|
|
2746
2777
|
export type RecipeIngredientResponsePantryItemId = number | null;
|
|
2747
2778
|
export type RecipeIngredientResponseIngredientId = number | null;
|
|
2748
2779
|
export interface RecipeIngredientResponse {
|
|
2780
|
+
id: number;
|
|
2749
2781
|
name: string;
|
|
2750
2782
|
quantity: number;
|
|
2751
2783
|
unit?: RecipeIngredientResponseUnit;
|
|
2752
2784
|
pantry_item_id?: RecipeIngredientResponsePantryItemId;
|
|
2753
2785
|
ingredient_id?: RecipeIngredientResponseIngredientId;
|
|
2754
2786
|
}
|
|
2787
|
+
export type RecipeIngredientSubstitutionsIngredientId = number | null;
|
|
2788
|
+
/**
|
|
2789
|
+
* The substitutes offered for one recipe-ingredient row (PAN-556).
|
|
2790
|
+
|
|
2791
|
+
Rows without any offer are absent from the endpoint's response; the row is
|
|
2792
|
+
identified by ``ingredient_row_id`` (``RecipeIngredientResponse.id``).
|
|
2793
|
+
*/
|
|
2794
|
+
export interface RecipeIngredientSubstitutions {
|
|
2795
|
+
ingredient_row_id: number;
|
|
2796
|
+
ingredient_id?: RecipeIngredientSubstitutionsIngredientId;
|
|
2797
|
+
substitutes?: IngredientSubstituteOffer[];
|
|
2798
|
+
}
|
|
2755
2799
|
export type RecipeMacrosResponseNote = string | null;
|
|
2756
2800
|
/**
|
|
2757
2801
|
* Estimated per-serving macros for one recipe (``GET /recipes/{id}/macros``).
|
|
@@ -2784,6 +2828,30 @@ export declare const RecipeModerationStatusEnum: {
|
|
|
2784
2828
|
readonly pending_review: "pending_review";
|
|
2785
2829
|
readonly hidden: "hidden";
|
|
2786
2830
|
};
|
|
2831
|
+
export type RecipeNoteResponseText = string | null;
|
|
2832
|
+
export type RecipeNoteResponseCreatedAt = string | null;
|
|
2833
|
+
export type RecipeNoteResponseUpdatedAt = string | null;
|
|
2834
|
+
/**
|
|
2835
|
+
* My private note on one recipe (GET /recipe-notes/{kind}/{recipe_id}).
|
|
2836
|
+
|
|
2837
|
+
With no note saved yet every field is ``None``, so the app does not need
|
|
2838
|
+
to special-case a 404 for a recipe that simply has no note.
|
|
2839
|
+
*/
|
|
2840
|
+
export interface RecipeNoteResponse {
|
|
2841
|
+
text?: RecipeNoteResponseText;
|
|
2842
|
+
created_at?: RecipeNoteResponseCreatedAt;
|
|
2843
|
+
updated_at?: RecipeNoteResponseUpdatedAt;
|
|
2844
|
+
}
|
|
2845
|
+
/**
|
|
2846
|
+
* PUT /recipe-notes/{kind}/{recipe_id}: create or replace my private note.
|
|
2847
|
+
*/
|
|
2848
|
+
export interface RecipeNoteUpsert {
|
|
2849
|
+
/**
|
|
2850
|
+
* @minLength 1
|
|
2851
|
+
* @maxLength 500
|
|
2852
|
+
*/
|
|
2853
|
+
text: string;
|
|
2854
|
+
}
|
|
2787
2855
|
export type RecipePinnedNoteResponseAuthorName = string | null;
|
|
2788
2856
|
/**
|
|
2789
2857
|
* The pinned note in a recipe detail response (visible to anyone who
|
|
@@ -2835,6 +2903,8 @@ export type RecipeResponseModerationStatus = RecipeModerationStatusEnum | null;
|
|
|
2835
2903
|
export type RecipeResponseModerationReason = string | null;
|
|
2836
2904
|
export type RecipeResponsePinnedNote = RecipePinnedNoteResponse | null;
|
|
2837
2905
|
export type RecipeResponseProfileFit = ProfileFit | null;
|
|
2906
|
+
export type RecipeResponseMyNote = string | null;
|
|
2907
|
+
export type RecipeResponseLastMadeAt = string | null;
|
|
2838
2908
|
export interface RecipeResponse {
|
|
2839
2909
|
id: number;
|
|
2840
2910
|
name: string;
|
|
@@ -2859,6 +2929,9 @@ export interface RecipeResponse {
|
|
|
2859
2929
|
pinned_note?: RecipeResponsePinnedNote;
|
|
2860
2930
|
source_images?: RecipeSourceImageResponse[];
|
|
2861
2931
|
profile_fit?: RecipeResponseProfileFit;
|
|
2932
|
+
my_note?: RecipeResponseMyNote;
|
|
2933
|
+
times_made?: number;
|
|
2934
|
+
last_made_at?: RecipeResponseLastMadeAt;
|
|
2862
2935
|
}
|
|
2863
2936
|
export type RecipeSourceEnum = typeof RecipeSourceEnum[keyof typeof RecipeSourceEnum];
|
|
2864
2937
|
export declare const RecipeSourceEnum: {
|
|
@@ -3386,6 +3459,15 @@ export declare const SpiceLevelEnum: {
|
|
|
3386
3459
|
readonly medium: "medium";
|
|
3387
3460
|
readonly hot: "hot";
|
|
3388
3461
|
};
|
|
3462
|
+
/**
|
|
3463
|
+
* The Running low strip's one tap (PAN-565): the shopping row the tap
|
|
3464
|
+
produced — the row already waiting when the item was on the list — and
|
|
3465
|
+
whether it was already there.
|
|
3466
|
+
*/
|
|
3467
|
+
export interface StapleShoppingAddResponse {
|
|
3468
|
+
item: ShoppingListItemResponse;
|
|
3469
|
+
already_listed: boolean;
|
|
3470
|
+
}
|
|
3389
3471
|
export type StorageLocationCreateIcon = string | null;
|
|
3390
3472
|
export type StorageLocationCreateSortOrder = number | null;
|
|
3391
3473
|
export interface StorageLocationCreate {
|
|
@@ -4402,6 +4484,31 @@ export declare function useGetQuickCheckItemsPantryItemsQuickCheckGet<TData = Aw
|
|
|
4402
4484
|
}): UseQueryResult<TData, TError> & {
|
|
4403
4485
|
queryKey: QueryKey;
|
|
4404
4486
|
};
|
|
4487
|
+
/**
|
|
4488
|
+
* The household's staples that need restocking (PAN-565): used up,
|
|
4489
|
+
marked finished (low/gone level), or under the household's per-item
|
|
4490
|
+
minimum. Each one offers a one-tap add to the shopping list.
|
|
4491
|
+
* @summary Get Running Low Staples
|
|
4492
|
+
*/
|
|
4493
|
+
export declare const getRunningLowStaplesPantryItemsStaplesRunningLowGet: (options?: AxiosRequestConfig) => Promise<AxiosResponse<PantryItemResponse[]>>;
|
|
4494
|
+
export declare const getGetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryKey: () => readonly ["/pantry-items/staples/running-low"];
|
|
4495
|
+
export declare const getGetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryOptions: <TData = Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError = AxiosError<unknown>>(options?: {
|
|
4496
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData>;
|
|
4497
|
+
axios?: AxiosRequestConfig;
|
|
4498
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData> & {
|
|
4499
|
+
queryKey: QueryKey;
|
|
4500
|
+
};
|
|
4501
|
+
export type GetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>>;
|
|
4502
|
+
export type GetRunningLowStaplesPantryItemsStaplesRunningLowGetQueryError = AxiosError<unknown>;
|
|
4503
|
+
/**
|
|
4504
|
+
* @summary Get Running Low Staples
|
|
4505
|
+
*/
|
|
4506
|
+
export declare function useGetRunningLowStaplesPantryItemsStaplesRunningLowGet<TData = Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError = AxiosError<unknown>>(options?: {
|
|
4507
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRunningLowStaplesPantryItemsStaplesRunningLowGet>>, TError, TData>;
|
|
4508
|
+
axios?: AxiosRequestConfig;
|
|
4509
|
+
}): UseQueryResult<TData, TError> & {
|
|
4510
|
+
queryKey: QueryKey;
|
|
4511
|
+
};
|
|
4405
4512
|
/**
|
|
4406
4513
|
* @summary Get Inventory Events
|
|
4407
4514
|
*/
|
|
@@ -4628,6 +4735,35 @@ export declare const useUndoLevelLowStockPantryItemsItemIdLevelUndoPost: <TError
|
|
|
4628
4735
|
itemId: number;
|
|
4629
4736
|
data: LevelUndoRequest;
|
|
4630
4737
|
}, TContext>;
|
|
4738
|
+
/**
|
|
4739
|
+
* The Running low strip's one tap (PAN-565): put the staple on the
|
|
4740
|
+
household's shopping list, deduplicated — a tap never duplicates what is
|
|
4741
|
+
already waiting there. Deliberately not automatic: staples are excluded
|
|
4742
|
+
from the level change's auto-add.
|
|
4743
|
+
* @summary Add Running Low Staple
|
|
4744
|
+
*/
|
|
4745
|
+
export declare const addRunningLowStaplePantryItemsItemIdAddToShoppingListPost: (itemId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<StapleShoppingAddResponse>>;
|
|
4746
|
+
export declare const getAddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationOptions: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
4747
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4748
|
+
itemId: number;
|
|
4749
|
+
}, TContext>;
|
|
4750
|
+
axios?: AxiosRequestConfig;
|
|
4751
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4752
|
+
itemId: number;
|
|
4753
|
+
}, TContext>;
|
|
4754
|
+
export type AddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationResult = NonNullable<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>>;
|
|
4755
|
+
export type AddRunningLowStaplePantryItemsItemIdAddToShoppingListPostMutationError = AxiosError<HTTPValidationError>;
|
|
4756
|
+
/**
|
|
4757
|
+
* @summary Add Running Low Staple
|
|
4758
|
+
*/
|
|
4759
|
+
export declare const useAddRunningLowStaplePantryItemsItemIdAddToShoppingListPost: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
4760
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4761
|
+
itemId: number;
|
|
4762
|
+
}, TContext>;
|
|
4763
|
+
axios?: AxiosRequestConfig;
|
|
4764
|
+
}) => UseMutationResult<Awaited<ReturnType<typeof addRunningLowStaplePantryItemsItemIdAddToShoppingListPost>>, TError, {
|
|
4765
|
+
itemId: number;
|
|
4766
|
+
}, TContext>;
|
|
4631
4767
|
/**
|
|
4632
4768
|
* Confirm an item is still there; optionally correct its expiry and level.
|
|
4633
4769
|
* @summary Verify Pantry Item
|
|
@@ -5795,6 +5931,33 @@ export declare const useDeleteRecipeRecipesRecipeIdDelete: <TError = AxiosError<
|
|
|
5795
5931
|
}) => UseMutationResult<Awaited<ReturnType<typeof deleteRecipeRecipesRecipeIdDelete>>, TError, {
|
|
5796
5932
|
recipeId: number;
|
|
5797
5933
|
}, TContext>;
|
|
5934
|
+
/**
|
|
5935
|
+
* Read-only stand-ins for the recipe's ingredients (PAN-556).
|
|
5936
|
+
|
|
5937
|
+
One entry per ingredient row that has substitutes in the curated table:
|
|
5938
|
+
pantry-owned ones first ("in your pantry"), allergen- and diet-safe only
|
|
5939
|
+
(PAN-459). No AI, and the recipe is never edited.
|
|
5940
|
+
* @summary Get Recipe Substitutions
|
|
5941
|
+
*/
|
|
5942
|
+
export declare const getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet: (recipeId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<RecipeIngredientSubstitutions[]>>;
|
|
5943
|
+
export declare const getGetRecipeSubstitutionsRecipesRecipeIdSubstitutionsGetQueryKey: (recipeId?: number) => readonly ["/recipes/undefined/substitutions" | `/recipes/${number}/substitutions`];
|
|
5944
|
+
export declare const getGetRecipeSubstitutionsRecipesRecipeIdSubstitutionsGetQueryOptions: <TData = Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>, TError = AxiosError<HTTPValidationError>>(recipeId: number, options?: {
|
|
5945
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>, TError, TData>;
|
|
5946
|
+
axios?: AxiosRequestConfig;
|
|
5947
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>, TError, TData> & {
|
|
5948
|
+
queryKey: QueryKey;
|
|
5949
|
+
};
|
|
5950
|
+
export type GetRecipeSubstitutionsRecipesRecipeIdSubstitutionsGetQueryResult = NonNullable<Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>>;
|
|
5951
|
+
export type GetRecipeSubstitutionsRecipesRecipeIdSubstitutionsGetQueryError = AxiosError<HTTPValidationError>;
|
|
5952
|
+
/**
|
|
5953
|
+
* @summary Get Recipe Substitutions
|
|
5954
|
+
*/
|
|
5955
|
+
export declare function useGetRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet<TData = Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>, TError = AxiosError<HTTPValidationError>>(recipeId: number, options?: {
|
|
5956
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRecipeSubstitutionsRecipesRecipeIdSubstitutionsGet>>, TError, TData>;
|
|
5957
|
+
axios?: AxiosRequestConfig;
|
|
5958
|
+
}): UseQueryResult<TData, TError> & {
|
|
5959
|
+
queryKey: QueryKey;
|
|
5960
|
+
};
|
|
5798
5961
|
/**
|
|
5799
5962
|
* Estimated per-serving macros for the recipe (PAN-450), from the USDA
|
|
5800
5963
|
FoodData Central cache. Unmatched ingredients (no USDA link, or a unit
|
|
@@ -5916,6 +6079,94 @@ export declare const useUndoCookCookEventsCookIdUndoPost: <TError = AxiosError<H
|
|
|
5916
6079
|
}) => UseMutationResult<Awaited<ReturnType<typeof undoCookCookEventsCookIdUndoPost>>, TError, {
|
|
5917
6080
|
cookId: string;
|
|
5918
6081
|
}, TContext>;
|
|
6082
|
+
/**
|
|
6083
|
+
* My note on a recipe — every field ``None`` while nothing is saved.
|
|
6084
|
+
* @summary Get Recipe Note
|
|
6085
|
+
*/
|
|
6086
|
+
export declare const getRecipeNoteRecipeNotesKindRecipeIdGet: (kind: "user" | "catalog", recipeId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<RecipeNoteResponse>>;
|
|
6087
|
+
export declare const getGetRecipeNoteRecipeNotesKindRecipeIdGetQueryKey: (kind?: "user" | "catalog", recipeId?: number) => readonly ["/recipe-notes/undefined/undefined" | `/recipe-notes/undefined/${number}` | "/recipe-notes/user/undefined" | `/recipe-notes/user/${number}` | "/recipe-notes/catalog/undefined" | `/recipe-notes/catalog/${number}`];
|
|
6088
|
+
export declare const getGetRecipeNoteRecipeNotesKindRecipeIdGetQueryOptions: <TData = Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>, TError = AxiosError<HTTPValidationError>>(kind: "user" | "catalog", recipeId: number, options?: {
|
|
6089
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>, TError, TData>;
|
|
6090
|
+
axios?: AxiosRequestConfig;
|
|
6091
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>, TError, TData> & {
|
|
6092
|
+
queryKey: QueryKey;
|
|
6093
|
+
};
|
|
6094
|
+
export type GetRecipeNoteRecipeNotesKindRecipeIdGetQueryResult = NonNullable<Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>>;
|
|
6095
|
+
export type GetRecipeNoteRecipeNotesKindRecipeIdGetQueryError = AxiosError<HTTPValidationError>;
|
|
6096
|
+
/**
|
|
6097
|
+
* @summary Get Recipe Note
|
|
6098
|
+
*/
|
|
6099
|
+
export declare function useGetRecipeNoteRecipeNotesKindRecipeIdGet<TData = Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>, TError = AxiosError<HTTPValidationError>>(kind: 'user' | 'catalog', recipeId: number, options?: {
|
|
6100
|
+
query?: UseQueryOptions<Awaited<ReturnType<typeof getRecipeNoteRecipeNotesKindRecipeIdGet>>, TError, TData>;
|
|
6101
|
+
axios?: AxiosRequestConfig;
|
|
6102
|
+
}): UseQueryResult<TData, TError> & {
|
|
6103
|
+
queryKey: QueryKey;
|
|
6104
|
+
};
|
|
6105
|
+
/**
|
|
6106
|
+
* Create or replace my note on a recipe.
|
|
6107
|
+
* @summary Save Recipe Note
|
|
6108
|
+
*/
|
|
6109
|
+
export declare const saveRecipeNoteRecipeNotesKindRecipeIdPut: (kind: "user" | "catalog", recipeId: number, recipeNoteUpsert: RecipeNoteUpsert, options?: AxiosRequestConfig) => Promise<AxiosResponse<RecipeNoteResponse>>;
|
|
6110
|
+
export declare const getSaveRecipeNoteRecipeNotesKindRecipeIdPutMutationOptions: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
6111
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof saveRecipeNoteRecipeNotesKindRecipeIdPut>>, TError, {
|
|
6112
|
+
kind: "user" | "catalog";
|
|
6113
|
+
recipeId: number;
|
|
6114
|
+
data: RecipeNoteUpsert;
|
|
6115
|
+
}, TContext>;
|
|
6116
|
+
axios?: AxiosRequestConfig;
|
|
6117
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof saveRecipeNoteRecipeNotesKindRecipeIdPut>>, TError, {
|
|
6118
|
+
kind: "user" | "catalog";
|
|
6119
|
+
recipeId: number;
|
|
6120
|
+
data: RecipeNoteUpsert;
|
|
6121
|
+
}, TContext>;
|
|
6122
|
+
export type SaveRecipeNoteRecipeNotesKindRecipeIdPutMutationResult = NonNullable<Awaited<ReturnType<typeof saveRecipeNoteRecipeNotesKindRecipeIdPut>>>;
|
|
6123
|
+
export type SaveRecipeNoteRecipeNotesKindRecipeIdPutMutationBody = RecipeNoteUpsert;
|
|
6124
|
+
export type SaveRecipeNoteRecipeNotesKindRecipeIdPutMutationError = AxiosError<HTTPValidationError>;
|
|
6125
|
+
/**
|
|
6126
|
+
* @summary Save Recipe Note
|
|
6127
|
+
*/
|
|
6128
|
+
export declare const useSaveRecipeNoteRecipeNotesKindRecipeIdPut: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
6129
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof saveRecipeNoteRecipeNotesKindRecipeIdPut>>, TError, {
|
|
6130
|
+
kind: "user" | "catalog";
|
|
6131
|
+
recipeId: number;
|
|
6132
|
+
data: RecipeNoteUpsert;
|
|
6133
|
+
}, TContext>;
|
|
6134
|
+
axios?: AxiosRequestConfig;
|
|
6135
|
+
}) => UseMutationResult<Awaited<ReturnType<typeof saveRecipeNoteRecipeNotesKindRecipeIdPut>>, TError, {
|
|
6136
|
+
kind: "user" | "catalog";
|
|
6137
|
+
recipeId: number;
|
|
6138
|
+
data: RecipeNoteUpsert;
|
|
6139
|
+
}, TContext>;
|
|
6140
|
+
/**
|
|
6141
|
+
* Clear my note — a no-op (empty response) when nothing is saved.
|
|
6142
|
+
* @summary Clear Recipe Note
|
|
6143
|
+
*/
|
|
6144
|
+
export declare const clearRecipeNoteRecipeNotesKindRecipeIdDelete: (kind: "user" | "catalog", recipeId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<RecipeNoteResponse>>;
|
|
6145
|
+
export declare const getClearRecipeNoteRecipeNotesKindRecipeIdDeleteMutationOptions: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
6146
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof clearRecipeNoteRecipeNotesKindRecipeIdDelete>>, TError, {
|
|
6147
|
+
kind: "user" | "catalog";
|
|
6148
|
+
recipeId: number;
|
|
6149
|
+
}, TContext>;
|
|
6150
|
+
axios?: AxiosRequestConfig;
|
|
6151
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof clearRecipeNoteRecipeNotesKindRecipeIdDelete>>, TError, {
|
|
6152
|
+
kind: "user" | "catalog";
|
|
6153
|
+
recipeId: number;
|
|
6154
|
+
}, TContext>;
|
|
6155
|
+
export type ClearRecipeNoteRecipeNotesKindRecipeIdDeleteMutationResult = NonNullable<Awaited<ReturnType<typeof clearRecipeNoteRecipeNotesKindRecipeIdDelete>>>;
|
|
6156
|
+
export type ClearRecipeNoteRecipeNotesKindRecipeIdDeleteMutationError = AxiosError<HTTPValidationError>;
|
|
6157
|
+
/**
|
|
6158
|
+
* @summary Clear Recipe Note
|
|
6159
|
+
*/
|
|
6160
|
+
export declare const useClearRecipeNoteRecipeNotesKindRecipeIdDelete: <TError = AxiosError<HTTPValidationError>, TContext = unknown>(options?: {
|
|
6161
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof clearRecipeNoteRecipeNotesKindRecipeIdDelete>>, TError, {
|
|
6162
|
+
kind: "user" | "catalog";
|
|
6163
|
+
recipeId: number;
|
|
6164
|
+
}, TContext>;
|
|
6165
|
+
axios?: AxiosRequestConfig;
|
|
6166
|
+
}) => UseMutationResult<Awaited<ReturnType<typeof clearRecipeNoteRecipeNotesKindRecipeIdDelete>>, TError, {
|
|
6167
|
+
kind: "user" | "catalog";
|
|
6168
|
+
recipeId: number;
|
|
6169
|
+
}, TContext>;
|
|
5919
6170
|
/**
|
|
5920
6171
|
* List/search canonical ingredients (autocomplete source).
|
|
5921
6172
|
* @summary List Ingredients
|