@automate.ax/integration-contracts 0.152.0 → 0.152.2

package/dist/highlevel/openapi-types.generated.d.ts

@@ -1224,7 +1224,9 @@ export declare 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
@@ -1341,30 +1343,30 @@ export declare 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
                  *
@@ -1398,28 +1400,28 @@ export declare 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 */
@@ -1677,9 +1679,9 @@ export declare 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: {
@@ -3115,12 +3117,12 @@ export declare namespace HighLevelContacts {
                  * @example
                  *   JohnDeo@gmail.com
                  */
-                email?: string;
+                email?: string | null;
                 /**
                  * @example
                  *   Asia / Calcutta
                  */
-                timezone?: string;
+                timezone?: string | null;
                 /**
                  * @example
                  *   DE
@@ -3130,7 +3132,7 @@ export declare namespace HighLevelContacts {
                  * @example
                  *   xyz form
                  */
-                source?: string;
+                source?: string | null;
                 /**
                  * @example
                  *   2020-10-29T09:31:30.255Z
@@ -3142,7 +3144,7 @@ export declare namespace HighLevelContacts {
                  * @example
                  *   641c094001436dbc2081e642
                  */
-                businessId?: string;
+                businessId?: string | null;
                 attributions?: components["schemas"]["AttributionSource"][];
                 /**
                  * @example
@@ -5030,6 +5032,28 @@ export declare 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;
@@ -5372,7 +5396,7 @@ export declare namespace HighLevelConversations {
                  * @example
                  *   This is a sample message body
                  */
-                lastMessageBody: string;
+                lastMessageBody?: string;
                 /**
                  * Channel/type of the most recent message (SMS, Email, Call, etc)
                  *
@@ -5381,7 +5405,7 @@ export declare namespace HighLevelConversations {
                  *
                  * @enum {string}
                  */
-                lastMessageType: "TYPE_CALL" | "TYPE_SMS" | "TYPE_RCS" | "TYPE_EMAIL" | "TYPE_SMS_REVIEW_REQUEST" | "TYPE_WEBCHAT" | "TYPE_SMS_NO_SHOW_REQUEST" | "TYPE_CAMPAIGN_SMS" | "TYPE_CAMPAIGN_CALL" | "TYPE_CAMPAIGN_EMAIL" | "TYPE_CAMPAIGN_VOICEMAIL" | "TYPE_FACEBOOK" | "TYPE_CAMPAIGN_FACEBOOK" | "TYPE_CAMPAIGN_MANUAL_CALL" | "TYPE_CAMPAIGN_MANUAL_SMS" | "TYPE_GMB" | "TYPE_CAMPAIGN_GMB" | "TYPE_REVIEW" | "TYPE_INSTAGRAM" | "TYPE_WHATSAPP" | "TYPE_CUSTOM_SMS" | "TYPE_CUSTOM_EMAIL" | "TYPE_CUSTOM_PROVIDER_SMS" | "TYPE_CUSTOM_PROVIDER_EMAIL" | "TYPE_IVR_CALL" | "TYPE_ACTIVITY_CONTACT" | "TYPE_ACTIVITY_INVOICE" | "TYPE_ACTIVITY_PAYMENT" | "TYPE_ACTIVITY_OPPORTUNITY" | "TYPE_LIVE_CHAT" | "TYPE_LIVE_CHAT_INFO_MESSAGE" | "TYPE_ACTIVITY_APPOINTMENT" | "TYPE_FACEBOOK_COMMENT" | "TYPE_INSTAGRAM_COMMENT" | "TYPE_CUSTOM_CALL" | "TYPE_INTERNAL_COMMENT" | "TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG" | "TYPE_TIKTOK" | "TYPE_TIKTOK_COMMENT" | "TYPE_ACTIVITY_WHATSAPP" | "TYPE_FORM_SUBMISSION" | "TYPE_SMS_REACTION";
+                lastMessageType: "TYPE_CALL" | "TYPE_SMS" | "TYPE_RCS" | "TYPE_EMAIL" | "TYPE_SMS_REVIEW_REQUEST" | "TYPE_WEBCHAT" | "TYPE_SMS_NO_SHOW_REQUEST" | "TYPE_CAMPAIGN_SMS" | "TYPE_CAMPAIGN_CALL" | "TYPE_CAMPAIGN_EMAIL" | "TYPE_CAMPAIGN_VOICEMAIL" | "TYPE_FACEBOOK" | "TYPE_CAMPAIGN_FACEBOOK" | "TYPE_CAMPAIGN_MANUAL_CALL" | "TYPE_CAMPAIGN_MANUAL_SMS" | "TYPE_GMB" | "TYPE_CAMPAIGN_GMB" | "TYPE_REVIEW" | "TYPE_INSTAGRAM" | "TYPE_WHATSAPP" | "TYPE_CUSTOM_SMS" | "TYPE_CUSTOM_EMAIL" | "TYPE_CUSTOM_PROVIDER_SMS" | "TYPE_CUSTOM_PROVIDER_EMAIL" | "TYPE_IVR_CALL" | "TYPE_ACTIVITY_CONTACT" | "TYPE_ACTIVITY_INVOICE" | "TYPE_ACTIVITY_PAYMENT" | "TYPE_ACTIVITY_OPPORTUNITY" | "TYPE_LIVE_CHAT" | "TYPE_LIVE_CHAT_INFO_MESSAGE" | "TYPE_ACTIVITY_APPOINTMENT" | "TYPE_FACEBOOK_COMMENT" | "TYPE_INSTAGRAM_COMMENT" | "TYPE_CUSTOM_CALL" | "TYPE_INTERNAL_COMMENT" | "TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG" | "TYPE_TIKTOK" | "TYPE_TIKTOK_COMMENT" | "TYPE_ACTIVITY_WHATSAPP" | "TYPE_FORM_SUBMISSION" | "TYPE_SMS_REACTION" | "TYPE_NO_SHOW";
                 /**
                  * Primary channel/type of the conversation (Phone, Email, etc)
                  *
@@ -5419,14 +5443,14 @@ export declare namespace HighLevelConversations {
                  * @example
                  *   johndoe@mailingdomain.com
                  */
-                email: string;
+                email?: string | null;
                 /**
                  * Primary phone number of the contact
                  *
                  * @example
                  *   ;+15550001234
                  */
-                phone: string;
+                phone?: string | null;
             };
             CreateConversationDto: {
                 /**
@@ -6103,7 +6127,9 @@ export declare namespace HighLevelConversations {
                  *
                  * @enum {string}
                  */
-                status: "delivered" | "failed" | "pending" | "read";
+                status?: "delivered" | "failed" | "pending" | "read";
+                /** Email conversation thread ID. */
+                threadId?: string;
             };
             StartAfterArrayNumberSchema: {
                 /**
@@ -6316,6 +6342,29 @@ export declare 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;
@@ -7467,7 +7516,16 @@ export declare 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
@@ -7516,12 +7574,12 @@ export declare namespace HighLevelOpportunities {
                  * @example
                  *   3
                  */
-                nextPage?: number;
+                nextPage?: number | string | null;
                 /**
                  * @example
                  *   1
                  */
-                prevPage?: number;
+                prevPage?: number | null;
             };
             SearchOpportunitiesContactResponseSchema: {
                 /**
@@ -7538,17 +7596,17 @@ export declare namespace HighLevelOpportunities {
                  * @example
                  *   Tesla Inc
                  */
-                companyName?: string;
+                companyName?: string | null;
                 /**
                  * @example
                  *   john@deo.com
                  */
-                email?: string;
+                email?: string | null;
                 /**
                  * @example
                  *   +1202-555-0107
                  */
-                phone?: string;
+                phone?: string | null;
                 tags?: string[];
             };
             SearchOpportunitiesResponseSchema: {
@@ -7581,13 +7639,13 @@ export declare 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
@@ -7636,7 +7694,7 @@ export declare namespace HighLevelOpportunities {
                  * @example
                  *   zT46WSCPbudrq4zhWMk6
                  */
-                lostReasonId?: string;
+                lostReasonId?: string | null;
                 customFields?: components["schemas"]["CustomFieldResponseSchema"][];
                 followers?: unknown[][];
                 externalObjectId?: string;
@@ -7753,7 +7811,7 @@ export declare namespace HighLevelOpportunities {
                  * @example
                  *   220
                  */
-                monetaryValue?: Record<string, never>;
+                monetaryValue?: number;
                 /**
                  * @example
                  *   082goXVW3lIExEQPOnd3
@@ -9136,6 +9194,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"];

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

@@ -509,6 +509,14 @@ export declare const HIGH_LEVEL_OPERATION_DEFINITIONS: readonly [{
     readonly product: "conversations";
     readonly replaySafety: HighLevelReplaySafety;
     readonly title: string;
+}, {
+    readonly alias: "cancelScheduledEmailMessage";
+    readonly description: string;
+    readonly exportName: "cancelScheduledHighLevelEmailMessage";
+    readonly operationId: "cancel-scheduled-email-message";
+    readonly product: "conversations";
+    readonly replaySafety: HighLevelReplaySafety;
+    readonly title: string;
 }, {
     readonly alias: "getMessageRecording";
     readonly description: string;

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.2",
   "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.2",
     "@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.
  *