@awell-health/awell-extensions 2.1.89 → 2.1.91

package/dist/extensions/text-em-all/actions/createSMSBroadcast/__testdata__/CreateSMSBroadcast.mock.d.ts

@@ -1,4 +1,7 @@
-export declare const CreateSMSBroadcastMockResponse: {
+/**
+ * Mock response for successful broadcast creation.
+ */
+export declare const CreateSMSBroadcastSuccessMockResponse: {
     status: number;
     statusText: string;
     headers: {
@@ -35,21 +38,40 @@ export declare const CreateSMSBroadcastMockResponse: {
             State: null;
             Permissions: null;
         };
-        RetryTimes: number;
-        CallThrottle: number;
-        LivePersonTotal: number;
-        AnsweringMachineTotal: number;
-        BusyNoAnswerTotal: number;
-        InvalidNumberTotal: number;
-        SurveyResponseTotal: number;
-        TransferTotal: number;
-        SurveyResponses: null;
-        MaxMessageLength: number;
-        MessageRecordingInstruction: null;
-        EstimatedDuration: number;
-        EstimatedCompletion: null;
-        ExcludedDaysIgnored: boolean;
-        CallingWindowIgnored: boolean;
-        NotEnoughTimeToComplete: boolean;
+    };
+};
+/**
+ * Mock response for invalid/opted-out phone number.
+ * ErrorCode 3005 = NoValidBroadcastContacts
+ */
+export declare const InvalidNumberMockResponse: {
+    status: number;
+    statusText: string;
+    data: {
+        ErrorCode: number;
+        ErrorName: string;
+        ErrorType: string;
+        Message: string;
+    };
+};
+/**
+ * Mock response for rate limiting (429).
+ */
+export declare const RateLimitMockResponse: {
+    status: number;
+    statusText: string;
+    data: {};
+};
+/**
+ * Mock response for generic API error.
+ */
+export declare const GenericErrorMockResponse: {
+    status: number;
+    statusText: string;
+    data: {
+        ErrorCode: number;
+        ErrorName: string;
+        ErrorType: string;
+        Message: string;
     };
 };

package/dist/extensions/text-em-all/actions/createSMSBroadcast/__testdata__/CreateSMSBroadcast.mock.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateSMSBroadcastMockResponse = void 0;
-exports.CreateSMSBroadcastMockResponse = {
+exports.GenericErrorMockResponse = exports.RateLimitMockResponse = exports.InvalidNumberMockResponse = exports.CreateSMSBroadcastSuccessMockResponse = void 0;
+/**
+ * Mock response for successful broadcast creation.
+ */
+exports.CreateSMSBroadcastSuccessMockResponse = {
     status: 200,
     statusText: 'OK',
     headers: {
@@ -38,22 +41,41 @@ exports.CreateSMSBroadcastMockResponse = {
             State: null,
             Permissions: null,
         },
-        RetryTimes: 1,
-        CallThrottle: 0,
-        LivePersonTotal: 0,
-        AnsweringMachineTotal: 0,
-        BusyNoAnswerTotal: 0,
-        InvalidNumberTotal: 0,
-        SurveyResponseTotal: 0,
-        TransferTotal: 0,
-        SurveyResponses: null,
-        MaxMessageLength: 30,
-        MessageRecordingInstruction: null,
-        EstimatedDuration: 0,
-        EstimatedCompletion: null,
-        ExcludedDaysIgnored: false,
-        CallingWindowIgnored: false,
-        NotEnoughTimeToComplete: false,
+    },
+};
+/**
+ * Mock response for invalid/opted-out phone number.
+ * ErrorCode 3005 = NoValidBroadcastContacts
+ */
+exports.InvalidNumberMockResponse = {
+    status: 400,
+    statusText: 'Bad Request',
+    data: {
+        ErrorCode: 3005,
+        ErrorName: 'NoValidBroadcastContacts',
+        ErrorType: 'Informational',
+        Message: 'Unable to create broadcast. None of the contacts are able to receive text messages.',
+    },
+};
+/**
+ * Mock response for rate limiting (429).
+ */
+exports.RateLimitMockResponse = {
+    status: 429,
+    statusText: 'Too Many Requests',
+    data: {},
+};
+/**
+ * Mock response for generic API error.
+ */
+exports.GenericErrorMockResponse = {
+    status: 400,
+    statusText: 'Bad Request',
+    data: {
+        ErrorCode: 9999,
+        ErrorName: 'SomeOtherError',
+        ErrorType: 'Error',
+        Message: 'Something went wrong',
     },
 };
 //# sourceMappingURL=CreateSMSBroadcast.mock.js.map

package/dist/extensions/text-em-all/actions/createSMSBroadcast/__testdata__/CreateSMSBroadcast.mock.js.map

@@ -1 +1 @@
-{"version":3,"file":"CreateSMSBroadcast.mock.js","sourceRoot":"","sources":["../../../../../../extensions/text-em-all/actions/createSMSBroadcast/__testdata__/CreateSMSBroadcast.mock.ts"],"names":[],"mappings":";;;AAEa,QAAA,8BAA8B,GAAG;IAC5C,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE;QACP,QAAQ,EAAE,oDAAoD;KAC/D;IACD,IAAI,EAAE;QACJ,GAAG,EAAE,yBAAyB;QAC9B,mBAAmB,EAAE,iCAAiC;QACtD,WAAW,EAAE,QAAQ;QACrB,aAAa,EAAE,eAAe;QAC9B,aAAa,EAAE,KAAK;QACpB,eAAe,EAAE,uBAAuB;QACxC,uBAAuB,EAAE,WAAW;QACpC,WAAW,EAAE,0BAA0B;QACvC,SAAS,EAAE,0BAA0B;QACrC,aAAa,EAAE,IAAI;QACnB,YAAY,EAAE,YAAY;QAC1B,WAAW,EAAE,4CAA4C;QACzD,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,CAAC;QAChB,gBAAgB,EAAE,CAAC;QACnB,cAAc,EAAE,CAAC;QACjB,IAAI,EAAE;YACJ,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;YACnB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,IAAI;SAClB;QACD,UAAU,EAAE,CAAC;QACb,YAAY,EAAE,CAAC;QACf,eAAe,EAAE,CAAC;QAClB,qBAAqB,EAAE,CAAC;QACxB,iBAAiB,EAAE,CAAC;QACpB,kBAAkB,EAAE,CAAC;QACrB,mBAAmB,EAAE,CAAC;QACtB,aAAa,EAAE,CAAC;QAChB,eAAe,EAAE,IAAI;QACrB,gBAAgB,EAAE,EAAE;QACpB,2BAA2B,EAAE,IAAI;QACjC,iBAAiB,EAAE,CAAC;QACpB,mBAAmB,EAAE,IAAI;QACzB,mBAAmB,EAAE,KAAK;QAC1B,oBAAoB,EAAE,KAAK;QAC3B,uBAAuB,EAAE,KAAK;KAC/B;CAC+B,CAAA"}
+{"version":3,"file":"CreateSMSBroadcast.mock.js","sourceRoot":"","sources":["../../../../../../extensions/text-em-all/actions/createSMSBroadcast/__testdata__/CreateSMSBroadcast.mock.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,qCAAqC,GAAG;IACnD,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE;QACP,QAAQ,EAAE,oDAAoD;KAC/D;IACD,IAAI,EAAE;QACJ,GAAG,EAAE,yBAAyB;QAC9B,mBAAmB,EAAE,iCAAiC;QACtD,WAAW,EAAE,QAAQ;QACrB,aAAa,EAAE,eAAe;QAC9B,aAAa,EAAE,KAAK;QACpB,eAAe,EAAE,uBAAuB;QACxC,uBAAuB,EAAE,WAAW;QACpC,WAAW,EAAE,0BAA0B;QACvC,SAAS,EAAE,0BAA0B;QACrC,aAAa,EAAE,IAAI;QACnB,YAAY,EAAE,YAAY;QAC1B,WAAW,EAAE,4CAA4C;QACzD,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,CAAC;QAChB,gBAAgB,EAAE,CAAC;QACnB,cAAc,EAAE,CAAC;QACjB,IAAI,EAAE;YACJ,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;YACnB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,IAAI;SAClB;KACF;CAC+B,CAAA;AAElC;;;GAGG;AACU,QAAA,yBAAyB,GAAG;IACvC,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE;QACJ,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,0BAA0B;QACrC,SAAS,EAAE,eAAe;QAC1B,OAAO,EACL,qFAAqF;KACxF;CAC+B,CAAA;AAElC;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,mBAAmB;IAC/B,IAAI,EAAE,EAAE;CACwB,CAAA;AAElC;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,MAAM,EAAE,GAAG;IACX,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE;QACJ,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,gBAAgB;QAC3B,SAAS,EAAE,OAAO;QAClB,OAAO,EAAE,sBAAsB;KAChC;CAC+B,CAAA"}

package/dist/extensions/text-em-all/actions/createSMSBroadcast/config.d.ts

@@ -38,7 +38,27 @@ export declare const fields: {
         description: string;
     };
 };
+/**
+ * Result types for SMS broadcast creation.
+ * - 'sent': Broadcast created successfully, message sent to carrier
+ * - 'invalid_number': Phone number is invalid or recipient cannot receive texts (opted out, etc.)
+ * - 'failed': Other API errors
+ */
+export declare const DeliveryResultType: {
+    readonly SENT: "sent";
+    readonly INVALID_NUMBER: "invalid_number";
+    readonly FAILED: "failed";
+};
+export type DeliveryResult = (typeof DeliveryResultType)[keyof typeof DeliveryResultType];
 export declare const dataPoints: {
+    /**
+     * Whether the SMS was sent successfully.
+     * true = message sent to carrier, false = failed (invalid number, opted out, etc.)
+     */
+    success: {
+        key: string;
+        valueType: "boolean";
+    };
     broadcastId: {
         key: string;
         valueType: "number";
@@ -59,6 +79,25 @@ export declare const dataPoints: {
         key: string;
         valueType: "string";
     };
+    /**
+     * The result of the SMS broadcast creation.
+     * Possible values:
+     * - 'sent': Broadcast created, message sent to carrier for delivery
+     * - 'invalid_number': Phone number is invalid or recipient cannot receive texts
+     * - 'failed': Other API errors
+     */
+    deliveryResult: {
+        key: string;
+        valueType: "string";
+    };
+    /**
+     * Additional details about the result.
+     * Contains the error message from Text-Em-All for failed requests.
+     */
+    deliveryResultDetails: {
+        key: string;
+        valueType: "string";
+    };
 };
 export declare const FieldsSchema: z.ZodObject<{
     broadcastName: z.ZodString;

package/dist/extensions/text-em-all/actions/createSMSBroadcast/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldsSchema = exports.dataPoints = exports.fields = void 0;
+exports.FieldsSchema = exports.dataPoints = exports.DeliveryResultType = exports.fields = void 0;
 const zod_1 = require("zod");
 const extensions_core_1 = require("@awell-health/extensions-core");
 const libphonenumber_js_1 = require("libphonenumber-js");
@@ -47,7 +47,26 @@ exports.fields = {
         description: 'The time the broadcast should start. Will default to start immediately. If provided must be a datetime as ISO 8601 string and time to send the message in UTC',
     },
 };
+/**
+ * Result types for SMS broadcast creation.
+ * - 'sent': Broadcast created successfully, message sent to carrier
+ * - 'invalid_number': Phone number is invalid or recipient cannot receive texts (opted out, etc.)
+ * - 'failed': Other API errors
+ */
+exports.DeliveryResultType = {
+    SENT: 'sent',
+    INVALID_NUMBER: 'invalid_number',
+    FAILED: 'failed',
+};
 exports.dataPoints = {
+    /**
+     * Whether the SMS was sent successfully.
+     * true = message sent to carrier, false = failed (invalid number, opted out, etc.)
+     */
+    success: {
+        key: 'success',
+        valueType: 'boolean',
+    },
     broadcastId: {
         key: 'broadcastId',
         valueType: 'number',
@@ -68,6 +87,25 @@ exports.dataPoints = {
         key: 'broadcastStartDate',
         valueType: 'string',
     },
+    /**
+     * The result of the SMS broadcast creation.
+     * Possible values:
+     * - 'sent': Broadcast created, message sent to carrier for delivery
+     * - 'invalid_number': Phone number is invalid or recipient cannot receive texts
+     * - 'failed': Other API errors
+     */
+    deliveryResult: {
+        key: 'deliveryResult',
+        valueType: 'string',
+    },
+    /**
+     * Additional details about the result.
+     * Contains the error message from Text-Em-All for failed requests.
+     */
+    deliveryResultDetails: {
+        key: 'deliveryResultDetails',
+        valueType: 'string',
+    },
 };
 exports.FieldsSchema = zod_1.z.object({
     broadcastName: zod_1.z.string(),

package/dist/extensions/text-em-all/actions/createSMSBroadcast/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../extensions/text-em-all/actions/createSMSBroadcast/config.ts"],"names":[],"mappings":";;;;;;AAAA,6BAAuB;AAEvB,mEAMsC;AACtC,yDAAoD;AACpD,mCAA8B;AAC9B,6DAAoC;AAEvB,QAAA,MAAM,GAAG;IACpB,aAAa,EAAE;QACb,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,4BAA4B;KAC1C;IACD,WAAW,EAAE;QACX,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,UAAU,EAAE,4BAAU,CAAC,KAAK;QAC5B,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,+GAA+G;KAClH;IACD,WAAW,EAAE;QACX,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,4GAA4G;KAC/G;IACD,YAAY,EAAE;QACZ,EAAE,EAAE,cAAc;QAClB,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,2BAAS,CAAC,OAAO;QACvB,QAAQ,EAAE,KAAK;QACf,WAAW,EACT,8HAA8H;KACjI;IACD,SAAS,EAAE;QACT,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,KAAK;QACf,WAAW,EACT,+JAA+J;KAClK;CACe,CAAA;AAEL,QAAA,UAAU,GAAG;IACxB,WAAW,EAAE;QACX,GAAG,EAAE,aAAa;QAClB,SAAS,EAAE,QAAQ;KACpB;IACD,eAAe,EAAE;QACf,GAAG,EAAE,iBAAiB;QACtB,SAAS,EAAE,QAAQ;KACpB;IACD,mBAAmB,EAAE;QACnB,GAAG,EAAE,qBAAqB;QAC1B,SAAS,EAAE,QAAQ;KACpB;IACD,uBAAuB,EAAE;QACvB,GAAG,EAAE,yBAAyB;QAC9B,SAAS,EAAE,QAAQ;KACpB;IACD,kBAAkB,EAAE;QAClB,GAAG,EAAE,oBAAoB;QACzB,SAAS,EAAE,QAAQ;KACpB;CAC4C,CAAA;AAElC,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;IACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1C,MAAM,YAAY,GAAG,IAAA,oCAAgB,EAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA,CAAC,uCAAuC;IAChF,CAAC,CAAC;IACF,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,gCAAc,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;QACtD,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,SAAS,CAAA;QAChD,wCAAwC;QACxC,OAAO,IAAA,gBAAM,EAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAA;IAClD,CAAC,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../extensions/text-em-all/actions/createSMSBroadcast/config.ts"],"names":[],"mappings":";;;;;;AAAA,6BAAuB;AAEvB,mEAMsC;AACtC,yDAAoD;AACpD,mCAA8B;AAC9B,6DAAoC;AAEvB,QAAA,MAAM,GAAG;IACpB,aAAa,EAAE;QACb,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,4BAA4B;KAC1C;IACD,WAAW,EAAE;QACX,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,UAAU,EAAE,4BAAU,CAAC,KAAK;QAC5B,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,+GAA+G;KAClH;IACD,WAAW,EAAE;QACX,EAAE,EAAE,aAAa;QACjB,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,4GAA4G;KAC/G;IACD,YAAY,EAAE;QACZ,EAAE,EAAE,cAAc;QAClB,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,2BAAS,CAAC,OAAO;QACvB,QAAQ,EAAE,KAAK;QACf,WAAW,EACT,8HAA8H;KACjI;IACD,SAAS,EAAE;QACT,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,KAAK;QACf,WAAW,EACT,+JAA+J;KAClK;CACe,CAAA;AAElB;;;;;GAKG;AACU,QAAA,kBAAkB,GAAG;IAChC,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,gBAAgB;IAChC,MAAM,EAAE,QAAQ;CACR,CAAA;AAKG,QAAA,UAAU,GAAG;IACxB;;;OAGG;IACH,OAAO,EAAE;QACP,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,SAAS;KACrB;IACD,WAAW,EAAE;QACX,GAAG,EAAE,aAAa;QAClB,SAAS,EAAE,QAAQ;KACpB;IACD,eAAe,EAAE;QACf,GAAG,EAAE,iBAAiB;QACtB,SAAS,EAAE,QAAQ;KACpB;IACD,mBAAmB,EAAE;QACnB,GAAG,EAAE,qBAAqB;QAC1B,SAAS,EAAE,QAAQ;KACpB;IACD,uBAAuB,EAAE;QACvB,GAAG,EAAE,yBAAyB;QAC9B,SAAS,EAAE,QAAQ;KACpB;IACD,kBAAkB,EAAE;QAClB,GAAG,EAAE,oBAAoB;QACzB,SAAS,EAAE,QAAQ;KACpB;IACD;;;;;;OAMG;IACH,cAAc,EAAE;QACd,GAAG,EAAE,gBAAgB;QACrB,SAAS,EAAE,QAAQ;KACpB;IACD;;;OAGG;IACH,qBAAqB,EAAE;QACrB,GAAG,EAAE,uBAAuB;QAC5B,SAAS,EAAE,QAAQ;KACpB;CAC4C,CAAA;AAElC,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;IACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1C,MAAM,YAAY,GAAG,IAAA,oCAAgB,EAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA,CAAC,uCAAuC;IAChF,CAAC,CAAC;IACF,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,gCAAc,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;QACtD,IAAI,IAAA,cAAK,EAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,SAAS,CAAA;QAChD,wCAAwC;QACxC,OAAO,IAAA,gBAAM,EAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAA;IAClD,CAAC,CAAC;CACH,CAAC,CAAA"}

package/dist/extensions/text-em-all/actions/createSMSBroadcast/createSMSBroadcast.js

@@ -6,15 +6,38 @@ const extensions_core_1 = require("@awell-health/extensions-core");
 const config_1 = require("./config");
 const settings_1 = require("../../settings");
 const lib_1 = require("../../lib");
+/**
+ * Known Text-Em-All error codes and their meanings.
+ */
+const ERROR_CODES = {
+    NO_VALID_CONTACTS: 3005, // "NoValidBroadcastContacts" - invalid/opted-out number
+};
+/**
+ * Determines the delivery result based on an error response.
+ */
+function getResultFromError(errorCode, errorName, message) {
+    // Handle known error codes
+    if (errorCode === ERROR_CODES.NO_VALID_CONTACTS || errorName === 'NoValidBroadcastContacts') {
+        return {
+            result: config_1.DeliveryResultType.INVALID_NUMBER,
+            details: message !== null && message !== void 0 ? message : 'Phone number is invalid or recipient cannot receive text messages',
+        };
+    }
+    // Default for unknown errors
+    return {
+        result: config_1.DeliveryResultType.FAILED,
+        details: message !== null && message !== void 0 ? message : 'Broadcast creation failed',
+    };
+}
 exports.createSMSBroadcast = {
     key: 'createSMSBroadcast',
     title: 'Send a new SMS broadcast',
-    description: 'A broadcast is a feature that allows you to send a text message to a recipient at specific time',
+    description: 'Send a text message to a recipient. Returns the delivery result (sent, invalid_number, failed, etc.) for triage purposes.',
     category: extensions_core_1.Category.COMMUNICATION,
     fields: config_1.fields,
     dataPoints: config_1.dataPoints,
     previewable: true,
-    onEvent: async ({ payload, onComplete, onError, helpers }) => {
+    onEvent: async ({ payload, onComplete, onError }) => {
         const { fields: { broadcastName: BroadcastName, phoneNumber, textMessage: TextMessage, textNumberID: TextNumberID, startDate: StartDate, }, settings, } = (0, extensions_core_1.validate)({
             schema: zod_1.z.object({ fields: config_1.FieldsSchema, settings: settings_1.SettingsSchema }),
             payload,
@@ -30,54 +53,86 @@ exports.createSMSBroadcast = {
         };
         const resp = await client.createBroadcast(request);
         const data = resp.data;
+        // Success - broadcast created
         if (resp.status === 200 && 'BroadcastID' in data) {
             await onComplete({
                 events: [
                     {
                         date: new Date().toISOString(),
                         text: {
-                            en: `Broadcast created. Response: ${JSON.stringify(data)}`,
+                            en: `SMS broadcast created successfully`,
                         },
                     },
                 ],
                 data_points: {
+                    success: 'true',
                     broadcastId: data.BroadcastID.toString(),
                     broadcastStatus: data.BroadcastStatus,
                     uriBroadcastDetails: data.UriBroadcastDetails,
                     broadcastStatusCategory: data.BroadcastStatusCategory,
                     broadcastStartDate: data.StartDate,
+                    deliveryResult: config_1.DeliveryResultType.SENT,
+                    deliveryResultDetails: 'Message sent to carrier for delivery',
                 },
             });
+            return;
         }
-        else if (resp.status === 400) {
-            const errorMessage = 'Message' in data ? data.Message : 'Unknown error';
+        // Handle rate limiting (429)
+        if (resp.status === 429) {
             await onError({
                 events: [
                     {
                         date: new Date().toISOString(),
-                        text: { en: `Broadcast creation failed: ${errorMessage}` },
+                        text: { en: 'Rate limit exceeded. Please try again later.' },
                         error: {
-                            category: 'BAD_REQUEST',
-                            message: 'Broadcast creation failed',
+                            category: 'SERVER_ERROR',
+                            message: 'Rate limit exceeded (429)',
                         },
                     },
                 ],
             });
+            return;
         }
-        else {
-            await onError({
+        // Handle API errors (400, etc.) - these are valid results, not failures
+        if ('ErrorCode' in data || 'ErrorName' in data || 'Message' in data) {
+            const errorData = data;
+            const { result, details } = getResultFromError(errorData.ErrorCode, errorData.ErrorName, errorData.Message);
+            // Return as success with the error result - this is valid triage data
+            await onComplete({
                 events: [
                     {
                         date: new Date().toISOString(),
-                        text: { en: 'Broadcast creation failed' },
-                        error: {
-                            category: 'SERVER_ERROR',
-                            message: 'Broadcast creation failed',
+                        text: {
+                            en: `SMS broadcast result: ${result} - ${details}`,
                         },
                     },
                 ],
+                data_points: {
+                    success: 'false',
+                    broadcastId: '',
+                    broadcastStatus: '',
+                    uriBroadcastDetails: '',
+                    broadcastStatusCategory: '',
+                    broadcastStartDate: '',
+                    deliveryResult: result,
+                    deliveryResultDetails: details,
+                },
             });
+            return;
         }
+        // Unknown error
+        await onError({
+            events: [
+                {
+                    date: new Date().toISOString(),
+                    text: { en: 'Broadcast creation failed with unknown error' },
+                    error: {
+                        category: 'SERVER_ERROR',
+                        message: 'Broadcast creation failed',
+                    },
+                },
+            ],
+        });
     },
 };
 //# sourceMappingURL=createSMSBroadcast.js.map

package/dist/extensions/text-em-all/actions/createSMSBroadcast/createSMSBroadcast.js.map

@@ -1 +1 @@
-{"version":3,"file":"createSMSBroadcast.js","sourceRoot":"","sources":["../../../../../extensions/text-em-all/actions/createSMSBroadcast/createSMSBroadcast.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,mEAA+E;AAC/E,qCAA2D;AAC3D,6CAA8D;AAC9D,mCAA2C;AAE9B,QAAA,kBAAkB,GAI3B;IACF,GAAG,EAAE,oBAAoB;IACzB,KAAK,EAAE,0BAA0B;IACjC,WAAW,EACT,iGAAiG;IACnG,QAAQ,EAAE,0BAAQ,CAAC,aAAa;IAChC,MAAM,EAAN,eAAM;IACN,UAAU,EAAV,mBAAU;IACV,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAiB,EAAE;QAC1E,MAAM,EACJ,MAAM,EAAE,EACN,aAAa,EAAE,aAAa,EAC5B,WAAW,EACX,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,GACrB,EACD,QAAQ,GACT,GAAG,IAAA,0BAAQ,EAAC;YACX,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,qBAAY,EAAE,QAAQ,EAAE,yBAAc,EAAE,CAAC;YACpE,OAAO;SACR,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,IAAI,qBAAe,CAAC,QAAQ,CAAC,CAAA;QAC5C,MAAM,OAAO,GAAG;YACd,aAAa;YACb,aAAa,EAAE,KAAK;YACpB,WAAW;YACX,YAAY;YACZ,SAAS;YACT,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;SAC1C,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QAEtB,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YACjD,MAAM,UAAU,CAAC;gBACf,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE;4BACJ,EAAE,EAAE,gCAAgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;yBAC3D;qBACF;iBACF;gBACD,WAAW,EAAE;oBACX,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;oBACxC,eAAe,EAAE,IAAI,CAAC,eAAe;oBACrC,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;oBAC7C,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;oBACrD,kBAAkB,EAAE,IAAI,CAAC,SAAS;iBACnC;aACF,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAA;YACvE,MAAM,OAAO,CAAC;gBACZ,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,8BAA8B,YAAY,EAAE,EAAE;wBAC1D,KAAK,EAAE;4BACL,QAAQ,EAAE,aAAa;4BACvB,OAAO,EAAE,2BAA2B;yBACrC;qBACF;iBACF;aACF,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,CAAC;gBACZ,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,2BAA2B,EAAE;wBACzC,KAAK,EAAE;4BACL,QAAQ,EAAE,cAAc;4BACxB,OAAO,EAAE,2BAA2B;yBACrC;qBACF;iBACF;aACF,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CAC+C,CAAA"}
+{"version":3,"file":"createSMSBroadcast.js","sourceRoot":"","sources":["../../../../../extensions/text-em-all/actions/createSMSBroadcast/createSMSBroadcast.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AACvB,mEAA+E;AAC/E,qCAKiB;AACjB,6CAA8D;AAC9D,mCAA2C;AAE3C;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,iBAAiB,EAAE,IAAI,EAAE,wDAAwD;CACzE,CAAA;AAEV;;GAEG;AACH,SAAS,kBAAkB,CAAC,SAAkB,EAAE,SAAkB,EAAE,OAAgB;IAIlF,2BAA2B;IAC3B,IAAI,SAAS,KAAK,WAAW,CAAC,iBAAiB,IAAI,SAAS,KAAK,0BAA0B,EAAE,CAAC;QAC5F,OAAO;YACL,MAAM,EAAE,2BAAkB,CAAC,cAAc;YACzC,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,mEAAmE;SACxF,CAAA;IACH,CAAC;IAED,6BAA6B;IAC7B,OAAO;QACL,MAAM,EAAE,2BAAkB,CAAC,MAAM;QACjC,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,2BAA2B;KAChD,CAAA;AACH,CAAC;AAEY,QAAA,kBAAkB,GAI3B;IACF,GAAG,EAAE,oBAAoB;IACzB,KAAK,EAAE,0BAA0B;IACjC,WAAW,EACT,2HAA2H;IAC7H,QAAQ,EAAE,0BAAQ,CAAC,aAAa;IAChC,MAAM,EAAN,eAAM;IACN,UAAU,EAAV,mBAAU;IACV,WAAW,EAAE,IAAI;IACjB,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,EAAiB,EAAE;QACjE,MAAM,EACJ,MAAM,EAAE,EACN,aAAa,EAAE,aAAa,EAC5B,WAAW,EACX,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,GACrB,EACD,QAAQ,GACT,GAAG,IAAA,0BAAQ,EAAC;YACX,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,qBAAY,EAAE,QAAQ,EAAE,yBAAc,EAAE,CAAC;YACpE,OAAO;SACR,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,IAAI,qBAAe,CAAC,QAAQ,CAAC,CAAA;QAC5C,MAAM,OAAO,GAAG;YACd,aAAa;YACb,aAAa,EAAE,KAAK;YACpB,WAAW;YACX,YAAY;YACZ,SAAS;YACT,QAAQ,EAAE,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;SAC1C,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QAEtB,8BAA8B;QAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YACjD,MAAM,UAAU,CAAC;gBACf,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE;4BACJ,EAAE,EAAE,oCAAoC;yBACzC;qBACF;iBACF;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE,MAAM;oBACf,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;oBACxC,eAAe,EAAE,IAAI,CAAC,eAAe;oBACrC,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;oBAC7C,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;oBACrD,kBAAkB,EAAE,IAAI,CAAC,SAAS;oBAClC,cAAc,EAAE,2BAAkB,CAAC,IAAI;oBACvC,qBAAqB,EAAE,sCAAsC;iBAC9D;aACF,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,6BAA6B;QAC7B,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,MAAM,OAAO,CAAC;gBACZ,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,8CAA8C,EAAE;wBAC5D,KAAK,EAAE;4BACL,QAAQ,EAAE,cAAc;4BACxB,OAAO,EAAE,2BAA2B;yBACrC;qBACF;iBACF;aACF,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,wEAAwE;QACxE,IAAI,WAAW,IAAI,IAAI,IAAI,WAAW,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACpE,MAAM,SAAS,GAAG,IAAoE,CAAA;YACtF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAC5C,SAAS,CAAC,SAAS,EACnB,SAAS,CAAC,SAAS,EACnB,SAAS,CAAC,OAAO,CAClB,CAAA;YAED,sEAAsE;YACtE,MAAM,UAAU,CAAC;gBACf,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE;4BACJ,EAAE,EAAE,yBAAyB,MAAM,MAAM,OAAO,EAAE;yBACnD;qBACF;iBACF;gBACD,WAAW,EAAE;oBACX,OAAO,EAAE,OAAO;oBAChB,WAAW,EAAE,EAAE;oBACf,eAAe,EAAE,EAAE;oBACnB,mBAAmB,EAAE,EAAE;oBACvB,uBAAuB,EAAE,EAAE;oBAC3B,kBAAkB,EAAE,EAAE;oBACtB,cAAc,EAAE,MAAM;oBACtB,qBAAqB,EAAE,OAAO;iBAC/B;aACF,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,gBAAgB;QAChB,MAAM,OAAO,CAAC;YACZ,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;oBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,8CAA8C,EAAE;oBAC5D,KAAK,EAAE;wBACL,QAAQ,EAAE,cAAc;wBACxB,OAAO,EAAE,2BAA2B;qBACrC;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CAC+C,CAAA"}

package/dist/extensions/text-em-all/actions/index.d.ts

@@ -58,5 +58,5 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "broadcastId" | "broadcastStatus" | "uriBroadcastDetails" | "broadcastStatusCategory" | "broadcastStartDate">;
+    }, "success" | "broadcastId" | "broadcastStatus" | "uriBroadcastDetails" | "broadcastStatusCategory" | "broadcastStartDate" | "deliveryResult" | "deliveryResultDetails">;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awell-health/awell-extensions",
-  "version": "2.1.89",
+  "version": "2.1.91",
   "packageManager": "yarn@4.5.3",
   "main": "dist/src/index.js",
   "repository": {