@zyphr-dev/node-sdk 0.1.68 → 0.1.69

package/src/src/models/MagicLinkSendResult.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a developer platform for user authentication and transactional messaging. One API covers auth (passkeys, social sign-in, passwordless, MFA, sessions, organizations) plus email, push notifications, SMS, in-app messages, and webhooks.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard.  > **Test keys are being retired.** `zy_test_*` keys are no longer issued, and existing ones stop working on **21 October 2026**. They never delivered mail — sends were mocked and marked sent without reaching a provider, so they could not verify domain authentication, rendering, or deliverability. To test your integration, use a `zy_live_*` key against a verified domain and send to an address you control.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
+import {
+    GetDomain200ResponseMetaFromJSON,
+    GetDomain200ResponseMetaFromJSONTyped,
+    GetDomain200ResponseMetaToJSON,
+    GetDomain200ResponseMetaToJSONTyped,
+} from './GetDomain200ResponseMeta';
+import type { MagicLinkSendResultData } from './MagicLinkSendResultData';
+import {
+    MagicLinkSendResultDataFromJSON,
+    MagicLinkSendResultDataFromJSONTyped,
+    MagicLinkSendResultDataToJSON,
+    MagicLinkSendResultDataToJSONTyped,
+} from './MagicLinkSendResultData';
+
+/**
+ * 
+ * @export
+ * @interface MagicLinkSendResult
+ */
+export interface MagicLinkSendResult {
+    /**
+     * 
+     * @type {MagicLinkSendResultData}
+     * @memberof MagicLinkSendResult
+     */
+    data?: MagicLinkSendResultData;
+    /**
+     * 
+     * @type {GetDomain200ResponseMeta}
+     * @memberof MagicLinkSendResult
+     */
+    meta?: GetDomain200ResponseMeta;
+}
+
+/**
+ * Check if a given object implements the MagicLinkSendResult interface.
+ */
+export function instanceOfMagicLinkSendResult(value: object): value is MagicLinkSendResult {
+    return true;
+}
+
+export function MagicLinkSendResultFromJSON(json: any): MagicLinkSendResult {
+    return MagicLinkSendResultFromJSONTyped(json, false);
+}
+
+export function MagicLinkSendResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): MagicLinkSendResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : MagicLinkSendResultDataFromJSON(json['data']),
+        'meta': json['meta'] == null ? undefined : GetDomain200ResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function MagicLinkSendResultToJSON(json: any): MagicLinkSendResult {
+    return MagicLinkSendResultToJSONTyped(json, false);
+}
+
+export function MagicLinkSendResultToJSONTyped(value?: MagicLinkSendResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': MagicLinkSendResultDataToJSON(value['data']),
+        'meta': GetDomain200ResponseMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/MagicLinkSendResultData.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a developer platform for user authentication and transactional messaging. One API covers auth (passkeys, social sign-in, passwordless, MFA, sessions, organizations) plus email, push notifications, SMS, in-app messages, and webhooks.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard.  > **Test keys are being retired.** `zy_test_*` keys are no longer issued, and existing ones stop working on **21 October 2026**. They never delivered mail — sends were mocked and marked sent without reaching a provider, so they could not verify domain authentication, rendering, or deliverability. To test your integration, use a `zy_live_*` key against a verified domain and send to an address you control.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ReturnedAuthLink } from './ReturnedAuthLink';
+import {
+    ReturnedAuthLinkFromJSON,
+    ReturnedAuthLinkFromJSONTyped,
+    ReturnedAuthLinkToJSON,
+    ReturnedAuthLinkToJSONTyped,
+} from './ReturnedAuthLink';
+
+/**
+ * 
+ * @export
+ * @interface MagicLinkSendResultData
+ */
+export interface MagicLinkSendResultData {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MagicLinkSendResultData
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {ReturnedAuthLink}
+     * @memberof MagicLinkSendResultData
+     */
+    link?: ReturnedAuthLink;
+}
+
+/**
+ * Check if a given object implements the MagicLinkSendResultData interface.
+ */
+export function instanceOfMagicLinkSendResultData(value: object): value is MagicLinkSendResultData {
+    return true;
+}
+
+export function MagicLinkSendResultDataFromJSON(json: any): MagicLinkSendResultData {
+    return MagicLinkSendResultDataFromJSONTyped(json, false);
+}
+
+export function MagicLinkSendResultDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): MagicLinkSendResultData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'] == null ? undefined : json['success'],
+        'link': json['link'] == null ? undefined : ReturnedAuthLinkFromJSON(json['link']),
+    };
+}
+
+export function MagicLinkSendResultDataToJSON(json: any): MagicLinkSendResultData {
+    return MagicLinkSendResultDataToJSONTyped(json, false);
+}
+
+export function MagicLinkSendResultDataToJSONTyped(value?: MagicLinkSendResultData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'link': ReturnedAuthLinkToJSON(value['link']),
+    };
+}
+

