mudbase-sdk 1.3.10 → 1.3.12

package/docs/MessagingApi.md

@@ -6,13 +6,22 @@ All URIs are relative to *https://cloud.mudbase.dev*
 |------------- | ------------- | -------------|
 | [**getMessageHistory**](MessagingApi.md#getmessagehistory) | **GET** /api/messaging/projects/{projectId}/messaging/history | Get message history |
 | [**getMessageStats**](MessagingApi.md#getmessagestats) | **GET** /api/messaging/projects/{projectId}/messaging/stats | Get message statistics |
-| [**getProjectFcmConfig**](MessagingApi.md#getprojectfcmconfig) | **GET** /api/messaging/projects/{projectId}/messaging/push-config | Get BYO FCM configuration (masked) |
+| [**getProjectFcmConfig**](MessagingApi.md#getprojectfcmconfig) | **GET** /api/messaging/projects/{projectId}/messaging/push-config | Get bring-your-own push credentials status (masked) |
 | [**getProjectSmsByo**](MessagingApi.md#getprojectsmsbyo) | **GET** /api/messaging/projects/{projectId}/messaging/sms-provider | Get BYO SMS provider configuration (masked) |
-| [**patchProjectFcmConfig**](MessagingApi.md#patchprojectfcmconfigoperation) | **PATCH** /api/messaging/projects/{projectId}/messaging/push-config | Set or clear per-project FCM service account |
+| [**getProjectVapidPublicKey**](MessagingApi.md#getprojectvapidpublickey) | **GET** /api/messaging/projects/{projectId}/messaging/web-push/public-key | Get the Web Push public key (public) |
+| [**getProjectWebPushConfig**](MessagingApi.md#getprojectwebpushconfig) | **GET** /api/messaging/projects/{projectId}/messaging/web-push-config | Get native Web Push (VAPID) configuration |
+| [**listDeviceTokens**](MessagingApi.md#listdevicetokens) | **GET** /api/messaging/projects/{projectId}/messaging/devices | List registered device tokens |
+| [**listWebPushSubscriptions**](MessagingApi.md#listwebpushsubscriptions) | **GET** /api/messaging/projects/{projectId}/messaging/web-push/subscriptions | List registered Web Push subscriptions |
+| [**patchProjectFcmConfig**](MessagingApi.md#patchprojectfcmconfigoperation) | **PATCH** /api/messaging/projects/{projectId}/messaging/push-config | Set or clear your own push service account (optional) |
 | [**patchProjectSmsByo**](MessagingApi.md#patchprojectsmsbyo) | **PATCH** /api/messaging/projects/{projectId}/messaging/sms-provider | Update BYO SMS provider credentials |
+| [**patchProjectWebPushConfig**](MessagingApi.md#patchprojectwebpushconfig) | **PATCH** /api/messaging/projects/{projectId}/messaging/web-push-config | Update native Web Push (VAPID) configuration |
+| [**registerDeviceToken**](MessagingApi.md#registerdevicetoken) | **POST** /api/messaging/projects/{projectId}/messaging/devices | Register a device push token |
+| [**registerWebPushSubscription**](MessagingApi.md#registerwebpushsubscription) | **POST** /api/messaging/projects/{projectId}/messaging/web-push/subscriptions | Register a browser Web Push subscription |
+| [**removeWebPushSubscription**](MessagingApi.md#removewebpushsubscription) | **DELETE** /api/messaging/projects/{projectId}/messaging/web-push/subscriptions | Unregister a Web Push subscription |
 | [**sendEmail**](MessagingApi.md#sendemail) | **POST** /api/messaging/projects/{projectId}/messaging/email | Send email |
 | [**sendPushNotification**](MessagingApi.md#sendpushnotification) | **POST** /api/messaging/projects/{projectId}/messaging/push | Send push notification |
 | [**sendSMS**](MessagingApi.md#sendsms) | **POST** /api/messaging/projects/{projectId}/messaging/sms | Send SMS |
+| [**unregisterDeviceToken**](MessagingApi.md#unregisterdevicetoken) | **DELETE** /api/messaging/projects/{projectId}/messaging/devices | Unregister a device push token |
 
 
 
@@ -186,9 +195,9 @@ example().catch(console.error);
 
 > GetProjectFcmConfig200Response getProjectFcmConfig(projectId)
 
-Get BYO FCM configuration (masked)
+Get bring-your-own push credentials status (masked)
 
-Returns whether a per-project Firebase service account JSON is stored (encrypted). Falls back to platform `FCM_SERVICE_ACCOUNT_JSON` when unset.
+Returns whether this project has its own push provider credentials stored (encrypted). This is an optional, advanced override - push works out of the box with platform-managed credentials, so when no per-project credentials are stored, push is sent with the platform-managed credentials.
 
 ### Example
 
@@ -252,7 +261,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | FCM BYO flags |  -  |
+| **200** | Bring-your-own push credentials flags |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -332,13 +341,465 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getProjectVapidPublicKey
+
+> WebPushPublicKeyResponse getProjectVapidPublicKey(projectId)
+
+Get the Web Push public key (public)
+
+Public read of the VAPID application-server public key a browser needs to subscribe with `pushManager.subscribe({ applicationServerKey })`. This is the one Web Push route that needs no authentication - the public key is designed to be exposed to browser clients. It returns only this project\'s own key.  When the project has not enabled native Web Push, `enabled` is `false` and `publicKey` is `null`. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { GetProjectVapidPublicKeyRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const api = new MessagingApi();
+
+  const body = {
+    // string
+    projectId: projectId_example,
+  } satisfies GetProjectVapidPublicKeyRequest;
+
+  try {
+    const data = await api.getProjectVapidPublicKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebPushPublicKeyResponse**](WebPushPublicKeyResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public application-server key (or disabled) |  -  |
+| **404** | Resource not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getProjectWebPushConfig
+
+> WebPushConfigResponse getProjectWebPushConfig(projectId)
+
+Get native Web Push (VAPID) configuration
+
+Read this project\'s native Web Push configuration. Native Web Push delivers browser push directly from Mudbase using the VAPID application-server key - no per-project push provider account is required. This returns whether native Web Push is enabled, whether a VAPID keypair has been provisioned, the public application-server key (when enabled), the RFC 8292 contact subject, and when the current keypair was generated. The private key is never returned.  Native Web Push is off until you enable it (`PATCH` this endpoint). It sits alongside the device-token push path - a project can use either or both.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { GetProjectWebPushConfigRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+  } satisfies GetProjectWebPushConfigRequest;
+
+  try {
+    const data = await api.getProjectWebPushConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebPushConfigResponse**](WebPushConfigResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Native Web Push configuration |  -  |
+| **404** | Resource not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDeviceTokens
+
+> DeviceListResponse listDeviceTokens(projectId)
+
+List registered device tokens
+
+List the device push tokens registered to a project, most-recently-seen first.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { ListDeviceTokensRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+  } satisfies ListDeviceTokensRequest;
+
+  try {
+    const data = await api.listDeviceTokens(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceListResponse**](DeviceListResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Registered device tokens |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listWebPushSubscriptions
+
+> WebPushSubscriptionListResponse listWebPushSubscriptions(projectId)
+
+List registered Web Push subscriptions
+
+List the browser Web Push subscriptions registered to a project, most-recently-seen first. The encryption keys are never returned - only the endpoint and metadata.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { ListWebPushSubscriptionsRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+  } satisfies ListWebPushSubscriptionsRequest;
+
+  try {
+    const data = await api.listWebPushSubscriptions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**WebPushSubscriptionListResponse**](WebPushSubscriptionListResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Registered Web Push subscriptions |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## patchProjectFcmConfig
 
-> patchProjectFcmConfig(projectId, patchProjectFcmConfigRequest)
+> patchProjectFcmConfig(projectId, patchProjectFcmConfigRequest)
+
+Set or clear your own push service account (optional)
+
+Optional advanced step - push works out of the box with platform-managed credentials, so most projects never call this. Use it only to deliver push from your own push provider account. Body `serviceAccountJson` is the Firebase service account JSON you download from your own Firebase project (stored encrypted). Send `clear: true` to remove it and go back to the platform-managed credentials. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { PatchProjectFcmConfigOperationRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+    // PatchProjectFcmConfigRequest
+    patchProjectFcmConfigRequest: {"serviceAccountJson":{"type":"service_account","project_id":"my-firebase-project","private_key":"-----BEGIN PRIVATE KEY-----\nMIIE...\n-----END PRIVATE KEY-----\n","client_email":"firebase-adminsdk-xxxxx@my-firebase-project.iam.gserviceaccount.com"}},
+  } satisfies PatchProjectFcmConfigOperationRequest;
+
+  try {
+    const data = await api.patchProjectFcmConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+| **patchProjectFcmConfigRequest** | [PatchProjectFcmConfigRequest](PatchProjectFcmConfigRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated |  -  |
+| **400** | Bad request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## patchProjectSmsByo
+
+> GetProjectSmsByo200Response patchProjectSmsByo(projectId, projectSmsByoPatchRequest)
+
+Update BYO SMS provider credentials
+
+Body `config` is provider-specific JSON stored encrypted per organization: - **twilio** — `accountSid`, `authToken` (required). Optional `from` sender override used if the send request does not specify `from` and `defaultFrom` is empty. - **termii** — `apiKey` (required). Optional `from` sender name (e.g. brand label). - **africastalking** — `username`, `apiKey` (both required). Optional `from` shortcode or sender ID. On enable, the API validates credentials with a lightweight ping (no SMS sent). See request body **Examples** for sample payloads. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { PatchProjectSmsByoRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+    // ProjectSmsByoPatchRequest
+    projectSmsByoPatchRequest: ...,
+  } satisfies PatchProjectSmsByoRequest;
+
+  try {
+    const data = await api.patchProjectSmsByo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+| **projectSmsByoPatchRequest** | [ProjectSmsByoPatchRequest](ProjectSmsByoPatchRequest.md) |  | |
+
+### Return type
+
+[**GetProjectSmsByo200Response**](GetProjectSmsByo200Response.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated configuration |  -  |
+| **400** | Bad request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
 
-Set or clear per-project FCM service account
+## patchProjectWebPushConfig
 
-Body `serviceAccountJson` is the Firebase service account object (stored encrypted). Send `clear: true` to remove and use platform FCM only. 
+> WebPushConfigResponse patchProjectWebPushConfig(projectId, webPushConfigPatchRequest)
+
+Update native Web Push (VAPID) configuration
+
+Enable or disable native Web Push, rotate the VAPID keypair, or set the contact subject.  - `enabled: true` turns native Web Push on and provisions a VAPID keypair the first time, so the public-key read path has a key to hand clients immediately. `enabled: false` turns it off. - `rotateKeys: true` regenerates the keypair. This invalidates existing browser subscriptions - clients must re-fetch the new public key and re-subscribe. - `subject` sets the RFC 8292 contact URI - a `mailto:` address or an `https` URL.  Returns the same shape as `GET`. The private key is never returned.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
 
 ### Example
 
@@ -347,7 +808,7 @@ import {
   Configuration,
   MessagingApi,
 } from 'mudbase-sdk';
-import type { PatchProjectFcmConfigOperationRequest } from 'mudbase-sdk';
+import type { PatchProjectWebPushConfigRequest } from 'mudbase-sdk';
 
 async function example() {
   console.log("🚀 Testing mudbase-sdk SDK...");
@@ -364,12 +825,12 @@ async function example() {
   const body = {
     // string
     projectId: projectId_example,
-    // PatchProjectFcmConfigRequest
-    patchProjectFcmConfigRequest: {"serviceAccountJson":{"type":"service_account","project_id":"my-firebase-project","private_key":"-----BEGIN PRIVATE KEY-----\nMIIE...\n-----END PRIVATE KEY-----\n","client_email":"firebase-adminsdk-xxxxx@my-firebase-project.iam.gserviceaccount.com"}},
-  } satisfies PatchProjectFcmConfigOperationRequest;
+    // WebPushConfigPatchRequest
+    webPushConfigPatchRequest: {"enabled":true,"subject":"mailto:push@yourapp.com"},
+  } satisfies PatchProjectWebPushConfigRequest;
 
   try {
-    const data = await api.patchProjectFcmConfig(body);
+    const data = await api.patchProjectWebPushConfig(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -386,11 +847,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **projectId** | `string` |  | [Defaults to `undefined`] |
-| **patchProjectFcmConfigRequest** | [PatchProjectFcmConfigRequest](PatchProjectFcmConfigRequest.md) |  | |
+| **webPushConfigPatchRequest** | [WebPushConfigPatchRequest](WebPushConfigPatchRequest.md) |  | |
 
 ### Return type
 
-`void` (Empty response body)
+[**WebPushConfigResponse**](WebPushConfigResponse.md)
 
 ### Authorization
 
@@ -405,19 +866,20 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Updated |  -  |
+| **200** | Updated native Web Push configuration |  -  |
 | **400** | Bad request |  -  |
+| **404** | Resource not found |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## patchProjectSmsByo
+## registerDeviceToken
 
-> GetProjectSmsByo200Response patchProjectSmsByo(projectId, projectSmsByoPatchRequest)
+> DeviceRegisteredResponse registerDeviceToken(projectId, deviceRegisterRequest)
 
-Update BYO SMS provider credentials
+Register a device push token
 
-Body `config` is provider-specific JSON stored encrypted per organization: - **twilio** — `accountSid`, `authToken` (required). Optional `from` sender override used if the send request does not specify `from` and `defaultFrom` is empty. - **termii** — `apiKey` (required). Optional `from` sender name (e.g. brand label). - **africastalking** — `username`, `apiKey` (both required). Optional `from` shortcode or sender ID. On enable, the API validates credentials with a lightweight ping (no SMS sent). See request body **Examples** for sample payloads. 
+Register a device\'s push token with a project so it can receive push notifications. A client registers its token here first; the send endpoint (`/messaging/push`) only delivers to tokens that are registered to the project, so a caller cannot push to arbitrary or other-tenant tokens.  Registration is idempotent - re-registering a token that already exists just refreshes it (updates `platform` and `lastSeenAt`) instead of creating a duplicate. Each project has a cap on the number of registered tokens; when the cap is reached, the least-recently-seen tokens are evicted to make room, so a register-on-launch call never fails.  Push works out of the box with platform-managed credentials - no provider setup is required to start registering tokens and sending push.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
 
 ### Example
 
@@ -426,7 +888,7 @@ import {
   Configuration,
   MessagingApi,
 } from 'mudbase-sdk';
-import type { PatchProjectSmsByoRequest } from 'mudbase-sdk';
+import type { RegisterDeviceTokenRequest } from 'mudbase-sdk';
 
 async function example() {
   console.log("🚀 Testing mudbase-sdk SDK...");
@@ -443,12 +905,12 @@ async function example() {
   const body = {
     // string
     projectId: projectId_example,
-    // ProjectSmsByoPatchRequest
-    projectSmsByoPatchRequest: ...,
-  } satisfies PatchProjectSmsByoRequest;
+    // DeviceRegisterRequest
+    deviceRegisterRequest: {"token":"fMEGV8example-device-push-token-string9xY","platform":"android"},
+  } satisfies RegisterDeviceTokenRequest;
 
   try {
-    const data = await api.patchProjectSmsByo(body);
+    const data = await api.registerDeviceToken(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -465,11 +927,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **projectId** | `string` |  | [Defaults to `undefined`] |
-| **projectSmsByoPatchRequest** | [ProjectSmsByoPatchRequest](ProjectSmsByoPatchRequest.md) |  | |
+| **deviceRegisterRequest** | [DeviceRegisterRequest](DeviceRegisterRequest.md) |  | |
 
 ### Return type
 
-[**GetProjectSmsByo200Response**](GetProjectSmsByo200Response.md)
+[**DeviceRegisteredResponse**](DeviceRegisteredResponse.md)
 
 ### Authorization
 
@@ -484,8 +946,169 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Updated configuration |  -  |
+| **201** | Device token registered |  -  |
+| **400** | Bad request |  -  |
+| **403** | App role feature permission denied |  -  |
+| **429** | Device registration rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## registerWebPushSubscription
+
+> WebPushSubscribeResponse registerWebPushSubscription(projectId, webPushSubscribeRequest)
+
+Register a browser Web Push subscription
+
+Register a browser `PushSubscription` (the `endpoint` plus the `p256dh` / `auth` keys returned by `pushManager.subscribe()`) so it becomes eligible to receive native Web Push. The send endpoint (`/messaging/push`) only delivers to subscriptions registered to the project, so a caller cannot push to arbitrary or other-tenant endpoints.  Registration is idempotent - re-registering the same endpoint updates the existing row (keys rotate, `lastSeenAt` bumps) instead of creating a duplicate. Each project has a cap on the number of registered subscriptions; when the cap is reached, the least-recently-seen subscriptions are evicted to make room. Optionally associate the subscription with a `userId` (your end-user id, for targeted sends) and a `deviceId`.  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { RegisterWebPushSubscriptionRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+    // WebPushSubscribeRequest
+    webPushSubscribeRequest: {"subscription":{"endpoint":"https://push-service.example.com/subscribe/abc123","keys":{"p256dh":"BEexample-p256dh-key-base64url","auth":"example-auth-secret-base64url"}},"userId":"user_123"},
+  } satisfies RegisterWebPushSubscriptionRequest;
+
+  try {
+    const data = await api.registerWebPushSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+| **webPushSubscribeRequest** | [WebPushSubscribeRequest](WebPushSubscribeRequest.md) |  | |
+
+### Return type
+
+[**WebPushSubscribeResponse**](WebPushSubscribeResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Web Push subscription registered |  -  |
 | **400** | Bad request |  -  |
+| **403** | App role feature permission denied |  -  |
+| **429** | Subscription registration rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeWebPushSubscription
+
+> WebPushUnsubscribeResponse removeWebPushSubscription(projectId, webPushUnsubscribeRequest)
+
+Unregister a Web Push subscription
+
+Remove a browser Web Push subscription - call this on unsubscribe or logout, so the send endpoint stops delivering to it. The subscription is identified by its `endpoint`, sent in the request body. Removing an endpoint that is not registered is a no-op and still returns 200 (with `removed: false`).  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { RemoveWebPushSubscriptionRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+    // WebPushUnsubscribeRequest
+    webPushUnsubscribeRequest: {"endpoint":"https://push-service.example.com/subscribe/abc123"},
+  } satisfies RemoveWebPushSubscriptionRequest;
+
+  try {
+    const data = await api.removeWebPushSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+| **webPushUnsubscribeRequest** | [WebPushUnsubscribeRequest](WebPushUnsubscribeRequest.md) |  | |
+
+### Return type
+
+[**WebPushUnsubscribeResponse**](WebPushUnsubscribeResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Subscription removed (or already absent) |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -572,7 +1195,7 @@ example().catch(console.error);
 
 ## sendPushNotification
 
-> MessageSentResponse sendPushNotification(projectId, pushNotificationRequest)
+> PushSentResponse sendPushNotification(projectId, pushNotificationRequest)
 
 Send push notification
 
@@ -626,7 +1249,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**MessageSentResponse**](MessageSentResponse.md)
+[**PushSentResponse**](PushSentResponse.md)
 
 ### Authorization
 
@@ -654,7 +1277,7 @@ example().catch(console.error);
 
 Send SMS
 
-Send an SMS message to one or more phone numbers. Uses project BYO SMS when configured; otherwise platform Twilio env if set. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented. 
+Send an SMS message to one or more phone numbers. Uses project BYO SMS when configured; otherwise the platform SMS provider if set. Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). Both ProjectBearerAuth and ApiKeyAuth are fully implemented. 
 
 ### Example
 
@@ -727,3 +1350,81 @@ example().catch(console.error);
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## unregisterDeviceToken
+
+> DeviceUnregisteredResponse unregisterDeviceToken(projectId, deviceUnregisterRequest)
+
+Unregister a device push token
+
+Remove a device push token from a project - call this on logout or when a token rotates, so the send endpoint stops delivering to it.  The token to remove is sent in the request body. Removing a token that is not registered is a no-op and still returns 200 (with `removed: false`).  Accepts: OrgBearerAuth (for admin users), ProjectBearerAuth (JWT for authenticated users), or ApiKeyAuth (X-API-Key for programmatic access). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MessagingApi,
+} from 'mudbase-sdk';
+import type { UnregisterDeviceTokenRequest } from 'mudbase-sdk';
+
+async function example() {
+  console.log("🚀 Testing mudbase-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: OrgBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: ProjectBearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MessagingApi(config);
+
+  const body = {
+    // string
+    projectId: projectId_example,
+    // DeviceUnregisterRequest
+    deviceUnregisterRequest: {"token":"fMEGV8example-device-push-token-string9xY"},
+  } satisfies UnregisterDeviceTokenRequest;
+
+  try {
+    const data = await api.unregisterDeviceToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `string` |  | [Defaults to `undefined`] |
+| **deviceUnregisterRequest** | [DeviceUnregisterRequest](DeviceUnregisterRequest.md) |  | |
+
+### Return type
+
+[**DeviceUnregisteredResponse**](DeviceUnregisteredResponse.md)
+
+### Authorization
+
+[OrgBearerAuth](../README.md#OrgBearerAuth), [ApiKeyAuth](../README.md#ApiKeyAuth), [ProjectBearerAuth](../README.md#ProjectBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Device token removed (or already absent) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+