@apideck/node
Version:
Apideck Node.js SDK
109 lines (108 loc) • 3.21 kB
TypeScript
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface WebhookEvent
*/
export interface WebhookEvent {
/**
* Unique reference to this request event
* @type {string}
* @memberof WebhookEvent
*/
event_id?: string;
/**
* Name of Apideck Unified API
* @type {string}
* @memberof WebhookEvent
*/
unified_api?: WebhookEventUnifiedApi;
/**
* Service provider identifier
* @type {string}
* @memberof WebhookEvent
*/
service_id?: string;
/**
* Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
* @type {string}
* @memberof WebhookEvent
*/
consumer_id?: string;
/**
* The service provider's ID of the entity that triggered this event
* @type {string}
* @memberof WebhookEvent
*/
entity_id?: string;
/**
* The type entity that triggered this event
* @type {string}
* @memberof WebhookEvent
*/
entity_type?: string;
/**
* The url to retrieve entity detail.
* @type {string}
* @memberof WebhookEvent
*/
entity_url?: string;
/**
* The current count this request event has been attempted
* @type {number}
* @memberof WebhookEvent
*/
execution_attempt?: number;
/**
* ISO Datetime for when the original event occurred
* @type {string}
* @memberof WebhookEvent
*/
occurred_at?: string;
}
/**
* @export
* @enum {string}
*/
export declare enum WebhookEventUnifiedApi {
accounting = "accounting",
ats = "ats",
calendar = "calendar",
crm = "crm",
csp = "csp",
customer_support = "customer-support",
ecommerce = "ecommerce",
email = "email",
email_marketing = "email-marketing",
expense_management = "expense-management",
file_storage = "file-storage",
form = "form",
hris = "hris",
lead = "lead",
payroll = "payroll",
pos = "pos",
procurement = "procurement",
project_management = "project-management",
script = "script",
sms = "sms",
spreadsheet = "spreadsheet",
team_messaging = "team-messaging",
issue_tracking = "issue-tracking",
time_registration = "time-registration",
transactional_email = "transactional-email",
vault = "vault",
data_warehouse = "data-warehouse"
}
export declare function WebhookEventFromJSON(json: any): WebhookEvent;
export declare function WebhookEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEvent;
export declare function WebhookEventToJSON(value?: WebhookEvent | null): any;