@zyphr-dev/node-sdk 0.1.43 → 0.1.44

package/src/src/models/AuthMethods.ts

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## 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. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## 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';
+/**
+ * Aggregate view of the sign-in methods configured for a single end user, for building a customer "sign-in methods" screen.
+ * @export
+ * @interface AuthMethods
+ */
+export interface AuthMethods {
+    /**
+     * True if the user has a password credential (false for OAuth-only / passwordless users).
+     * @type {boolean}
+     * @memberof AuthMethods
+     */
+    hasPassword: boolean;
+    /**
+     * Distinct OAuth providers linked to the user (e.g. google, apple).
+     * @type {Array<string>}
+     * @memberof AuthMethods
+     */
+    oauthProviders: Array<string>;
+    /**
+     * True if the user has multi-factor authentication enabled.
+     * @type {boolean}
+     * @memberof AuthMethods
+     */
+    mfaEnabled: boolean;
+    /**
+     * True if the user's email address has been verified.
+     * @type {boolean}
+     * @memberof AuthMethods
+     */
+    emailVerified: boolean;
+    /**
+     * True if the user's phone number has been verified.
+     * @type {boolean}
+     * @memberof AuthMethods
+     */
+    phoneVerified: boolean;
+    /**
+     * Number of WebAuthn passkeys registered for the user.
+     * @type {number}
+     * @memberof AuthMethods
+     */
+    passkeys: number;
+}
+
+/**
+ * Check if a given object implements the AuthMethods interface.
+ */
+export function instanceOfAuthMethods(value: object): value is AuthMethods {
+    if (!('hasPassword' in value) || value['hasPassword'] === undefined) return false;
+    if (!('oauthProviders' in value) || value['oauthProviders'] === undefined) return false;
+    if (!('mfaEnabled' in value) || value['mfaEnabled'] === undefined) return false;
+    if (!('emailVerified' in value) || value['emailVerified'] === undefined) return false;
+    if (!('phoneVerified' in value) || value['phoneVerified'] === undefined) return false;
+    if (!('passkeys' in value) || value['passkeys'] === undefined) return false;
+    return true;
+}
+
+export function AuthMethodsFromJSON(json: any): AuthMethods {
+    return AuthMethodsFromJSONTyped(json, false);
+}
+
+export function AuthMethodsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthMethods {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'hasPassword': json['has_password'],
+        'oauthProviders': json['oauth_providers'],
+        'mfaEnabled': json['mfa_enabled'],
+        'emailVerified': json['email_verified'],
+        'phoneVerified': json['phone_verified'],
+        'passkeys': json['passkeys'],
+    };
+}
+
+export function AuthMethodsToJSON(json: any): AuthMethods {
+    return AuthMethodsToJSONTyped(json, false);
+}
+
+export function AuthMethodsToJSONTyped(value?: AuthMethods | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'has_password': value['hasPassword'],
+        'oauth_providers': value['oauthProviders'],
+        'mfa_enabled': value['mfaEnabled'],
+        'email_verified': value['emailVerified'],
+        'phone_verified': value['phoneVerified'],
+        'passkeys': value['passkeys'],
+    };
+}
+

package/src/src/models/GetEndUserAuthMethods200Response.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## 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. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## 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 { AuthMethods } from './AuthMethods';
+import {
+    AuthMethodsFromJSON,
+    AuthMethodsFromJSONTyped,
+    AuthMethodsToJSON,
+    AuthMethodsToJSONTyped,
+} from './AuthMethods';
+import type { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
+import {
+    GetDomain200ResponseMetaFromJSON,
+    GetDomain200ResponseMetaFromJSONTyped,
+    GetDomain200ResponseMetaToJSON,
+    GetDomain200ResponseMetaToJSONTyped,
+} from './GetDomain200ResponseMeta';
+
+/**
+ * 
+ * @export
+ * @interface GetEndUserAuthMethods200Response
+ */
+export interface GetEndUserAuthMethods200Response {
+    /**
+     * 
+     * @type {AuthMethods}
+     * @memberof GetEndUserAuthMethods200Response
+     */
+    data?: AuthMethods;
+    /**
+     * 
+     * @type {GetDomain200ResponseMeta}
+     * @memberof GetEndUserAuthMethods200Response
+     */
+    meta?: GetDomain200ResponseMeta;
+}
+
+/**
+ * Check if a given object implements the GetEndUserAuthMethods200Response interface.
+ */
+export function instanceOfGetEndUserAuthMethods200Response(value: object): value is GetEndUserAuthMethods200Response {
+    return true;
+}
+
+export function GetEndUserAuthMethods200ResponseFromJSON(json: any): GetEndUserAuthMethods200Response {
+    return GetEndUserAuthMethods200ResponseFromJSONTyped(json, false);
+}
+
+export function GetEndUserAuthMethods200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEndUserAuthMethods200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : AuthMethodsFromJSON(json['data']),
+        'meta': json['meta'] == null ? undefined : GetDomain200ResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function GetEndUserAuthMethods200ResponseToJSON(json: any): GetEndUserAuthMethods200Response {
+    return GetEndUserAuthMethods200ResponseToJSONTyped(json, false);
+}
+
+export function GetEndUserAuthMethods200ResponseToJSONTyped(value?: GetEndUserAuthMethods200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': AuthMethodsToJSON(value['data']),
+        'meta': GetDomain200ResponseMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/index.ts

@@ -10,6 +10,8 @@ export * from './AddWorkflowStepRequest';
 export * from './ApiError';
 export * from './ApiErrorError';
 export * from './ApiErrorMeta';
+export * from './ApplicationSelf';
+export * from './ApplicationSelfResponse';
 export * from './AuthEmailTemplate';
 export * from './AuthEmailTemplateDefault';
 export * from './AuthEmailTemplateDefaultResponse';
@@ -30,6 +32,7 @@ export * from './AuthEmailType';
 export * from './AuthLoginResponse';
 export * from './AuthLoginResult';
 export * from './AuthLoginResultMfaChallenge';
+export * from './AuthMethods';
 export * from './AuthResult';
 export * from './AuthResultResponse';
 export * from './AuthSession';
@@ -123,6 +126,7 @@ export * from './GenerateSubscriberTokenRequest';
 export * from './GenerateWaaSPortalToken201Response';
 export * from './GetDomain200Response';
 export * from './GetDomain200ResponseMeta';
+export * from './GetEndUserAuthMethods200Response';
 export * from './GetEndUserById200Response';
 export * from './GetEndUserClaims200Response';
 export * from './GetEndUserClaims200ResponseData';