From 022cc9832883f44052e16bb22b3062587fdda954 Mon Sep 17 00:00:00 2001
From: OneSignal <noreply@onesignal.com>
Date: Wed, 3 Jun 2026 19:18:00 +0000
Subject: [PATCH] feat: add v5.7.0 package updates

---
 DefaultApi.md              | 794 +++++++++++++++++++++++++++++--------
 apis/exception.ts          |   7 +
 dist/apis/exception.js     |   1 +
 dist/apis/exception.js.map |   2 +-
 yarn.lock                  |  12 +-
 5 files changed, 633 insertions(+), 183 deletions(-)

diff --git a/DefaultApi.md b/DefaultApi.md
index df9704b..02733d0 100644
--- a/DefaultApi.md
+++ b/DefaultApi.md
@@ -50,6 +50,34 @@ Method | HTTP request | Description
 [**viewTemplates**](DefaultApi.md#viewTemplates) | **GET** /templates | View templates
 
 
+## Common patterns
+
+The per-endpoint examples below illustrate one specific call each. This section covers patterns that apply to most operations.
+
+### Authentication
+
+Every operation requires either a **REST API Key** (App-scoped, used by ~77% of endpoints) or an **Organization API Key** (used by the remaining ~23% — the app-management endpoints `getApps` / `createApp` / `getApp` / `updateApp` / `copyTemplateToApp`, plus the API-key administration endpoints `viewApiKeys` / `createApiKey` / `deleteApiKey` / `updateApiKey` / `rotateApiKey`). The two are not interchangeable. The "Authorization" row on each endpoint below lists the exact scheme.
+
+### Idempotency
+
+`POST /notifications` accepts a top-level `idempotency_key` (UUIDv4) that the server uses for request dedup within a **30-day window**. Pass a freshly-generated UUID per logical send so that network-level retries are safe. Never reuse a key across distinct sends — the server returns the original response instead of acting on the new payload. The hero `createNotification` example below demonstrates the call.
+
+### Error handling
+
+When a request fails, the SDK rejects the returned Promise with an `Onesignal.ApiException`. Wrap each call in `try { ... } catch (e) { ... }` and narrow with `e instanceof Onesignal.ApiException`. The HTTP status code is `e.code` (number); the parsed error body is `e.body`. Most envelopes match `{ "errors": ["..."] }` (an array of strings) but a few endpoints return `{ "errors": [{"code": ..., "title": ..., "meta": {...}}] }` (an array of structured error objects — used by `POST /apps/{app_id}/users` 409 conflict, see `CreateUserConflictResponse`), `{ "errors": "..." }` (string), or `{ "success": false }` (no `errors` field at all). Robust error-handling code should tolerate all four shapes.
+
+### Polymorphic 200 from POST /notifications
+
+`CreateNotificationSuccessResponse` has two distinct shapes that share the same schema; branch on `id`:
+- **Success** — `id` is a non-empty UUID. `errors`, if present, is an object keyed by recipient-identifier type (`invalid_player_ids`, `invalid_external_user_ids`, `invalid_aliases`, ...) listing recipients that were skipped (partial-success path).
+- **No-send** — `id` is the empty string `""`. `errors` is a string array with the sentinel reason, typically `["All included players are not subscribed"]`.
+
+The hero `createNotification` example below demonstrates the branch pattern explicitly.
+
+### Targeting users by External ID
+
+Set `include_aliases.external_id` to a list of External IDs and set `target_channel` to `push` / `email` / `sms`. The alias label must be the literal string `external_id` — camelCase variants such as `externalId` are silently ignored and yield zero recipients. **Do not confuse** this with the deprecated top-level `external_id` notification field — a separate correlation/idempotency field with its own 30-day dedup keyspace (parallel to `idempotency_key`, not an alias) and no targeting effect.
+
 # **cancelNotification**
 > GenericSuccessBoolResponse cancelNotification()
 
@@ -68,13 +96,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCancelNotificationRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  notificationId: "notification_id_example",
+  notificationId: "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88",
 };
 
