@zyphr-dev/node-sdk 0.1.8 → 0.1.10

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/MarkAllSubscriberNotificationsReadRequest.ts

@@ -0,0 +1,65 @@
+/* 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 MarkAllSubscriberNotificationsReadRequest
+ */
+export interface MarkAllSubscriberNotificationsReadRequest {
+    /**
+     * Only mark notifications in this category
+     * @type {string}
+     * @memberof MarkAllSubscriberNotificationsReadRequest
+     */
+    category?: string;
+}
+
+/**
+ * Check if a given object implements the MarkAllSubscriberNotificationsReadRequest interface.
+ */
+export function instanceOfMarkAllSubscriberNotificationsReadRequest(value: object): value is MarkAllSubscriberNotificationsReadRequest {
+    return true;
+}
+
+export function MarkAllSubscriberNotificationsReadRequestFromJSON(json: any): MarkAllSubscriberNotificationsReadRequest {
+    return MarkAllSubscriberNotificationsReadRequestFromJSONTyped(json, false);
+}
+
+export function MarkAllSubscriberNotificationsReadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): MarkAllSubscriberNotificationsReadRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'category': json['category'] == null ? undefined : json['category'],
+    };
+}
+
+export function MarkAllSubscriberNotificationsReadRequestToJSON(json: any): MarkAllSubscriberNotificationsReadRequest {
+    return MarkAllSubscriberNotificationsReadRequestToJSONTyped(json, false);
+}
+
+export function MarkAllSubscriberNotificationsReadRequestToJSONTyped(value?: MarkAllSubscriberNotificationsReadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'category': value['category'],
+    };
+}
+

package/src/src/models/UpdateSubscriberPreferencesRequest.ts

@@ -0,0 +1,74 @@
+/* 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 { UpdateSubscriberPreferencesRequestPreferencesInner } from './UpdateSubscriberPreferencesRequestPreferencesInner';
+import {
+    UpdateSubscriberPreferencesRequestPreferencesInnerFromJSON,
+    UpdateSubscriberPreferencesRequestPreferencesInnerFromJSONTyped,
+    UpdateSubscriberPreferencesRequestPreferencesInnerToJSON,
+    UpdateSubscriberPreferencesRequestPreferencesInnerToJSONTyped,
+} from './UpdateSubscriberPreferencesRequestPreferencesInner';
+
+/**
+ * 
+ * @export
+ * @interface UpdateSubscriberPreferencesRequest
+ */
+export interface UpdateSubscriberPreferencesRequest {
+    /**
+     * 
+     * @type {Array<UpdateSubscriberPreferencesRequestPreferencesInner>}
+     * @memberof UpdateSubscriberPreferencesRequest
+     */
+    preferences: Array<UpdateSubscriberPreferencesRequestPreferencesInner>;
+}
+
+/**
+ * Check if a given object implements the UpdateSubscriberPreferencesRequest interface.
+ */
+export function instanceOfUpdateSubscriberPreferencesRequest(value: object): value is UpdateSubscriberPreferencesRequest {
+    if (!('preferences' in value) || value['preferences'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSubscriberPreferencesRequestFromJSON(json: any): UpdateSubscriberPreferencesRequest {
+    return UpdateSubscriberPreferencesRequestFromJSONTyped(json, false);
+}
+
+export function UpdateSubscriberPreferencesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriberPreferencesRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'preferences': ((json['preferences'] as Array<any>).map(UpdateSubscriberPreferencesRequestPreferencesInnerFromJSON)),
+    };
+}
+
+export function UpdateSubscriberPreferencesRequestToJSON(json: any): UpdateSubscriberPreferencesRequest {
+    return UpdateSubscriberPreferencesRequestToJSONTyped(json, false);
+}
+
+export function UpdateSubscriberPreferencesRequestToJSONTyped(value?: UpdateSubscriberPreferencesRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'preferences': ((value['preferences'] as Array<any>).map(UpdateSubscriberPreferencesRequestPreferencesInnerToJSON)),
+    };
+}
+

package/src/src/models/UpdateSubscriberPreferencesRequestPreferencesInner.ts

@@ -0,0 +1,96 @@
+/* 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 UpdateSubscriberPreferencesRequestPreferencesInner
+ */
+export interface UpdateSubscriberPreferencesRequestPreferencesInner {
+    /**
+     * Category ID, or null for global preference
+     * @type {string}
+     * @memberof UpdateSubscriberPreferencesRequestPreferencesInner
+     */
+    categoryId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateSubscriberPreferencesRequestPreferencesInner
+     */
+    channel: UpdateSubscriberPreferencesRequestPreferencesInnerChannelEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateSubscriberPreferencesRequestPreferencesInner
+     */
+    enabled: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateSubscriberPreferencesRequestPreferencesInnerChannelEnum = {
+    EMAIL: 'email',
+    PUSH: 'push',
+    SMS: 'sms',
+    IN_APP: 'in_app'
+} as const;
+export type UpdateSubscriberPreferencesRequestPreferencesInnerChannelEnum = typeof UpdateSubscriberPreferencesRequestPreferencesInnerChannelEnum[keyof typeof UpdateSubscriberPreferencesRequestPreferencesInnerChannelEnum];
+
+
+/**
+ * Check if a given object implements the UpdateSubscriberPreferencesRequestPreferencesInner interface.
+ */
+export function instanceOfUpdateSubscriberPreferencesRequestPreferencesInner(value: object): value is UpdateSubscriberPreferencesRequestPreferencesInner {
+    if (!('channel' in value) || value['channel'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSubscriberPreferencesRequestPreferencesInnerFromJSON(json: any): UpdateSubscriberPreferencesRequestPreferencesInner {
+    return UpdateSubscriberPreferencesRequestPreferencesInnerFromJSONTyped(json, false);
+}
+
+export function UpdateSubscriberPreferencesRequestPreferencesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSubscriberPreferencesRequestPreferencesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'categoryId': json['category_id'] == null ? undefined : json['category_id'],
+        'channel': json['channel'],
+        'enabled': json['enabled'],
+    };
+}
+
+export function UpdateSubscriberPreferencesRequestPreferencesInnerToJSON(json: any): UpdateSubscriberPreferencesRequestPreferencesInner {
+    return UpdateSubscriberPreferencesRequestPreferencesInnerToJSONTyped(json, false);
+}
+
+export function UpdateSubscriberPreferencesRequestPreferencesInnerToJSONTyped(value?: UpdateSubscriberPreferencesRequestPreferencesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'category_id': value['categoryId'],
+        'channel': value['channel'],
+        'enabled': value['enabled'],
+    };
+}
+

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';
@@ -85,6 +88,7 @@ export * from './MagicLinkVerifyResponseData';
 export * from './MarkAllInboxReadRequest';
 export * from './MarkAllReadData';
 export * from './MarkAllReadResponse';
+export * from './MarkAllSubscriberNotificationsReadRequest';
 export * from './MarkInboxReadRequest';
 export * from './MfaBackupCodesResponse';
 export * from './MfaBackupCodesResponseData';
@@ -250,6 +254,8 @@ export * from './UnsubscribeRequest';
 export * from './UnsubscribeResponse';
 export * from './UpdateCategoryRequest';
 export * from './UpdateEndUserRequest';
+export * from './UpdateSubscriberPreferencesRequest';
+export * from './UpdateSubscriberPreferencesRequestPreferencesInner';
 export * from './UpdateSubscriberRequest';
 export * from './UpdateTemplateRequest';
 export * from './UpdateTopicRequest';