@getopenpay/client/models/BillingMeterEventAdjustmentExternal.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 type { BillingMeterEventAdjustmentStatus } from './BillingMeterEventAdjustmentStatus';
import type { BillingMeterAdjustmentType } from './BillingMeterAdjustmentType';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface BillingMeterEventAdjustmentExternal
 */
export interface BillingMeterEventAdjustmentExternal {
    /**
     * Unique identifier for the account.
     * @type {string}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    accountId: string;
    /**
     * Unique identifier for the event.
     * @type {string}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    cancelIdentifier: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    createdAt: Date;
    /**
     * The name of the meter event. Corresponds with the event_name field on a meter.
     * @type {string}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    eventName: string;
    /**
     * Unique identifier of meter event.
     * @type {string}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    object?: ObjectName;
    /**
     * Status of the billing meter adjustment event.
     * @type {BillingMeterEventAdjustmentStatus}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    status: BillingMeterEventAdjustmentStatus;
    /**
     * Specifies whether to cancel a single event.
     * @type {BillingMeterAdjustmentType}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    type?: BillingMeterAdjustmentType;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof BillingMeterEventAdjustmentExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the BillingMeterEventAdjustmentExternal interface.
 */
export declare function instanceOfBillingMeterEventAdjustmentExternal(value: object): value is BillingMeterEventAdjustmentExternal;
export declare function BillingMeterEventAdjustmentExternalFromJSON(json: any): BillingMeterEventAdjustmentExternal;
export declare function BillingMeterEventAdjustmentExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingMeterEventAdjustmentExternal;
export declare function BillingMeterEventAdjustmentExternalToJSON(json: any): BillingMeterEventAdjustmentExternal;
export declare function BillingMeterEventAdjustmentExternalToJSONTyped(value?: BillingMeterEventAdjustmentExternal | null, ignoreDiscriminator?: boolean): any;