OneSignal · onesignal-deploy · Jun 17, 2026
diff --git a/DefaultApi.md b/DefaultApi.md
diff --git a/apis/exception.ts b/apis/exception.ts
@@ -21,4 +21,58 @@ export class ApiException<T> extends Error {
         // Reference: https://github.com/microsoft/TypeScript-wiki/blob/main/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
         Object.setPrototypeOf(this, ApiException.prototype);
     }
+
+    /**
+     * The error messages carried by the response body, normalized to a flat
+     * string array regardless of which envelope shape the API returned
+     * (`{ errors: "..." }`, `{ errors: ["..."] }`, `{ errors: [{ code, title }] }`,
+     * or an object map such as `{ errors: { invalid_aliases: {...} } }`, which is
+     * surfaced as `"<key>: <value>"` entries). Returns an empty array when the
+     * body is not a recognizable error envelope. The raw body remains on `body`.
+     */
+    public get errorMessages(): string[] {
+        let parsed: any = this.body;
+        if (typeof parsed === "string") {
+            try {
+                parsed = JSON.parse(parsed);
+            } catch {
+                return [];
+            }
+        }
+        if (parsed === null || typeof parsed !== "object") {
+            return [];
+        }
+        const errors: any = parsed.errors;
+        if (typeof errors === "string") {
+            return [errors];
+        }
+        if (Array.isArray(errors)) {
+            return errors
+                .map((e: any) => {
+                    if (typeof e === "string") {
+                        return e;
+                    }
+                    if (e !== null && typeof e === "object") {
+                        const title = typeof e.title === "string" ? e.title : undefined;
+                        const code = typeof e.code === "string" ? e.code : (e.code != null ? String(e.code) : undefined);
+                        return title || code;
+                    }
+                    return undefined;
+                })
+                .filter((m: any): m is string => typeof m === "string");
+        }
+        if (errors !== null && typeof errors === "object") {
+            // Object-shaped envelopes (e.g. { invalid_aliases: {...} }) carry data
+            // under arbitrary keys; surface each so it isn't silently dropped. Key
+            // order is unspecified, so sort for deterministic output.
+            return Object.keys(errors)
+                .map((key: string) => {
+                    const value: any = errors[key];
+                    const rendered = typeof value === "string" ? value : JSON.stringify(value);
+                    return key + ": " + rendered;
+                })
+                .sort();
+        }
+        return [];
+    }
 }
diff --git a/dist/apis/exception.d.ts b/dist/apis/exception.d.ts
@@ -7,4 +7,5 @@ export declare class ApiException<T> extends Error {
     constructor(code: number, message: string, body: T, headers: {
         [key: string]: string;
     });
+    get errorMessages(): string[];
 }
diff --git a/dist/apis/exception.js b/dist/apis/exception.js
diff --git a/dist/apis/exception.js.map b/dist/apis/exception.js.map
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -8,3 +8,4 @@ export * from "./servers";
 export { RequiredError } from "./apis/baseapi";
 export { PromiseMiddleware as Middleware } from './middleware';
 export { PromiseDefaultApi as DefaultApi } from './types/PromiseAPI';
+export * from "./errors";
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/errors.ts b/errors.ts
@@ -0,0 +1,25 @@
+// Generated from inputs/api/error-catalog.json. Do not edit by hand.
+
+/**
+ * Sentinel error message strings the OneSignal API can return. Each value
+ * equals the literal message the server emits, so you can test membership
+ * against `ApiException.errorMessages` (e.g. NO_TARGETING_SPECIFIED).
+ *
+ * Note: 200-status sentinels such as NO_SUBSCRIBERS arrive on a successful
+ * response (CreateNotificationSuccessResponse.errors), not via the exception
+ * accessor — read the response's `errors` field for those.
+ */
+export const OneSignalErrors = {
+    /** HTTP 403 | retryable: no | emitted by: any API-key-authenticated endpoint (REST or Organization key) | note: Generic auth-failure message the public api.onesignal.com edge returns for any invalid or mismatched key — REST or Organization — so a single sentinel covers both. Supersedes the Rails-monolith INVALID_REST_API_KEY / INVALID_USER_AUTH_KEY strings, which the public host no longer returns verbatim. Note the double space after 'denied.' */
+    INVALID_API_KEY: "Access denied.  Please include an 'Authorization: ...' header with a valid API key (https://documentation.onesignal.com/docs/en/keys-and-ids#api-keys).",
+    /** HTTP 400, 404 | retryable: no | emitted by: POST /notifications/{id}/history, POST /notifications/{id}/messages, GET /notifications/{id} (export) | note: Verified live 2026-06-16: GET /notifications/{bogus-uuid} returns 404 with this exact message. */
+    NOTIFICATION_NOT_FOUND: "Notification not found",
+    /** HTTP 200 | retryable: no | emitted by: POST /notifications | note: Returned with HTTP 200 OK (id is empty), not an error status. The flagship case for the errorMessages accessor — lets callers distinguish a sent notification from a no-op without parsing the polymorphic 200 body. */
+    NO_SUBSCRIBERS: "All included players are not subscribed",
+    /** HTTP 400 | retryable: no | emitted by: POST /notifications | note: Verified live 2026-06-16: a no-targeting POST /notifications returns 400 with this exact message. */
+    NO_TARGETING_SPECIFIED: "You must include which players, segments, or tags you wish to send this notification to.",
+    /** HTTP 503 | retryable: yes | emitted by: any endpoint (pgbouncer rejection) | note: Transient DB/pgbouncer failure — the canonical retryable sentinel. */
+    SERVICE_UNAVAILABLE: "Service temporarily unavailable",
+} as const;
+
+export type OneSignalErrorMessage = typeof OneSignalErrors[keyof typeof OneSignalErrors];
diff --git a/index.ts b/index.ts
@@ -10,3 +10,4 @@ export { RequiredError } from "./apis/baseapi";
 export { PromiseMiddleware as Middleware } from './middleware';
 export { PromiseDefaultApi as DefaultApi } from './types/PromiseAPI';
 
+export * from "./errors";
diff --git a/models/ApiKeyToken.ts b/models/ApiKeyToken.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/ApiKeyTokensListResponse.ts b/models/ApiKeyTokensListResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/App.ts b/models/App.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/BasicNotification.ts b/models/BasicNotification.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/BasicNotificationAllOf.ts b/models/BasicNotificationAllOf.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/BasicNotificationAllOfAndroidBackgroundLayout.ts b/models/BasicNotificationAllOfAndroidBackgroundLayout.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/Button.ts b/models/Button.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CopyTemplateRequest.ts b/models/CopyTemplateRequest.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateApiKeyRequest.ts b/models/CreateApiKeyRequest.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateApiKeyResponse.ts b/models/CreateApiKeyResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateNotificationSuccessResponse.ts b/models/CreateNotificationSuccessResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateSegmentConflictResponse.ts b/models/CreateSegmentConflictResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateSegmentSuccessResponse.ts b/models/CreateSegmentSuccessResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateTemplateRequest.ts b/models/CreateTemplateRequest.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateUserConflictResponse.ts b/models/CreateUserConflictResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateUserConflictResponseErrorsInner.ts b/models/CreateUserConflictResponseErrorsInner.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CreateUserConflictResponseErrorsItemsMeta.ts b/models/CreateUserConflictResponseErrorsItemsMeta.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CustomEvent.ts b/models/CustomEvent.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/CustomEventsRequest.ts b/models/CustomEventsRequest.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/DeliveryData.ts b/models/DeliveryData.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/ExportEventsSuccessResponse.ts b/models/ExportEventsSuccessResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/ExportSubscriptionsRequestBody.ts b/models/ExportSubscriptionsRequestBody.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/ExportSubscriptionsSuccessResponse.ts b/models/ExportSubscriptionsSuccessResponse.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/Filter.ts b/models/Filter.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
 

diff --git a/models/FilterExpression.ts b/models/FilterExpression.ts
@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 5.6.0
+ * API Version: 5.7.0
  * Contact: devrel@onesignal.com
  */
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,3 +10,4 @@ export { RequiredError } from "./apis/baseapi";
		export { PromiseMiddleware as Middleware } from './middleware';
		export { PromiseDefaultApi as DefaultApi } from './types/PromiseAPI';

		export * from "./errors";