@lob/lob-typescript-sdk/dist/models/events.d.ts

Lob API wrapper

/**
 * Lob
 * The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
 *
 * The version of the OpenAPI document: 1.3.0
 * Contact: lob-openapi@lob.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { EventType } from "./event-type";
/**
 *
 * @export
 * @class Events
 */
export declare class Events {
    constructor(input?: any);
    /**
     * Unique identifier prefixed with `evt_`.
     * @type {string}
     * @memberof Events
     */
    private "_id";
    get id(): string;
    set id(newValue: string);
    /**
     * The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)).
     * @type {object}
     * @memberof Events
     */
    "body": object;
    /**
     * Unique identifier of the related resource for the event.
     * @type {string}
     * @memberof Events
     */
    "reference_id": string;
    /**
     *
     * @type {EventType}
     * @memberof Events
     */
    "event_type": EventType;
    /**
     * A timestamp in ISO 8601 format of the date the resource was created.
     * @type {string}
     * @memberof Events
     */
    "date_created": string;
    /**
     * Value is resource type.
     * @type {string}
     * @memberof Events
     */
    "object": EventsObjectEnum;
    toJSON(): {};
}
/**
 * @export
 * @enum {string}
 */
export declare enum EventsObjectEnum {
    Event = "event"
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */