@zyphr-dev/node-sdk 0.1.54 → 0.1.56

package/dist/index.js

@@ -6461,7 +6461,8 @@ function InviteEndUser200ResponseDataFromJSONTyped(json, ignoreDiscriminator) {
   return {
     "userId": json["user_id"] == null ? void 0 : json["user_id"],
     "created": json["created"] == null ? void 0 : json["created"],
-    "linkSent": json["link_sent"] == null ? void 0 : json["link_sent"]
+    "linkSent": json["link_sent"] == null ? void 0 : json["link_sent"],
+    "linkSuppressedReason": json["link_suppressed_reason"] == null ? void 0 : json["link_suppressed_reason"]
   };
 }
 function InviteEndUser200ResponseDataToJSON(json) {
@@ -6474,7 +6475,8 @@ function InviteEndUser200ResponseDataToJSONTyped(value, ignoreDiscriminator = fa
   return {
     "user_id": value["userId"],
     "created": value["created"],
-    "link_sent": value["linkSent"]
+    "link_sent": value["linkSent"],
+    "link_suppressed_reason": value["linkSuppressedReason"]
   };
 }
 
@@ -16230,7 +16232,6 @@ function WebhookDeliveryFromJSONTyped(json, ignoreDiscriminator) {
     "firstAttemptedAt": json["first_attempted_at"] == null ? void 0 : new Date(json["first_attempted_at"]),
     "lastAttemptedAt": json["last_attempted_at"] == null ? void 0 : new Date(json["last_attempted_at"]),
     "completedAt": json["completed_at"] == null ? void 0 : new Date(json["completed_at"]),
-    "deliveryRegion": json["delivery_region"] == null ? void 0 : json["delivery_region"],
     "createdAt": json["created_at"] == null ? void 0 : new Date(json["created_at"])
   };
 }
@@ -16256,7 +16257,6 @@ function WebhookDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
     "first_attempted_at": value["firstAttemptedAt"] == null ? void 0 : value["firstAttemptedAt"].toISOString(),
     "last_attempted_at": value["lastAttemptedAt"] == null ? void 0 : value["lastAttemptedAt"].toISOString(),
     "completed_at": value["completedAt"] == null ? void 0 : value["completedAt"].toISOString(),
-    "delivery_region": value["deliveryRegion"],
     "created_at": value["createdAt"] == null ? void 0 : value["createdAt"].toISOString()
   };
 }
@@ -16294,7 +16294,6 @@ function WebhookDeliveryDetailFromJSONTyped(json, ignoreDiscriminator) {
     "firstAttemptedAt": json["first_attempted_at"] == null ? void 0 : new Date(json["first_attempted_at"]),
     "lastAttemptedAt": json["last_attempted_at"] == null ? void 0 : new Date(json["last_attempted_at"]),
     "completedAt": json["completed_at"] == null ? void 0 : new Date(json["completed_at"]),
-    "deliveryRegion": json["delivery_region"] == null ? void 0 : json["delivery_region"],
     "createdAt": json["created_at"] == null ? void 0 : new Date(json["created_at"]),
     "payload": json["payload"] == null ? void 0 : json["payload"],
     "lastResponseBody": json["last_response_body"] == null ? void 0 : json["last_response_body"],
@@ -16324,7 +16323,6 @@ function WebhookDeliveryDetailToJSONTyped(value, ignoreDiscriminator = false) {
     "first_attempted_at": value["firstAttemptedAt"] == null ? void 0 : value["firstAttemptedAt"].toISOString(),
     "last_attempted_at": value["lastAttemptedAt"] == null ? void 0 : value["lastAttemptedAt"].toISOString(),
     "completed_at": value["completedAt"] == null ? void 0 : value["completedAt"].toISOString(),
-    "delivery_region": value["deliveryRegion"],
     "created_at": value["createdAt"] == null ? void 0 : value["createdAt"].toISOString(),
     "payload": value["payload"],
     "last_response_body": value["lastResponseBody"],
@@ -16660,95 +16658,6 @@ function WebhookMetricsResponseToJSONTyped(value, ignoreDiscriminator = false) {
   };
 }
 
-// src/src/models/WebhookRegion.ts
-function instanceOfWebhookRegion(value) {
-  return true;
-}
-function WebhookRegionFromJSON(json) {
-  return WebhookRegionFromJSONTyped(json, false);
-}
-function WebhookRegionFromJSONTyped(json, ignoreDiscriminator) {
-  if (json == null) {
-    return json;
-  }
-  return {
-    "code": json["code"] == null ? void 0 : json["code"],
-    "name": json["name"] == null ? void 0 : json["name"],
-    "staticIps": json["static_ips"] == null ? void 0 : json["static_ips"]
-  };
-}
-function WebhookRegionToJSON(json) {
-  return WebhookRegionToJSONTyped(json, false);
-}
-function WebhookRegionToJSONTyped(value, ignoreDiscriminator = false) {
-  if (value == null) {
-    return value;
-  }
-  return {
-    "code": value["code"],
-    "name": value["name"],
-    "static_ips": value["staticIps"]
-  };
-}
-
-// src/src/models/WebhookRegionsResponseData.ts
-function instanceOfWebhookRegionsResponseData(value) {
-  return true;
-}
-function WebhookRegionsResponseDataFromJSON(json) {
-  return WebhookRegionsResponseDataFromJSONTyped(json, false);
-}
-function WebhookRegionsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
-  if (json == null) {
-    return json;
-  }
-  return {
-    "regions": json["regions"] == null ? void 0 : json["regions"].map(WebhookRegionFromJSON),
-    "defaultRegion": json["default_region"] == null ? void 0 : json["default_region"]
-  };
-}
-function WebhookRegionsResponseDataToJSON(json) {
-  return WebhookRegionsResponseDataToJSONTyped(json, false);
-}
-function WebhookRegionsResponseDataToJSONTyped(value, ignoreDiscriminator = false) {
-  if (value == null) {
-    return value;
-  }
-  return {
-    "regions": value["regions"] == null ? void 0 : value["regions"].map(WebhookRegionToJSON),
-    "default_region": value["defaultRegion"]
-  };
-}
-
-// src/src/models/WebhookRegionsResponse.ts
-function instanceOfWebhookRegionsResponse(value) {
-  return true;
-}
-function WebhookRegionsResponseFromJSON(json) {
-  return WebhookRegionsResponseFromJSONTyped(json, false);
-}
-function WebhookRegionsResponseFromJSONTyped(json, ignoreDiscriminator) {
-  if (json == null) {
-    return json;
-  }
-  return {
-    "data": json["data"] == null ? void 0 : WebhookRegionsResponseDataFromJSON(json["data"]),
-    "meta": json["meta"] == null ? void 0 : RequestMetaFromJSON(json["meta"])
-  };
-}
-function WebhookRegionsResponseToJSON(json) {
-  return WebhookRegionsResponseToJSONTyped(json, false);
-}
-function WebhookRegionsResponseToJSONTyped(value, ignoreDiscriminator = false) {
-  if (value == null) {
-    return value;
-  }
-  return {
-    "data": WebhookRegionsResponseDataToJSON(value["data"]),
-    "meta": RequestMetaToJSON(value["meta"])
-  };
-}
-
 // src/src/models/WebhookReplayResponse.ts
 function instanceOfWebhookReplayResponse(value) {
   return true;
@@ -17113,6 +17022,40 @@ function WithdrawSubscriberConsentRequestToJSONTyped(value, ignoreDiscriminator
 
 // src/src/apis/AuthApplicationApi.ts
 var AuthApplicationApi = class extends BaseAPI {
+  /**
+   * Returns a machine-readable JSON bundle of everything stored about one end user, for answering a GDPR Art. 15 (access) or Art. 20 (portability) request.  Zyphr is a **processor**: we do not answer data subjects directly. This endpoint gives you, the controller, the data needed to respond to your own end user.  **Credentials are deliberately excluded** and are listed in `export_metadata.excluded`: password hashes, session refresh-token hashes, MFA secrets, OAuth access/refresh tokens and WebAuthn public keys. These are authentication artifacts rather than personal data about the subject, and including them would turn this endpoint into a credential-exfiltration path.  Message history is capped at the 1,000 most recent messages; `export_metadata.message_history_truncated` reports whether the cap was hit. 
+   * Export all data held about an end user
+   */
+  async exportEndUserDataRaw(requestParameters, initOverrides) {
+    if (requestParameters["id"] == null) {
+      throw new RequiredError(
+        "id",
+        'Required parameter "id" was null or undefined when calling exportEndUserData().'
+      );
+    }
+    if (requestParameters["userId"] == null) {
+      throw new RequiredError(
+        "userId",
+        'Required parameter "userId" was null or undefined when calling exportEndUserData().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    const response = await this.request({
+      path: `/v1/applications/{id}/users/{userId}/export`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))).replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters["userId"]))),
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    }, initOverrides);
+    return new VoidApiResponse(response);
+  }
+  /**
+   * Returns a machine-readable JSON bundle of everything stored about one end user, for answering a GDPR Art. 15 (access) or Art. 20 (portability) request.  Zyphr is a **processor**: we do not answer data subjects directly. This endpoint gives you, the controller, the data needed to respond to your own end user.  **Credentials are deliberately excluded** and are listed in `export_metadata.excluded`: password hashes, session refresh-token hashes, MFA secrets, OAuth access/refresh tokens and WebAuthn public keys. These are authentication artifacts rather than personal data about the subject, and including them would turn this endpoint into a credential-exfiltration path.  Message history is capped at the 1,000 most recent messages; `export_metadata.message_history_truncated` reports whether the cap was hit. 
+   * Export all data held about an end user
+   */
+  async exportEndUserData(id, userId, initOverrides) {
+    await this.exportEndUserDataRaw({ id, userId }, initOverrides);
+  }
   /**
    * Return non-sensitive metadata about the application whose credentials authenticated this request. Lets an integrator read their own application_id (the sole tenant discriminator embedded in every end-user token) directly from the API, rather than only from the dashboard UI or by decoding a token. Returns only id, name, the calling environment\'s mode, and the JWT signing algorithm — never secrets, signing keys, or account-internal fields. 
    * Get the authenticating application
@@ -19058,7 +19001,7 @@ var AuthOrganizationsApi = class extends BaseAPI {
 // src/src/apis/AuthPasswordResetApi.ts
 var AuthPasswordResetApi = class extends BaseAPI {
   /**
-   * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+   * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
    * Request a password reset
    */
   async forgotPasswordRaw(requestParameters, initOverrides) {
@@ -19087,7 +19030,7 @@ var AuthPasswordResetApi = class extends BaseAPI {
     return new JSONApiResponse(response, (jsonValue) => SuccessResultFromJSON(jsonValue));
   }
   /**
-   * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+   * Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration — the response is identical whether or not the address is registered.  An identity with **no password set** still receives a link, which sets a first password. This covers users migrated from a provider that cannot export password hashes.  The one case where no email is sent (beyond an unknown address) is an identity that has no password but *does* have another way in — a linked OAuth provider and/or a passkey. Those users are not locked out, so no set-password link is sent; the attempt is recorded as a suppressed message visible via `GET /emails`. 
    * Request a password reset
    */
   async forgotPassword(forgotPasswordRequest, initOverrides) {
@@ -21082,7 +21025,7 @@ var EmailsApi = class extends BaseAPI {
     return await response.value();
   }
   /**
-   * Queue an email for delivery. The email is processed asynchronously and you\'ll receive a message ID to track its status.  You can provide content directly via `html`/`text` fields, or use a template by specifying `template_id` and `template_data`. 
+   * Queue an email for delivery. The email is processed asynchronously and you\'ll receive a message ID to track its status.  You can provide content directly via `html`/`text` fields, or use a template by specifying `template_id` and `template_data`.  **CAN-SPAM compliance — actions required from you:**  - **Set `classification`** to `transactional` or `marketing`. Unclassified is   treated as marketing, the stricter reading. Transactional mail (password   resets, receipts) is exempt from the opt-out and postal-address requirements. - **Set your postal address** in project settings. Commercial email must carry a   valid physical postal address — the most commonly missed CAN-SPAM element.   Marketing sends without one are flagged. - **Include an unsubscribe mechanism** on commercial email. Zyphr enforces   suppression automatically once someone opts out, but the link itself is yours   to include.  See [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). 
    * Send an email
    */
   async sendEmailRaw(requestParameters, initOverrides) {
@@ -21108,7 +21051,7 @@ var EmailsApi = class extends BaseAPI {
     return new JSONApiResponse(response, (jsonValue) => SendEmailResponseFromJSON(jsonValue));
   }
   /**
-   * Queue an email for delivery. The email is processed asynchronously and you\'ll receive a message ID to track its status.  You can provide content directly via `html`/`text` fields, or use a template by specifying `template_id` and `template_data`. 
+   * Queue an email for delivery. The email is processed asynchronously and you\'ll receive a message ID to track its status.  You can provide content directly via `html`/`text` fields, or use a template by specifying `template_id` and `template_data`.  **CAN-SPAM compliance — actions required from you:**  - **Set `classification`** to `transactional` or `marketing`. Unclassified is   treated as marketing, the stricter reading. Transactional mail (password   resets, receipts) is exempt from the opt-out and postal-address requirements. - **Set your postal address** in project settings. Commercial email must carry a   valid physical postal address — the most commonly missed CAN-SPAM element.   Marketing sends without one are flagged. - **Include an unsubscribe mechanism** on commercial email. Zyphr enforces   suppression automatically once someone opts out, but the link itself is yours   to include.  See [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). 
    * Send an email
    */
   async sendEmail(sendEmailRequest, initOverrides) {
@@ -22493,6 +22436,31 @@ var SMSApi = class extends BaseAPI {
     const response = await this.getSmsConfigRaw(initOverrides);
     return await response.value();
   }
+  /**
+   * Returns the URL to configure in your SMS provider so STOP/opt-out replies reach Zyphr. The token is generated on first request and is stable thereafter.  **This is required for TCPA compliance.** Until your provider is pointed at this URL, opt-out replies stop at the provider and never reach us — from Zyphr\'s side the recipient never opted out, and sends continue.  See [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). 
+   * Get the inbound SMS webhook URL
+   */
+  async getSmsInboundWebhookRaw(initOverrides) {
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
+    }
+    const response = await this.request({
+      path: `/sms/inbound-webhook`,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    }, initOverrides);
+    return new VoidApiResponse(response);
+  }
+  /**
+   * Returns the URL to configure in your SMS provider so STOP/opt-out replies reach Zyphr. The token is generated on first request and is stable thereafter.  **This is required for TCPA compliance.** Until your provider is pointed at this URL, opt-out replies stop at the provider and never reach us — from Zyphr\'s side the recipient never opted out, and sends continue.  See [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). 
+   * Get the inbound SMS webhook URL
+   */
+  async getSmsInboundWebhook(initOverrides) {
+    await this.getSmsInboundWebhookRaw(initOverrides);
+  }
   /**
    * List SMS messages for the account with optional filtering and pagination.
    * List SMS messages
@@ -22566,7 +22534,7 @@ var SMSApi = class extends BaseAPI {
     return await response.value();
   }
   /**
-   * Send a single SMS text message. Supports subscriber preference checks and scheduling.
+   * Send a single SMS text message. Supports subscriber preference checks and scheduling.  **TCPA compliance — actions required from you:**  - **Configure the inbound webhook.** Zyphr only processes STOP/opt-out replies   if your SMS provider is pointed at our inbound endpoint. Until you do this,   opt-outs never reach us and we will keep delivering. See   [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). - **Pass `recipient_timezone`** (IANA, e.g. `America/New_York`) so quiet hours   (8am-9pm recipient-local) can be enforced. Without it we send and record that   quiet hours could not be evaluated. We deliberately do not infer a timezone   from the area code — people keep numbers when they move. - **Record consent** for marketing sends. Marketing requires prior express   *written* consent; `express` consent covers transactional only. With no record   on file we deliver and flag it, which is a gap in your evidence, not permission. - **Set `classification`.** Unclassified messages are treated as marketing, the   stricter reading. 
    * Send an SMS message
    */
   async sendSmsRaw(requestParameters, initOverrides) {
@@ -22592,7 +22560,7 @@ var SMSApi = class extends BaseAPI {
     return new JSONApiResponse(response, (jsonValue) => SendSmsResponseFromJSON(jsonValue));
   }
   /**
-   * Send a single SMS text message. Supports subscriber preference checks and scheduling.
+   * Send a single SMS text message. Supports subscriber preference checks and scheduling.  **TCPA compliance — actions required from you:**  - **Configure the inbound webhook.** Zyphr only processes STOP/opt-out replies   if your SMS provider is pointed at our inbound endpoint. Until you do this,   opt-outs never reach us and we will keep delivering. See   [Compliance Requirements](https://zyphr.dev/guides/compliance-requirements). - **Pass `recipient_timezone`** (IANA, e.g. `America/New_York`) so quiet hours   (8am-9pm recipient-local) can be enforced. Without it we send and record that   quiet hours could not be evaluated. We deliberately do not infer a timezone   from the area code — people keep numbers when they move. - **Record consent** for marketing sends. Marketing requires prior express   *written* consent; `express` consent covers transactional only. With no record   on file we deliver and flag it, which is a gap in your evidence, not permission. - **Set `classification`.** Unclassified messages are treated as marketing, the   stricter reading. 
    * Send an SMS message
    */
   async sendSms(sendSmsRequest, initOverrides) {
@@ -25616,32 +25584,6 @@ var WebhooksApi = class extends BaseAPI {
     const response = await this.getWebhookMetricsRaw({ id }, initOverrides);
     return await response.value();
   }
-  /**
-   * Get available webhook delivery regions. Requires multi_region plan feature (Enterprise only).
-   * Get available webhook regions
-   */
-  async getWebhookRegionsRaw(initOverrides) {
-    const queryParameters = {};
-    const headerParameters = {};
-    if (this.configuration && this.configuration.apiKey) {
-      headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key");
-    }
-    const response = await this.request({
-      path: `/v1/webhooks/regions`,
-      method: "GET",
-      headers: headerParameters,
-      query: queryParameters
-    }, initOverrides);
-    return new JSONApiResponse(response, (jsonValue) => WebhookRegionsResponseFromJSON(jsonValue));
-  }
-  /**
-   * Get available webhook delivery regions. Requires multi_region plan feature (Enterprise only).
-   * Get available webhook regions
-   */
-  async getWebhookRegions(initOverrides) {
-    const response = await this.getWebhookRegionsRaw(initOverrides);
-    return await response.value();
-  }
   /**
    * Get webhook delivery usage statistics for the current billing period.
    * Get webhook usage metrics
@@ -26624,6 +26566,15 @@ var Zyphr = class {
   /** Publishable-key-safe utilities: password policy + pre-submit strength check. */
   utility;
   domains;
+  /**
+   * Multi-step workflow definitions and triggering (sc-7926).
+   *
+   * All 12 operations are API-key authenticated with dedicated
+   * `workflows:read` / `workflows:write` / `workflows:execute` scopes, so this
+   * is deliberate public surface. It was generated but never wired onto the
+   * facade, which made the documented `zyphr.workflows.*` calls throw.
+   */
+  workflows;
   /** Inbound (received) email — read access. Requires the `email:read` scope. */
   inbound;
   waas;
@@ -26652,6 +26603,7 @@ var Zyphr = class {
     this.devices = new DevicesApi(config);
     this.utility = new UtilityApi(config);
     this.domains = new DomainsApi(config);
+    this.workflows = new WorkflowsApi(config);
     this.inbound = new InboundEmailApi(config);
     this.waas = {
       applications: new WaaSApplicationsApi(config),
@@ -28895,18 +28847,6 @@ export {
   WebhookMetricsResponseFromJSONTyped,
   WebhookMetricsResponseToJSON,
   WebhookMetricsResponseToJSONTyped,
-  WebhookRegionFromJSON,
-  WebhookRegionFromJSONTyped,
-  WebhookRegionToJSON,
-  WebhookRegionToJSONTyped,
-  WebhookRegionsResponseDataFromJSON,
-  WebhookRegionsResponseDataFromJSONTyped,
-  WebhookRegionsResponseDataToJSON,
-  WebhookRegionsResponseDataToJSONTyped,
-  WebhookRegionsResponseFromJSON,
-  WebhookRegionsResponseFromJSONTyped,
-  WebhookRegionsResponseToJSON,
-  WebhookRegionsResponseToJSONTyped,
   WebhookReplayResponseFromJSON,
   WebhookReplayResponseFromJSONTyped,
   WebhookReplayResponseToJSON,
@@ -29492,9 +29432,6 @@ export {
   instanceOfWebhookJobResponse,
   instanceOfWebhookListResponse,
   instanceOfWebhookMetricsResponse,
-  instanceOfWebhookRegion,
-  instanceOfWebhookRegionsResponse,
-  instanceOfWebhookRegionsResponseData,
   instanceOfWebhookReplayResponse,
   instanceOfWebhookResponse,
   instanceOfWebhookSecretRotateResponse,