@automate.ax/integration-contracts 0.145.2 → 0.146.0

package/dist/highlevel/operation-manifest.js

@@ -0,0 +1,98 @@
+/** 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"),
+];
+/**
+ * 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(product, operationId, alias, exportName, title, description, replaySafety) {
+    return {
+        alias,
+        description,
+        exportName,
+        operationId,
+        product,
+        replaySafety,
+        title,
+    };
+}

package/dist/highlevel/schemas.d.ts

@@ -0,0 +1,41 @@
+import * as z from "zod";
+import type { HighLevelOperationKey } from "./operation-manifest.js";
+import type { HighLevelOperationInput, HighLevelOperationOutput } from "./types.js";
+interface HighLevelRuntimeOperation {
+    apiVersion: string;
+    bodyParameters: string[];
+    inputSchema: Record<string, unknown>;
+    locationPlacements: ("body" | "path" | "query")[];
+    locationParameterNames: Partial<Record<"body" | "path" | "query", string>>;
+    method: "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
+    outputSchema: Record<string, unknown>;
+    path: string;
+    pathParameters: string[];
+    queryParameters: {
+        explode: boolean;
+        name: string;
+        providerName: string;
+        style: string;
+    }[];
+    responseMode: "binary" | "json";
+    requiredScope: string;
+}
+/**
+ * Returns the immutable runtime descriptor for one HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export declare function highLevelOperation<TKey extends HighLevelOperationKey>(key: TKey): Record<HighLevelOperationKey, HighLevelRuntimeOperation>[TKey];
+/**
+ * Validates flattened input for one frozen HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export declare function highLevelOperationInputSchema<TKey extends HighLevelOperationKey>(key: TKey): z.ZodType<HighLevelOperationInput<TKey>>;
+/**
+ * Validates the documented success response for one HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export declare function highLevelOperationOutputSchema<TKey extends HighLevelOperationKey>(key: TKey): z.ZodType<HighLevelOperationOutput<TKey>>;
+export {};

package/dist/highlevel/schemas.js

@@ -0,0 +1,39 @@
+/* oxlint-disable typescript/no-unsafe-type-assertion -- Generated operation keys index a frozen external contract. */
+import { Validator } from "@cfworker/json-schema";
+import * as z from "zod";
+import operationData from "./openapi-operations.generated.json" with { type: "json" };
+const OPERATIONS = operationData.operations;
+const VALIDATOR = new Validator({
+    $defs: operationData.definitions,
+    $schema: "https://json-schema.org/draft/2020-12/schema",
+    additionalProperties: false,
+    properties: Object.fromEntries(Object.entries(OPERATIONS).flatMap(([key, operation]) => [
+        [`${key}:input`, operation.inputSchema],
+        [`${key}:output`, operation.outputSchema],
+    ])),
+    type: "object",
+}, "2020-12");
+/**
+ * Returns the immutable runtime descriptor for one HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperation(key) {
+    return OPERATIONS[key];
+}
+/**
+ * Validates flattened input for one frozen HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperationInputSchema(key) {
+    return z.custom((value) => VALIDATOR.validate({ [`${key}:input`]: value }).valid, { message: `Input does not match HighLevel operation ${key}.` });
+}
+/**
+ * Validates the documented success response for one HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperationOutputSchema(key) {
+    return z.custom((value) => VALIDATOR.validate({ [`${key}:output`]: value }).valid, { message: `Output does not match HighLevel operation ${key}.` });
+}

package/dist/highlevel/types.d.ts

@@ -0,0 +1,41 @@
+import type { Encodable } from "@automate.ax/codec";
+import type { HighLevelOperationMap } from "./openapi-types.generated";
+import type { HighLevelOperationKey } from "./operation-manifest.js";
+type Operation<TKey extends HighLevelOperationKey> = TKey extends keyof HighLevelOperationMap ? HighLevelOperationMap[TKey] : never;
+type Parameters<TOperation, TLocation extends string> = TOperation extends {
+    parameters: infer TParameters;
+} ? TLocation extends keyof TParameters ? NonNullable<TParameters[TLocation]> : object : object;
+/** JSON request body from one generated OpenAPI operation. */
+type JsonBody<TOperation> = TOperation extends {
+    requestBody: infer TBody;
+} ? NonNullable<TBody> extends {
+    content: infer TContent;
+} ? "application/json" extends keyof TContent ? TContent["application/json"] : object : object : object;
+/** JSON payload from one generated response entry. */
+type JsonResponse<TResponse> = TResponse extends {
+    content: infer TContent;
+} ? "application/json" extends keyof TContent ? TContent["application/json"] : null : null;
+/** First supported successful response for one operation. */
+type SuccessResponse<TOperation> = TOperation extends {
+    responses: infer TResponses;
+} ? JsonResponse<TResponses[Extract<keyof TResponses, 200 | 201 | 202 | 203 | 204 | "default">]> : never;
+type SnakeToCamel<TValue extends string> = TValue extends `${infer THead}_${infer TTail}` ? `${THead}${Capitalize<SnakeToCamel<TTail>>}` : TValue;
+type PublicKeys<TValue> = TValue extends unknown ? {
+    [TKey in keyof TValue as TKey extends string ? SnakeToCamel<TKey> : TKey]: TValue[TKey];
+} : never;
+type WithoutLocationId<TValue> = TValue extends unknown ? Omit<TValue, "locationId" | "location_id"> : never;
+/** Flattens intersections for public editor display. */
+type Simplify<TValue> = {
+    [TKey in keyof TValue]: TValue[TKey];
+} & {};
+type EncodableValue<TValue> = unknown extends TValue ? Encodable : TValue extends undefined | null | boolean | number | string ? TValue : TValue extends readonly (infer TItem)[] ? EncodableValue<TItem>[] : TValue extends object ? keyof TValue extends never ? Record<string, Encodable> : {
+    [TKey in keyof TValue]: EncodableValue<TValue[TKey]>;
+} : never;
+type HighLevelRawOperationInput<TKey extends HighLevelOperationKey> = Simplify<PublicKeys<WithoutLocationId<Parameters<Operation<TKey>, "path">>> & PublicKeys<WithoutLocationId<Parameters<Operation<TKey>, "query">>> & PublicKeys<WithoutLocationId<JsonBody<Operation<TKey>>>>>;
+/** Flattened, location-safe input for one frozen HighLevel operation. */
+export type HighLevelOperationInput<TKey extends HighLevelOperationKey> = {
+    [TField in keyof HighLevelRawOperationInput<TKey>]: EncodableValue<HighLevelRawOperationInput<TKey>[TField]>;
+};
+/** Documented successful JSON response for one frozen HighLevel operation. */
+export type HighLevelOperationOutput<TKey extends HighLevelOperationKey> = EncodableValue<SuccessResponse<Operation<TKey>>>;
+export {};

