@zyphr-dev/node-sdk 0.1.41 → 0.1.42

package/package.json

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

package/src/.openapi-generator/FILES

@@ -329,6 +329,8 @@ src/models/SessionListResponse.ts
 src/models/SessionListResponseData.ts
 src/models/SessionListResponseDataSessionInfo.ts
 src/models/SetDomainInboundRequest.ts
+src/models/SetEndUserClaims200Response.ts
+src/models/SetEndUserClaims200ResponseData.ts
 src/models/SetEndUserClaimsRequest.ts
 src/models/SetPreferencesRequest.ts
 src/models/SetPreferencesRequestPreferencesInner.ts

package/src/client.ts

@@ -27,6 +27,7 @@ import {
   AuthPhoneApi,
   AuthRegistrationApi,
   AuthSessionsApi,
+  AuthUserDirectoryApi,
   AuthUserProfileApi,
   AuthWebAuthnApi,
   DevicesApi,
@@ -111,6 +112,8 @@ export class Zyphr {
     readonly phone: AuthPhoneApi;
     readonly emailOtp: AuthEmailOTPApi;
     readonly profile: AuthUserProfileApi;
+    /** Server-side (secret-key) end-user directory: list/search/get/update/delete, invite, and the trusted claims store. */
+    readonly userDirectory: AuthUserDirectoryApi;
     readonly webauthn: AuthWebAuthnApi;
   };
 
@@ -166,6 +169,7 @@ export class Zyphr {
       phone: new AuthPhoneApi(config),
       emailOtp: new AuthEmailOTPApi(config),
       profile: new AuthUserProfileApi(config),
+      userDirectory: new AuthUserDirectoryApi(config),
       webauthn: new AuthWebAuthnApi(config),
     };
   }

package/src/src/apis/AuthUserDirectoryApi.ts

