@automate.ax/integration-contracts 0.152.0 → 0.152.1

package/dist/highlevel/operation-manifest.js

@@ -62,6 +62,7 @@ export const HIGH_LEVEL_OPERATION_DEFINITIONS = [
     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", "cancel-scheduled-email-message", "cancelScheduledEmailMessage", "cancelScheduledHighLevelEmailMessage", "Cancel scheduled HighLevel email message", "Cancels one scheduled email 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"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.152.0",
+  "version": "0.152.1",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -72,7 +72,7 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "0.123.0",
-    "@automate.ax/codec": "0.152.0",
+    "@automate.ax/codec": "0.152.1",
     "@cfworker/json-schema": "^4.1.1",
     "@googleapis/calendar": "^16.0.0",
     "@googleapis/forms": "^6.0.1",

package/src/highlevel/api.ts

@@ -86,7 +86,12 @@ export function getHighLevelApi(account: HighLevelResolvedAccount) {
         pathValues.set(name, inputRecord[name])
       }
       for (const { name } of definition.queryParameters) {
-        queryValues.set(name, inputRecord[name])
+        queryValues.set(
+          name,
+          inputRecord[name] === undefined
+            ? queryParameterDefault(definition.inputSchema, name)
+            : inputRecord[name],
+        )
       }
       for (const name of definition.bodyParameters) {
         if (inputRecord[name] !== undefined)
@@ -171,6 +176,28 @@ export function getHighLevelApi(account: HighLevelResolvedAccount) {
   }
 }
 
+/**
+ * Reads one documented top-level query default from a generated input schema.
+ *
+ * @param schema - Generated operation input schema.
+ * @param name - Public query parameter name.
+ */
+function queryParameterDefault(schema: Record<string, unknown>, name: string) {
+  const properties = schema.properties
+  if (!isRecord(properties)) return undefined
+  const property = properties[name]
+  return isRecord(property) ? property.default : undefined
+}
+
+/**
+ * Whether one unknown JSON value is an object record.
+ *
+ * @param value - Candidate value.
+ */
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value)
+}
+
 /**
  * Encodes one required path parameter.
  *

package/src/highlevel/openapi-operations.generated.json

@@ -330,10 +330,18 @@
         },
         "openHours": {
           "description": "This is only to set the standard availability. For custom availability, use the availabilities property",
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/calendars.OpenHour"
-          }
+          "anyOf": [
+            {
+              "items": {
+                "$ref": "#/$defs/calendars.OpenHour"
+              },
+              "type": "array"
+            },
+            {
+              "additionalProperties": true,
+              "type": "object"
+            }
+          ]
         },
         "enableRecurring": {
           "type": "boolean",
@@ -518,22 +526,22 @@
           ]
         },
         "startTime": {
-          "type": "object",
+          "type": "string",
           "description": "Start Time",
           "example": "2023-09-25T16:00:00+05:30"
         },
         "endTime": {
-          "type": "object",
+          "type": "string",
           "description": "End Time",
           "example": "2023-09-25T16:00:00+05:30"
         },
         "dateAdded": {
-          "type": "object",
+          "type": "string",
           "description": "Date Added",
           "example": "2023-09-25T16:00:00+05:30"
         },
         "dateUpdated": {
-          "type": "object",
+          "type": "string",
           "description": "Date Updated",
           "example": "2023-09-25T16:00:00+05:30"
         },
@@ -563,11 +571,6 @@
         "title",
         "calendarId",
         "locationId",
-        "contactId",
-        "groupId",
-        "appointmentStatus",
-        "assignedUserId",
-        "users",
         "startTime",
         "endTime",
         "dateAdded",
@@ -625,15 +628,22 @@
       "type": "object",
       "properties": {
         "userId": {
-          "type": "string",
-          "description": "The ID of the user who created or updated the appointment"
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "The ID of the user who created or updated the appointment"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "source": {
           "type": "string",
           "description": "The source of the appointment"
         }
       },
-      "required": ["source"]
+      "required": []
     },
     "calendars.DeleteEventSuccessfulResponseDto": {
       "type": "object",
@@ -1373,8 +1383,15 @@
           "example": "JohnDeo@gmail.com"
         },
         "timezone": {
-          "type": "string",
-          "example": "Asia/Calcutta"
+          "anyOf": [
+            {
+              "type": "string",
+              "example": "Asia/Calcutta"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "country": {
           "type": "string",
@@ -2450,7 +2467,8 @@
             "TYPE_TIKTOK_COMMENT",
             "TYPE_ACTIVITY_WHATSAPP",
             "TYPE_FORM_SUBMISSION",
-            "TYPE_SMS_REACTION"
+            "TYPE_SMS_REACTION",
+            "TYPE_NO_SHOW"
           ]
         },
         "type": {
@@ -2495,7 +2513,6 @@
         "id",
         "contactId",
         "locationId",
-        "lastMessageBody",
         "lastMessageType",
         "type",
         "unreadCount",
@@ -3674,7 +3691,29 @@
         "stages": {
           "type": "array",
           "items": {
-            "type": "array"
+            "additionalProperties": true,
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "position": {
+                "type": "number"
+              },
+              "showInFunnel": {
+                "type": "boolean"
+              },
+              "showInPieChart": {
+                "type": "boolean"
+              },
+              "stageWinProbability": {
+                "type": "number"
+              }
+            },
+            "required": ["id", "name"],
+            "type": "object"
           }
         },
         "showInFunnel": {
@@ -3720,12 +3759,29 @@
           "example": 2
         },
         "nextPage": {
-          "type": "number",
-          "example": 3
+          "example": 3,
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "prevPage": {
-          "type": "number",
-          "example": 1
+          "anyOf": [
+            {
+              "type": "number",
+              "example": 1
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       }
     },
@@ -3741,16 +3797,30 @@
           "example": "John Deo"
         },
         "companyName": {
-          "type": "string",
-          "example": "Tesla Inc"
+          "anyOf": [
+            {
+              "type": "string",
+              "example": "Tesla Inc"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "email": {
           "type": "string",
           "example": "john@deo.com"
         },
         "phone": {
-          "type": "string",
-          "example": "+1202-555-0107"
+          "anyOf": [
+            {
+              "type": "string",
+              "example": "+1202-555-0107"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "tags": {
           "type": "array",
@@ -3784,16 +3854,30 @@
           "example": "e93ba61a-53b3-45e7-985a-c7732dbcdb69"
         },
         "assignedTo": {
-          "type": "string",
-          "example": "zT46WSCPbudrq4zhWMk6"
+          "anyOf": [
+            {
+              "type": "string",
+              "example": "zT46WSCPbudrq4zhWMk6"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "status": {
           "type": "string",
           "example": "open"
         },
         "source": {
-          "type": "string",
-          "example": ""
+          "anyOf": [
+            {
+              "type": "string",
+              "example": ""
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "lastStatusChangeAt": {
           "type": "string",
@@ -3849,8 +3933,15 @@
           }
         },
         "lostReasonId": {
-          "type": "string",
-          "example": "zT46WSCPbudrq4zhWMk6"
+          "anyOf": [
+            {
+              "type": "string",
+              "example": "zT46WSCPbudrq4zhWMk6"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "customFields": {
           "type": "array",
@@ -5873,7 +5964,18 @@
           }
         },
         "required": ["startTime", "endTime"],
-        "type": "object"
+        "type": "object",
+        "anyOf": [
+          {
+            "required": ["calendarId"]
+          },
+          {
+            "required": ["groupId"]
+          },
+          {
+            "required": ["userId"]
+          }
+        ]
       },
       "locationPlacements": ["query"],
       "locationParameterNames": {
@@ -5974,7 +6076,18 @@
           }
         },
         "required": ["startTime", "endTime"],
-        "type": "object"
+        "type": "object",
+        "anyOf": [
+          {
+            "required": ["calendarId"]
+          },
+          {
+            "required": ["groupId"]
+          },
+          {
+            "required": ["userId"]
+          }
+        ]
       },
       "locationPlacements": ["query"],
       "locationParameterNames": {
@@ -8250,6 +8363,32 @@
       "responseMode": "json",
       "requiredScope": "contacts.write"
     },
+    "conversations:cancel-scheduled-email-message": {
+      "apiVersion": "2021-07-28",
+      "bodyParameters": [],
+      "inputSchema": {
+        "additionalProperties": false,
+        "properties": {
+          "emailMessageId": {
+            "example": "ve9EPM428h8vShlRW1KT",
+            "type": "string"
+          }
+        },
+        "required": ["emailMessageId"],
+        "type": "object"
+      },
+      "locationPlacements": [],
+      "locationParameterNames": {},
+      "method": "DELETE",
+      "outputSchema": {
+        "$ref": "#/$defs/conversations.CancelScheduledResponseDto"
+      },
+      "path": "/conversations/messages/email/{emailMessageId}/schedule",
+      "pathParameters": ["emailMessageId"],
+      "queryParameters": [],
+      "responseMode": "json",
+      "requiredScope": "conversations/message.write"
+    },
     "conversations:cancel-scheduled-message": {
       "apiVersion": "2021-04-15",
       "bodyParameters": [],
@@ -9844,7 +9983,7 @@
             "example": "7915dedc-8f18-44d5-8bc3-77c04e994a10"
           },
           "monetaryValue": {
-            "type": "object",
+            "type": "number",
             "example": 220
           },
           "assignedTo": {

package/src/highlevel/openapi-types.generated.ts

@@ -1274,7 +1274,11 @@ export namespace HighLevelCalendars {
          * This is only to set the standard availability. For custom
          * availability, use the availabilities property
          */
