mudbase-sdk 1.3.11 → 1.3.13

package/docs/OrganizationsApi.md

@@ -28,7 +28,7 @@ All URIs are relative to *https://cloud.mudbase.dev*
 | [**orgCustomDomainPlatformReady**](OrganizationsApi.md#orgcustomdomainplatformreadyoperation) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/platform-ready | Notify platform ops that hosting or edge work is ready (email) |
 | [**orgCustomDomainSubmitCname**](OrganizationsApi.md#orgcustomdomainsubmitcname) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/submit-cname | Custom domain step 2 (optional): org confirms routing CNAME was added |
 | [**orgCustomDomainSubmitPlatformDnsVerificationDeprecated**](OrganizationsApi.md#orgcustomdomainsubmitplatformdnsverificationdeprecated) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/submit-platform-dns-verification | Deprecated — use POST .../verify-platform-dns |
-| [**orgCustomDomainVerifyPlatformDns**](OrganizationsApi.md#orgcustomdomainverifyplatformdns) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-platform-dns | Custom domain step 3: verify platform DNS (manual TXT or Fly certificate readiness) |
+| [**orgCustomDomainVerifyPlatformDns**](OrganizationsApi.md#orgcustomdomainverifyplatformdns) | **POST** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-platform-dns | Custom domain step 3: verify platform DNS (manual TXT or managed certificate readiness) |
 | [**patchOrgCustomDomain**](OrganizationsApi.md#patchorgcustomdomain) | **PATCH** /api/orgs/{orgId}/projects/{projectId}/domains/{hostname} | Update domain status or regenerate verification token |
 | [**removeSubOrganizationMember**](OrganizationsApi.md#removesuborganizationmember) | **DELETE** /api/orgs/{orgId}/suborgs/{suborgId}/members/{userId} | ~~Remove member from sub-organization~~ (deprecated) |
 | [**removeTeamMember**](OrganizationsApi.md#removeteammember) | **DELETE** /api/orgs/{orgId}/members/{userId} | Remove team member from organization |
@@ -49,7 +49,7 @@ All URIs are relative to *https://cloud.mudbase.dev*
 
 Add a custom domain
 
-Creates a pending domain row; the response **`domain`** uses the compact **`OrgDomainEntryOrgConsole`** shape (**`dnsRecords`** includes the Mudbase ownership TXT). **`dnsRecords`** may include Mudbase TXT and routing CNAME only until Mudbase TXT succeeds and Fly ACME (if enabled) provisions a certificate. **`flyCertificateStatus`** is typically omitted until Fly ACME runs after first successful **`verify-dns`**. 
+Creates a pending domain row; the response **`domain`** uses the compact **`OrgDomainEntryOrgConsole`** shape (**`dnsRecords`** includes the Mudbase ownership TXT). **`dnsRecords`** may include the Mudbase TXT and routing CNAME only until the Mudbase TXT succeeds and the managed certificate is provisioned. **`flyCertificateStatus`** is typically omitted until certificate provisioning runs after the first successful **`verify-dns`**. 
 
 ### Example
 
@@ -421,7 +421,7 @@ example().catch(console.error);
 
 Get DNS TXT record instructions for one hostname
 
-Returns the same shape as list/add for one hostname (URL-encode `hostname` in the path), including **`dnsRecords`** and **`flyCertificateStatus`** when applicable. See **`listOrgCustomDomains`** for how Fly ACME and Cloudflare SaaS affect those fields. 
+Returns the same shape as list/add for one hostname (URL-encode `hostname` in the path), including **`dnsRecords`** and **`flyCertificateStatus`** when applicable. See **`listOrgCustomDomains`** for how managed certificate provisioning affects those fields. 
 
 ### Example
 
@@ -1088,7 +1088,7 @@ example().catch(console.error);
 
 Custom domain background sweep status (internal)
 
-Returns the last automated custom-domain sweep (TXT recheck + Fly ACME retry), job env flags, and Fly deploy troubleshooting hints when the proxy reports the app is not listening on 0.0.0.0:PORT. Requires header `X-Internal-Api-Key` (same as other /internal routes).
+Returns the last automated custom-domain sweep (TXT recheck + certificate provisioning retry), job env flags, and deploy troubleshooting hints when the proxy reports the app is not listening on 0.0.0.0:PORT. Requires header `X-Internal-Api-Key` (same as other /internal routes).
 
 ### Example
 
@@ -1446,7 +1446,7 @@ example().catch(console.error);
 
 List custom domains and DNS verification hints
 
-Returns allowed hostnames for **this project**, primary hostname (per project), API base URL, and per-domain DNS guidance.  Each row uses **`dnsRecords`** for the Mudbase ownership TXT (purpose **`mudbase_ownership`**) and routing **CNAME** from Fly **`dns_requirements.cname`** when Fly ACME has provisioned (else fallback **`CUSTOM_DOMAIN_API_CNAME_TARGET`**), and—when Fly ACME is enabled (**`FLY_API_TOKEN`** + **`CUSTOM_DOMAIN_FLY_ACME_ENABLED`**)—Fly rows (`fly_ownership`, `acme_challenge`, etc.) after the org has passed Mudbase TXT at least once. **`flyCertificateStatus`** mirrors Fly’s certificate state when ACME automation is on (e.g. `pending_validation`, `active`).  **`edge`** appears only when edge SSL (SSL-for-SaaS) is configured. Fly ACME and edge SSL are mutually exclusive on the server.  Requires Growth, Scale, or Enterprise plan (custom domains included in plan features). 
+Returns allowed hostnames for **this project**, primary hostname (per project), API base URL, and per-domain DNS guidance.  Each row uses **`dnsRecords`** for the Mudbase ownership TXT (purpose **`mudbase_ownership`**) and the routing **CNAME** target that Mudbase provisions for the hostname (else the platform default target). Once the ownership TXT has passed at least once, Mudbase provisions and manages the TLS certificate for the hostname automatically and may add further checklist rows (for example `acme_challenge`) needed to complete certificate issuance. The certificate status field mirrors the managed certificate’s state during issuance (e.g. `pending_validation`, `active`).  Managed edge TLS details are present only on deployments that serve managed edge certificates.  Requires Growth, Scale, or Enterprise plan (custom domains included in plan features). 
 
 ### Example
 
@@ -1669,7 +1669,7 @@ example().catch(console.error);
 
 Custom domain step 2 (optional): org confirms routing CNAME was added
 
-Usually unnecessary. With Fly ACME default automation, Mudbase TXT verify may already set `cname_approved`. Legacy pipelines may queue `cname_pending_staff` until staff **`approve-cname`**. Use **`routingCnameTarget`** from **`GET .../projects/{projectId}/domains`** (Fly **`dns_requirements.cname`** when provisioned, else **`CUSTOM_DOMAIN_API_CNAME_TARGET`**). 
+Usually unnecessary. With automated certificate provisioning, the Mudbase TXT verify may already set `cname_approved`. Legacy pipelines may queue `cname_pending_staff` until staff **`approve-cname`**. Use **`routingCnameTarget`** from **`GET .../projects/{projectId}/domains`** (the managed routing CNAME target when provisioned, else the platform default target). 
 
 ### Example
 
@@ -1749,7 +1749,7 @@ example().catch(console.error);
 
 Deprecated — use POST .../verify-platform-dns
 
-Deprecated alias of **`orgCustomDomainVerifyPlatformDns`** (same behavior — manual TXT and/or Fly ACME path per server config).
+Deprecated alias of **`orgCustomDomainVerifyPlatformDns`** (same behavior: manual TXT and/or automated certificate provisioning per deployment).
 
 ### Example
 
@@ -1826,9 +1826,9 @@ example().catch(console.error);
 
 > OrgPatchDomainResponse orgCustomDomainVerifyPlatformDns(orgId, projectId, hostname)
 
-Custom domain step 3: verify platform DNS (manual TXT or Fly certificate readiness)
+Custom domain step 3: verify platform DNS (manual TXT or managed certificate readiness)
 
-**Manual path (no Fly ACME):** After staff **`PATCH .../platform-dns-verification`**, the org adds the published TXT and calls this endpoint. The API resolves public TXT at **`platformDnsVerification.recordName`** and matches **`recordValue`**. On success, `status` → **`platform_dns_pending_review`** until staff **`POST .../activate`**.  **Fly ACME path (default):** When Fly ACME is enabled and **`CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE`** is **not** set, the org calls this after Mudbase TXT and Fly DNS rows are in place (status typically **`cname_approved`** from automated verify-dns). The API triggers Fly **`POST .../check`** and **`GET`** certificate with bounded retries. On success, `status` → **`active`** and the org may receive the activation email—**no** staff **`approve-cname`** or **`activate`** required.  **Fly legacy:** If **`CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE=true`**, behavior matches the older flow: staff **`approve-cname`** may be required first; after a ready Fly cert, **`status`** becomes **`active`** only when **`CUSTOM_DOMAIN_FLY_AUTO_ACTIVATE=true`**, else **`platform_dns_pending_review`** until staff **`activate`**.  **`platform_dns_verification_failed`** may include **`details.flyStatus`** / **`details.flyError`** on the Fly path. 
+**Manual path:** After staff **`PATCH .../platform-dns-verification`**, the org adds the published TXT and calls this endpoint. The API resolves public TXT at **`platformDnsVerification.recordName`** and matches **`recordValue`**. On success, `status` → **`platform_dns_pending_review`** until staff **`POST .../activate`**.  **Automated path (default):** When automated certificate provisioning is in effect, the org calls this after the Mudbase TXT and the certificate DNS rows are in place (status typically **`cname_approved`** from automated verify-dns). The API checks the managed certificate with bounded retries. On success, `status` → **`active`** and the org may receive the activation email, with no staff **`approve-cname`** or **`activate`** required.  **Legacy path:** In the legacy staff pipeline, staff **`approve-cname`** may be required first; after the managed certificate is ready, **`status`** becomes **`active`** on auto-activation, else **`platform_dns_pending_review`** until staff **`activate`**.  **`platform_dns_verification_failed`** may include **`details.flyStatus`** / **`details.flyError`** with provisioning error context. 
 
 ### Example
 
@@ -1894,8 +1894,8 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Domain row updated (`OrgPatchDomainResponse.domain`). Manual TXT path typically sets `platform_dns_pending_review`. Fly ACME default automation: typically `active` when the certificate is ready. Fly legacy staff pipeline: may set `platform_dns_pending_review` unless `CUSTOM_DOMAIN_FLY_AUTO_ACTIVATE` is enabled. Body may include refreshed `dnsRecords` and `flyCertificateStatus` on the Fly path. |  -  |
-| **400** | custom_domain_invalid_state, platform_dns_verification_failed (manual TXT mismatch or Fly cert not active yet; see response details on Fly path) |  -  |
+| **200** | Domain row updated (`OrgPatchDomainResponse.domain`). Manual TXT path typically sets `platform_dns_pending_review`. Automated provisioning: typically `active` when the certificate is ready. Legacy staff pipeline: may set `platform_dns_pending_review` unless auto-activation is enabled. Body may include refreshed `dnsRecords` and `flyCertificateStatus` when certificate provisioning ran. |  -  |
+| **400** | custom_domain_invalid_state, platform_dns_verification_failed (manual TXT mismatch or managed certificate not active yet; see response details) |  -  |
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **503** | dns_lookup_error |  -  |
@@ -2680,7 +2680,7 @@ example().catch(console.error);
 
 Verify domain ownership via DNS TXT
 
-Looks up TXT at `_mudbase-verify.<hostname>` for value `mudbase-domain-verification=<token>`.  When the server has **`CLOUDFLARE_API_TOKEN`** and **`CLOUDFLARE_ZONE_ID`** configured (and Fly ACME is **not** enabled), a successful verify also creates or refreshes a Cloudflare Custom Hostname (SSL for SaaS) and returns **`cloudflare`** with DCV hints.  When **Fly ACME** is enabled (**`FLY_API_TOKEN`** + **`CUSTOM_DOMAIN_FLY_ACME_ENABLED=true`** + app slug), a successful verify calls Fly’s Certificates API (`POST .../certificates/acme`) and persists DNS requirements. If Fly returns DNS rows and **`CUSTOM_DOMAIN_FLY_LEGACY_STAFF_PIPELINE`** is **not** set, status advances to **`cname_approved`** in the same response (no staff **`approve-cname`**); **`org.domain.cname_staff_queued`** is not logged for that path. Otherwise (legacy Fly or non-Fly), first success from `pending`/`failed` may move to **`cname_pending_staff`** and queue staff as before.  The **200** response may include **`dnsRecords`**, **`flyCertificateStatus`**, and **`routingCnameTarget`** from Fly’s **`dns_requirements.cname`** when provisioned.  Cloudflare SaaS and Fly ACME cannot both be enabled; the API process refuses to start if both are configured. 
+Looks up TXT at `_mudbase-verify.<hostname>` for value `mudbase-domain-verification=<token>`.  On a successful verify, Mudbase begins provisioning and managing the TLS certificate for the hostname automatically. Depending on the deployment, the response may include managed edge TLS details with domain-control validation (DCV) hints for the certificate.  When automated certificate provisioning is in effect, a successful verify records the certificate’s DNS requirements and status may advance to **`cname_approved`** in the same response (no staff **`approve-cname`** step). Otherwise, first success from `pending`/`failed` may move to **`cname_pending_staff`** and queue platform review as before.  The **200** response may include **`dnsRecords`**, certificate status, and **`routingCnameTarget`** for the managed certificate once its requirements are provisioned. 
 
 ### Example
 
@@ -2746,7 +2746,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | TXT verified. Fly ACME (default automation): often `cname_approved` when Fly returns DNS requirements; legacy Fly or non-Fly may show `cname_pending_staff` or `dns_verified`. Includes `dnsTxtHost`/`dnsTxtValue`, optional `cloudflare` (Cloudflare SaaS), optional `dnsRecords` + `flyCertificateStatus` when Fly ACME ran after this verify. |  -  |
+| **200** | TXT verified. With automated certificate provisioning, often `cname_approved` once DNS requirements are returned; otherwise may show `cname_pending_staff` or `dns_verified`. Includes `dnsTxtHost`/`dnsTxtValue`, optional managed edge TLS details, optional `dnsRecords` + certificate status when provisioning ran after this verify. |  -  |
 | **400** | dns_verification_failed (TXT missing or wrong); body includes dnsTxtHost, dnsTxtValue, challengeHost, expectedTxt |  -  |
 | **503** | dns_lookup_error |  -  |
 

package/docs/PushNotificationRequest.md

@@ -1,12 +1,16 @@
 
 # PushNotificationRequest
 
+Provide at least one target: `tokens` (registered device tokens), `endpoints` (registered Web Push subscription endpoints), `userIds` (Web Push subscriptions associated to those user ids), or `webPushBroadcast: true` (every enabled Web Push subscription in the project). A single send can target both the device-token channel and the native Web Push channel at once. 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `tokens` | Array<string>
+`endpoints` | Array<string>
+`userIds` | Array<string>
+`webPushBroadcast` | boolean
 `title` | string
 `body` | string
 `data` | object
@@ -20,6 +24,9 @@ import type { PushNotificationRequest } from 'mudbase-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "tokens": null,
+  "endpoints": null,
+  "userIds": null,
+  "webPushBroadcast": null,
   "title": null,
   "body": null,
   "data": null,

package/docs/PushSentResponse.md

@@ -0,0 +1,37 @@
+
+# PushSentResponse
+
+Result of a push send, summarized per channel. `channels.fcm` covers the device-token channel and `channels.webPush` the native Web Push channel; each is `null` when that channel had no targets in the request. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [PushSentResponseData](PushSentResponseData.md)
+
+## Example
+
+```typescript
+import type { PushSentResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies PushSentResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PushSentResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PushSentResponseData.md

@@ -0,0 +1,44 @@
+
+# PushSentResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`messageId` | string
+`successCount` | number
+`failureCount` | number
+`channels` | [PushSentResponseDataChannels](PushSentResponseDataChannels.md)
+`rejectedTokens` | Array<string>
+
+## Example
+
+```typescript
+import type { PushSentResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "messageId": null,
+  "successCount": null,
+  "failureCount": null,
+  "channels": null,
+  "rejectedTokens": null,
+} satisfies PushSentResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PushSentResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PushSentResponseDataChannels.md

@@ -0,0 +1,36 @@
+
+# PushSentResponseDataChannels
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fcm` | [PushSentResponseDataChannelsFcm](PushSentResponseDataChannelsFcm.md)
+`webPush` | [PushSentResponseDataChannelsWebPush](PushSentResponseDataChannelsWebPush.md)
+
+## Example
+
+```typescript
+import type { PushSentResponseDataChannels } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fcm": null,
+  "webPush": null,
+} satisfies PushSentResponseDataChannels
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PushSentResponseDataChannels
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PushSentResponseDataChannelsFcm.md

@@ -0,0 +1,36 @@
+
+# PushSentResponseDataChannelsFcm
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`successCount` | number
+`failureCount` | number
+
+## Example
+
+```typescript
+import type { PushSentResponseDataChannelsFcm } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "successCount": null,
+  "failureCount": null,
+} satisfies PushSentResponseDataChannelsFcm
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PushSentResponseDataChannelsFcm
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PushSentResponseDataChannelsWebPush.md

@@ -0,0 +1,38 @@
+
+# PushSentResponseDataChannelsWebPush
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`successCount` | number
+`failureCount` | number
+`pruned` | number
+
+## Example
+
+```typescript
+import type { PushSentResponseDataChannelsWebPush } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "successCount": null,
+  "failureCount": null,
+  "pruned": null,
+} satisfies PushSentResponseDataChannelsWebPush
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PushSentResponseDataChannelsWebPush
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SimulateAppPermissionsRequest.md

@@ -24,7 +24,7 @@ const example = {
   "roleSlug": null,
   "operationId": sendEmail,
   "method": POST,
-  "pathname": /api/messaging/projects/685ad30be129932fbb7a1047/messaging/email,
+  "pathname": /api/messaging/projects/65f1a2b3c4d5e6f7a8b9c0d1/messaging/email,
   "path": null,
 } satisfies SimulateAppPermissionsRequest
 

package/docs/WebPushConfigPatchRequest.md

@@ -0,0 +1,39 @@
+
+# WebPushConfigPatchRequest
+
+All fields optional. `enabled` toggles native Web Push (and provisions a keypair on first enable); `rotateKeys` regenerates the keypair (invalidating existing subscriptions); `subject` sets the RFC 8292 contact URI. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`rotateKeys` | boolean
+`subject` | string
+
+## Example
+
+```typescript
+import type { WebPushConfigPatchRequest } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "rotateKeys": null,
+  "subject": null,
+} satisfies WebPushConfigPatchRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushConfigPatchRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushConfigResponse.md

@@ -0,0 +1,36 @@
+
+# WebPushConfigResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [WebPushConfigResponseData](WebPushConfigResponseData.md)
+
+## Example
+
+```typescript
+import type { WebPushConfigResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies WebPushConfigResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushConfigResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushConfigResponseData.md

@@ -0,0 +1,42 @@
+
+# WebPushConfigResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`hasKeys` | boolean
+`publicKey` | string
+`vapidSubject` | string
+`generatedAt` | Date
+
+## Example
+
+```typescript
+import type { WebPushConfigResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "hasKeys": null,
+  "publicKey": null,
+  "vapidSubject": null,
+  "generatedAt": null,
+} satisfies WebPushConfigResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushConfigResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushPublicKeyResponse.md

@@ -0,0 +1,36 @@
+
+# WebPushPublicKeyResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [WebPushPublicKeyResponseData](WebPushPublicKeyResponseData.md)
+
+## Example
+
+```typescript
+import type { WebPushPublicKeyResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies WebPushPublicKeyResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushPublicKeyResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushPublicKeyResponseData.md

@@ -0,0 +1,36 @@
+
+# WebPushPublicKeyResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`publicKey` | string
+
+## Example
+
+```typescript
+import type { WebPushPublicKeyResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "publicKey": null,
+} satisfies WebPushPublicKeyResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushPublicKeyResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushSubscribeRequest.md

@@ -0,0 +1,38 @@
+
+# WebPushSubscribeRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscription` | [WebPushSubscription](WebPushSubscription.md)
+`userId` | string
+`deviceId` | string
+
+## Example
+
+```typescript
+import type { WebPushSubscribeRequest } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscription": null,
+  "userId": null,
+  "deviceId": null,
+} satisfies WebPushSubscribeRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushSubscribeRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushSubscribeResponse.md

@@ -0,0 +1,36 @@
+
+# WebPushSubscribeResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`data` | [WebPushSubscribeResponseData](WebPushSubscribeResponseData.md)
+
+## Example
+
+```typescript
+import type { WebPushSubscribeResponse } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "data": null,
+} satisfies WebPushSubscribeResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushSubscribeResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebPushSubscribeResponseData.md

@@ -0,0 +1,38 @@
+
+# WebPushSubscribeResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`endpoint` | string
+`userId` | string
+`lastSeenAt` | Date
+
+## Example
+
+```typescript
+import type { WebPushSubscribeResponseData } from 'mudbase-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "endpoint": null,
+  "userId": null,
+  "lastSeenAt": null,
+} satisfies WebPushSubscribeResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebPushSubscribeResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+