api.ts

/* tslint:disable */
/* eslint-disable */
/**
 * Food Data Central API
 * The FoodData Central API provides REST access to FoodData Central (FDC). It is intended primarily to assist application developers wishing to incorporate nutrient data into their applications or websites.   To take full advantage of the API, developers should familiarize themselves with the database by reading the database documentation available via links on [Data Type Documentation](https://fdc.nal.usda.gov/data-documentation.html). This documentation provides the detailed definitions and descriptions needed to understand the data elements referenced in the API documentation.      Additional details about the API including rate limits, access, and licensing are available on the [FDC website](https://fdc.nal.usda.gov/api-guide.html)
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


import { Configuration } from './configuration';
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';

/**
 * 
 * @export
 * @interface AbridgedFoodItem
 */
export interface AbridgedFoodItem {
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'dataType': string;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'description': string;
    /**
     * 
     * @type {number}
     * @memberof AbridgedFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {Array<AbridgedFoodNutrient>}
     * @memberof AbridgedFoodItem
     */
    'foodNutrients'?: Array<AbridgedFoodNutrient>;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'publicationDate'?: string;
    /**
     * only applies to Branded Foods
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'brandOwner'?: string;
    /**
     * only applies to Branded Foods
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'gtinUpc'?: string;
    /**
     * only applies to Foundation and SRLegacy Foods
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'ndbNumber'?: string;
    /**
     * only applies to Survey Foods
     * @type {string}
     * @memberof AbridgedFoodItem
     */
    'foodCode'?: string;
}
/**
 * 
 * @export
 * @interface AbridgedFoodNutrient
 */
export interface AbridgedFoodNutrient {
    /**
     * 
     * @type {number}
     * @memberof AbridgedFoodNutrient
     */
    'number'?: number;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodNutrient
     */
    'name'?: string;
    /**
     * 
     * @type {number}
     * @memberof AbridgedFoodNutrient
     */
    'amount'?: number;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodNutrient
     */
    'unitName'?: string;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodNutrient
     */
    'derivationCode'?: string;
    /**
     * 
     * @type {string}
     * @memberof AbridgedFoodNutrient
     */
    'derivationDescription'?: string;
}
/**
 * 
 * @export
 * @interface BrandedFoodItem
 */
export interface BrandedFoodItem {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'availableDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'brandOwner'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'dataSource'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'dataType': string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'description': string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'foodClass'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'gtinUpc'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'householdServingFullText'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'ingredients'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'modifiedDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItem
     */
    'servingSize'?: number;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'servingSizeUnit'?: string;
    /**
     * 
     * @type {string}
     * @memberof BrandedFoodItem
     */
    'brandedFoodCategory'?: string;
    /**
     * 
     * @type {Array<FoodNutrient>}
     * @memberof BrandedFoodItem
     */
    'foodNutrients'?: Array<FoodNutrient>;
    /**
     * 
     * @type {Array<FoodUpdateLog>}
     * @memberof BrandedFoodItem
     */
    'foodUpdateLog'?: Array<FoodUpdateLog>;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrients}
     * @memberof BrandedFoodItem
     */
    'labelNutrients'?: BrandedFoodItemLabelNutrients;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrients
 */
export interface BrandedFoodItemLabelNutrients {
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsFat}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'fat'?: BrandedFoodItemLabelNutrientsFat;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsSaturatedFat}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'saturatedFat'?: BrandedFoodItemLabelNutrientsSaturatedFat;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsTransFat}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'transFat'?: BrandedFoodItemLabelNutrientsTransFat;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsTransFat}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'cholesterol'?: BrandedFoodItemLabelNutrientsTransFat;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsTransFat}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'sodium'?: BrandedFoodItemLabelNutrientsTransFat;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsCarbohydrates}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'carbohydrates'?: BrandedFoodItemLabelNutrientsCarbohydrates;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsFiber}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'fiber'?: BrandedFoodItemLabelNutrientsFiber;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsSugars}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'sugars'?: BrandedFoodItemLabelNutrientsSugars;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsProtein}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'protein'?: BrandedFoodItemLabelNutrientsProtein;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsCalcium}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'calcium'?: BrandedFoodItemLabelNutrientsCalcium;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsIron}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'iron'?: BrandedFoodItemLabelNutrientsIron;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsPostassium}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'postassium'?: BrandedFoodItemLabelNutrientsPostassium;
    /**
     * 
     * @type {BrandedFoodItemLabelNutrientsCalories}
     * @memberof BrandedFoodItemLabelNutrients
     */
    'calories'?: BrandedFoodItemLabelNutrientsCalories;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsCalcium
 */