package/dist/highlevel/types.js

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

package/dist/resend/action-schemas.d.ts

@@ -670,8 +670,8 @@ export declare const RESEND_CONTACT_TOPIC_SCHEMA: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
     subscription: z.ZodEnum<{
-        opt_in: "opt_in";
         opt_out: "opt_out";
+        opt_in: "opt_in";
     }>;
 }, z.core.$strip>;
 export declare const RESEND_CONTACT_SEGMENT_DELETE_WIRE_SCHEMA: z.ZodObject<{
@@ -717,8 +717,8 @@ export declare const RESEND_CONTACT_TOPICS_UPDATE_SCHEMA: z.ZodObject<{
     topics: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         subscription: z.ZodEnum<{
-            opt_in: "opt_in";
             opt_out: "opt_out";
+            opt_in: "opt_in";
         }>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

package/dist/triggers.d.ts

@@ -21,6 +21,7 @@ import type { googleMeetTriggerContracts } from "./google-meet/index.js";
 import type { googleAdsTriggerContracts } from "./google-ads/index.js";
 import type { googleSheetsTriggerContracts } from "./google-sheets/index.js";
 import type { hubspotTriggerContracts } from "./hubspot/index.js";
+import type { highLevelTriggerContracts } from "./highlevel/index.js";
 import type { linearTriggerContracts } from "./linear/index.js";
 import type { millionVerifierTriggerContracts } from "./millionverifier/index.js";
 import type { metaAdsTriggerContracts } from "./meta-ads/index.js";
@@ -36,7 +37,7 @@ import type { vercelTriggerContracts } from "./vercel/index.js";
 import type { webflowTriggerContracts } from "./webflow/index.js";
 import type { whatsappTriggerContracts } from "./whatsapp/index.js";
 import type { z } from "zod";
-export type TriggerContractMap = typeof airtableTriggerContracts & typeof anthropicTriggerContracts & typeof apifyTriggerContracts & typeof axiomTriggerContracts & typeof automateTriggerContracts & typeof asanaTriggerContracts & typeof brevoTriggerContracts & typeof calcomTriggerContracts & typeof convexTriggerContracts & typeof discordTriggerContracts & typeof closeTriggerContracts & typeof clickUpTriggerContracts & typeof calendlyTriggerContracts & typeof cloudflareTriggerContracts & typeof githubTriggerContracts & typeof gmailTriggerContracts & typeof googleCalendarTriggerContracts & typeof googleDriveTriggerContracts & typeof googleFormsTriggerContracts & typeof googleMeetTriggerContracts & typeof googleAdsTriggerContracts & typeof googleSheetsTriggerContracts & typeof hubspotTriggerContracts & typeof linearTriggerContracts & typeof millionVerifierTriggerContracts & typeof metaAdsTriggerContracts & typeof notionTriggerContracts & typeof outlookTriggerContracts & typeof redditTriggerContracts & typeof resendTriggerContracts & typeof slackTriggerContracts & typeof stripeTriggerContracts & typeof teamsTriggerContracts & typeof trelloTriggerContracts & typeof vercelTriggerContracts & typeof webflowTriggerContracts & typeof whatsappTriggerContracts;
+export type TriggerContractMap = typeof airtableTriggerContracts & typeof anthropicTriggerContracts & typeof apifyTriggerContracts & typeof axiomTriggerContracts & typeof automateTriggerContracts & typeof asanaTriggerContracts & typeof brevoTriggerContracts & typeof calcomTriggerContracts & typeof convexTriggerContracts & typeof discordTriggerContracts & typeof closeTriggerContracts & typeof clickUpTriggerContracts & typeof calendlyTriggerContracts & typeof cloudflareTriggerContracts & typeof githubTriggerContracts & typeof gmailTriggerContracts & typeof googleCalendarTriggerContracts & typeof googleDriveTriggerContracts & typeof googleFormsTriggerContracts & typeof googleMeetTriggerContracts & typeof googleAdsTriggerContracts & typeof googleSheetsTriggerContracts & typeof hubspotTriggerContracts & typeof highLevelTriggerContracts & typeof linearTriggerContracts & typeof millionVerifierTriggerContracts & typeof metaAdsTriggerContracts & typeof notionTriggerContracts & typeof outlookTriggerContracts & typeof redditTriggerContracts & typeof resendTriggerContracts & typeof slackTriggerContracts & typeof stripeTriggerContracts & typeof teamsTriggerContracts & typeof trelloTriggerContracts & typeof vercelTriggerContracts & typeof webflowTriggerContracts & typeof whatsappTriggerContracts;
 export type IntegrationTriggerType = keyof TriggerContractMap;
 /** Canonical authoring configuration for one integration trigger type. */
 export type TriggerConfig<TType extends IntegrationTriggerType> = z.input<TriggerContractMap[TType]["configSchema"]> extends Record<string, never> ? object : z.input<TriggerContractMap[TType]["configSchema"]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.145.2",
+  "version": "0.146.0",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -43,6 +43,7 @@
       "./google-sheets": "./src/google-sheets/index.ts",
       "./github": "./src/github/index.ts",
       "./hubspot": "./src/hubspot/index.ts",
+      "./highlevel": "./src/highlevel/index.ts",
       "./jobnimbus": "./src/jobnimbus/index.ts",
       "./linear": "./src/linear/index.ts",
       "./millionverifier": "./src/millionverifier/index.ts",
@@ -67,7 +68,7 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "0.123.0",
-    "@automate.ax/codec": "0.145.2",
+    "@automate.ax/codec": "0.146.0",
     "@cfworker/json-schema": "^4.1.1",
     "@googleapis/calendar": "^16.0.0",
     "@googleapis/forms": "^6.0.1",
@@ -103,6 +104,7 @@
   "scripts": {
     "generate:github": "bun scripts/generate-github-webhook-schemas.ts",
     "generate:calcom": "bun scripts/generate-calcom-openapi.ts",
+    "generate:highlevel": "bun scripts/generate-highlevel-openapi.ts",
     "typecheck": "resource-broker run --pool automate-ax-validation --limit 2 --weight 1 -- tsc --noEmit",
     "lint": "oxlint --type-aware --threads=2 && bun --bun eslint . --cache --cache-strategy content",
     "lint:fix": "oxlint --type-aware --threads=2 --fix --fix-suggestions && bun --bun eslint . --fix --cache --cache-strategy content",
@@ -246,6 +248,11 @@
       "types": "./dist/hubspot/index.d.ts",
       "default": "./dist/hubspot/index.js"
     },
+    "./highlevel": {
+      "bun": "./src/highlevel/index.ts",
+      "types": "./dist/highlevel/index.d.ts",
+      "default": "./dist/highlevel/index.js"
+    },
     "./jobnimbus": {
       "bun": "./src/jobnimbus/index.ts",
       "types": "./dist/jobnimbus/index.d.ts",

package/src/highlevel/api.ts

@@ -0,0 +1,294 @@
+import { encodableSchema, type Encodable } from "@automate.ax/codec"
+import * as z from "zod"
+import type { HighLevelOperationKey } from "./operation-manifest"
+import { highLevelOperation, highLevelOperationOutputSchema } from "./schemas"
+import type { HighLevelOperationInput, HighLevelOperationOutput } from "./types"
+
+const HIGH_LEVEL_API_BASE_URL = "https://services.leadconnectorhq.com/"
+const HIGH_LEVEL_API_ORIGIN = new URL(HIGH_LEVEL_API_BASE_URL).origin
+const HIGH_LEVEL_SECRET_SCHEMA = z.object({
+  accessToken: z.string().min(1),
+  locationId: z.string().min(1),
+})
+
+/** Resolved account accepted by the shared HighLevel API client. */
+export interface HighLevelResolvedAccount {
+  connectionMethodId: string
+  secret: Record<string, unknown>
+  serviceId: "highlevel"
+}
+
+/** Structured error returned by a rejected HighLevel request. */
+export class HighLevelApiError extends Error {
+  readonly body?: Encodable
+  readonly retryAfter?: string
+  readonly status: number
+
+  /**
+   * Creates an error from one rejected HighLevel response.
+   *
+   * @param options - Rejected response details.
+   * @param options.body - Encodable provider error body.
+   * @param options.retryAfter - Provider retry timing.
+   * @param options.status - HTTP status.
+   */
+  constructor(options: {
+    body?: Encodable
+    retryAfter?: string
+    status: number
+  }) {
+    super(
+      getErrorMessage(options.body) ??
+        `HighLevel API request failed with status ${options.status}.`,
+    )
+    this.name = "HighLevelApiError"
+    this.body = options.body
+    this.retryAfter = options.retryAfter
+    this.status = options.status
+  }
+}
+
+/**
+ * Creates an authenticated client for the frozen HighLevel action surface.
+ *
+ * @param account - Resolved HighLevel account.
+ * @throws When the connection method or secret is invalid.
+ */
+export function getHighLevelApi(account: HighLevelResolvedAccount) {
+  const credentials = HIGH_LEVEL_SECRET_SCHEMA.parse(account.secret)
+  if (
+    account.connectionMethodId !== "oauth" &&
+    account.connectionMethodId !== "private-integration-token"
+  ) {
+    throw new Error(
+      `Unsupported HighLevel connection method: ${account.connectionMethodId}`,
+    )
+  }
+
+  return {
+    /**
+     * Executes and validates one named HighLevel OpenAPI operation.
+     *
+     * @param key - Frozen operation key.
+     * @param input - Flattened operation input.
+     */
+    async operation<TKey extends HighLevelOperationKey>(
+      key: TKey,
+      input: HighLevelOperationInput<TKey>,
+    ): Promise<HighLevelOperationOutput<TKey>> {
+      const definition = highLevelOperation(key)
+      const pathValues = new Map<string, unknown>()
+      const queryValues = new Map<string, unknown>()
+      const bodyValues: Record<string, unknown> = {}
+      const inputRecord = input as Record<string, unknown>
+
+      for (const name of definition.pathParameters) {
+        pathValues.set(name, inputRecord[name])
+      }
+      for (const { name } of definition.queryParameters) {
+        queryValues.set(name, inputRecord[name])
+      }
+      for (const name of definition.bodyParameters) {
+        if (inputRecord[name] !== undefined)
+          bodyValues[name] = inputRecord[name]
+      }
+      for (const placement of definition.locationPlacements) {
+        if (placement === "path")
+          pathValues.set("locationId", credentials.locationId)
+        if (placement === "query")
+          queryValues.set("locationId", credentials.locationId)
+        if (placement === "body") bodyValues.locationId = credentials.locationId
+      }
+
+      // Resolve path placeholders before applying the fixed-origin guard.
+      const path = definition.path.replace(
+        /\{([^}]+)\}/g,
+        (_match, name: string) => encodePathSegment(pathValues.get(name), name),
+      )
+      const normalizedPath = path.replace(/^\/+/, "")
+      const url = new URL(normalizedPath, HIGH_LEVEL_API_BASE_URL)
+      if (
+        !normalizedPath ||
+        normalizedPath.includes("://") ||
+        normalizedPath.includes("\\") ||
+        normalizedPath.includes("?") ||
+        normalizedPath.includes("#") ||
+        url.origin !== HIGH_LEVEL_API_ORIGIN
+      ) {
+        throw new TypeError(
+          "HighLevel API paths must remain provider-relative.",
+        )
+      }
+      for (const parameter of definition.queryParameters) {
+        appendQuery(
+          url,
+          { ...parameter, name: parameter.providerName },
+          queryValues.get(parameter.name),
+        )
+      }
+      if (definition.locationPlacements.includes("query")) {
+        url.searchParams.set(
+          definition.locationParameterNames.query ?? "locationId",
+          credentials.locationId,
+        )
+      }
+
+      const hasBody =
+        definition.bodyParameters.length > 0 ||
+        definition.locationPlacements.includes("body")
+      const response = await fetch(url, {
+        body: hasBody ? JSON.stringify(bodyValues) : undefined,
+        headers: {
+          Accept: "application/json",
+          Authorization: `Bearer ${credentials.accessToken}`,
+          Version: definition.apiVersion,
+          ...(hasBody ? { "Content-Type": "application/json" } : {}),
+        },
+        method: definition.method,
+        redirect: "error",
+      })
+      const parsed =
+        response.ok && definition.responseMode === "binary"
+          ? {
+              contentType:
+                response.headers.get("Content-Type") ??
+                "application/octet-stream",
+              data: Buffer.from(await response.arrayBuffer()).toString(
+                "base64",
+              ),
+            }
+          : await parseResponseText(response)
+      if (!response.ok) {
+        const body = encodableSchema.safeParse(parsed)
+        throw new HighLevelApiError({
+          ...(body.success && { body: body.data }),
+          retryAfter: getRetryAfter(response.headers),
+          status: response.status,
+        })
+      }
+      return highLevelOperationOutputSchema(key).parse(parsed)
+    },
+  }
+}
+
+/**
+ * Encodes one required path parameter.
+ *
+ * @param value - Parameter value.
+ * @param name - Parameter name.
+ * @throws When the value is not scalar.
+ */
+function encodePathSegment(value: unknown, name: string) {
+  if (typeof value !== "number" && typeof value !== "string") {
+    throw new TypeError(`HighLevel path parameter ${name} is required.`)
+  }
+  return encodeURIComponent(String(value))
+}
+
+/**
+ * Appends one OpenAPI query parameter.
+ *
+ * @param url - Provider request URL.
+ * @param parameter - Query serialization metadata.
+ * @param parameter.explode - Whether array items repeat the query key.
+ * @param parameter.name - Query parameter name.
+ * @param parameter.style - OpenAPI serialization style.
+ * @param value - Parameter value.
+ * @throws When the value is not scalar or an array of scalars.
+ */
+function appendQuery(
+  url: URL,
+  parameter: { explode: boolean; name: string; style: string },
+  value: unknown,
+) {
+  if (value == null) return
+  if (Array.isArray(value)) {
+    if (parameter.style === "form" && parameter.explode) {
+      for (const item of value)
+        url.searchParams.append(parameter.name, stringifyQueryValue(item))
+    } else {
+      url.searchParams.set(
+        parameter.name,
+        value.map(stringifyQueryValue).join(","),
+      )
+    }
+    return
+  }
+  url.searchParams.set(parameter.name, stringifyQueryValue(value))
+}
+
+/**
+ * Converts one supported query value to text.
+ *
+ * @param value - Query value.
+ * @throws When the value is not scalar.
+ */
+function stringifyQueryValue(value: unknown) {
+  if (
+    typeof value !== "boolean" &&
+    typeof value !== "number" &&
+    typeof value !== "string"
+  ) {
+    throw new TypeError("HighLevel query parameters must be scalar.")
+  }
+  return String(value)
+}
+
+/**
+ * Reads provider-directed retry timing.
+ *
+ * @param headers - Rejected response headers.
+ */
+function getRetryAfter(headers: Headers) {
+  const retryAfter = headers.get("Retry-After")
+  if (retryAfter) return retryAfter
+  const interval = headers.get("X-RateLimit-Interval-Milliseconds")
+  if (!interval || !/^\d+$/.test(interval)) return undefined
+  return String(Math.ceil(Number(interval) / 1_000))
+}
+
+/**
+ * Extracts a provider error message.
+ *
+ * @param value - Encodable provider error body.
+ */
+function getErrorMessage(value: Encodable | undefined) {
+  if (!isPlainObject(value)) return undefined
+  for (const key of ["message", "error", "error_description"]) {
+    const candidate = value[key]
+    if (typeof candidate === "string" && candidate.trim()) return candidate
+  }
+  return undefined
+}
+
+/**
+ * Narrows a value to a plain object.
+ *
+ * @param value - Candidate value.
+ */
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
+/**
+ * Parses JSON while retaining non-JSON provider bodies.
+ *
+ * @param value - Response body text.
+ */
+function parseJson(value: string): unknown {
+  try {
+    return JSON.parse(value)
+  } catch {
+    return { response: value }
+  }
+}
+
+/**
+ * Reads one text or JSON provider response.
+ *
+ * @param response - Provider response to decode.
+ */
+async function parseResponseText(response: Response) {
+  const text = await response.text()
+  return text ? parseJson(text) : null
+}