amberflo-metering-typescript/dist/usageClient.d.ts

Amberflo metering client for TypeScript

import { IAxiosRetryConfig } from "axios-retry";
import BaseClient from "./baseClient";
import { UsageApiPayload, AllUsageApiPayload, UsageReport } from "./model/usageApiPayload";
/**
 * See: https://docs.amberflo.io/reference/post_usage
 */
export declare class UsageClient extends BaseClient {
    /**
     * Initialize a new `UsageClient`
     * `debug`: Whether to issue debug level logs or not.
     * `retry`: Whether to retry idempotent requests on 5xx or network errors, or retry configuration (see https://github.com/softonic/axios-retry).
     */
    constructor(apiKey: string, debug?: boolean, retry?: boolean | IAxiosRetryConfig);
    /**
     * Get usage data
     * See: https://docs.amberflo.io/reference/post_usage
     */
    getUsage(query: UsageApiPayload): Promise<UsageReport>;
    /**
     * Get usage data, multiple reports at a time.
     * See: https://docs.amberflo.io/reference/post_usage-batch
     */
    getUsageBatch(queries: UsageApiPayload[]): Promise<UsageReport[]>;
    /**
     * Get usage reports for all meters. Because it incudes all meters, this is more limited than `getUsage`.
     */
    getAllUsage(query: AllUsageApiPayload): Promise<UsageReport[]>;
}