feat: update TwilioMessage schema to include enum for direction and status fields

Author: nicosammito

actions/twilio-action/schemas/twilio-api-v2010-openapi.filtered.json

@@ -41,8 +41,14 @@
             "description": "The number of segments that make up the complete message. SMS message bodies that exceed the [character limit](https://www.twilio.com/docs/glossary/what-sms-character-limit) are segmented and charged as multiple messages. Note: For messages sent via a Messaging Service, `num_segments` is initially `0`, since a sender hasn't yet been assigned."
           },
           "direction": {
-            "type": "object",
-            "additionalProperties": true
+            "type": "string",
+            "enum": [
+              "inbound",
+              "outbound-api",
+              "outbound-call",
+              "outbound-reply"
+            ],
+            "description": "The direction of the message. Can be: `inbound` for incoming messages, `outbound-api` for messages created by the REST API, `outbound-call` for messages created during a call, or `outbound-reply` for messages created in response to an incoming message."
           },
           "from": {
             "type": "string",
@@ -90,9 +96,6 @@
           },
           "account_sid": {
             "type": "string",
-            "minLength": 34,
-            "maxLength": 34,
-            "pattern": "^AC[0-9a-fA-F]{32}$",
             "nullable": true,
             "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with the Message resource"
           },
@@ -102,22 +105,31 @@
             "description": "The number of media files associated with the Message resource."
           },
           "status": {
-            "type": "object",
-            "additionalProperties": true
+            "type": "string",
+            "enum": [
+              "queued",
+              "sending",
+              "sent",
+              "failed",
+              "delivered",
+              "undelivered",
+              "receiving",
+              "received",
+              "accepted",
+              "scheduled",
+              "read",
+              "partially_delivered",
+              "canceled"
+            ],
+            "description": "The status of the Message. Possible values: `accepted`, `scheduled`, `canceled`, `queued`, `sending`, `sent`, `failed`, `delivered`, `undelivered`, `receiving`, `received`, or `read` (WhatsApp only). For more information, See [detailed descriptions](https://www.twilio.com/docs/sms/api/message-resource#message-status-values)."
           },
           "messaging_service_sid": {
             "type": "string",
-            "minLength": 34,
-            "maxLength": 34,
-            "pattern": "^MG[0-9a-fA-F]{32}$",
             "nullable": true,
             "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. A unique default value is assigned if a Messaging Service is not used."
           },
           "sid": {
             "type": "string",
-            "minLength": 34,
-            "maxLength": 34,
-            "pattern": "^(SM|MM)[0-9a-fA-F]{32}$",
             "nullable": true,
             "description": "The unique, Twilio-provided string that identifies the Message resource."
           },

actions/twilio-action/scripts/filterTwilioSpec.mjs

@@ -6,14 +6,23 @@
 //   - keeps `api.v2010.account.message`, re-exposed under the stable name
 //     `TwilioMessage` so the generated schema has a predictable identifier
 //     regardless of how openapi-zod-client would sanitize the dotted name
-//   - replaces $refs to any other component with a permissive untyped object,
-//     cutting the rest of the graph
+//   - inlines $refs that point at scalar/enum components (e.g. the
+//     `message_enum_direction` / `message_enum_status` string enums) so their
+//     type and allowed values survive instead of collapsing to an empty object
+//   - replaces every other ($ref to an object/array) component with a
+//     permissive untyped object, cutting the rest of the graph
+//   - drops `minLength` / `maxLength` / `pattern` string constraints: this is a
+//     schema for *parsing Twilio responses*, so it stays lenient (Postel's law)
+//     rather than rejecting a real response over an exact SID-format mismatch
 // Runs as part of "generate:twilio-schemas" right after the download.
 import {readFileSync, writeFileSync} from "node:fs";
 
 const SOURCE_NAME = "api.v2010.account.message";
 const TARGET_NAME = "TwilioMessage";
 
+// String validation constraints stripped for lenient response parsing.
+const DROPPED_VALIDATION_KEYS = new Set(["minLength", "maxLength", "pattern"]);
+
 const input = new URL("../schemas/twilio-api-v2010-openapi.json", import.meta.url);
 const output = new URL("../schemas/twilio-api-v2010-openapi.filtered.json", import.meta.url);
 
@@ -24,8 +33,9 @@ if (!(SOURCE_NAME in allSchemas)) {
     throw new Error(`Schema "${SOURCE_NAME}" not found in ${input}`);
 }
 
-// Rewrite $refs: self-references point at the renamed schema, every other
-// component reference is stubbed out as an untyped object.
+// Rewrite $refs: self-references point at the renamed schema, references to
+// scalar/enum components are inlined (so enum values survive), and every other
+// (object/array) component reference is stubbed out as an untyped object.
 const rewriteRefs = (node) => {
     if (Array.isArray(node)) {
         return node.map(rewriteRefs);
@@ -38,10 +48,18 @@ const rewriteRefs = (node) => {
                 if (match[1] === SOURCE_NAME) {
                     return {$ref: `#/components/schemas/${TARGET_NAME}`};
                 }
+                const target = allSchemas[match[1]];
+                if (target && target.type && target.type !== "object" && target.type !== "array") {
+                    return rewriteRefs(target);
+                }
                 return {type: "object", additionalProperties: true};
             }
         }
-        return Object.fromEntries(Object.entries(node).map(([key, value]) => [key, rewriteRefs(value)]));
+        return Object.fromEntries(
+            Object.entries(node)
+                .filter(([key]) => !DROPPED_VALIDATION_KEYS.has(key))
+                .map(([key, value]) => [key, rewriteRefs(value)]),
+        );
     }
     return node;
 };

actions/twilio-action/src/generated/twilio-schemas.ts

@@ -4,33 +4,37 @@ const TwilioMessage = z
   .object({
     body: z.string().nullable(),
     num_segments: z.string().nullable(),
-    direction: z.object({}).partial().passthrough(),
+    direction: z.enum([
+      "inbound",
+      "outbound-api",
+      "outbound-call",
+      "outbound-reply",
+    ]),
     from: z.string().nullable(),
     to: z.string().nullable(),
     date_updated: z.string().nullable(),
     price: z.string().nullable(),
     error_message: z.string().nullable(),
     uri: z.string().nullable(),
-    account_sid: z
-      .string()
-      .min(34)
-      .max(34)
-      .regex(/^AC[0-9a-fA-F]{32}$/)
-      .nullable(),
+    account_sid: z.string().nullable(),
     num_media: z.string().nullable(),
-    status: z.object({}).partial().passthrough(),
-    messaging_service_sid: z
-      .string()
-      .min(34)
-      .max(34)
-      .regex(/^MG[0-9a-fA-F]{32}$/)
-      .nullable(),
-    sid: z
-      .string()
-      .min(34)
-      .max(34)
-      .regex(/^(SM|MM)[0-9a-fA-F]{32}$/)
-      .nullable(),
+    status: z.enum([
+      "queued",
+      "sending",
+      "sent",
+      "failed",
+      "delivered",
+      "undelivered",
+      "receiving",
+      "received",
+      "accepted",
+      "scheduled",
+      "read",
+      "partially_delivered",
+      "canceled",
+    ]),
+    messaging_service_sid: z.string().nullable(),
+    sid: z.string().nullable(),
     date_sent: z.string().nullable(),
     date_created: z.string().nullable(),
     error_code: z.number().int().nullable(),