From 4edd72985005bc200e6485de62daff7b826644e8 Mon Sep 17 00:00:00 2001 From: smilerz Date: Thu, 18 Apr 2024 15:55:16 -0500 Subject: [PATCH] add schema parameters for all list endpoinst with filters --- .openapi-generator/FILES | 1 - apis/ApiApi.ts | 47 +++++++++++++++ cookbook/views/api.py | 50 +++++++++------- vue/src/utils/openapi/api.ts | 112 +++++++++++++++++++++++++---------- 4 files changed, 155 insertions(+), 55 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 464336964..7b8955f78 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,4 +1,3 @@ -.openapi-generator-ignore apis/ApiApi.ts apis/ApiImportOpenDataApi.ts apis/ApiTokenAuthApi.ts diff --git a/apis/ApiApi.ts b/apis/ApiApi.ts index a0f917cf1..8756c8097 100644 --- a/apis/ApiApi.ts +++ b/apis/ApiApi.ts @@ -692,8 +692,10 @@ export interface ApiIngredientDestroyRequest { } export interface ApiIngredientListRequest { + food?: number; page?: number; pageSize?: number; + unit?: number; } export interface ApiIngredientPartialUpdateRequest { @@ -719,6 +721,7 @@ export interface ApiInviteLinkDestroyRequest { } export interface ApiInviteLinkListRequest { + internalNote?: string; limit?: string; page?: number; pageSize?: number; @@ -893,6 +896,8 @@ export interface ApiRecipeBookEntryUpdateRequest { export interface ApiRecipeBookListRequest { limit?: string; + orderDirection?: ApiRecipeBookListOrderDirectionEnum; + orderField?: ApiRecipeBookListOrderFieldEnum; page?: number; pageSize?: number; query?: string; @@ -1385,6 +1390,7 @@ export interface ApiUserSpaceDestroyRequest { } export interface ApiUserSpaceListRequest { + internalNote?: string; page?: number; pageSize?: number; } @@ -4204,6 +4210,10 @@ export class ApiApi extends runtime.BaseAPI { async apiIngredientListRaw(requestParameters: ApiIngredientListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; + if (requestParameters.food !== undefined) { + queryParameters['food'] = requestParameters.food; + } + if (requestParameters.page !== undefined) { queryParameters['page'] = requestParameters.page; } @@ -4212,6 +4222,10 @@ export class ApiApi extends runtime.BaseAPI { queryParameters['page_size'] = requestParameters.pageSize; } + if (requestParameters.unit !== undefined) { + queryParameters['unit'] = requestParameters.unit; + } + const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.apiKey) { @@ -4412,6 +4426,10 @@ export class ApiApi extends runtime.BaseAPI { async apiInviteLinkListRaw(requestParameters: ApiInviteLinkListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; + if (requestParameters.internalNote !== undefined) { + queryParameters['internal_note'] = requestParameters.internalNote; + } + if (requestParameters.limit !== undefined) { queryParameters['limit'] = requestParameters.limit; } @@ -5689,6 +5707,14 @@ export class ApiApi extends runtime.BaseAPI { queryParameters['limit'] = requestParameters.limit; } + if (requestParameters.orderDirection !== undefined) { + queryParameters['order_direction'] = requestParameters.orderDirection; + } + + if (requestParameters.orderField !== undefined) { + queryParameters['order_field'] = requestParameters.orderField; + } + if (requestParameters.page !== undefined) { queryParameters['page'] = requestParameters.page; } @@ -9416,6 +9442,10 @@ export class ApiApi extends runtime.BaseAPI { async apiUserSpaceListRaw(requestParameters: ApiUserSpaceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; + if (requestParameters.internalNote !== undefined) { + queryParameters['internal_note'] = requestParameters.internalNote; + } + if (requestParameters.page !== undefined) { queryParameters['page'] = requestParameters.page; } @@ -9740,3 +9770,20 @@ export const ApiAutomationListTypeEnum = { UnitReplace: 'UNIT_REPLACE' } as const; export type ApiAutomationListTypeEnum = typeof ApiAutomationListTypeEnum[keyof typeof ApiAutomationListTypeEnum]; +/** + * @export + */ +export const ApiRecipeBookListOrderDirectionEnum = { + Asc: 'asc', + Desc: 'desc' +} as const; +export type ApiRecipeBookListOrderDirectionEnum = typeof ApiRecipeBookListOrderDirectionEnum[keyof typeof ApiRecipeBookListOrderDirectionEnum]; +/** + * @export + */ +export const ApiRecipeBookListOrderFieldEnum = { + Id: 'id', + Name: 'name', + Order: 'order' +} as const; +export type ApiRecipeBookListOrderFieldEnum = typeof ApiRecipeBookListOrderFieldEnum[keyof typeof ApiRecipeBookListOrderFieldEnum]; diff --git a/cookbook/views/api.py b/cookbook/views/api.py index 90898a396..a88214620 100644 --- a/cookbook/views/api.py +++ b/cookbook/views/api.py @@ -427,6 +427,10 @@ class SpaceViewSet(mixins.RetrieveModelMixin, mixins.UpdateModelMixin, viewsets. return self.queryset.filter(id=self.request.space.id) +# TODO what is internal_note for? +@extend_schema_view(list=extend_schema(parameters=[ + OpenApiParameter(name='internal_note', description='I have no idea what this is', type=str), +])) class UserSpaceViewSet(viewsets.ModelViewSet): queryset = UserSpace.objects serializer_class = UserSpaceSerializer @@ -509,8 +513,7 @@ class SupermarketViewSet(StandardFilterModelViewSet): pagination_class = DefaultPagination def get_queryset(self): - self.queryset = self.queryset.filter(space=self.request.space) - return super().get_queryset() + return self.queryset.filter(space=self.request.space) # TODO does supermarket category have settings to support fuzzy filtering and/or merge? @@ -522,8 +525,7 @@ class SupermarketCategoryViewSet(FuzzyFilterMixin, MergeMixin): pagination_class = DefaultPagination def get_queryset(self): - self.queryset = self.queryset.filter(space=self.request.space).order_by(Lower('name').asc()) - return super().get_queryset() + return self.queryset.filter(space=self.request.space).order_by(Lower('name').asc()) class SupermarketCategoryRelationViewSet(StandardFilterModelViewSet): @@ -533,8 +535,7 @@ class SupermarketCategoryRelationViewSet(StandardFilterModelViewSet): pagination_class = DefaultPagination def get_queryset(self): - self.queryset = self.queryset.filter(supermarket__space=self.request.space).order_by('order') - return super().get_queryset() + return self.queryset.filter(supermarket__space=self.request.space).order_by('order') class KeywordViewSet(TreeMixin): @@ -561,8 +562,7 @@ class FoodInheritFieldViewSet(viewsets.ReadOnlyModelViewSet): def get_queryset(self): # exclude fields not yet implemented - self.queryset = Food.inheritable_fields - return super().get_queryset() + return Food.inheritable_fields class FoodViewSet(TreeMixin): @@ -701,6 +701,10 @@ class FoodViewSet(TreeMixin): return Response(content, status=status.HTTP_403_FORBIDDEN) +@extend_schema_view(list=extend_schema(parameters=[ + OpenApiParameter(name='order_field', description='Field to order recipe books on', type=str, enum=['id', 'name', 'order']), + OpenApiParameter(name='order_direction', description='Order ascending or descending', type=str, enum=['asc', 'desc']), +])) class RecipeBookViewSet(StandardFilterModelViewSet): queryset = RecipeBook.objects serializer_class = RecipeBookSerializer @@ -715,9 +719,7 @@ class RecipeBookViewSet(StandardFilterModelViewSet): order_field = 'id' ordering = f"{'' if order_direction == 'asc' else '-'}{order_field}" - - self.queryset = self.queryset.filter(Q(created_by=self.request.user) | Q(shared=self.request.user)).filter(space=self.request.space).distinct().order_by(ordering) - return super().get_queryset() + return self.queryset.filter(Q(created_by=self.request.user) | Q(shared=self.request.user)).filter(space=self.request.space).distinct().order_by(ordering) @extend_schema_view(list=extend_schema(parameters=[ @@ -861,6 +863,10 @@ class MealTypeViewSet(viewsets.ModelViewSet): return queryset +@extend_schema_view(list=extend_schema(parameters=[ + OpenApiParameter(name='food', description='ID of food to filter for', type=int), + OpenApiParameter(name='unit', description='ID of unit to filter for', type=int), +])) class IngredientViewSet(viewsets.ModelViewSet): queryset = Ingredient.objects serializer_class = IngredientSerializer @@ -1165,7 +1171,8 @@ class ShoppingListRecipeViewSet(viewsets.ModelViewSet): OpenApiParameter( name='checked', description=_('Filter shopping list entries on checked. [''true'', ''false'', ''both'', ''recent'']
\ - - ''recent'' includes unchecked items and recently completed items.') + - ''recent'' includes unchecked items and recently completed items.'), + type=str ), OpenApiParameter(name='supermarket', description=_('Returns the shopping list entries sorted by supermarket category order.'), type=int), ])) @@ -1304,8 +1311,7 @@ class UserFileViewSet(StandardFilterModelViewSet): parser_classes = [MultiPartParser] def get_queryset(self): - self.queryset = self.queryset.filter(space=self.request.space).all() - return super().get_queryset() + return self.queryset.filter(space=self.request.space).all() class AutomationViewSet(StandardFilterModelViewSet): @@ -1317,7 +1323,7 @@ class AutomationViewSet(StandardFilterModelViewSet): @extend_schema( parameters=[OpenApiParameter( name='type', - description=_('Return the Automations matching the automation type. Multiple values allowed.'), + description=_('Return the Automations matching the automation type. Repeat for multiple.'), type=str, enum=[a[0] for a in Automation.automation_types]) ] @@ -1329,10 +1335,13 @@ class AutomationViewSet(StandardFilterModelViewSet): automation_type = self.request.query_params.getlist('type', []) if automation_type: self.queryset = self.queryset.filter(type__in=automation_type) - self.queryset = self.queryset.filter(space=self.request.space).all() - return super().get_queryset() + return self.queryset.filter(space=self.request.space).all() +# TODO explain what internal_note is for +@extend_schema_view(list=extend_schema(parameters=[ + OpenApiParameter(name='internal_note', description=_('I have no idea what internal_note is for.'), type=str) +])) class InviteLinkViewSet(StandardFilterModelViewSet): queryset = InviteLink.objects serializer_class = InviteLinkSerializer @@ -1340,14 +1349,12 @@ class InviteLinkViewSet(StandardFilterModelViewSet): pagination_class = DefaultPagination def get_queryset(self): - internal_note = self.request.query_params.get('internal_note', None) if internal_note is not None: self.queryset = self.queryset.filter(internal_note=internal_note) if is_space_owner(self.request.user, self.request.space): - self.queryset = self.queryset.filter(space=self.request.space).all() - return super().get_queryset() + return self.queryset.filter(space=self.request.space).all() else: return None @@ -1359,8 +1366,7 @@ class CustomFilterViewSet(StandardFilterModelViewSet): pagination_class = DefaultPagination def get_queryset(self): - self.queryset = self.queryset.filter(Q(created_by=self.request.user) | Q(shared=self.request.user)).filter(space=self.request.space).distinct() - return super().get_queryset() + return self.queryset.filter(Q(created_by=self.request.user) | Q(shared=self.request.user)).filter(space=self.request.space).distinct() class AccessTokenViewSet(viewsets.ModelViewSet): diff --git a/vue/src/utils/openapi/api.ts b/vue/src/utils/openapi/api.ts index 55af3a210..67b02e7e4 100644 --- a/vue/src/utils/openapi/api.ts +++ b/vue/src/utils/openapi/api.ts @@ -6488,7 +6488,7 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) * * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. - * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Multiple values allowed. + * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Repeat for multiple. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9256,12 +9256,14 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @param {number} [food] ID of food to filter for * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. + * @param {number} [unit] ID of unit to filter for * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiIngredientList: async (page?: number, pageSize?: number, options: any = {}): Promise => { + apiIngredientList: async (food?: number, page?: number, pageSize?: number, unit?: number, options: any = {}): Promise => { const localVarPath = `/api/ingredient/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -9277,6 +9279,10 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (food !== undefined) { + localVarQueryParameter['food'] = food; + } + if (page !== undefined) { localVarQueryParameter['page'] = page; } @@ -9285,6 +9291,10 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['page_size'] = pageSize; } + if (unit !== undefined) { + localVarQueryParameter['unit'] = unit; + } + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -9490,6 +9500,7 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @param {string} [internalNote] I have no idea what internal_note is for. * @param {string} [limit] limit number of entries to return * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. @@ -9499,7 +9510,7 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiInviteLinkList: async (limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options: any = {}): Promise => { + apiInviteLinkList: async (internalNote?: string, limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options: any = {}): Promise => { const localVarPath = `/api/invite-link/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -9515,6 +9526,10 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (internalNote !== undefined) { + localVarQueryParameter['internal_note'] = internalNote; + } + if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } @@ -10915,6 +10930,8 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) /** * * @param {string} [limit] limit number of entries to return + * @param {'asc' | 'desc'} [orderDirection] Order ascending or descending + * @param {'id' | 'name' | 'order'} [orderField] Field to order recipe books on * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {string} [query] lookup if query string is contained within the name, case insensitive @@ -10923,7 +10940,7 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiRecipeBookList: async (limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options: any = {}): Promise => { + apiRecipeBookList: async (limit?: string, orderDirection?: 'asc' | 'desc', orderField?: 'id' | 'name' | 'order', page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options: any = {}): Promise => { const localVarPath = `/api/recipe-book/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -10943,6 +10960,14 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['limit'] = limit; } + if (orderDirection !== undefined) { + localVarQueryParameter['order_direction'] = orderDirection; + } + + if (orderField !== undefined) { + localVarQueryParameter['order_field'] = orderField; + } + if (page !== undefined) { localVarQueryParameter['page'] = page; } @@ -15070,12 +15095,13 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @param {string} [internalNote] I have no idea what this is * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiUserSpaceList: async (page?: number, pageSize?: number, options: any = {}): Promise => { + apiUserSpaceList: async (internalNote?: string, page?: number, pageSize?: number, options: any = {}): Promise => { const localVarPath = `/api/user-space/`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -15091,6 +15117,10 @@ export const ApiApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (internalNote !== undefined) { + localVarQueryParameter['internal_note'] = internalNote; + } + if (page !== undefined) { localVarQueryParameter['page'] = page; } @@ -15525,7 +15555,7 @@ export const ApiApiFp = function(configuration?: Configuration) { * * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. - * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Multiple values allowed. + * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Repeat for multiple. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16266,13 +16296,15 @@ export const ApiApiFp = function(configuration?: Configuration) { }, /** * + * @param {number} [food] ID of food to filter for * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. + * @param {number} [unit] ID of unit to filter for * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiIngredientList(page?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiIngredientList(page, pageSize, options); + async apiIngredientList(food?: number, page?: number, pageSize?: number, unit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiIngredientList(food, page, pageSize, unit, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -16329,6 +16361,7 @@ export const ApiApiFp = function(configuration?: Configuration) { }, /** * + * @param {string} [internalNote] I have no idea what internal_note is for. * @param {string} [limit] limit number of entries to return * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. @@ -16338,8 +16371,8 @@ export const ApiApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiInviteLinkList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiInviteLinkList(limit, page, pageSize, query, random, updatedAt, options); + async apiInviteLinkList(internalNote?: string, limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiInviteLinkList(internalNote, limit, page, pageSize, query, random, updatedAt, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -16707,6 +16740,8 @@ export const ApiApiFp = function(configuration?: Configuration) { /** * * @param {string} [limit] limit number of entries to return + * @param {'asc' | 'desc'} [orderDirection] Order ascending or descending + * @param {'id' | 'name' | 'order'} [orderField] Field to order recipe books on * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {string} [query] lookup if query string is contained within the name, case insensitive @@ -16715,8 +16750,8 @@ export const ApiApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiRecipeBookList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiRecipeBookList(limit, page, pageSize, query, random, updatedAt, options); + async apiRecipeBookList(limit?: string, orderDirection?: 'asc' | 'desc', orderField?: 'id' | 'name' | 'order', page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiRecipeBookList(limit, orderDirection, orderField, page, pageSize, query, random, updatedAt, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -17793,13 +17828,14 @@ export const ApiApiFp = function(configuration?: Configuration) { }, /** * + * @param {string} [internalNote] I have no idea what this is * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiUserSpaceList(page?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiUserSpaceList(page, pageSize, options); + async apiUserSpaceList(internalNote?: string, page?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiUserSpaceList(internalNote, page, pageSize, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -17982,7 +18018,7 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: * * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. - * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Multiple values allowed. + * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Repeat for multiple. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18653,13 +18689,15 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: }, /** * + * @param {number} [food] ID of food to filter for * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. + * @param {number} [unit] ID of unit to filter for * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiIngredientList(page?: number, pageSize?: number, options?: any): AxiosPromise { - return localVarFp.apiIngredientList(page, pageSize, options).then((request) => request(axios, basePath)); + apiIngredientList(food?: number, page?: number, pageSize?: number, unit?: number, options?: any): AxiosPromise { + return localVarFp.apiIngredientList(food, page, pageSize, unit, options).then((request) => request(axios, basePath)); }, /** * @@ -18710,6 +18748,7 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: }, /** * + * @param {string} [internalNote] I have no idea what internal_note is for. * @param {string} [limit] limit number of entries to return * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. @@ -18719,8 +18758,8 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiInviteLinkList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): AxiosPromise { - return localVarFp.apiInviteLinkList(limit, page, pageSize, query, random, updatedAt, options).then((request) => request(axios, basePath)); + apiInviteLinkList(internalNote?: string, limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): AxiosPromise { + return localVarFp.apiInviteLinkList(internalNote, limit, page, pageSize, query, random, updatedAt, options).then((request) => request(axios, basePath)); }, /** * @@ -19054,6 +19093,8 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: /** * * @param {string} [limit] limit number of entries to return + * @param {'asc' | 'desc'} [orderDirection] Order ascending or descending + * @param {'id' | 'name' | 'order'} [orderField] Field to order recipe books on * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {string} [query] lookup if query string is contained within the name, case insensitive @@ -19062,8 +19103,8 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiRecipeBookList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): AxiosPromise { - return localVarFp.apiRecipeBookList(limit, page, pageSize, query, random, updatedAt, options).then((request) => request(axios, basePath)); + apiRecipeBookList(limit?: string, orderDirection?: 'asc' | 'desc', orderField?: 'id' | 'name' | 'order', page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any): AxiosPromise { + return localVarFp.apiRecipeBookList(limit, orderDirection, orderField, page, pageSize, query, random, updatedAt, options).then((request) => request(axios, basePath)); }, /** * @@ -20043,13 +20084,14 @@ export const ApiApiFactory = function (configuration?: Configuration, basePath?: }, /** * + * @param {string} [internalNote] I have no idea what this is * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiUserSpaceList(page?: number, pageSize?: number, options?: any): AxiosPromise { - return localVarFp.apiUserSpaceList(page, pageSize, options).then((request) => request(axios, basePath)); + apiUserSpaceList(internalNote?: string, page?: number, pageSize?: number, options?: any): AxiosPromise { + return localVarFp.apiUserSpaceList(internalNote, page, pageSize, options).then((request) => request(axios, basePath)); }, /** * @@ -20241,7 +20283,7 @@ export class ApiApi extends BaseAPI { * * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. - * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Multiple values allowed. + * @param {'DESCRIPTION_REPLACE' | 'FOOD_ALIAS' | 'FOOD_REPLACE' | 'INSTRUCTION_REPLACE' | 'KEYWORD_ALIAS' | 'NAME_REPLACE' | 'NEVER_UNIT' | 'TRANSPOSE_WORDS' | 'UNIT_ALIAS' | 'UNIT_REPLACE'} [type] Return the Automations matching the automation type. Repeat for multiple. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiApi @@ -21052,14 +21094,16 @@ export class ApiApi extends BaseAPI { /** * + * @param {number} [food] ID of food to filter for * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. + * @param {number} [unit] ID of unit to filter for * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiApi */ - public apiIngredientList(page?: number, pageSize?: number, options?: any) { - return ApiApiFp(this.configuration).apiIngredientList(page, pageSize, options).then((request) => request(this.axios, this.basePath)); + public apiIngredientList(food?: number, page?: number, pageSize?: number, unit?: number, options?: any) { + return ApiApiFp(this.configuration).apiIngredientList(food, page, pageSize, unit, options).then((request) => request(this.axios, this.basePath)); } /** @@ -21121,6 +21165,7 @@ export class ApiApi extends BaseAPI { /** * + * @param {string} [internalNote] I have no idea what internal_note is for. * @param {string} [limit] limit number of entries to return * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. @@ -21131,8 +21176,8 @@ export class ApiApi extends BaseAPI { * @throws {RequiredError} * @memberof ApiApi */ - public apiInviteLinkList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any) { - return ApiApiFp(this.configuration).apiInviteLinkList(limit, page, pageSize, query, random, updatedAt, options).then((request) => request(this.axios, this.basePath)); + public apiInviteLinkList(internalNote?: string, limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any) { + return ApiApiFp(this.configuration).apiInviteLinkList(internalNote, limit, page, pageSize, query, random, updatedAt, options).then((request) => request(this.axios, this.basePath)); } /** @@ -21533,6 +21578,8 @@ export class ApiApi extends BaseAPI { /** * * @param {string} [limit] limit number of entries to return + * @param {'asc' | 'desc'} [orderDirection] Order ascending or descending + * @param {'id' | 'name' | 'order'} [orderField] Field to order recipe books on * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {string} [query] lookup if query string is contained within the name, case insensitive @@ -21542,8 +21589,8 @@ export class ApiApi extends BaseAPI { * @throws {RequiredError} * @memberof ApiApi */ - public apiRecipeBookList(limit?: string, page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any) { - return ApiApiFp(this.configuration).apiRecipeBookList(limit, page, pageSize, query, random, updatedAt, options).then((request) => request(this.axios, this.basePath)); + public apiRecipeBookList(limit?: string, orderDirection?: 'asc' | 'desc', orderField?: 'id' | 'name' | 'order', page?: number, pageSize?: number, query?: string, random?: string, updatedAt?: string, options?: any) { + return ApiApiFp(this.configuration).apiRecipeBookList(limit, orderDirection, orderField, page, pageSize, query, random, updatedAt, options).then((request) => request(this.axios, this.basePath)); } /** @@ -22716,14 +22763,15 @@ export class ApiApi extends BaseAPI { /** * + * @param {string} [internalNote] I have no idea what this is * @param {number} [page] A page number within the paginated result set. * @param {number} [pageSize] Number of results to return per page. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiApi */ - public apiUserSpaceList(page?: number, pageSize?: number, options?: any) { - return ApiApiFp(this.configuration).apiUserSpaceList(page, pageSize, options).then((request) => request(this.axios, this.basePath)); + public apiUserSpaceList(internalNote?: string, page?: number, pageSize?: number, options?: any) { + return ApiApiFp(this.configuration).apiUserSpaceList(internalNote, page, pageSize, options).then((request) => request(this.axios, this.basePath)); } /**