@getopenpay/client/apis/BillingMeterEventsApi.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { BillingMeterEventExternal, CreateBillingMeterEventRequest, ListBillingMeterEventSummariesRequest, ListResponseBillingMeterSummary } from '../models/index';
export interface CreateBillingMeterEventOperationRequest {
    createBillingMeterEventRequest: CreateBillingMeterEventRequest;
}
export interface ListBillingMeterEventSummariesOperationRequest {
    listBillingMeterEventSummariesRequest: ListBillingMeterEventSummariesRequest;
}
/**
 *
 */
export declare class BillingMeterEventsApi extends runtime.BaseAPI {
    /**
     * A billing meter event represents a customer’s usage of a product. Meter events are used to bill a customer based on their usage. Meter events are associated with billing meters, which define the shape of the event’s payload and how those events are aggregated for billing. Every event is identified by an unique identifier, same identifier can not be used again.
     * Create Billing Meter Event
     */
    createBillingMeterEventRaw(requestParameters: CreateBillingMeterEventOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingMeterEventExternal>>;
    /**
     * A billing meter event represents a customer’s usage of a product. Meter events are used to bill a customer based on their usage. Meter events are associated with billing meters, which define the shape of the event’s payload and how those events are aggregated for billing. Every event is identified by an unique identifier, same identifier can not be used again.
     * Create Billing Meter Event
     */
    createBillingMeterEvent(requestParameters: CreateBillingMeterEventOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingMeterEventExternal>;
    /**
     * A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.
     * List Billing Meter Event Summaries
     */
    listBillingMeterEventSummariesRaw(requestParameters: ListBillingMeterEventSummariesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseBillingMeterSummary>>;
    /**
     * A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.
     * List Billing Meter Event Summaries
     */
    listBillingMeterEventSummaries(requestParameters: ListBillingMeterEventSummariesOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseBillingMeterSummary>;
}