-const response = await apiInstance.cancelNotification(body);
-console.log(response);
+try {
+  const response = await apiInstance.cancelNotification(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("cancelNotification failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -128,17 +165,26 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCopyTemplateToAppRequest = {
   // string
-  templateId: "template_id_example",
+  templateId: "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c",
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // CopyTemplateRequest
   copyTemplateRequest: {
     target_app_id: "target_app_id_example",
   },
 };
 
-const response = await apiInstance.copyTemplateToApp(body);
-console.log(response);
+try {
+  const response = await apiInstance.copyTemplateToApp(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("copyTemplateToApp failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -191,11 +237,11 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateAliasRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
   // UserIdentityBody
   userIdentityBody: {
     identity: {
@@ -204,8 +250,17 @@ let body: Onesignal.DefaultApiCreateAliasRequest = {
   },
 };
 
-const response = await apiInstance.createAlias(body);
-console.log(response);
+try {
+  const response = await apiInstance.createAlias(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createAlias failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -262,9 +317,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateAliasBySubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  subscriptionId: "subscription_id_example",
+  subscriptionId: "7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51",
   // UserIdentityBody
   userIdentityBody: {
     identity: {
@@ -273,8 +328,17 @@ let body: Onesignal.DefaultApiCreateAliasBySubscriptionRequest = {
   },
 };
 
-const response = await apiInstance.createAliasBySubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.createAliasBySubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createAliasBySubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -330,7 +394,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateApiKeyRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // CreateApiKeyRequest
   createApiKeyRequest: {
     name: "name_example",
@@ -341,8 +405,17 @@ let body: Onesignal.DefaultApiCreateApiKeyRequest = {
   },
 };
 
-const response = await apiInstance.createApiKey(body);
-console.log(response);
+try {
+  const response = await apiInstance.createApiKey(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createApiKey failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -419,8 +492,17 @@ let body: Onesignal.DefaultApiCreateAppRequest = {
   },
 };
 
-const response = await apiInstance.createApp(body);
-console.log(response);
+try {
+  const response = await apiInstance.createApp(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createApp failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -472,7 +554,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateCustomEventsRequest = {
   // string | Your OneSignal App ID in UUID v4 format.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // CustomEventsRequest
   customEventsRequest: {
     events: [
@@ -487,8 +569,17 @@ let body: Onesignal.DefaultApiCreateCustomEventsRequest = {
   },
 };
 
-const response = await apiInstance.createCustomEvents(body);
-console.log(response);
+try {
+  const response = await apiInstance.createCustomEvents(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createCustomEvents failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -534,6 +625,7 @@ Sends notifications to your users.  **Target by External ID (push example):** se
 
 ```typescript
 import Onesignal from '@onesignal/node-onesignal';
+import { randomUUID } from 'node:crypto';
 
 const configuration = Onesignal.createConfiguration({
     restApiKey: '<YOUR_REST_API_KEY>',
@@ -547,9 +639,35 @@ notification.headings = { en: 'Push Notification' };
 // Target by External ID: alias keys must match the API (external_id, not externalId).
 notification.include_aliases = { external_id: ['YOUR_USER_EXTERNAL_ID'] };
 notification.target_channel = 'push';
-
-const response = await apiInstance.createNotification(notification);
-console.log(response);
+// Idempotency key: a client-generated UUID that lets you safely retry on network failure.
+// If two requests arrive with the same key inside the 30-day window, only the first is sent
+// and the second returns the original response. `randomUUID` is imported from `node:crypto`
+// (available on Node 14.17+) — DO NOT reuse keys across logically distinct sends.
+notification.idempotency_key = randomUUID();
+
+try {
+  const response = await apiInstance.createNotification(notification);
+  // `response.id` discriminates the two HTTP 200 shapes. A falsy value (empty string,
+  // null, or undefined) means no notification was created (e.g. all targets were
+  // unreachable / not subscribed). `response.errors` is polymorphic: a `string[]` in the
+  // no-subscribers case, or an object keyed by recipient-identifier type
+  // (`invalid_player_ids`, `invalid_external_user_ids`, `invalid_aliases`, …) when the
+  // notification WAS created but some recipients were skipped.
+  if (!response.id) {
+    console.warn("Notification was not sent:", response.errors);
+  } else if (response.errors) {
+    console.log("Notification created:", response.id, "(partial failures:", response.errors, ")");
+  } else {
+    console.log("Notification created:", response.id);
+  }
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createNotification failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -601,7 +719,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateSegmentRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // Segment (optional)
   segment: {
     id: "id_example",
@@ -612,8 +730,17 @@ let body: Onesignal.DefaultApiCreateSegmentRequest = {
   },
 };
 
-const response = await apiInstance.createSegment(body);
-console.log(response);
+try {
+  const response = await apiInstance.createSegment(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createSegment failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -667,11 +794,11 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateSubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
   // SubscriptionBody
   subscriptionBody: {
     subscription: {
@@ -696,8 +823,17 @@ let body: Onesignal.DefaultApiCreateSubscriptionRequest = {
   },
 };
 
-const response = await apiInstance.createSubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.createSubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createSubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -904,8 +1040,17 @@ let body: Onesignal.DefaultApiCreateTemplateRequest = {
   },
 };
 
-const response = await apiInstance.createTemplate(body);
-console.log(response);
+try {
+  const response = await apiInstance.createTemplate(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createTemplate failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -957,7 +1102,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiCreateUserRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // User
   user: {
     properties: {
@@ -1007,8 +1152,17 @@ let body: Onesignal.DefaultApiCreateUserRequest = {
   },
 };
 
-const response = await apiInstance.createUser(body);
-console.log(response);
+try {
+  const response = await apiInstance.createUser(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("createUser failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1064,17 +1218,26 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteAliasRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
   // string
-  aliasLabelToDelete: "alias_label_to_delete_example",
+  aliasLabelToDelete: "external_id",
 };
 
-const response = await apiInstance.deleteAlias(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteAlias(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteAlias failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1131,13 +1294,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteApiKeyRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  tokenId: "token_id_example",
+  tokenId: "0aa1b2c3-d4e5-46f7-8899-aabbccddeeff",
 };
 
-const response = await apiInstance.deleteApiKey(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteApiKey(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteApiKey failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1189,13 +1361,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteSegmentRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | The segment_id can be found in the URL of the segment when viewing it in the dashboard.
-  segmentId: "segment_id_example",
+  segmentId: "d6c5a3e1-9f17-44a1-9d10-7c0e4a2b1c8e",
 };
 
-const response = await apiInstance.deleteSegment(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteSegment(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteSegment failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1249,13 +1430,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteSubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  subscriptionId: "subscription_id_example",
+  subscriptionId: "7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51",
 };
 
-const response = await apiInstance.deleteSubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteSubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteSubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1310,13 +1500,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteTemplateRequest = {
   // string
-  templateId: "template_id_example",
+  templateId: "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c",
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
 };
 
-const response = await apiInstance.deleteTemplate(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteTemplate(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteTemplate failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1369,15 +1568,24 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiDeleteUserRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
 };
 
-const response = await apiInstance.deleteUser(body);
-console.log(response);
+try {
+  const response = await apiInstance.deleteUser(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("deleteUser failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1432,13 +1640,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiExportEventsRequest = {
   // string | The ID of the notification to export events from.
-  notificationId: "notification_id_example",
+  notificationId: "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88",
   // string | The ID of the app that the notification belongs to.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
 };
 
-const response = await apiInstance.exportEvents(body);
-console.log(response);
+try {
+  const response = await apiInstance.exportEvents(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("exportEvents failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1492,7 +1709,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiExportSubscriptionsRequest = {
   // string | The app ID that you want to export devices from
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // ExportSubscriptionsRequestBody (optional)
   exportSubscriptionsRequestBody: {
     extra_fields: [
@@ -1503,8 +1720,17 @@ let body: Onesignal.DefaultApiExportSubscriptionsRequest = {
   },
 };
 
-const response = await apiInstance.exportSubscriptions(body);
-console.log(response);
+try {
+  const response = await apiInstance.exportSubscriptions(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("exportSubscriptions failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1557,15 +1783,24 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetAliasesRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
 };
 
-const response = await apiInstance.getAliases(body);
-console.log(response);
+try {
+  const response = await apiInstance.getAliases(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getAliases failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1620,13 +1855,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetAliasesBySubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  subscriptionId: "subscription_id_example",
+  subscriptionId: "7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51",
 };
 
-const response = await apiInstance.getAliasesBySubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.getAliasesBySubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getAliasesBySubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1679,11 +1923,20 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetAppRequest = {
   // string | An app id
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
 };
 
-const response = await apiInstance.getApp(body);
-console.log(response);
+try {
+  const response = await apiInstance.getApp(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getApp failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1733,8 +1986,17 @@ const configuration = Onesignal.createConfiguration({
 });
 const apiInstance = new Onesignal.DefaultApi(configuration);
 
-const response = await apiInstance.getApps();
-console.log(response);
+try {
+  const response = await apiInstance.getApps();
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getApps failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1783,13 +2045,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetNotificationRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  notificationId: "notification_id_example",
+  notificationId: "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88",
 };
 
-const response = await apiInstance.getNotification(body);
-console.log(response);
+try {
+  const response = await apiInstance.getNotification(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getNotification failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1843,7 +2114,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetNotificationHistoryRequest = {
   // string | The \"id\" of the message found in the Notification object
-  notificationId: "notification_id_example",
+  notificationId: "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88",
   // GetNotificationHistoryRequestBody
   getNotificationHistoryRequestBody: {
     events: "sent",
@@ -1852,8 +2123,17 @@ let body: Onesignal.DefaultApiGetNotificationHistoryRequest = {
   },
 };
 
-const response = await apiInstance.getNotificationHistory(body);
-console.log(response);
+try {
+  const response = await apiInstance.getNotificationHistory(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getNotificationHistory failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1907,17 +2187,26 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetNotificationsRequest = {
   // string | The app ID that you want to view notifications from
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // number | How many notifications to return.  Max is 50.  Default is 50. (optional)
-  limit: 1,
+  limit: 10,
   // number | Page offset.  Default is 0.  Results are sorted by queued_at in descending order.  queued_at is a representation of the time that the notification was queued at. (optional)
-  offset: 1,
+  offset: 0,
   // 0 | 1 | 3 | Kind of notifications returned:   * unset - All notification types (default)   * `0` - Dashboard only   * `1` - API only   * `3` - Automated only  (optional)
   kind: 0,
 };
 
-const response = await apiInstance.getNotifications(body);
-console.log(response);
+try {
+  const response = await apiInstance.getNotifications(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getNotifications failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -1972,21 +2261,30 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetOutcomesRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the \"os\" prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum 
-  outcomeNames: "outcome_names_example",
+  outcomeNames: "os__session_duration.count,os__click.count",
   // string | Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count where \"Sales, Purchase\" is the custom outcomes with a comma in the name.  (optional)
-  outcomeNames2: "outcome_names[]_example",
+  outcomeNames2: "os__session_duration.count",
   // string | Optional Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is 1h if the parameter is omitted.  (optional)
-  outcomeTimeRange: "outcome_time_range_example",
+  outcomeTimeRange: "1d",
   // string | Optional Platform id. Refer device\'s platform ids for values. Example: outcome_platform=0 for iOS outcome_platform=7,8 for Safari and Firefox Default is data from all platforms if the parameter is omitted.  (optional)
-  outcomePlatforms: "outcome_platforms_example",
+  outcomePlatforms: "0,1",
   // string | Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution=direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted.  (optional)
-  outcomeAttribution: "outcome_attribution_example",
+  outcomeAttribution: "direct",
 };
 
-const response = await apiInstance.getOutcomes(body);
-console.log(response);
+try {
+  const response = await apiInstance.getOutcomes(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getOutcomes failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2043,15 +2341,24 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetSegmentsRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // number | Segments are listed in ascending order of created_at date. offset will omit that number of segments from the beginning of the list. Eg offset 5, will remove the 5 earliest created Segments. (optional)
-  offset: 1,
+  offset: 0,
   // number | The amount of Segments in the response. Maximum 300. (optional)
-  limit: 1,
+  limit: 10,
 };
 
-const response = await apiInstance.getSegments(body);
-console.log(response);
+try {
+  const response = await apiInstance.getSegments(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getSegments failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2105,15 +2412,24 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiGetUserRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
 };
 
-const response = await apiInstance.getUser(body);
-console.log(response);
+try {
+  const response = await apiInstance.getUser(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("getUser failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2168,13 +2484,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiRotateApiKeyRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  tokenId: "token_id_example",
+  tokenId: "0aa1b2c3-d4e5-46f7-8899-aabbccddeeff",
 };
 
-const response = await apiInstance.rotateApiKey(body);
-console.log(response);
+try {
+  const response = await apiInstance.rotateApiKey(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("rotateApiKey failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2226,9 +2551,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiStartLiveActivityRequest = {
   // string | Your OneSignal App ID in UUID v4 format.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | The name of the Live Activity defined in your app. This should match the attributes struct used in your app\'s Live Activity implementation.
-  activityType: "activity_type_example",
+  activityType: "order_status",
   // StartLiveActivityRequest
   startLiveActivityRequest: {
     name: "name_example",
@@ -2350,8 +2675,17 @@ let body: Onesignal.DefaultApiStartLiveActivityRequest = {
   },
 };
 
-const response = await apiInstance.startLiveActivity(body);
-console.log(response);
+try {
+  const response = await apiInstance.startLiveActivity(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("startLiveActivity failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2405,9 +2739,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiTransferSubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  subscriptionId: "subscription_id_example",
+  subscriptionId: "7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51",
   // TransferSubscriptionRequestBody
   transferSubscriptionRequestBody: {
     identity: {
@@ -2416,8 +2750,17 @@ let body: Onesignal.DefaultApiTransferSubscriptionRequest = {
   },
 };
 
-const response = await apiInstance.transferSubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.transferSubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("transferSubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2473,15 +2816,24 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUnsubscribeEmailWithTokenRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report.
-  notificationId: "notification_id_example",
+  notificationId: "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88",
   // string | The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email.
-  token: "token_example",
+  token: "YOUR_TOKEN_ID",
 };
 
-const response = await apiInstance.unsubscribeEmailWithToken(body);
-console.log(response);
+try {
+  const response = await apiInstance.unsubscribeEmailWithToken(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("unsubscribeEmailWithToken failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2535,9 +2887,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateApiKeyRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  tokenId: "token_id_example",
+  tokenId: "0aa1b2c3-d4e5-46f7-8899-aabbccddeeff",
   // UpdateApiKeyRequest
   updateApiKeyRequest: {
     name: "name_example",
@@ -2548,8 +2900,17 @@ let body: Onesignal.DefaultApiUpdateApiKeyRequest = {
   },
 };
 
-const response = await apiInstance.updateApiKey(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateApiKey(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateApiKey failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2602,7 +2963,7 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateAppRequest = {
   // string | An app id
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // App
   app: {
     name: "name_example",
@@ -2629,8 +2990,17 @@ let body: Onesignal.DefaultApiUpdateAppRequest = {
   },
 };
 
-const response = await apiInstance.updateApp(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateApp(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateApp failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2683,9 +3053,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateLiveActivityRequest = {
   // string | The OneSignal App ID for your app.  Available in Keys & IDs.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | Live Activity record ID
-  activityId: "activity_id_example",
+  activityId: "12345",
   // UpdateLiveActivityRequest
   updateLiveActivityRequest: {
     name: "name_example",
@@ -2788,8 +3158,17 @@ let body: Onesignal.DefaultApiUpdateLiveActivityRequest = {
   },
 };
 
-const response = await apiInstance.updateLiveActivity(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateLiveActivity(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateLiveActivity failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2843,9 +3222,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateSubscriptionRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  subscriptionId: "subscription_id_example",
+  subscriptionId: "7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51",
   // SubscriptionBody
   subscriptionBody: {
     subscription: {
@@ -2870,8 +3249,17 @@ let body: Onesignal.DefaultApiUpdateSubscriptionRequest = {
   },
 };
 
-const response = await apiInstance.updateSubscription(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateSubscription(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateSubscription failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -2927,11 +3315,11 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateSubscriptionByTokenRequest = {
   // string | Your OneSignal App ID in UUID v4 format.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string | The type of token to use when looking up the subscription. See Subscription Types.
-  tokenType: "token_type_example",
+  tokenType: "Email",
   // string | The value of the token to lookup by (e.g., email address, phone number).
-  token: "token_example",
+  token: "user@example.com",
   // SubscriptionBody
   subscriptionBody: {
     subscription: {
@@ -2956,8 +3344,17 @@ let body: Onesignal.DefaultApiUpdateSubscriptionByTokenRequest = {
   },
 };
 
-const response = await apiInstance.updateSubscriptionByToken(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateSubscriptionByToken(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateSubscriptionByToken failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -3012,9 +3409,9 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateTemplateRequest = {
   // string
-  templateId: "template_id_example",
+  templateId: "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c",
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // UpdateTemplateRequest
   updateTemplateRequest: {
     name: "name_example",
@@ -3164,8 +3561,17 @@ let body: Onesignal.DefaultApiUpdateTemplateRequest = {
   },
 };
 
-const response = await apiInstance.updateTemplate(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateTemplate(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateTemplate failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -3218,11 +3624,11 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiUpdateUserRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // string
-  aliasLabel: "alias_label_example",
+  aliasLabel: "external_id",
   // string
-  aliasId: "alias_id_example",
+  aliasId: "YOUR_USER_EXTERNAL_ID",
   // UpdateUserRequest
   updateUserRequest: {
     properties: {
@@ -3261,8 +3667,17 @@ let body: Onesignal.DefaultApiUpdateUserRequest = {
   },
 };
 
-const response = await apiInstance.updateUser(body);
-console.log(response);
+try {
+  const response = await apiInstance.updateUser(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("updateUser failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -3318,11 +3733,20 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiViewApiKeysRequest = {
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
 };
 
-const response = await apiInstance.viewApiKeys(body);
-console.log(response);
+try {
+  const response = await apiInstance.viewApiKeys(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("viewApiKeys failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -3373,13 +3797,22 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiViewTemplateRequest = {
   // string
-  templateId: "template_id_example",
+  templateId: "e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c",
   // string
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
 };
 
-const response = await apiInstance.viewTemplate(body);
-console.log(response);
+try {
+  const response = await apiInstance.viewTemplate(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("viewTemplate failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
@@ -3432,17 +3865,26 @@ const apiInstance = new Onesignal.DefaultApi(configuration);
 
 let body: Onesignal.DefaultApiViewTemplatesRequest = {
   // string | Your OneSignal App ID in UUID v4 format.
-  appId: "app_id_example",
+  appId: "00000000-0000-0000-0000-000000000000",
   // number | Maximum number of templates. Default and max is 50. (optional)
-  limit: 50,
+  limit: 10,
   // number | Pagination offset. (optional)
   offset: 0,
   // 'push' | 'email' | 'sms' | Filter by delivery channel. (optional)
   channel: "push",
 };
 
-const response = await apiInstance.viewTemplates(body);
-console.log(response);
+try {
+  const response = await apiInstance.viewTemplates(body);
+  console.log(response);
+} catch (e) {
+  if (e instanceof Onesignal.ApiException) {
+    // `e.body` is the parsed error response (typically `{ errors: string[] }`).
+    console.error("viewTemplates failed: HTTP " + e.code, e.body);
+  } else {
+    throw e;
+  }
+}
 ```
 
 
diff --git a/apis/exception.ts b/apis/exception.ts
index 9365d33..7341424 100644
--- a/apis/exception.ts
+++ b/apis/exception.ts
@@ -11,5 +11,12 @@ export class ApiException<T> extends Error {
     public constructor(public code: number, message: string, public body: T, public headers: { [key: string]: string; }) {
         super("HTTP-Code: " + code + "\nMessage: " + message + "\nBody: " + JSON.stringify(body) + "\nHeaders: " +
         JSON.stringify(headers))
+        // Restore the prototype chain. Under tsconfig `target: "es5"`, classes that
+        // extend a built-in (Error/Array/Map/...) lose their instance prototype because
+        // the emitted __extends helper cannot fix `this` after super() returns. Without
+        // this line, `err instanceof ApiException` is always `false` at runtime, even
+        // though the data (code/body/headers) is present on the instance.
+        // 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);
     }
 }
diff --git a/dist/apis/exception.js b/dist/apis/exception.js
index af55922..201a944 100644
--- a/dist/apis/exception.js
+++ b/dist/apis/exception.js
@@ -24,6 +24,7 @@ var ApiException = (function (_super) {
         _this.code = code;
         _this.body = body;
         _this.headers = headers;
+        Object.setPrototypeOf(_this, ApiException.prototype);
         return _this;
     }
     return ApiException;
diff --git a/dist/apis/exception.js.map b/dist/apis/exception.js.map
index 21cb073..a682fcc 100644
--- a/dist/apis/exception.js.map
+++ b/dist/apis/exception.js.map
@@ -1 +1 @@
-{"version":3,"file":"exception.js","sourceRoot":"","sources":["../../apis/exception.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AASA;IAAqC,gCAAK;IACtC,sBAA0B,IAAY,EAAE,OAAe,EAAS,IAAO,EAAS,OAAmC;QAAnH,YACI,kBAAM,aAAa,GAAG,IAAI,GAAG,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,aAAa;YACxG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,SAC3B;QAHyB,UAAI,GAAJ,IAAI,CAAQ;QAA0B,UAAI,GAAJ,IAAI,CAAG;QAAS,aAAO,GAAP,OAAO,CAA4B;;IAGnH,CAAC;IACL,mBAAC;AAAD,CAAC,AALD,CAAqC,KAAK,GAKzC;AALY,oCAAY"}
\ No newline at end of file
+{"version":3,"file":"exception.js","sourceRoot":"","sources":["../../apis/exception.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AASA;IAAqC,gCAAK;IACtC,sBAA0B,IAAY,EAAE,OAAe,EAAS,IAAO,EAAS,OAAmC;QAAnH,YACI,kBAAM,aAAa,GAAG,IAAI,GAAG,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,aAAa;YACxG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,SAQ3B;QAVyB,UAAI,GAAJ,IAAI,CAAQ;QAA0B,UAAI,GAAJ,IAAI,CAAG;QAAS,aAAO,GAAP,OAAO,CAA4B;QAS/G,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;;IACxD,CAAC;IACL,mBAAC;AAAD,CAAC,AAZD,CAAqC,KAAK,GAYzC;AAZY,oCAAY"}
\ No newline at end of file
diff --git a/yarn.lock b/yarn.lock
index 439ebb9..485303f 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -64,9 +64,9 @@ es-errors@^1.3.0:
   integrity sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==
 
 es-object-atoms@^1.0.0, es-object-atoms@^1.1.1:
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.1.tgz#1c4f2c4837327597ce69d2ca190a7fdd172338c1"
-  integrity sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.2.tgz#a2d0b373205724dfa525d23b0c3e1b1ca582c99b"
+  integrity sha512-HWcBoN6NileqtSydK2FqHbS/LoDd2pqrnQHLyJzBj4kOp/ky2MWMN694xOfkK8/SnUsW2DH7EfyVlydKCsm1Zw==
   dependencies:
     es-errors "^1.3.0"
 
@@ -144,9 +144,9 @@ has-tostringtag@^1.0.2:
     has-symbols "^1.0.3"
 
 hasown@^2.0.2:
-  version "2.0.3"
-  resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.3.tgz#5e5c2b15b60370a4c7930c383dfb76bf17bc403c"
-  integrity sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.4.tgz#8c62d8cb90beb2aad5d0a5b67581ad9854c3f003"
+  integrity sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==
   dependencies:
     function-bind "^1.1.2"