export interface BrandedFoodItemLabelNutrientsCalcium {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsCalcium
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsCalories
 */
export interface BrandedFoodItemLabelNutrientsCalories {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsCalories
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsCarbohydrates
 */
export interface BrandedFoodItemLabelNutrientsCarbohydrates {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsCarbohydrates
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsFat
 */
export interface BrandedFoodItemLabelNutrientsFat {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsFat
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsFiber
 */
export interface BrandedFoodItemLabelNutrientsFiber {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsFiber
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsIron
 */
export interface BrandedFoodItemLabelNutrientsIron {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsIron
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsPostassium
 */
export interface BrandedFoodItemLabelNutrientsPostassium {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsPostassium
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsProtein
 */
export interface BrandedFoodItemLabelNutrientsProtein {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsProtein
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsSaturatedFat
 */
export interface BrandedFoodItemLabelNutrientsSaturatedFat {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsSaturatedFat
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsSugars
 */
export interface BrandedFoodItemLabelNutrientsSugars {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsSugars
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface BrandedFoodItemLabelNutrientsTransFat
 */
export interface BrandedFoodItemLabelNutrientsTransFat {
    /**
     * 
     * @type {number}
     * @memberof BrandedFoodItemLabelNutrientsTransFat
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface FoodAttribute
 */
export interface FoodAttribute {
    /**
     * 
     * @type {number}
     * @memberof FoodAttribute
     */
    'id'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodAttribute
     */
    'sequenceNumber'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodAttribute
     */
    'value'?: string;
    /**
     * 
     * @type {FoodAttributeFoodAttributeType}
     * @memberof FoodAttribute
     */
    'FoodAttributeType'?: FoodAttributeFoodAttributeType;
}
/**
 * 
 * @export
 * @interface FoodAttributeFoodAttributeType
 */
export interface FoodAttributeFoodAttributeType {
    /**
     * 
     * @type {number}
     * @memberof FoodAttributeFoodAttributeType
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodAttributeFoodAttributeType
     */
    'name'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodAttributeFoodAttributeType
     */
    'description'?: string;
}
/**
 * 
 * @export
 * @interface FoodCategory
 */
export interface FoodCategory {
    /**
     * 
     * @type {number}
     * @memberof FoodCategory
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodCategory
     */
    'code'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodCategory
     */
    'description'?: string;
}
/**
 * 
 * @export
 * @interface FoodComponent
 */
export interface FoodComponent {
    /**
     * 
     * @type {number}
     * @memberof FoodComponent
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodComponent
     */
    'name'?: string;
    /**
     * 
     * @type {number}
     * @memberof FoodComponent
     */
    'dataPoints'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodComponent
     */
    'gramWeight'?: number;
    /**
     * 
     * @type {boolean}
     * @memberof FoodComponent
     */
    'isRefuse'?: boolean;
    /**
     * 
     * @type {number}
     * @memberof FoodComponent
     */
    'minYearAcquired'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodComponent
     */
    'percentWeight'?: number;
}
/**
 * JSON for request body of \'list\' POST request
 * @export
 * @interface FoodListCriteria
 */
export interface FoodListCriteria {
    /**
     * Optional. Filter on a specific data type; specify one or more values in an array.
     * @type {Array<string>}
     * @memberof FoodListCriteria
     */
    'dataType'?: Array<FoodListCriteriaDataTypeEnum>;
    /**
     * Optional. Maximum number of results to return for the current page. Default is 50.
     * @type {number}
     * @memberof FoodListCriteria
     */
    'pageSize'?: number;
    /**
     * Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
     * @type {number}
     * @memberof FoodListCriteria
     */
    'pageNumber'?: number;
    /**
     * Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
     * @type {string}
     * @memberof FoodListCriteria
     */
    'sortBy'?: FoodListCriteriaSortByEnum;
    /**
     * Optional. The sort direction for the results. Only applicable if sortBy is specified.
     * @type {string}
     * @memberof FoodListCriteria
     */
    'sortOrder'?: FoodListCriteriaSortOrderEnum;
}

/**
    * @export
    * @enum {string}
    */
export enum FoodListCriteriaDataTypeEnum {
    Branded = 'Branded',
    Foundation = 'Foundation',
    SurveyFndds = 'Survey (FNDDS)',
    SrLegacy = 'SR Legacy'
}
/**
    * @export
    * @enum {string}
    */
export enum FoodListCriteriaSortByEnum {
    DataTypeKeyword = 'dataType.keyword',
    LowercaseDescriptionKeyword = 'lowercaseDescription.keyword',
    FdcId = 'fdcId',
    PublishedDate = 'publishedDate'
}
/**
    * @export
    * @enum {string}
    */
export enum FoodListCriteriaSortOrderEnum {
    Asc = 'asc',
    Desc = 'desc'
}

/**
 * 
 * @export
 * @interface FoodNutrient
 */
export interface FoodNutrient {
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'id': number;
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'amount'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'dataPoints'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'min'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'max'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodNutrient
     */
    'median'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodNutrient
     */
    'type'?: string;
    /**
     * 
     * @type {Nutrient}
     * @memberof FoodNutrient
     */
    'nutrient'?: Nutrient;
    /**
     * 
     * @type {FoodNutrientDerivation}
     * @memberof FoodNutrient
     */
    'foodNutrientDerivation'?: FoodNutrientDerivation;
    /**
     * 
     * @type {NutrientAnalysisDetails}
     * @memberof FoodNutrient
     */
    'nutrientAnalysisDetails'?: NutrientAnalysisDetails;
}
/**
 * 
 * @export
 * @interface FoodNutrientDerivation
 */
export interface FoodNutrientDerivation {
    /**
     * 
     * @type {number}
     * @memberof FoodNutrientDerivation
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodNutrientDerivation
     */
    'code'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodNutrientDerivation
     */
    'description'?: string;
    /**
     * 
     * @type {FoodNutrientSource}
     * @memberof FoodNutrientDerivation
     */
    'foodNutrientSource'?: FoodNutrientSource;
}
/**
 * 
 * @export
 * @interface FoodNutrientSource
 */
export interface FoodNutrientSource {
    /**
     * 
     * @type {number}
     * @memberof FoodNutrientSource
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodNutrientSource
     */
    'code'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodNutrientSource
     */
    'description'?: string;
}
/**
 * 
 * @export
 * @interface FoodPortion
 */
export interface FoodPortion {
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'id'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'amount'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'dataPoints'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'gramWeight'?: number;
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'minYearAcquired'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodPortion
     */
    'modifier'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodPortion
     */
    'portionDescription'?: string;
    /**
     * 
     * @type {number}
     * @memberof FoodPortion
     */
    'sequenceNumber'?: number;
    /**
     * 
     * @type {MeasureUnit}
     * @memberof FoodPortion
     */
    'measureUnit'?: MeasureUnit;
}
/**
 * JSON for request body of \'search\' POST request
 * @export
 * @interface FoodSearchCriteria
 */
export interface FoodSearchCriteria {
    /**
     * Search terms to use in the search. The string may also include standard [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
     * @type {string}
     * @memberof FoodSearchCriteria
     */
    'query'?: string;
    /**
     * Optional. Filter on a specific data type; specify one or more values in an array.
     * @type {Array<string>}
     * @memberof FoodSearchCriteria
     */
    'dataType'?: Array<FoodSearchCriteriaDataTypeEnum>;
    /**
     * Optional. Maximum number of results to return for the current page. Default is 50.
     * @type {number}
     * @memberof FoodSearchCriteria
     */
    'pageSize'?: number;
    /**
     * Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
     * @type {number}
     * @memberof FoodSearchCriteria
     */
    'pageNumber'?: number;
    /**
     * Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
     * @type {string}
     * @memberof FoodSearchCriteria
     */
    'sortBy'?: FoodSearchCriteriaSortByEnum;
    /**
     * Optional. The sort direction for the results. Only applicable if sortBy is specified.
     * @type {string}
     * @memberof FoodSearchCriteria
     */
    'sortOrder'?: FoodSearchCriteriaSortOrderEnum;
    /**
     * Optional. Filter results based on the brand owner of the food. Only applies to Branded Foods.
     * @type {string}
     * @memberof FoodSearchCriteria
     */
    'brandOwner'?: string;
}

/**
    * @export
    * @enum {string}
    */
export enum FoodSearchCriteriaDataTypeEnum {
    Branded = 'Branded',
    Foundation = 'Foundation',
    SurveyFndds = 'Survey (FNDDS)',
    SrLegacy = 'SR Legacy'
}
/**
    * @export
    * @enum {string}
    */
export enum FoodSearchCriteriaSortByEnum {
    DataTypeKeyword = 'dataType.keyword',
    LowercaseDescriptionKeyword = 'lowercaseDescription.keyword',
    FdcId = 'fdcId',
    PublishedDate = 'publishedDate'
}
/**
    * @export
    * @enum {string}
    */
export enum FoodSearchCriteriaSortOrderEnum {
    Asc = 'asc',
    Desc = 'desc'
}

/**
 * 
 * @export
 * @interface FoodUpdateLog
 */
export interface FoodUpdateLog {
    /**
     * 
     * @type {number}
     * @memberof FoodUpdateLog
     */
    'fdcId'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'availableDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'brandOwner'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'dataSource'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'dataType'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'description'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'foodClass'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'gtinUpc'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'householdServingFullText'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'ingredients'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'modifiedDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {number}
     * @memberof FoodUpdateLog
     */
    'servingSize'?: number;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'servingSizeUnit'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'brandedFoodCategory'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoodUpdateLog
     */
    'changes'?: string;
    /**
     * 
     * @type {Array<FoodAttribute>}
     * @memberof FoodUpdateLog
     */
    'foodAttributes'?: Array<FoodAttribute>;
}
/**
 * JSON for request body of \'foods\' POST request. Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
 * @export
 * @interface FoodsCriteria
 */
export interface FoodsCriteria {
    /**
     * List of multiple FDC ID\'s
     * @type {Array<number>}
     * @memberof FoodsCriteria
     */
    'fdcIds'?: Array<number>;
    /**
     * Optional. \'abridged\' for an abridged set of elements, \'full\' for all elements (default).
     * @type {string}
     * @memberof FoodsCriteria
     */
    'format'?: FoodsCriteriaFormatEnum;
    /**
     * Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned.  If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
     * @type {Array<number>}
     * @memberof FoodsCriteria
     */
    'nutrients'?: Array<number>;
}

/**
    * @export
    * @enum {string}
    */
export enum FoodsCriteriaFormatEnum {
    Abridged = 'abridged',
    Full = 'full'
}

/**
 * 
 * @export
 * @interface FoundationFoodItem
 */
export interface FoundationFoodItem {
    /**
     * 
     * @type {number}
     * @memberof FoundationFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'dataType': string;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'description': string;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'foodClass'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'footNote'?: string;
    /**
     * 
     * @type {boolean}
     * @memberof FoundationFoodItem
     */
    'isHistoricalReference'?: boolean;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'ndbNumber'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof FoundationFoodItem
     */
    'scientificName'?: string;
    /**
     * 
     * @type {FoodCategory}
     * @memberof FoundationFoodItem
     */
    'foodCategory'?: FoodCategory;
    /**
     * 
     * @type {Array<FoodComponent>}
     * @memberof FoundationFoodItem
     */
    'foodComponents'?: Array<FoodComponent>;
    /**
     * 
     * @type {Array<FoodNutrient>}
     * @memberof FoundationFoodItem
     */
    'foodNutrients'?: Array<FoodNutrient>;
    /**
     * 
     * @type {Array<FoodPortion>}
     * @memberof FoundationFoodItem
     */
    'foodPortions'?: Array<FoodPortion>;
    /**
     * 
     * @type {Array<InputFoodFoundation>}
     * @memberof FoundationFoodItem
     */
    'inputFoods'?: Array<InputFoodFoundation>;
    /**
     * 
     * @type {Array<NutrientConversionFactors>}
     * @memberof FoundationFoodItem
     */
    'nutrientConversionFactors'?: Array<NutrientConversionFactors>;
}
/**
 * applies to Foundation foods. Not all inputFoods will have all fields.
 * @export
 * @interface InputFoodFoundation
 */
export interface InputFoodFoundation {
    /**
     * 
     * @type {number}
     * @memberof InputFoodFoundation
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof InputFoodFoundation
     */
    'foodDescription'?: string;
    /**
     * 
     * @type {SampleFoodItem}
     * @memberof InputFoodFoundation
     */
    'inputFood'?: SampleFoodItem;
}
/**
 * applies to Survey (FNDDS). Not all inputFoods will have all fields.
 * @export
 * @interface InputFoodSurvey
 */
export interface InputFoodSurvey {
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'id'?: number;
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'amount'?: number;
    /**
     * 
     * @type {string}
     * @memberof InputFoodSurvey
     */
    'foodDescription'?: string;
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'ingredientCode'?: number;
    /**
     * 
     * @type {string}
     * @memberof InputFoodSurvey
     */
    'ingredientDescription'?: string;
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'ingredientWeight'?: number;
    /**
     * 
     * @type {string}
     * @memberof InputFoodSurvey
     */
    'portionCode'?: string;
    /**
     * 
     * @type {string}
     * @memberof InputFoodSurvey
     */
    'portionDescription'?: string;
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'sequenceNumber'?: number;
    /**
     * 
     * @type {number}
     * @memberof InputFoodSurvey
     */
    'surveyFlag'?: number;
    /**
     * 
     * @type {string}
     * @memberof InputFoodSurvey
     */
    'unit'?: string;
    /**
     * 
     * @type {SurveyFoodItem}
     * @memberof InputFoodSurvey
     */
    'inputFood'?: SurveyFoodItem;
    /**
     * 
     * @type {RetentionFactor}
     * @memberof InputFoodSurvey
     */
    'retentionFactor'?: RetentionFactor;
}
/**
 * 
 * @export
 * @interface MeasureUnit
 */
export interface MeasureUnit {
    /**
     * 
     * @type {number}
     * @memberof MeasureUnit
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof MeasureUnit
     */
    'abbreviation'?: string;
    /**
     * 
     * @type {string}
     * @memberof MeasureUnit
     */
    'name'?: string;
}
/**
 * a food nutrient
 * @export
 * @interface Nutrient
 */
export interface Nutrient {
    /**
     * 
     * @type {number}
     * @memberof Nutrient
     */
    'id'?: number;
    /**
     * 
     * @type {string}
     * @memberof Nutrient
     */
    'number'?: string;
    /**
     * 
     * @type {string}
     * @memberof Nutrient
     */
    'name'?: string;
    /**
     * 
     * @type {number}
     * @memberof Nutrient
     */
    'rank'?: number;
    /**
     * 
     * @type {string}
     * @memberof Nutrient
     */
    'unitName'?: string;
}
/**
 * 
 * @export
 * @interface NutrientAcquisitionDetails
 */
export interface NutrientAcquisitionDetails {
    /**
     * 
     * @type {number}
     * @memberof NutrientAcquisitionDetails
     */
    'sampleUnitId'?: number;
    /**
     * 
     * @type {string}
     * @memberof NutrientAcquisitionDetails
     */
    'purchaseDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof NutrientAcquisitionDetails
     */
    'storeCity'?: string;
    /**
     * 
     * @type {string}
     * @memberof NutrientAcquisitionDetails
     */
    'storeState'?: string;
}
/**
 * 
 * @export
 * @interface NutrientAnalysisDetails
 */
export interface NutrientAnalysisDetails {
    /**
     * 
     * @type {number}
     * @memberof NutrientAnalysisDetails
     */
    'subSampleId'?: number;
    /**
     * 
     * @type {number}
     * @memberof NutrientAnalysisDetails
     */
    'amount'?: number;
    /**
     * 
     * @type {number}
     * @memberof NutrientAnalysisDetails
     */
    'nutrientId'?: number;
    /**
     * 
     * @type {string}
     * @memberof NutrientAnalysisDetails
     */
    'labMethodDescription'?: string;
    /**
     * 
     * @type {string}
     * @memberof NutrientAnalysisDetails
     */
    'labMethodOriginalDescription'?: string;
    /**
     * 
     * @type {string}
     * @memberof NutrientAnalysisDetails
     */
    'labMethodLink'?: string;
    /**
     * 
     * @type {string}
     * @memberof NutrientAnalysisDetails
     */
    'labMethodTechnique'?: string;
    /**
     * 
     * @type {Array<NutrientAcquisitionDetails>}
     * @memberof NutrientAnalysisDetails
     */
    'nutrientAcquisitionDetails'?: Array<NutrientAcquisitionDetails>;
}
/**
 * 
 * @export
 * @interface NutrientConversionFactors
 */
export interface NutrientConversionFactors {
    /**
     * 
     * @type {string}
     * @memberof NutrientConversionFactors
     */
    'type'?: string;
    /**
     * 
     * @type {number}
     * @memberof NutrientConversionFactors
     */
    'value'?: number;
}
/**
 * 
 * @export
 * @interface RetentionFactor
 */
export interface RetentionFactor {
    /**
     * 
     * @type {number}
     * @memberof RetentionFactor
     */
    'id'?: number;
    /**
     * 
     * @type {number}
     * @memberof RetentionFactor
     */
    'code'?: number;
    /**
     * 
     * @type {string}
     * @memberof RetentionFactor
     */
    'description'?: string;
}
/**
 * 
 * @export
 * @interface SRLegacyFoodItem
 */
export interface SRLegacyFoodItem {
    /**
     * 
     * @type {number}
     * @memberof SRLegacyFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'dataType': string;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'description': string;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'foodClass'?: string;
    /**
     * 
     * @type {boolean}
     * @memberof SRLegacyFoodItem
     */
    'isHistoricalReference'?: boolean;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'ndbNumber'?: string;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof SRLegacyFoodItem
     */
    'scientificName'?: string;
    /**
     * 
     * @type {FoodCategory}
     * @memberof SRLegacyFoodItem
     */
    'foodCategory'?: FoodCategory;
    /**
     * 
     * @type {Array<FoodNutrient>}
     * @memberof SRLegacyFoodItem
     */
    'foodNutrients'?: Array<FoodNutrient>;
    /**
     * 
     * @type {Array<NutrientConversionFactors>}
     * @memberof SRLegacyFoodItem
     */
    'nutrientConversionFactors'?: Array<NutrientConversionFactors>;
}
/**
 * 
 * @export
 * @interface SampleFoodItem
 */
export interface SampleFoodItem {
    /**
     * 
     * @type {number}
     * @memberof SampleFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {string}
     * @memberof SampleFoodItem
     */
    'datatype'?: string;
    /**
     * 
     * @type {string}
     * @memberof SampleFoodItem
     */
    'description': string;
    /**
     * 
     * @type {string}
     * @memberof SampleFoodItem
     */
    'foodClass'?: string;
    /**
     * 
     * @type {string}
     * @memberof SampleFoodItem
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {Array<FoodCategory>}
     * @memberof SampleFoodItem
     */
    'foodAttributes'?: Array<FoodCategory>;
}
/**
 * 
 * @export
 * @interface SearchResult
 */
export interface SearchResult {
    /**
     * A copy of the criteria that were used in the search.
     * @type {Array<FoodSearchCriteria>}
     * @memberof SearchResult
     */
    'foodSearchCriteria'?: Array<FoodSearchCriteria>;
    /**
     * The total number of foods found matching the search criteria.
     * @type {number}
     * @memberof SearchResult
     */
    'totalHits'?: number;
    /**
     * The current page of results being returned.
     * @type {number}
     * @memberof SearchResult
     */
    'currentPage'?: number;
    /**
     * The total number of pages found matching the search criteria.
     * @type {number}
     * @memberof SearchResult
     */
    'totalPages'?: number;
    /**
     * The list of foods found matching the search criteria. See Food Fields below.
     * @type {Array<SearchResultFood>}
     * @memberof SearchResult
     */
    'foods'?: Array<SearchResultFood>;
}
/**
 * 
 * @export
 * @interface SearchResultFood
 */
export interface SearchResultFood {
    /**
     * Unique ID of the food.
     * @type {number}
     * @memberof SearchResultFood
     */
    'fdcId': number;
    /**
     * The type of the food data.
     * @type {string}
     * @memberof SearchResultFood
     */
    'dataType'?: string;
    /**
     * The description of the food.
     * @type {string}
     * @memberof SearchResultFood
     */
    'description': string;
    /**
     * Any A unique ID identifying the food within FNDDS.
     * @type {string}
     * @memberof SearchResultFood
     */
    'foodCode'?: string;
    /**
     * 
     * @type {Array<AbridgedFoodNutrient>}
     * @memberof SearchResultFood
     */
    'foodNutrients'?: Array<AbridgedFoodNutrient>;
    /**
     * Date the item was published to FDC.
     * @type {string}
     * @memberof SearchResultFood
     */
    'publicationDate'?: string;
    /**
     * The scientific name of the food.
     * @type {string}
     * @memberof SearchResultFood
     */
    'scientificName'?: string;
    /**
     * Brand owner for the food. Only applies to Branded Foods.
     * @type {string}
     * @memberof SearchResultFood
     */
    'brandOwner'?: string;
    /**
     * GTIN or UPC code identifying the food. Only applies to Branded Foods.
     * @type {string}
     * @memberof SearchResultFood
     */
    'gtinUpc'?: string;
    /**
     * The list of ingredients (as it appears on the product label). Only applies to Branded Foods.
     * @type {string}
     * @memberof SearchResultFood
     */
    'ingredients'?: string;
    /**
     * Unique number assigned for foundation foods. Only applies to Foundation and SRLegacy Foods.
     * @type {string}
     * @memberof SearchResultFood
     */
    'ndbNumber'?: string;
    /**
     * Any additional descriptions of the food.
     * @type {string}
     * @memberof SearchResultFood
     */
    'additionalDescriptions'?: string;
    /**
     * allHighlightFields
     * @type {string}
     * @memberof SearchResultFood
     */
    'allHighlightFields'?: string;
    /**
     * Relative score indicating how well the food matches the search criteria.
     * @type {number}
     * @memberof SearchResultFood
     */
    'score'?: number;
}
/**
 * 
 * @export
 * @interface SurveyFoodItem
 */
export interface SurveyFoodItem {
    /**
     * 
     * @type {number}
     * @memberof SurveyFoodItem
     */
    'fdcId': number;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'datatype'?: string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'description': string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'endDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'foodClass'?: string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'foodCode'?: string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'publicationDate'?: string;
    /**
     * 
     * @type {string}
     * @memberof SurveyFoodItem
     */
    'startDate'?: string;
    /**
     * 
     * @type {Array<FoodAttribute>}
     * @memberof SurveyFoodItem
     */
    'foodAttributes'?: Array<FoodAttribute>;
    /**
     * 
     * @type {Array<FoodPortion>}
     * @memberof SurveyFoodItem
     */
    'foodPortions'?: Array<FoodPortion>;
    /**
     * 
     * @type {Array<InputFoodSurvey>}
     * @memberof SurveyFoodItem
     */
    'inputFoods'?: Array<InputFoodSurvey>;
    /**
     * 
     * @type {WweiaFoodCategory}
     * @memberof SurveyFoodItem
     */
    'wweiaFoodCategory'?: WweiaFoodCategory;
}
/**
 * 
 * @export
 * @interface WweiaFoodCategory
 */
export interface WweiaFoodCategory {
    /**
     * 
     * @type {number}
     * @memberof WweiaFoodCategory
     */
    'wweiaFoodCategoryCode'?: number;
    /**
     * 
     * @type {string}
     * @memberof WweiaFoodCategory
     */
    'wweiaFoodCategoryDescription'?: string;
}

/**
 * FDCApi - axios parameter creator
 * @export
 */
export const FDCApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * Retrieves a single food item by an FDC ID. Optional format and nutrients can be specified.
         * @summary Fetches details for one food item by FDC ID
         * @param {string} fdcId FDC id of the food to retrieve
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFood: async (fdcId: string, format?: 'abridged' | 'full', nutrients?: Array<number>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'fdcId' is not null or undefined
            assertParamExists('getFood', 'fdcId', fdcId)
            const localVarPath = `/v1/food/{fdcId}`
                .replace(`{${"fdcId"}}`, encodeURIComponent(String(fdcId)));
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)

