@zyphr-dev/node-sdk 0.1.66 → 0.1.68

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyphr-dev/node-sdk",
-  "version": "0.1.66",
+  "version": "0.1.68",
   "description": "Official Zyphr SDK for Node.js, React, and React Native",
   "type": "module",
   "main": "./dist/index.cjs",

package/src/client.ts

@@ -18,6 +18,7 @@ import type { Middleware, ResponseContext } from './src/runtime.js';
 import {
   AuthApplicationApi,
   AuthEmailOTPApi,
+  AuthEmailTemplatesApi,
   AuthEmailVerificationApi,
   AuthLoginApi,
   AuthMFAApi,
@@ -36,6 +37,7 @@ import {
   UtilityApi,
   WorkflowsApi,
   EmailsApi,
+  ExecutionsApi,
   InboundEmailApi,
   InboxApi,
   PushApi,
@@ -113,6 +115,13 @@ export class Zyphr {
    * facade, which made the documented `zyphr.workflows.*` calls throw.
    */
   readonly workflows: WorkflowsApi;
+  /**
+   * A single workflow execution by id: get its status and step results, cancel
+   * it while running, or retry it after a failure (#1866). List a workflow's
+   * executions with `workflows.listWorkflowExecutions`. Requires the
+   * `workflows:read` scope for reads and `workflows:execute` for cancel/retry.
+   */
+  readonly executions: ExecutionsApi;
   /** Inbound (received) email — read access. Requires the `email:read` scope. */
   readonly inbound: InboundEmailApi;
 
@@ -143,6 +152,13 @@ export class Zyphr {
     readonly webauthn: AuthWebAuthnApi;
     /** Read the authenticating application's own non-sensitive metadata (id, name, environment, signing algorithm) via GET /auth/application. */
     readonly application: AuthApplicationApi;
+    /**
+     * Per-application auth email templates (magic link, password reset, email
+     * verification, email OTP, invitation): list, get, set, reset to the
+     * default, preview and test-send (#1866). Secret-key scoped. Not to be
+     * confused with `zyphr.templates`, which manages notification templates.
+     */
+    readonly emailTemplates: AuthEmailTemplatesApi;
   };
 
   private readonly options: ZyphrOptions;
@@ -173,6 +189,7 @@ export class Zyphr {
     this.utility = new UtilityApi(config);
     this.domains = new DomainsApi(config);
     this.workflows = new WorkflowsApi(config);
+    this.executions = new ExecutionsApi(config);
     this.inbound = new InboundEmailApi(config);
 
     this.waas = {
@@ -202,6 +219,7 @@ export class Zyphr {
       userDirectory: new AuthUserDirectoryApi(config),
       webauthn: new AuthWebAuthnApi(config),
       application: new AuthApplicationApi(config),
+      emailTemplates: new AuthEmailTemplatesApi(config),
     };
   }
 

package/src/src/apis/AuthEmailVerificationApi.ts

@@ -73,7 +73,7 @@ export interface AuthEmailVerificationApiInterface {
     confirmEmailVerification(confirmEmailVerificationRequest: ConfirmEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConfirmEmailVerificationResponse>;
 
     /**
-     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
      * @summary Resend email verification
      * @param {ResendEmailVerificationRequest} [resendEmailVerificationRequest] 
      * @param {*} [options] Override http request option.
@@ -83,7 +83,7 @@ export interface AuthEmailVerificationApiInterface {
     resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>>;
 
     /**
-     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
      * Resend email verification
      */
     resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult>;
@@ -172,7 +172,7 @@ export class AuthEmailVerificationApi extends runtime.BaseAPI implements AuthEma
     }
 
     /**
-     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
      * Resend email verification
      */
     async resendEmailVerificationRaw(requestParameters: AuthEmailVerificationApiResendEmailVerificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResult>> {
@@ -224,7 +224,7 @@ export class AuthEmailVerificationApi extends runtime.BaseAPI implements AuthEma
     }
 
     /**
-     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+     * Resend the verification email to the authenticated user. Rate limited to once per 60 seconds. Requires all three credentials simultaneously: the application key (`X-Application-Key`), the application secret (`X-Application-Secret`), and the end user\'s `Authorization: Bearer` token. Failures behave as on `POST /auth/verify-email/send`, including the 200 accepted-and-suppressed response for a recipient outside the application allowlist.
      * Resend email verification
      */
     async resendEmailVerification(resendEmailVerificationRequest?: ResendEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResult> {

package/src/src/models/ResendEmailVerificationRequest.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface ResendEmailVerificationRequest {
     /**
-     * URL to redirect to after verification
+     * URL to redirect to after verification. Same rules as `POST /auth/verify-email/send`.
      * @type {string}
      * @memberof ResendEmailVerificationRequest
      */

package/src/src/models/SendEmailVerificationRequest.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface SendEmailVerificationRequest {
     /**
-     * URL to redirect to after verification (snake_case `redirect_url` — a camelCase `redirectUrl` is ignored and the hosted verification page is used instead). Must match one of the application's configured redirect URIs.
+     * URL to redirect to after verification. Must be snake_case `redirect_url`: a camelCase `redirectUrl` is rejected with 400, since Zyphr hosts no fallback page. Must match one of the application's configured redirect URIs.
      * @type {string}
      * @memberof SendEmailVerificationRequest
      */