package/src/src/models/ReturnedAuthLink.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a developer platform for user authentication and transactional messaging. One API covers auth (passkeys, social sign-in, passwordless, MFA, sessions, organizations) plus email, push notifications, SMS, in-app messages, and webhooks.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard.  > **Test keys are being retired.** `zy_test_*` keys are no longer issued, and existing ones stop working on **21 October 2026**. They never delivered mail — sends were mocked and marked sent without reaching a provider, so they could not verify domain authentication, rendering, or deliverability. To test your integration, use a `zy_live_*` key against a verified domain and send to an address you control.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A sign-in, reset or invitation link returned instead of emailed
+ * (`return_link: true`). The token is a live, single-use credential:
+ * never log it or expose it to anyone but the end user.
+ * 
+ * @export
+ * @interface ReturnedAuthLink
+ */
+export interface ReturnedAuthLink {
+    /**
+     * Your `redirect_url` with `?token=` appended — the same URL Zyphr's email would carry.
+     * @type {string}
+     * @memberof ReturnedAuthLink
+     */
+    url: string;
+    /**
+     * The raw token, redeemed at the matching endpoint (`/auth/magic-link/verify` or `/auth/reset-password`).
+     * @type {string}
+     * @memberof ReturnedAuthLink
+     */
+    token: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ReturnedAuthLink
+     */
+    expiresAt: Date;
+}
+
+/**
+ * Check if a given object implements the ReturnedAuthLink interface.
+ */
+export function instanceOfReturnedAuthLink(value: object): value is ReturnedAuthLink {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('token' in value) || value['token'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    return true;
+}
+
+export function ReturnedAuthLinkFromJSON(json: any): ReturnedAuthLink {
+    return ReturnedAuthLinkFromJSONTyped(json, false);
+}
+
+export function ReturnedAuthLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReturnedAuthLink {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'token': json['token'],
+        'expiresAt': (new Date(json['expires_at'])),
+    };
+}
+
+export function ReturnedAuthLinkToJSON(json: any): ReturnedAuthLink {
+    return ReturnedAuthLinkToJSONTyped(json, false);
+}
+
+export function ReturnedAuthLinkToJSONTyped(value?: ReturnedAuthLink | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'token': value['token'],
+        'expires_at': ((value['expiresAt']).toISOString()),
+    };
+}
+

package/src/src/models/index.ts

@@ -121,6 +121,8 @@ export * from './ExecutionResponse';
 export * from './ExecutionRetryResponse';
 export * from './ExecutionRetryResponseData';
 export * from './ForgotPasswordRequest';
+export * from './ForgotPasswordResult';
+export * from './ForgotPasswordResultData';
 export * from './GenerateSubscriberToken200Response';
 export * from './GenerateSubscriberToken200ResponseData';
 export * from './GenerateSubscriberTokenRequest';
@@ -174,6 +176,8 @@ export * from './ListWorkflows200Response';
 export * from './ListWorkflows200ResponseMeta';
 export * from './LoginRequest';
 export * from './MagicLinkSendRequest';
+export * from './MagicLinkSendResult';
+export * from './MagicLinkSendResultData';
 export * from './MagicLinkVerifyRequest';
 export * from './MagicLinkVerifyResponse';
 export * from './MagicLinkVerifyResponseData';
@@ -282,6 +286,7 @@ export * from './ResetPasswordRequest';
 export * from './ResetPasswordResponse';
 export * from './ResubscribeRequest';
 export * from './ResubscribeResponse';
+export * from './ReturnedAuthLink';
 export * from './RevokeAllSessionsResponse';
 export * from './RevokeAllSessionsResponseData';
 export * from './RevokeSessionRequest';