@automate.ax/integration-contracts 0.145.1 → 0.146.0

package/src/highlevel/operation-manifest.ts

@@ -0,0 +1,740 @@
+/** 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 const HIGH_LEVEL_OPERATION_DEFINITIONS = [
+  operation(
+    "contacts",
+    "get-contacts",
+    "listContacts",
+    "listHighLevelContacts",
+    "List HighLevel contacts",
+    "Lists contacts in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-contact",
+    "getContact",
+    "getHighLevelContact",
+    "Get HighLevel contact",
+    "Retrieves one contact by ID.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "search-contacts-advanced",
+    "searchContacts",
+    "searchHighLevelContacts",
+    "Search HighLevel contacts",
+    "Searches contacts with HighLevel's advanced filters and sorting.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-duplicate-contact",
+    "findDuplicateContact",
+    "findDuplicateHighLevelContact",
+    "Find duplicate HighLevel contact",
+    "Finds an existing contact by email or phone before creation.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "create-contact",
+    "createContact",
+    "createHighLevelContact",
+    "Create HighLevel contact",
+    "Creates a contact in the connected sub-account.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "upsert-contact",
+    "upsertContact",
+    "upsertHighLevelContact",
+    "Upsert HighLevel contact",
+    "Creates or updates a contact using HighLevel's duplicate-contact policy.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "update-contact",
+    "updateContact",
+    "updateHighLevelContact",
+    "Update HighLevel contact",
+    "Updates one contact by ID.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "delete-contact",
+    "deleteContact",
+    "deleteHighLevelContact",
+    "Delete HighLevel contact",
+    "Permanently deletes one contact by ID.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "add-tags",
+    "addContactTags",
+    "addHighLevelContactTags",
+    "Add HighLevel contact tags",
+    "Adds tags to one contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "remove-tags",
+    "removeContactTags",
+    "removeHighLevelContactTags",
+    "Remove HighLevel contact tags",
+    "Removes tags from one contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-all-tasks",
+    "listContactTasks",
+    "listHighLevelContactTasks",
+    "List HighLevel contact tasks",
+    "Lists tasks attached to one contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-task",
+    "getContactTask",
+    "getHighLevelContactTask",
+    "Get HighLevel contact task",
+    "Retrieves one task attached to a contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "create-task",
+    "createContactTask",
+    "createHighLevelContactTask",
+    "Create HighLevel contact task",
+    "Creates a task attached to one contact.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "update-task",
+    "updateContactTask",
+    "updateHighLevelContactTask",
+    "Update HighLevel contact task",
+    "Updates one contact task.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "update-task-completed",
+    "completeContactTask",
+    "completeHighLevelContactTask",
+    "Complete HighLevel contact task",
+    "Marks one contact task complete or incomplete.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "delete-task",
+    "deleteContactTask",
+    "deleteHighLevelContactTask",
+    "Delete HighLevel contact task",
+    "Deletes one contact task.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-all-notes",
+    "listContactNotes",
+    "listHighLevelContactNotes",
+    "List HighLevel contact notes",
+    "Lists notes attached to one contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "get-note",
+    "getContactNote",
+    "getHighLevelContactNote",
+    "Get HighLevel contact note",
+    "Retrieves one note attached to a contact.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "create-note",
+    "createContactNote",
+    "createHighLevelContactNote",
+    "Create HighLevel contact note",
+    "Creates a note attached to one contact.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "update-note",
+    "updateContactNote",
+    "updateHighLevelContactNote",
+    "Update HighLevel contact note",
+    "Updates one contact note.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "delete-note",
+    "deleteContactNote",
+    "deleteHighLevelContactNote",
+    "Delete HighLevel contact note",
+    "Deletes one contact note.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "add-contact-to-campaign",
+    "addContactToCampaign",
+    "addHighLevelContactToCampaign",
+    "Add HighLevel contact to campaign",
+    "Adds one contact to a campaign.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "remove-contact-from-campaign",
+    "removeContactFromCampaign",
+    "removeHighLevelContactFromCampaign",
+    "Remove HighLevel contact from campaign",
+    "Removes one contact from a campaign.",
+    "safe",
+  ),
+  operation(
+    "contacts",
+    "add-contact-to-workflow",
+    "addContactToWorkflow",
+    "addHighLevelContactToWorkflow",
+    "Add HighLevel contact to workflow",
+    "Adds one contact to a workflow.",
+    "unsafe",
+  ),
+  operation(
+    "contacts",
+    "delete-contact-from-workflow",
+    "removeContactFromWorkflow",
+    "removeHighLevelContactFromWorkflow",
+    "Remove HighLevel contact from workflow",
+    "Removes one contact from a workflow.",
+    "safe",
+  ),
+
+  operation(
+    "opportunities",
+    "search-opportunity",
+    "searchOpportunities",
+    "searchHighLevelOpportunities",
+    "Search HighLevel opportunities",
+    "Searches opportunities with pipeline, status, owner, and pagination filters.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "get-opportunity",
+    "getOpportunity",
+    "getHighLevelOpportunity",
+    "Get HighLevel opportunity",
+    "Retrieves one opportunity by ID.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "create-opportunity",
+    "createOpportunity",
+    "createHighLevelOpportunity",
+    "Create HighLevel opportunity",
+    "Creates an opportunity in a pipeline.",
+    "unsafe",
+  ),
+  operation(
+    "opportunities",
+    "Upsert-opportunity",
+    "upsertOpportunity",
+    "upsertHighLevelOpportunity",
+    "Upsert HighLevel opportunity",
+    "Creates or updates an opportunity using HighLevel's matching rules.",
+    "unsafe",
+  ),
+  operation(
+    "opportunities",
+    "update-opportunity",
+    "updateOpportunity",
+    "updateHighLevelOpportunity",
+    "Update HighLevel opportunity",
+    "Updates one opportunity by ID.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "update-opportunity-status",
+    "updateOpportunityStatus",
+    "updateHighLevelOpportunityStatus",
+    "Update HighLevel opportunity status",
+    "Changes one opportunity's open, won, lost, or abandoned status.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "delete-opportunity",
+    "deleteOpportunity",
+    "deleteHighLevelOpportunity",
+    "Delete HighLevel opportunity",
+    "Deletes one opportunity by ID.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "get-pipelines",
+    "listPipelines",
+    "listHighLevelPipelines",
+    "List HighLevel pipelines",
+    "Lists the connected sub-account's opportunity pipelines and stages.",
+    "safe",
+  ),
+  operation(
+    "opportunities",
+    "get-lost-reason",
+    "listOpportunityLostReasons",
+    "listHighLevelOpportunityLostReasons",
+    "List HighLevel opportunity lost reasons",
+    "Lists configured reasons for lost opportunities.",
+    "safe",
+  ),
+
+  operation(
+    "calendars",
+    "get-calendars",
+    "listCalendars",
+    "listHighLevelCalendars",
+    "List HighLevel calendars",
+    "Lists calendars in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "get-calendar",
+    "getCalendar",
+    "getHighLevelCalendar",
+    "Get HighLevel calendar",
+    "Retrieves one calendar by ID.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "create-calendar",
+    "createCalendar",
+    "createHighLevelCalendar",
+    "Create HighLevel calendar",
+    "Creates a calendar in the connected sub-account.",
+    "unsafe",
+  ),
+  operation(
+    "calendars",
+    "update-calendar",
+    "updateCalendar",
+    "updateHighLevelCalendar",
+    "Update HighLevel calendar",
+    "Updates one calendar by ID.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "delete-calendar",
+    "deleteCalendar",
+    "deleteHighLevelCalendar",
+    "Delete HighLevel calendar",
+    "Deletes one calendar by ID.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "get-slots",
+    "getCalendarFreeSlots",
+    "getHighLevelCalendarFreeSlots",
+    "Get HighLevel calendar free slots",
+    "Returns available slots for a calendar and date range.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "get-calendar-events",
+    "listAppointments",
+    "listHighLevelAppointments",
+    "List HighLevel appointments",
+    "Lists calendar events and appointments in a date range.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "get-appointment",
+    "getAppointment",
+    "getHighLevelAppointment",
+    "Get HighLevel appointment",
+    "Retrieves one appointment by event ID.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "create-appointment",
+    "createAppointment",
+    "createHighLevelAppointment",
+    "Create HighLevel appointment",
+    "Creates an appointment on a calendar.",
+    "unsafe",
+  ),
+  operation(
+    "calendars",
+    "edit-appointment",
+    "updateAppointment",
+    "updateHighLevelAppointment",
+    "Update HighLevel appointment",
+    "Updates one calendar appointment.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "delete-event",
+    "deleteAppointment",
+    "deleteHighLevelAppointment",
+    "Delete HighLevel appointment",
+    "Deletes one calendar event or appointment.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "get-blocked-slots",
+    "listBlockedSlots",
+    "listHighLevelBlockedSlots",
+    "List HighLevel blocked slots",
+    "Lists blocked calendar slots in a date range.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "create-block-slot",
+    "createBlockedSlot",
+    "createHighLevelBlockedSlot",
+    "Create HighLevel blocked slot",
+    "Blocks a time range on a calendar.",
+    "unsafe",
+  ),
+  operation(
+    "calendars",
+    "edit-block-slot",
+    "updateBlockedSlot",
+    "updateHighLevelBlockedSlot",
+    "Update HighLevel blocked slot",
+    "Updates one blocked calendar slot.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "getAllSchedules",
+    "listSchedules",
+    "listHighLevelSchedules",
+    "List HighLevel schedules",
+    "Lists availability schedules for the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "getScheduleById",
+    "getSchedule",
+    "getHighLevelSchedule",
+    "Get HighLevel schedule",
+    "Retrieves one availability schedule by ID.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "createSchedule",
+    "createSchedule",
+    "createHighLevelSchedule",
+    "Create HighLevel schedule",
+    "Creates an availability schedule.",
+    "unsafe",
+  ),
+  operation(
+    "calendars",
+    "updateSchedule",
+    "updateSchedule",
+    "updateHighLevelSchedule",
+    "Update HighLevel schedule",
+    "Updates one availability schedule.",
+    "safe",
+  ),
+  operation(
+    "calendars",
+    "deleteSchedule",
+    "deleteSchedule",
+    "deleteHighLevelSchedule",
+    "Delete HighLevel schedule",
+    "Deletes one availability schedule.",
+    "safe",
+  ),
+
+  operation(
+    "conversations",
+    "search-conversation",
+    "searchConversations",
+    "searchHighLevelConversations",
+    "Search HighLevel conversations",
+    "Searches conversations by contact, assignment, status, and pagination.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "get-conversation",
+    "getConversation",
+    "getHighLevelConversation",
+    "Get HighLevel conversation",
+    "Retrieves one conversation by ID.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "create-conversation",
+    "createConversation",
+    "createHighLevelConversation",
+    "Create HighLevel conversation",
+    "Creates a conversation for a contact.",
+    "unsafe",
+  ),
+  operation(
+    "conversations",
+    "update-conversation",
+    "updateConversation",
+    "updateHighLevelConversation",
+    "Update HighLevel conversation",
+    "Updates assignment, status, or read state for one conversation.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "delete-conversation",
+    "deleteConversation",
+    "deleteHighLevelConversation",
+    "Delete HighLevel conversation",
+    "Deletes one conversation by ID.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "get-messages",
+    "listMessages",
+    "listHighLevelMessages",
+    "List HighLevel messages",
+    "Lists messages in one conversation.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "get-message",
+    "getMessage",
+    "getHighLevelMessage",
+    "Get HighLevel message",
+    "Retrieves one message by ID.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "send-a-new-message",
+    "sendMessage",
+    "sendHighLevelMessage",
+    "Send HighLevel message",
+    "Sends a supported message through a contact conversation.",
+    "unsafe",
+  ),
+  operation(
+    "conversations",
+    "cancel-scheduled-message",
+    "cancelScheduledMessage",
+    "cancelScheduledHighLevelMessage",
+    "Cancel scheduled HighLevel message",
+    "Cancels one scheduled message before delivery.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "get-message-recording",
+    "getMessageRecording",
+    "getHighLevelMessageRecording",
+    "Get HighLevel message recording",
+    "Returns the recording for a voice or call message.",
+    "safe",
+  ),
+  operation(
+    "conversations",
+    "get-message-transcription",
+    "getMessageTranscription",
+    "getHighLevelMessageTranscription",
+    "Get HighLevel message transcription",
+    "Returns the transcription for a supported message.",
+    "safe",
+  ),
+
+  operation(
+    "locations",
+    "get-location",
+    "getLocation",
+    "getHighLevelLocation",
+    "Get HighLevel location",
+    "Retrieves the connected sub-account's location record.",
+    "safe",
+  ),
+  operation(
+    "users",
+    "get-user-by-location",
+    "listUsers",
+    "listHighLevelUsers",
+    "List HighLevel users",
+    "Lists users assigned to the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "users",
+    "get-user",
+    "getUser",
+    "getHighLevelUser",
+    "Get HighLevel user",
+    "Retrieves one user by ID.",
+    "safe",
+  ),
+  operation(
+    "campaigns",
+    "get-campaigns",
+    "listCampaigns",
+    "listHighLevelCampaigns",
+    "List HighLevel campaigns",
+    "Lists campaigns in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "workflows",
+    "get-workflow",
+    "listWorkflows",
+    "listHighLevelWorkflows",
+    "List HighLevel workflows",
+    "Lists workflows in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "forms",
+    "get-forms",
+    "listForms",
+    "listHighLevelForms",
+    "List HighLevel forms",
+    "Lists forms in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "forms",
+    "get-forms-submissions",
+    "listFormSubmissions",
+    "listHighLevelFormSubmissions",
+    "List HighLevel form submissions",
+    "Lists form submissions with date and pagination filters.",
+    "safe",
+  ),
+  operation(
+    "surveys",
+    "get-surveys",
+    "listSurveys",
+    "listHighLevelSurveys",
+    "List HighLevel surveys",
+    "Lists surveys in the connected sub-account.",
+    "safe",
+  ),
+  operation(
+    "surveys",
+    "get-surveys-submissions",
+    "listSurveySubmissions",
+    "listHighLevelSurveySubmissions",
+    "List HighLevel survey submissions",
+    "Lists survey submissions with date and pagination filters.",
+    "safe",
+  ),
+] as const satisfies readonly HighLevelOperationDefinition[]
+
+/** 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
+
+/**
+ * Defines one public HighLevel action bound to an official operation.
+ *
+ * @param product - Provider OpenAPI product.
+ * @param operationId - Official operation identifier.
+ * @param alias - Public object alias.
+ * @param exportName - Named SDK export.
+ * @param title - Action title.
+ * @param description - Action description.
+ * @param replaySafety - Automatic replay classification.
+ */
+function operation<
+  const TProduct extends HighLevelOpenApiProduct,
+  const TOperationId extends string,
+  const TAlias extends string,
+  const TExportName extends string,
+>(
+  product: TProduct,
+  operationId: TOperationId,
+  alias: TAlias,
+  exportName: TExportName,
+  title: string,
+  description: string,
+  replaySafety: HighLevelReplaySafety,
+) {
+  return {
+    alias,
+    description,
+    exportName,
+    operationId,
+    product,
+    replaySafety,
+    title,
+  } as const
+}