-        openHours?: components["schemas"]["OpenHour"][]
+        openHours?:
+          | components["schemas"]["OpenHour"][]
+          | {
+              [key: string]: unknown
+            }
         /**
          * Enable recurring appointments for the calendars. Please note that
          * only one member should be added in the calendar to enable this
@@ -1391,30 +1395,30 @@ export namespace HighLevelCalendars {
          * @example
          *   9NkT25Vor1v4aQatFsv2
          */
-        contactId: string
+        contactId?: string
         /**
          * Group ID
          *
          * @example
          *   9NkT25Vor1v4aQatFsv2
          */
-        groupId: string
+        groupId?: string
         /**
          * Appointment Status
          *
          * @example
          *   confirmed
          */
-        appointmentStatus: string
+        appointmentStatus?: string
         /**
          * AssignedUser - the primary owner of an appointment
          *
          * @example
          *   YlWd2wuCAZQzh2cH1fVZ
          */
-        assignedUserId: string
+        assignedUserId?: string
         /** Users - the secondary owners of an appointment. */
-        users: string[]
+        users?: string[]
         /**
          * Notes
          *
@@ -1448,28 +1452,28 @@ export namespace HighLevelCalendars {
          * @example
          *   2023-09-25T16:00:00+05:30
          */
-        startTime: Record<string, never>
+        startTime: string
         /**
          * End Time
          *
          * @example
          *   2023-09-25T16:00:00+05:30
          */