            if (format !== undefined) {
                localVarQueryParameter['format'] = format;
            }

            if (nutrients) {
                localVarQueryParameter['nutrients'] = nutrients;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {Array<string>} fdcIds List of multiple FDC ID\&#39;s. Should be comma separated list (e.g. fdcIds&#x3D;534358,373052) or repeating parameters (e.g. fdcIds&#x3D;534358&amp;fdcIds&#x3D;373052).
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoods: async (fdcIds: Array<string>, format?: 'abridged' | 'full', nutrients?: Array<number>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'fdcIds' is not null or undefined
            assertParamExists('getFoods', 'fdcIds', fdcIds)
            const localVarPath = `/v1/foods`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)

            if (fdcIds) {
                localVarQueryParameter['fdcIds'] = fdcIds;
            }

            if (format !== undefined) {
                localVarQueryParameter['format'] = format;
            }

            if (nutrients) {
                localVarQueryParameter['nutrients'] = nutrients;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoodsList: async (dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/v1/foods/list`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)

            if (dataType) {
                localVarQueryParameter['dataType'] = dataType.join(COLLECTION_FORMATS.csv);
            }

            if (pageSize !== undefined) {
                localVarQueryParameter['pageSize'] = pageSize;
            }

            if (pageNumber !== undefined) {
                localVarQueryParameter['pageNumber'] = pageNumber;
            }

            if (sortBy !== undefined) {
                localVarQueryParameter['sortBy'] = sortBy;
            }

            if (sortOrder !== undefined) {
                localVarQueryParameter['sortOrder'] = sortOrder;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {string} query One or more search terms.  The string may include [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {string} [brandOwner] Optional. Filter results based on the brand owner of the food. Only applies to Branded Foods
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoodsSearch: async (query: string, dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', brandOwner?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'query' is not null or undefined
            assertParamExists('getFoodsSearch', 'query', query)
            const localVarPath = `/v1/foods/search`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)

            if (query !== undefined) {
                localVarQueryParameter['query'] = query;
            }

            if (dataType) {
                localVarQueryParameter['dataType'] = dataType.join(COLLECTION_FORMATS.csv);
            }

            if (pageSize !== undefined) {
                localVarQueryParameter['pageSize'] = pageSize;
            }

            if (pageNumber !== undefined) {
                localVarQueryParameter['pageNumber'] = pageNumber;
            }

            if (sortBy !== undefined) {
                localVarQueryParameter['sortBy'] = sortBy;
            }

            if (sortOrder !== undefined) {
                localVarQueryParameter['sortOrder'] = sortOrder;
            }

            if (brandOwner !== undefined) {
                localVarQueryParameter['brandOwner'] = brandOwner;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as JSON (JavaScript Object Notation)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getJsonSpec: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/v1/json-spec`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as YAML (YAML Ain\'t Markup Language)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getYamlSpec: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/v1/yaml-spec`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {FoodsCriteria} foodsCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoods: async (foodsCriteria: FoodsCriteria, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'foodsCriteria' is not null or undefined
            assertParamExists('postFoods', 'foodsCriteria', foodsCriteria)
            const localVarPath = `/v1/foods`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)


    
            localVarHeaderParameter['Content-Type'] = 'application/json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(foodsCriteria, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {FoodListCriteria} foodListCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoodsList: async (foodListCriteria: FoodListCriteria, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'foodListCriteria' is not null or undefined
            assertParamExists('postFoodsList', 'foodListCriteria', foodListCriteria)
            const localVarPath = `/v1/foods/list`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)


    
            localVarHeaderParameter['Content-Type'] = 'application/json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(foodListCriteria, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {FoodSearchCriteria} foodSearchCriteria The query string may also include standard [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoodsSearch: async (foodSearchCriteria: FoodSearchCriteria, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'foodSearchCriteria' is not null or undefined
            assertParamExists('postFoodsSearch', 'foodSearchCriteria', foodSearchCriteria)
            const localVarPath = `/v1/foods/search`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }

            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication ApiKeyAuth required
            await setApiKeyToObject(localVarQueryParameter, "api_key", configuration)


    
            localVarHeaderParameter['Content-Type'] = 'application/json';

            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            localVarRequestOptions.data = serializeDataIfNeeded(foodSearchCriteria, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
    }
};

/**
 * FDCApi - functional programming interface
 * @export
 */
export const FDCApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = FDCApiAxiosParamCreator(configuration)
    return {
        /**
         * Retrieves a single food item by an FDC ID. Optional format and nutrients can be specified.
         * @summary Fetches details for one food item by FDC ID
         * @param {string} fdcId FDC id of the food to retrieve
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFood(fdcId: string, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getFood(fdcId, format, nutrients, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {Array<string>} fdcIds List of multiple FDC ID\&#39;s. Should be comma separated list (e.g. fdcIds&#x3D;534358,373052) or repeating parameters (e.g. fdcIds&#x3D;534358&amp;fdcIds&#x3D;373052).
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFoods(fdcIds: Array<string>, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getFoods(fdcIds, format, nutrients, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFoodsList(dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AbridgedFoodItem>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getFoodsList(dataType, pageSize, pageNumber, sortBy, sortOrder, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {string} query One or more search terms.  The string may include [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {string} [brandOwner] Optional. Filter results based on the brand owner of the food. Only applies to Branded Foods
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFoodsSearch(query: string, dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', brandOwner?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchResult>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getFoodsSearch(query, dataType, pageSize, pageNumber, sortBy, sortOrder, brandOwner, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as JSON (JavaScript Object Notation)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getJsonSpec(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getJsonSpec(options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as YAML (YAML Ain\'t Markup Language)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getYamlSpec(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.getYamlSpec(options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {FoodsCriteria} foodsCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async postFoods(foodsCriteria: FoodsCriteria, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.postFoods(foodsCriteria, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {FoodListCriteria} foodListCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async postFoodsList(foodListCriteria: FoodListCriteria, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AbridgedFoodItem>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.postFoodsList(foodListCriteria, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {FoodSearchCriteria} foodSearchCriteria The query string may also include standard [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async postFoodsSearch(foodSearchCriteria: FoodSearchCriteria, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchResult>>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.postFoodsSearch(foodSearchCriteria, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
        },
    }
};

/**
 * FDCApi - factory interface
 * @export
 */
export const FDCApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = FDCApiFp(configuration)
    return {
        /**
         * Retrieves a single food item by an FDC ID. Optional format and nutrients can be specified.
         * @summary Fetches details for one food item by FDC ID
         * @param {string} fdcId FDC id of the food to retrieve
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFood(fdcId: string, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: any): AxiosPromise<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem> {
            return localVarFp.getFood(fdcId, format, nutrients, options).then((request) => request(axios, basePath));
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {Array<string>} fdcIds List of multiple FDC ID\&#39;s. Should be comma separated list (e.g. fdcIds&#x3D;534358,373052) or repeating parameters (e.g. fdcIds&#x3D;534358&amp;fdcIds&#x3D;373052).
         * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
         * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoods(fdcIds: Array<string>, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: any): AxiosPromise<Array<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem>> {
            return localVarFp.getFoods(fdcIds, format, nutrients, options).then((request) => request(axios, basePath));
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoodsList(dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', options?: any): AxiosPromise<Array<AbridgedFoodItem>> {
            return localVarFp.getFoodsList(dataType, pageSize, pageNumber, sortBy, sortOrder, options).then((request) => request(axios, basePath));
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {string} query One or more search terms.  The string may include [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
         * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
         * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
         * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
         * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
         * @param {string} [brandOwner] Optional. Filter results based on the brand owner of the food. Only applies to Branded Foods
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFoodsSearch(query: string, dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', brandOwner?: string, options?: any): AxiosPromise<Array<SearchResult>> {
            return localVarFp.getFoodsSearch(query, dataType, pageSize, pageNumber, sortBy, sortOrder, brandOwner, options).then((request) => request(axios, basePath));
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as JSON (JavaScript Object Notation)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getJsonSpec(options?: any): AxiosPromise<void> {
            return localVarFp.getJsonSpec(options).then((request) => request(axios, basePath));
        },
        /**
         * The OpenAPI 3.0 specification for the FDC API rendered as YAML (YAML Ain\'t Markup Language)
         * @summary Returns this documentation in JSON format
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getYamlSpec(options?: any): AxiosPromise<void> {
            return localVarFp.getYamlSpec(options).then((request) => request(axios, basePath));
        },
        /**
         * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
         * @summary Fetches details for multiple food items using input FDC IDs
         * @param {FoodsCriteria} foodsCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoods(foodsCriteria: FoodsCriteria, options?: any): AxiosPromise<Array<AbridgedFoodItem | BrandedFoodItem | FoundationFoodItem | SRLegacyFoodItem | SurveyFoodItem>> {
            return localVarFp.postFoods(foodsCriteria, options).then((request) => request(axios, basePath));
        },
        /**
         * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
         * @summary Returns a paged list of foods, in the \'abridged\' format
         * @param {FoodListCriteria} foodListCriteria 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoodsList(foodListCriteria: FoodListCriteria, options?: any): AxiosPromise<Array<AbridgedFoodItem>> {
            return localVarFp.postFoodsList(foodListCriteria, options).then((request) => request(axios, basePath));
        },
        /**
         * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
         * @summary Returns a list of foods that matched search (query) keywords
         * @param {FoodSearchCriteria} foodSearchCriteria The query string may also include standard [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        postFoodsSearch(foodSearchCriteria: FoodSearchCriteria, options?: any): AxiosPromise<Array<SearchResult>> {
            return localVarFp.postFoodsSearch(foodSearchCriteria, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * FDCApi - object-oriented interface
 * @export
 * @class FDCApi
 * @extends {BaseAPI}
 */
export class FDCApi extends BaseAPI {
    /**
     * Retrieves a single food item by an FDC ID. Optional format and nutrients can be specified.
     * @summary Fetches details for one food item by FDC ID
     * @param {string} fdcId FDC id of the food to retrieve
     * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
     * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getFood(fdcId: string, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getFood(fdcId, format, nutrients, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
     * @summary Fetches details for multiple food items using input FDC IDs
     * @param {Array<string>} fdcIds List of multiple FDC ID\&#39;s. Should be comma separated list (e.g. fdcIds&#x3D;534358,373052) or repeating parameters (e.g. fdcIds&#x3D;534358&amp;fdcIds&#x3D;373052).
     * @param {'abridged' | 'full'} [format] Optional. \&#39;abridged\&#39; for an abridged set of elements, \&#39;full\&#39; for all elements (default).
     * @param {Array<number>} [nutrients] Optional. List of up to 25 nutrient numbers. Only the nutrient information for the specified nutrients will be returned. Should be comma separated list (e.g. nutrients&#x3D;203,204) or repeating parameters (e.g. nutrients&#x3D;203&amp;nutrients&#x3D;204). If a food does not have any matching nutrients, the food will be returned with an empty foodNutrients element.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getFoods(fdcIds: Array<string>, format?: 'abridged' | 'full', nutrients?: Array<number>, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getFoods(fdcIds, format, nutrients, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
     * @summary Returns a paged list of foods, in the \'abridged\' format
     * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
     * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
     * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
     * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
     * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getFoodsList(dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getFoodsList(dataType, pageSize, pageNumber, sortBy, sortOrder, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
     * @summary Returns a list of foods that matched search (query) keywords
     * @param {string} query One or more search terms.  The string may include [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
     * @param {Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>} [dataType] Optional. Filter on a specific data type; specify one or more values in an array.
     * @param {number} [pageSize] Optional. Maximum number of results to return for the current page. Default is 50.
     * @param {number} [pageNumber] Optional. Page number to retrieve. The offset into the overall result set is expressed as (pageNumber * pageSize)
     * @param {'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate'} [sortBy] Optional. Specify one of the possible values to sort by that field. Note, dataType.keyword will be dataType and lowercaseDescription.keyword will be description in future releases.
     * @param {'asc' | 'desc'} [sortOrder] Optional. The sort direction for the results. Only applicable if sortBy is specified.
     * @param {string} [brandOwner] Optional. Filter results based on the brand owner of the food. Only applies to Branded Foods
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getFoodsSearch(query: string, dataType?: Array<'Branded' | 'Foundation' | 'Survey (FNDDS)' | 'SR Legacy'>, pageSize?: number, pageNumber?: number, sortBy?: 'dataType.keyword' | 'lowercaseDescription.keyword' | 'fdcId' | 'publishedDate', sortOrder?: 'asc' | 'desc', brandOwner?: string, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getFoodsSearch(query, dataType, pageSize, pageNumber, sortBy, sortOrder, brandOwner, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * The OpenAPI 3.0 specification for the FDC API rendered as JSON (JavaScript Object Notation)
     * @summary Returns this documentation in JSON format
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getJsonSpec(options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getJsonSpec(options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * The OpenAPI 3.0 specification for the FDC API rendered as YAML (YAML Ain\'t Markup Language)
     * @summary Returns this documentation in JSON format
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public getYamlSpec(options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).getYamlSpec(options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Retrieves a list of food items by a list of up to 20 FDC IDs. Optional format and nutrients can be specified. Invalid FDC ID\'s or ones that are not found are omitted and an empty set is returned if there are no matches.
     * @summary Fetches details for multiple food items using input FDC IDs
     * @param {FoodsCriteria} foodsCriteria 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public postFoods(foodsCriteria: FoodsCriteria, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).postFoods(foodsCriteria, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Retrieves a paged list of foods. Use the pageNumber parameter to page through the entire result set.
     * @summary Returns a paged list of foods, in the \'abridged\' format
     * @param {FoodListCriteria} foodListCriteria 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public postFoodsList(foodListCriteria: FoodListCriteria, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).postFoodsList(foodListCriteria, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Search for foods using keywords. Results can be filtered by dataType and there are options for result page sizes or sorting.
     * @summary Returns a list of foods that matched search (query) keywords
     * @param {FoodSearchCriteria} foodSearchCriteria The query string may also include standard [search operators](https://fdc.nal.usda.gov/help.html#bkmk-2)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FDCApi
     */
    public postFoodsSearch(foodSearchCriteria: FoodSearchCriteria, options?: AxiosRequestConfig) {
        return FDCApiFp(this.configuration).postFoodsSearch(foodSearchCriteria, options).then((request) => request(this.axios, this.basePath));
    }
}