@licht-77/dmm-sdk/dist/cjs/helperClient.d.ts

DMM Affiliate API v3 SDK for Node.js/TypeScript

import { DmmApiClient, type DmmApiClientOptions } from './client';
import type { ItemListRequestParams, Item } from './types';
/**
 * A helper client that wraps DmmApiClient to provide additional functionalities.
 */
export declare class DmmApiHelperClient {
    private readonly client;
    /**
     * Creates an instance of DmmApiHelperClient.
     * @param {DmmApiClientOptions} options - Options for the DMM API client.
     */
    constructor(options: DmmApiClientOptions);
    /**
     * Gets the underlying DmmApiClient instance.
     * @returns {DmmApiClient} The DmmApiClient instance.
     */
    api(): DmmApiClient;
    /**
     * Retrieves a single item by its Content ID (cid).
     * This method uses the ItemList API and returns the first item found.
     * @param {string} cid - The Content ID of the item.
     * @param {Omit<ItemListRequestParams, 'cid' | 'hits' | 'offset'>} [options] - Additional ItemListRequestParams (e.g., site).
     * @returns {Promise<Item | null>} The item information, or null if not found.
     */
    getItemById(cid: string, options?: Omit<ItemListRequestParams, 'cid' | 'hits' | 'offset'>): Promise<Item | null>;
}
//# sourceMappingURL=helperClient.d.ts.map