@zyphr-dev/node-sdk 0.1.8 → 0.1.9

package/package.json

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

package/src/.openapi-generator/FILES

@@ -97,6 +97,9 @@ src/models/EmailTrackingResponse.ts
 src/models/EndUserDeleteResponse.ts
 src/models/EndUserDeleteResponseData.ts
 src/models/ForgotPasswordRequest.ts
+src/models/GenerateSubscriberToken200Response.ts
+src/models/GenerateSubscriberToken200ResponseData.ts
+src/models/GenerateSubscriberTokenRequest.ts
 src/models/GenerateWaaSPortalToken201Response.ts
 src/models/GetWaaSEndpoint200Response.ts
 src/models/GetWaaSUsage200Response.ts

package/src/src/apis/InboxApi.ts

@@ -15,6 +15,9 @@
 
 import * as runtime from '../runtime';
 import type {
+  ApiError,
+  GenerateSubscriberToken200Response,
+  GenerateSubscriberTokenRequest,
   InboxListResponse,
   InboxNotificationResponse,
   MarkAllInboxReadRequest,
@@ -27,6 +30,12 @@ import type {
   UnreadCountResponse,
 } from '../models/index';
 import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    GenerateSubscriberToken200ResponseFromJSON,
+    GenerateSubscriberToken200ResponseToJSON,
+    GenerateSubscriberTokenRequestFromJSON,
+    GenerateSubscriberTokenRequestToJSON,
     InboxListResponseFromJSON,
     InboxListResponseToJSON,
     InboxNotificationResponseFromJSON,
@@ -60,6 +69,10 @@ export interface InboxApiDeleteInboxNotificationRequest {
     externalId?: string;
 }
 
+export interface InboxApiGenerateSubscriberTokenOperationRequest {
+    generateSubscriberTokenRequest: GenerateSubscriberTokenRequest;
+}
+
 export interface InboxApiGetInboxNotificationRequest {
     id: string;
     subscriberId?: string;
@@ -141,6 +154,22 @@ export interface InboxApiInterface {
      */
     deleteInboxNotification(id: string, subscriberId?: string, externalId?: 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. 
+     * @summary Generate a subscriber token
+     * @param {GenerateSubscriberTokenRequest} generateSubscriberTokenRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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 subscriber token
+     */
+    generateSubscriberToken(generateSubscriberTokenRequest: GenerateSubscriberTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateSubscriberToken200Response>;
+
     /**
      * Get a specific in-app notification by ID.
      * @summary Get a notification
@@ -359,6 +388,48 @@ export class InboxApi extends runtime.BaseAPI implements InboxApiInterface {
         await this.deleteInboxNotificationRaw({ id: id, subscriberId: subscriberId, externalId: externalId }, initOverrides);
     }
 
+    /**
+     * 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 subscriber token
+     */
+    async generateSubscriberTokenRaw(requestParameters: InboxApiGenerateSubscriberTokenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateSubscriberToken200Response>> {
+        if (requestParameters['generateSubscriberTokenRequest'] == null) {
+            throw new runtime.RequiredError(
+                'generateSubscriberTokenRequest',
+                'Required parameter "generateSubscriberTokenRequest" was null or undefined when calling generateSubscriberToken().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/subscriber-inbox/token`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GenerateSubscriberTokenRequestToJSON(requestParameters['generateSubscriberTokenRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenerateSubscriberToken200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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 subscriber token
+     */
+    async generateSubscriberToken(generateSubscriberTokenRequest: GenerateSubscriberTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateSubscriberToken200Response> {
+        const response = await this.generateSubscriberTokenRaw({ generateSubscriberTokenRequest: generateSubscriberTokenRequest }, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get a specific in-app notification by ID.
      * Get a notification

package/src/src/models/GenerateSubscriberToken200Response.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  ## 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 { GenerateSubscriberToken200ResponseData } from './GenerateSubscriberToken200ResponseData';
+import {
+    GenerateSubscriberToken200ResponseDataFromJSON,
+    GenerateSubscriberToken200ResponseDataFromJSONTyped,
+    GenerateSubscriberToken200ResponseDataToJSON,
+    GenerateSubscriberToken200ResponseDataToJSONTyped,
+} from './GenerateSubscriberToken200ResponseData';
+
+/**
+ * 
+ * @export
+ * @interface GenerateSubscriberToken200Response
+ */
+export interface GenerateSubscriberToken200Response {
+    /**
+     * 
+     * @type {GenerateSubscriberToken200ResponseData}
+     * @memberof GenerateSubscriberToken200Response
+     */
+    data?: GenerateSubscriberToken200ResponseData;
+}
+
+/**
+ * Check if a given object implements the GenerateSubscriberToken200Response interface.
+ */
+export function instanceOfGenerateSubscriberToken200Response(value: object): value is GenerateSubscriberToken200Response {
+    return true;
+}
+
+export function GenerateSubscriberToken200ResponseFromJSON(json: any): GenerateSubscriberToken200Response {
+    return GenerateSubscriberToken200ResponseFromJSONTyped(json, false);
+}
+
+export function GenerateSubscriberToken200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateSubscriberToken200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : GenerateSubscriberToken200ResponseDataFromJSON(json['data']),
+    };
+}
+
+export function GenerateSubscriberToken200ResponseToJSON(json: any): GenerateSubscriberToken200Response {
+    return GenerateSubscriberToken200ResponseToJSONTyped(json, false);
+}
+
+export function GenerateSubscriberToken200ResponseToJSONTyped(value?: GenerateSubscriberToken200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': GenerateSubscriberToken200ResponseDataToJSON(value['data']),
+    };
+}
+

package/src/src/models/GenerateSubscriberToken200ResponseData.ts

@@ -0,0 +1,81 @@
+/* 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  ## 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 GenerateSubscriberToken200ResponseData
+ */
+export interface GenerateSubscriberToken200ResponseData {
+    /**
+     * JWT subscriber token for client-side authentication
+     * @type {string}
+     * @memberof GenerateSubscriberToken200ResponseData
+     */
+    token?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GenerateSubscriberToken200ResponseData
+     */
+    subscriberId?: string;
+    /**
+     * Token lifetime in seconds
+     * @type {number}
+     * @memberof GenerateSubscriberToken200ResponseData
+     */
+    expiresIn?: number;
+}
+
+/**
+ * Check if a given object implements the GenerateSubscriberToken200ResponseData interface.
+ */
+export function instanceOfGenerateSubscriberToken200ResponseData(value: object): value is GenerateSubscriberToken200ResponseData {
+    return true;
+}
+
+export function GenerateSubscriberToken200ResponseDataFromJSON(json: any): GenerateSubscriberToken200ResponseData {
+    return GenerateSubscriberToken200ResponseDataFromJSONTyped(json, false);
+}
+
+export function GenerateSubscriberToken200ResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateSubscriberToken200ResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'token': json['token'] == null ? undefined : json['token'],
+        'subscriberId': json['subscriber_id'] == null ? undefined : json['subscriber_id'],
+        'expiresIn': json['expires_in'] == null ? undefined : json['expires_in'],
+    };
+}
+
+export function GenerateSubscriberToken200ResponseDataToJSON(json: any): GenerateSubscriberToken200ResponseData {
+    return GenerateSubscriberToken200ResponseDataToJSONTyped(json, false);
+}
+
+export function GenerateSubscriberToken200ResponseDataToJSONTyped(value?: GenerateSubscriberToken200ResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'token': value['token'],
+        'subscriber_id': value['subscriberId'],
+        'expires_in': value['expiresIn'],
+    };
+}
+

package/src/src/models/GenerateSubscriberTokenRequest.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  ## 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';
+/**
+ * Provide either subscriber_id or external_id
+ * @export
+ * @interface GenerateSubscriberTokenRequest
+ */
+export interface GenerateSubscriberTokenRequest {
+    /**
+     * Internal subscriber ID
+     * @type {string}
+     * @memberof GenerateSubscriberTokenRequest
+     */
+    subscriberId?: string;
+    /**
+     * Your external subscriber ID
+     * @type {string}
+     * @memberof GenerateSubscriberTokenRequest
+     */
+    externalId?: string;
+}
+
+/**
+ * Check if a given object implements the GenerateSubscriberTokenRequest interface.
+ */
+export function instanceOfGenerateSubscriberTokenRequest(value: object): value is GenerateSubscriberTokenRequest {
+    return true;
+}
+
+export function GenerateSubscriberTokenRequestFromJSON(json: any): GenerateSubscriberTokenRequest {
+    return GenerateSubscriberTokenRequestFromJSONTyped(json, false);
+}
+
+export function GenerateSubscriberTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenerateSubscriberTokenRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subscriberId': json['subscriber_id'] == null ? undefined : json['subscriber_id'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+
+export function GenerateSubscriberTokenRequestToJSON(json: any): GenerateSubscriberTokenRequest {
+    return GenerateSubscriberTokenRequestToJSONTyped(json, false);
+}
+
+export function GenerateSubscriberTokenRequestToJSONTyped(value?: GenerateSubscriberTokenRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subscriber_id': value['subscriberId'],
+        'external_id': value['externalId'],
+    };
+}
+

package/src/src/models/index.ts

@@ -66,6 +66,9 @@ export * from './EmailTrackingResponse';
 export * from './EndUserDeleteResponse';
 export * from './EndUserDeleteResponseData';
 export * from './ForgotPasswordRequest';
+export * from './GenerateSubscriberToken200Response';
+export * from './GenerateSubscriberToken200ResponseData';
+export * from './GenerateSubscriberTokenRequest';
 export * from './GenerateWaaSPortalToken201Response';
 export * from './GetWaaSEndpoint200Response';
 export * from './GetWaaSUsage200Response';