@automate.ax/integration-contracts 0.145.2 → 0.146.0

package/dist/highlevel/openapi-types.generated.js

@@ -0,0 +1 @@
+export {};

package/dist/highlevel/operation-manifest.d.ts

@@ -0,0 +1,608 @@
+/** HighLevel OpenAPI products frozen into the Automate.ax integration. */
+export type HighLevelOpenApiProduct = "calendars" | "campaigns" | "contacts" | "conversations" | "forms" | "locations" | "opportunities" | "surveys" | "users" | "workflows";
+/** Retry classification for one HighLevel operation. */
+export type HighLevelReplaySafety = "safe" | "unsafe";
+/** Hand-authored public metadata bound to one official OpenAPI operation. */
+export interface HighLevelOperationDefinition {
+    readonly alias: string;
+    readonly description: string;
+    readonly exportName: string;
+    readonly operationId: string;
+    readonly product: HighLevelOpenApiProduct;
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}
+/** Complete practical HighLevel CRM action surface. */
+export declare const HIGH_LEVEL_OPERATION_DEFINITIONS: readonly [{
+    readonly alias: "listContacts";
+    readonly description: string;
+    readonly exportName: "listHighLevelContacts";
+    readonly operationId: "get-contacts";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getContact";
+    readonly description: string;
+    readonly exportName: "getHighLevelContact";
+    readonly operationId: "get-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "searchContacts";
+    readonly description: string;
+    readonly exportName: "searchHighLevelContacts";
+    readonly operationId: "search-contacts-advanced";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "findDuplicateContact";
+    readonly description: string;
+    readonly exportName: "findDuplicateHighLevelContact";
+    readonly operationId: "get-duplicate-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createContact";
+    readonly description: string;
+    readonly exportName: "createHighLevelContact";
+    readonly operationId: "create-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "upsertContact";
+    readonly description: string;
+    readonly exportName: "upsertHighLevelContact";
+    readonly operationId: "upsert-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateContact";
+    readonly description: string;
+    readonly exportName: "updateHighLevelContact";
+    readonly operationId: "update-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteContact";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelContact";
+    readonly operationId: "delete-contact";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "addContactTags";
+    readonly description: string;
+    readonly exportName: "addHighLevelContactTags";
+    readonly operationId: "add-tags";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "removeContactTags";
+    readonly description: string;
+    readonly exportName: "removeHighLevelContactTags";
+    readonly operationId: "remove-tags";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listContactTasks";
+    readonly description: string;
+    readonly exportName: "listHighLevelContactTasks";
+    readonly operationId: "get-all-tasks";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getContactTask";
+    readonly description: string;
+    readonly exportName: "getHighLevelContactTask";
+    readonly operationId: "get-task";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createContactTask";
+    readonly description: string;
+    readonly exportName: "createHighLevelContactTask";
+    readonly operationId: "create-task";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateContactTask";
+    readonly description: string;
+    readonly exportName: "updateHighLevelContactTask";
+    readonly operationId: "update-task";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "completeContactTask";
+    readonly description: string;
+    readonly exportName: "completeHighLevelContactTask";
+    readonly operationId: "update-task-completed";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteContactTask";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelContactTask";
+    readonly operationId: "delete-task";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listContactNotes";
+    readonly description: string;
+    readonly exportName: "listHighLevelContactNotes";
+    readonly operationId: "get-all-notes";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getContactNote";
+    readonly description: string;
+    readonly exportName: "getHighLevelContactNote";
+    readonly operationId: "get-note";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createContactNote";
+    readonly description: string;
+    readonly exportName: "createHighLevelContactNote";
+    readonly operationId: "create-note";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateContactNote";
+    readonly description: string;
+    readonly exportName: "updateHighLevelContactNote";
+    readonly operationId: "update-note";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteContactNote";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelContactNote";
+    readonly operationId: "delete-note";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "addContactToCampaign";
+    readonly description: string;
+    readonly exportName: "addHighLevelContactToCampaign";
+    readonly operationId: "add-contact-to-campaign";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "removeContactFromCampaign";
+    readonly description: string;
+    readonly exportName: "removeHighLevelContactFromCampaign";
+    readonly operationId: "remove-contact-from-campaign";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "addContactToWorkflow";
+    readonly description: string;
+    readonly exportName: "addHighLevelContactToWorkflow";
+    readonly operationId: "add-contact-to-workflow";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "removeContactFromWorkflow";
+    readonly description: string;
+    readonly exportName: "removeHighLevelContactFromWorkflow";
+    readonly operationId: "delete-contact-from-workflow";
+    readonly product: "contacts";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "searchOpportunities";
+    readonly description: string;
+    readonly exportName: "searchHighLevelOpportunities";
+    readonly operationId: "search-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getOpportunity";
+    readonly description: string;
+    readonly exportName: "getHighLevelOpportunity";
+    readonly operationId: "get-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createOpportunity";
+    readonly description: string;
+    readonly exportName: "createHighLevelOpportunity";
+    readonly operationId: "create-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "upsertOpportunity";
+    readonly description: string;
+    readonly exportName: "upsertHighLevelOpportunity";
+    readonly operationId: "Upsert-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateOpportunity";
+    readonly description: string;
+    readonly exportName: "updateHighLevelOpportunity";
+    readonly operationId: "update-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateOpportunityStatus";
+    readonly description: string;
+    readonly exportName: "updateHighLevelOpportunityStatus";
+    readonly operationId: "update-opportunity-status";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteOpportunity";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelOpportunity";
+    readonly operationId: "delete-opportunity";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listPipelines";
+    readonly description: string;
+    readonly exportName: "listHighLevelPipelines";
+    readonly operationId: "get-pipelines";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listOpportunityLostReasons";
+    readonly description: string;
+    readonly exportName: "listHighLevelOpportunityLostReasons";
+    readonly operationId: "get-lost-reason";
+    readonly product: "opportunities";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listCalendars";
+    readonly description: string;
+    readonly exportName: "listHighLevelCalendars";
+    readonly operationId: "get-calendars";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getCalendar";
+    readonly description: string;
+    readonly exportName: "getHighLevelCalendar";
+    readonly operationId: "get-calendar";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createCalendar";
+    readonly description: string;
+    readonly exportName: "createHighLevelCalendar";
+    readonly operationId: "create-calendar";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateCalendar";
+    readonly description: string;
+    readonly exportName: "updateHighLevelCalendar";
+    readonly operationId: "update-calendar";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteCalendar";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelCalendar";
+    readonly operationId: "delete-calendar";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getCalendarFreeSlots";
+    readonly description: string;
+    readonly exportName: "getHighLevelCalendarFreeSlots";
+    readonly operationId: "get-slots";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listAppointments";
+    readonly description: string;
+    readonly exportName: "listHighLevelAppointments";
+    readonly operationId: "get-calendar-events";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getAppointment";
+    readonly description: string;
+    readonly exportName: "getHighLevelAppointment";
+    readonly operationId: "get-appointment";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createAppointment";
+    readonly description: string;
+    readonly exportName: "createHighLevelAppointment";
+    readonly operationId: "create-appointment";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateAppointment";
+    readonly description: string;
+    readonly exportName: "updateHighLevelAppointment";
+    readonly operationId: "edit-appointment";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteAppointment";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelAppointment";
+    readonly operationId: "delete-event";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listBlockedSlots";
+    readonly description: string;
+    readonly exportName: "listHighLevelBlockedSlots";
+    readonly operationId: "get-blocked-slots";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createBlockedSlot";
+    readonly description: string;
+    readonly exportName: "createHighLevelBlockedSlot";
+    readonly operationId: "create-block-slot";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateBlockedSlot";
+    readonly description: string;
+    readonly exportName: "updateHighLevelBlockedSlot";
+    readonly operationId: "edit-block-slot";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listSchedules";
+    readonly description: string;
+    readonly exportName: "listHighLevelSchedules";
+    readonly operationId: "getAllSchedules";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getSchedule";
+    readonly description: string;
+    readonly exportName: "getHighLevelSchedule";
+    readonly operationId: "getScheduleById";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createSchedule";
+    readonly description: string;
+    readonly exportName: "createHighLevelSchedule";
+    readonly operationId: "createSchedule";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateSchedule";
+    readonly description: string;
+    readonly exportName: "updateHighLevelSchedule";
+    readonly operationId: "updateSchedule";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteSchedule";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelSchedule";
+    readonly operationId: "deleteSchedule";
+    readonly product: "calendars";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "searchConversations";
+    readonly description: string;
+    readonly exportName: "searchHighLevelConversations";
+    readonly operationId: "search-conversation";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getConversation";
+    readonly description: string;
+    readonly exportName: "getHighLevelConversation";
+    readonly operationId: "get-conversation";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "createConversation";
+    readonly description: string;
+    readonly exportName: "createHighLevelConversation";
+    readonly operationId: "create-conversation";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "updateConversation";
+    readonly description: string;
+    readonly exportName: "updateHighLevelConversation";
+    readonly operationId: "update-conversation";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "deleteConversation";
+    readonly description: string;
+    readonly exportName: "deleteHighLevelConversation";
+    readonly operationId: "delete-conversation";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listMessages";
+    readonly description: string;
+    readonly exportName: "listHighLevelMessages";
+    readonly operationId: "get-messages";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getMessage";
+    readonly description: string;
+    readonly exportName: "getHighLevelMessage";
+    readonly operationId: "get-message";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "sendMessage";
+    readonly description: string;
+    readonly exportName: "sendHighLevelMessage";
+    readonly operationId: "send-a-new-message";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "cancelScheduledMessage";
+    readonly description: string;
+    readonly exportName: "cancelScheduledHighLevelMessage";
+    readonly operationId: "cancel-scheduled-message";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getMessageRecording";
+    readonly description: string;
+    readonly exportName: "getHighLevelMessageRecording";
+    readonly operationId: "get-message-recording";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getMessageTranscription";
+    readonly description: string;
+    readonly exportName: "getHighLevelMessageTranscription";
+    readonly operationId: "get-message-transcription";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getLocation";
+    readonly description: string;
+    readonly exportName: "getHighLevelLocation";
+    readonly operationId: "get-location";
+    readonly product: "locations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listUsers";
+    readonly description: string;
+    readonly exportName: "listHighLevelUsers";
+    readonly operationId: "get-user-by-location";
+    readonly product: "users";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "getUser";
+    readonly description: string;
+    readonly exportName: "getHighLevelUser";
+    readonly operationId: "get-user";
+    readonly product: "users";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listCampaigns";
+    readonly description: string;
+    readonly exportName: "listHighLevelCampaigns";
+    readonly operationId: "get-campaigns";
+    readonly product: "campaigns";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listWorkflows";
+    readonly description: string;
+    readonly exportName: "listHighLevelWorkflows";
+    readonly operationId: "get-workflow";
+    readonly product: "workflows";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listForms";
+    readonly description: string;
+    readonly exportName: "listHighLevelForms";
+    readonly operationId: "get-forms";
+    readonly product: "forms";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listFormSubmissions";
+    readonly description: string;
+    readonly exportName: "listHighLevelFormSubmissions";
+    readonly operationId: "get-forms-submissions";
+    readonly product: "forms";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listSurveys";
+    readonly description: string;
+    readonly exportName: "listHighLevelSurveys";
+    readonly operationId: "get-surveys";
+    readonly product: "surveys";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}, {
+    readonly alias: "listSurveySubmissions";
+    readonly description: string;
+    readonly exportName: "listHighLevelSurveySubmissions";
+    readonly operationId: "get-surveys-submissions";
+    readonly product: "surveys";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
+}];
+/** Stable key joining an official HighLevel OpenAPI product and operation ID. */
+export type HighLevelOperationKey = OperationKey<(typeof HIGH_LEVEL_OPERATION_DEFINITIONS)[number]>;
+/** Derives a product-qualified key from a manifest definition. */
+type OperationKey<TDefinition> = TDefinition extends {
+    operationId: infer TOperationId extends string;
+    product: infer TProduct extends string;
+} ? `${TProduct}:${TOperationId}` : never;
+export {};