@shaggytools/nhtsa-api-wrapper/dist/types/api/endpoints/GetMakeForManufacturer.d.ts

Universal javascript wrapper for the NHTSA.dot.gov VPIC 'vehicles' API, useful for VIN decoding, etc.

/**
 * @module api/endpoints/GetMakeForManufacturer
 * @category API Endpoints
 */
import type { NhtsaResponse } from '../../types';
/**
 * ::: tip :bulb: More Information
 * See: [GetMakeForManufacturer Documentation](/api/endpoints/get-make-for-manufacturer)
 * :::
 *
 * `GetMakeForManufacturer` returns all the Makes in the vPIC dataset for a specified manufacturer
 * that is requested. Multiple results are returned in case of multiple matches.
 *
 * `manufacturer` name can be a partial name, or a full name for more specificity, e.g. "988",
 * "honda", "HONDA OF CANADA MFG., INC.", etc.
 *
 * - If supplied `manufacturer` is a number - method will do exact match on Manufacturer's Id.
 * - If supplied `manufacturer` is a string - it will look for manufacturers whose name is LIKE the
 *   provided name. It accepts a partial manufacturer name as an input.
 *
 * @param {(string|number)} manufacturer - Manufacturer Name or ID
 * @param {boolean} [doFetch=true] - Whether to fetch the data or just return the URL
 * (default: `true`)
 * @returns {(Promise<NhtsaResponse<GetMakeForManufacturerResults> | string>)} - Api Response
 * `object` -or- url `string` if `doFetch = false`
 */
declare function GetMakeForManufacturer(manufacturer: string | number, doFetch?: true): Promise<NhtsaResponse<GetMakeForManufacturerResults>>;
declare function GetMakeForManufacturer(manufacturer: string | number, doFetch: false): Promise<string>;
export { GetMakeForManufacturer };
/**
 * Objects found in the `Results` array of `GetMakeForManufacturer` endpoint response.
 */
export type GetMakeForManufacturerResults = {
    Make_ID: number;
    Make_Name: string;
    Mfr_Name: string;
};
//# sourceMappingURL=GetMakeForManufacturer.d.ts.map