@@ -16,12 +16,15 @@
 import * as runtime from '../runtime';
 import type {
   InviteEndUserRequest,
+  SetEndUserClaims200Response,
   SetEndUserClaimsRequest,
   UpdateEndUserByApplicationRequest,
 } from '../models/index';
 import {
     InviteEndUserRequestFromJSON,
     InviteEndUserRequestToJSON,
+    SetEndUserClaims200ResponseFromJSON,
+    SetEndUserClaims200ResponseToJSON,
     SetEndUserClaimsRequestFromJSON,
     SetEndUserClaimsRequestToJSON,
     UpdateEndUserByApplicationRequestFromJSON,
@@ -172,7 +175,7 @@ export interface AuthUserDirectoryApiInterface {
     listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user\'s next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
      * @summary Set an end user\'s stored custom claims (server-side admin)
      * @param {string} userId 
      * @param {SetEndUserClaimsRequest} setEndUserClaimsRequest 
@@ -180,13 +183,13 @@ export interface AuthUserDirectoryApiInterface {
      * @throws {RequiredError}
      * @memberof AuthUserDirectoryApiInterface
      */
-    setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetEndUserClaims200Response>>;
 
     /**
-     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user\'s next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
      * Set an end user\'s stored custom claims (server-side admin)
      */
-    setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetEndUserClaims200Response>;
 
     /**
      * Secret-key-scoped update of an arbitrary end user in the authenticating application. Updatable fields: email, name, avatar_url, metadata, status. Scoped to the application — a caller can never modify a user belonging to another application. 
@@ -481,10 +484,10 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
     }
 
     /**
-     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user\'s next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
      * Set an end user\'s stored custom claims (server-side admin)
      */
-    async setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetEndUserClaims200Response>> {
         if (requestParameters['userId'] == null) {
             throw new runtime.RequiredError(
                 'userId',
@@ -521,15 +524,16 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
             body: SetEndUserClaimsRequestToJSON(requestParameters['setEndUserClaimsRequest']),
         }, initOverrides);
 
-        return new runtime.VoidApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => SetEndUserClaims200ResponseFromJSON(jsonValue));
     }
 
     /**
-     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+     * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user\'s next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
      * Set an end user\'s stored custom claims (server-side admin)
      */
-    async setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.setEndUserClaimsRaw({ userId: userId, setEndUserClaimsRequest: setEndUserClaimsRequest }, initOverrides);
+    async setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetEndUserClaims200Response> {
+        const response = await this.setEndUserClaimsRaw({ userId: userId, setEndUserClaimsRequest: setEndUserClaimsRequest }, initOverrides);
+        return await response.value();
     }
 
     /**

package/src/src/apis/InboxApi.ts

@@ -235,7 +235,7 @@ export interface InboxApiInterface {
     deleteSubscriberNotification(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
      * @summary Generate a subscriber token
      * @param {GenerateSubscriberTokenRequest} generateSubscriberTokenRequest 
      * @param {*} [options] Override http request option.
@@ -245,7 +245,7 @@ export interface InboxApiInterface {
     generateSubscriberTokenRaw(requestParameters: InboxApiGenerateSubscriberTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateSubscriberToken200Response>>;
 
     /**
-     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
      * Generate a subscriber token
      */
     generateSubscriberToken(generateSubscriberTokenRequest: GenerateSubscriberTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateSubscriberToken200Response>;
@@ -682,7 +682,7 @@ export class InboxApi extends runtime.BaseAPI implements InboxApiInterface {
     }
 
     /**
-     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
      * Generate a subscriber token
      */
     async generateSubscriberTokenRaw(requestParameters: InboxApiGenerateSubscriberTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateSubscriberToken200Response>> {
@@ -715,7 +715,7 @@ export class InboxApi extends runtime.BaseAPI implements InboxApiInterface {
     }
 
     /**
-     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+     * Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`\'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
      * Generate a subscriber token
      */
     async generateSubscriberToken(generateSubscriberTokenRequest: GenerateSubscriberTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateSubscriberToken200Response> {

package/src/src/models/SetEndUserClaims200Response.ts

@@ -0,0 +1,73 @@
+/* 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 { SetEndUserClaims200ResponseData } from './SetEndUserClaims200ResponseData';
+import {
+    SetEndUserClaims200ResponseDataFromJSON,
+    SetEndUserClaims200ResponseDataFromJSONTyped,
+    SetEndUserClaims200ResponseDataToJSON,
+    SetEndUserClaims200ResponseDataToJSONTyped,
+} from './SetEndUserClaims200ResponseData';
+
+/**
+ * 
+ * @export
+ * @interface SetEndUserClaims200Response
+ */
+export interface SetEndUserClaims200Response {
+    /**
+     * 
+     * @type {SetEndUserClaims200ResponseData}
+     * @memberof SetEndUserClaims200Response
+     */
+    data?: SetEndUserClaims200ResponseData;
+}
+
+/**
+ * Check if a given object implements the SetEndUserClaims200Response interface.
+ */
+export function instanceOfSetEndUserClaims200Response(value: object): value is SetEndUserClaims200Response {
+    return true;
+}
+
+export function SetEndUserClaims200ResponseFromJSON(json: any): SetEndUserClaims200Response {
+    return SetEndUserClaims200ResponseFromJSONTyped(json, false);
+}
+
+export function SetEndUserClaims200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetEndUserClaims200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : SetEndUserClaims200ResponseDataFromJSON(json['data']),
+    };
+}
+
+export function SetEndUserClaims200ResponseToJSON(json: any): SetEndUserClaims200Response {
+    return SetEndUserClaims200ResponseToJSONTyped(json, false);
+}
+
+export function SetEndUserClaims200ResponseToJSONTyped(value?: SetEndUserClaims200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': SetEndUserClaims200ResponseDataToJSON(value['data']),
+    };
+}
+

package/src/src/models/SetEndUserClaims200ResponseData.ts

@@ -0,0 +1,73 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface SetEndUserClaims200ResponseData
+ */
+export interface SetEndUserClaims200ResponseData {
+    /**
+     * 
+     * @type {object}
+     * @memberof SetEndUserClaims200ResponseData
+     */
+    claims?: object;
+    /**
+     * Monotonic version bumped on each write; embedded in issued tokens.
+     * @type {number}
+     * @memberof SetEndUserClaims200ResponseData
+     */
+    claimsVersion?: number;
+}
+
+/**
+ * Check if a given object implements the SetEndUserClaims200ResponseData interface.
+ */
+export function instanceOfSetEndUserClaims200ResponseData(value: object): value is SetEndUserClaims200ResponseData {
+    return true;
+}
+
+export function SetEndUserClaims200ResponseDataFromJSON(json: any): SetEndUserClaims200ResponseData {
+    return SetEndUserClaims200ResponseDataFromJSONTyped(json, false);
+}
+
+export function SetEndUserClaims200ResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetEndUserClaims200ResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'claims': json['claims'] == null ? undefined : json['claims'],
+        'claimsVersion': json['claims_version'] == null ? undefined : json['claims_version'],
+    };
+}
+
+export function SetEndUserClaims200ResponseDataToJSON(json: any): SetEndUserClaims200ResponseData {
+    return SetEndUserClaims200ResponseDataToJSONTyped(json, false);
+}
+
+export function SetEndUserClaims200ResponseDataToJSONTyped(value?: SetEndUserClaims200ResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'claims': value['claims'],
+        'claims_version': value['claimsVersion'],
+    };
+}
+

package/src/src/models/index.ts

@@ -289,6 +289,8 @@ export * from './SessionListResponse';
 export * from './SessionListResponseData';
 export * from './SessionListResponseDataSessionInfo';
 export * from './SetDomainInboundRequest';
+export * from './SetEndUserClaims200Response';
+export * from './SetEndUserClaims200ResponseData';
 export * from './SetEndUserClaimsRequest';
 export * from './SetPreferencesRequest';
 export * from './SetPreferencesRequestPreferencesInner';