-        endTime: Record<string, never>
+        endTime: string
         /**
          * Date Added
          *
          * @example
          *   2023-09-25T16:00:00+05:30
          */
-        dateAdded: Record<string, never>
+        dateAdded: string
         /**
          * Date Updated
          *
          * @example
          *   2023-09-25T16:00:00+05:30
          */
-        dateUpdated: Record<string, never>
+        dateUpdated: string
         /** Ids of associated resources rooms and/or equipments */
         assignedResources?: string[]
         /** Appointment booked by metadata */
@@ -1729,9 +1733,9 @@ export namespace HighLevelCalendars {
       }
       CreatedOrUpdatedBy: {
         /** The ID of the user who created or updated the appointment */
-        userId?: string
+        userId?: string | null
         /** The source of the appointment */
-        source: string
+        source?: string
       }
       DeleteAppointmentSchema: Record<string, never>
       DeleteEventSuccessfulResponseDto: {
@@ -3211,7 +3215,7 @@ export namespace HighLevelContacts {
          * @example
          *   Asia / Calcutta
          */
-        timezone?: string
+        timezone?: string | null
         /**
          * @example
          *   DE
@@ -5152,6 +5156,28 @@ export namespace HighLevelConversations {
       patch?: never
       trace?: never
     }
+    "/conversations/messages/email/{emailMessageId}/schedule": {
+      parameters: {
+        query?: never
+        header?: never
+        path?: never
+        cookie?: never
+      }
+      get?: never
+      put?: never
+      post?: never
+      /**
+       * Cancel a scheduled email message.
+       *
+       * Post the messageId for the API to delete a scheduled email message. <br
+       * />
+       */
+      delete: operations["cancel-scheduled-email-message"]
+      options?: never
+      head?: never
+      patch?: never
+      trace?: never
+    }
     "/conversations/messages/{id}": {
       parameters: {
         query?: never
@@ -5536,7 +5562,7 @@ export namespace HighLevelConversations {
          * @example
          *   This is a sample message body
          */
-        lastMessageBody: string
+        lastMessageBody?: string
         /**
          * Channel/type of the most recent message (SMS, Email, Call, etc)
          *
@@ -5588,6 +5614,7 @@ export namespace HighLevelConversations {
           | "TYPE_ACTIVITY_WHATSAPP"
           | "TYPE_FORM_SUBMISSION"
           | "TYPE_SMS_REACTION"
+          | "TYPE_NO_SHOW"
         /**
          * Primary channel/type of the conversation (Phone, Email, etc)
          *
@@ -6644,6 +6671,29 @@ export namespace HighLevelConversations {
         }
       }
     }
+    "cancel-scheduled-email-message": {
+      parameters: {
+        query?: never
+        header?: never
+        path: {
+          /** Email Message Id */
+          emailMessageId: string
+        }
+        cookie?: never
+      }
+      requestBody?: never
+      responses: {
+        /** The scheduled email message was cancelled successfully */
+        200: {
+          headers: {
+            [name: string]: unknown
+          }
+          content: {
+            "application/json": components["schemas"]["CancelScheduledResponseDto"]
+          }
+        }
+      }
+    }
     "get-message": {
       parameters: {
         query?: never
@@ -7825,7 +7875,16 @@ export namespace HighLevelOpportunities {
          *   new pipeline()
          */
         name?: string
-        stages?: unknown[][]
+        stages?: ({
+          id: string
+          name: string
+          position?: number
+          showInFunnel?: boolean
+          showInPieChart?: boolean
+          stageWinProbability?: number
+        } & {
+          [key: string]: unknown
+        })[]
         /**
          * @example
          *   false
@@ -7874,12 +7933,12 @@ export namespace HighLevelOpportunities {
          * @example
          *   3
          */
-        nextPage?: number
+        nextPage?: number | string | null
         /**
          * @example
          *   1
          */
-        prevPage?: number
+        prevPage?: number | null
       }
       SearchOpportunitiesContactResponseSchema: {
         /**
@@ -7896,7 +7955,7 @@ export namespace HighLevelOpportunities {
          * @example
          *   Tesla Inc
          */
-        companyName?: string
+        companyName?: string | null
         /**
          * @example
          *   john@deo.com
@@ -7906,7 +7965,7 @@ export namespace HighLevelOpportunities {
          * @example
          *   +1202-555-0107
          */
-        phone?: string
+        phone?: string | null
         tags?: string[]
       }
       SearchOpportunitiesResponseSchema: {
@@ -7939,13 +7998,13 @@ export namespace HighLevelOpportunities {
          * @example
          *   zT46WSCPbudrq4zhWMk6
          */
-        assignedTo?: string
+        assignedTo?: string | null
         /**
          * @example
          *   open
          */
         status?: string
-        source?: string
+        source?: string | null
         /**
          * @example
          *   2021-08-03T04:55:17.355Z
@@ -7994,7 +8053,7 @@ export namespace HighLevelOpportunities {
          * @example
          *   zT46WSCPbudrq4zhWMk6
          */
-        lostReasonId?: string
+        lostReasonId?: string | null
         customFields?: components["schemas"]["CustomFieldResponseSchema"][]
         followers?: unknown[][]
         externalObjectId?: string
@@ -8115,7 +8174,7 @@ export namespace HighLevelOpportunities {
          * @example
          *   220
          */
-        monetaryValue?: Record<string, never>
+        monetaryValue?: number
         /**
          * @example
          *   082goXVW3lIExEQPOnd3
@@ -9906,6 +9965,7 @@ export interface HighLevelOperationMap {
   "conversations:get-message": HighLevelConversations.operations["get-message"]
   "conversations:send-a-new-message": HighLevelConversations.operations["send-a-new-message"]
   "conversations:cancel-scheduled-message": HighLevelConversations.operations["cancel-scheduled-message"]
+  "conversations:cancel-scheduled-email-message": HighLevelConversations.operations["cancel-scheduled-email-message"]
   "conversations:get-message-recording": HighLevelConversations.operations["get-message-recording"]
   "conversations:get-message-transcription": HighLevelConversations.operations["get-message-transcription"]
   "forms:get-forms": HighLevelForms.operations["get-forms"]