@types/amazon-product-api

Installation

npm install --save @types/amazon-product-api

Summary

This package contains type definitions for amazon-product-api (https://github.com/t3chnoboy/amazon-product-api).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/amazon-product-api.

index.d.ts

interface ICredentials {
    awsId: string;
    awsSecret: string;
    awsTag: string;
}

interface IAmazonProductQueryCallback {
    (err: string, results: Object[]): void;
}

interface IItemSearchOptions {
    condition?: string | undefined;
    keywords?: string | undefined;
    responseGroup?: string | undefined;
    searchIndex?: string | undefined;
    itemPage?: number | undefined;
    sort?: string | undefined;
}

interface IItemLookupOptions {
    condition?: string | undefined;
    idType?: string | undefined;
    includeReviewsSummary?: boolean | undefined;
    itemId?: string | string[] | undefined;
    responseGroup?: string | undefined;
    searchIndex?: string | undefined;
    truncateReviewsAt?: number | undefined;
    variationPage?: string | undefined;
    domain?: string | undefined;
    request?: Function | undefined;
}

interface IBrowseNodeLookupOptions {
    browseNodeId?: string | undefined;
    responseGroup?: string | undefined;
}

interface ISimilarityLookupOptions {
    similarityType?: string | undefined;
    responseGroup?: string | undefined;
}

interface IAmazonProductClient {
    itemSearch(query: IItemSearchOptions, callback?: IAmazonProductQueryCallback): Promise<Object[]> | undefined;
    itemLookup(query: IItemLookupOptions, callback?: IAmazonProductQueryCallback): Promise<Object[]> | undefined;
    browseNodeLookup(
        query: IBrowseNodeLookupOptions,
        callback?: IAmazonProductQueryCallback,
    ): Promise<Object[]> | undefined;
    similarityLookup(
        query: ISimilarityLookupOptions,
        callback?: IAmazonProductQueryCallback,
    ): Promise<Object[]> | undefined;
}

export declare function createClient(credentials: ICredentials): IAmazonProductClient;

Additional Details

• Last updated: Fri, 01 Nov 2024 22:02:19 GMT
• Dependencies: none

Credits

These definitions were written by Matti Lehtinen, and Alex Leon.