UNPKG

@gnosticdev/highlevel-sdk

Version:
1,868 lines (1,867 loc) 90.8 kB
type webhooks = { AppointmentCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['AppointmentCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; AppointmentDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['AppointmentDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; AppInstall: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['AppInstall']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; AppointmentUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['AppointmentUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; AppUninstall: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['AppUninstall']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; CampaignStatusUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['CampaignStatusUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ContactCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ContactCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ContactDndUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ContactDndUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ContactTagUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ContactTagUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ContactUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ContactUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ContactDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ContactDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ConversationProviderOutboundWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ConversationProviderOutboundWebhook']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoiceCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoiceCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InboundMessage: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InboundMessage']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoiceSent: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoiceSent']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ConversationUnreadWebhook: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ConversationUnreadWebhook']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoicePartiallyPaid: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoicePartiallyPaid']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoicePaid: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoicePaid']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoiceVoid: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoiceVoid']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoiceDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoiceDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; LCEmailStats: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['LCEmailStats']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; InvoiceUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['InvoiceUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; LocationCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['LocationCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; LocationUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['LocationUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; NoteCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['NoteCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; NoteDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['NoteDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityAssignedToUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityAssignedToUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; NoteUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['NoteUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityStageUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityStageUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityStatusUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityStatusUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OpportunityMonetaryValueUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OpportunityMonetaryValueUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OutboundMessage: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OutboundMessage']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OrderStatusUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OrderStatusUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; OrderCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['OrderCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; PriceCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['PriceCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; PriceUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['PriceUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; PlanChange: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['PlanChange']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; PriceDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['PriceDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ProductUpdate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ProductUpdate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ProductCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ProductCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; ProductDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['ProductDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; TaskCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['TaskCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; TaskComplete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['TaskComplete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; UserCreate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['UserCreate']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; TaskDelete: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { 'application/json': components['schemas']['TaskDelete']; }; }; responses: { /** @description Webhook processed successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; }; type components = { schemas: { AppointmentCreate: { appointment?: { address?: string; appointmentStatus?: string; assignedUserId?: string; calendarId?: string; contactId?: string; dateAdded?: string; dateUpdated?: string; endTime?: string; groupId?: string; id?: string; notes?: string; source?: string; startTime?: string; title?: string; users?: unknown[]; }; locationId?: string; type?: string; }; AppointmentDelete: { appointment?: { address?: string; appointmentStatus?: string; assignedUserId?: string; calendarId?: string; contactId?: string; dateAdded?: string; dateUpdated?: string; endTime?: string; groupId?: string; id?: string; notes?: string; source?: string; startTime?: string; title?: string; users?: unknown[]; }; locationId?: string; type?: string; }; AppInstall: { appId?: string; companyId?: string; locationId?: string; planId?: string; trial?: { onTrial?: boolean; trialDuration?: number; trialStartDate?: Record<string, never>; }; type?: string; userId?: string; }; AppointmentUpdate: { appointment?: { address?: string; appointmentStatus?: string; assignedUserId?: string; calendarId?: string; contactId?: string; dateAdded?: string; dateUpdated?: string; endTime?: string; groupId?: string; id?: string; notes?: string; source?: string; startTime?: string; title?: string; users?: unknown[]; }; locationId?: string; type?: string; }; AppUninstall: { appId?: string; companyId?: string; locationId?: string; type?: string; }; CampaignStatusUpdate: { contactId?: string; dateAdded?: string; id?: string; locationId?: string;