@zyphr-dev/node-sdk 0.1.27 → 0.1.28

package/src/src/models/AddDomainRequest.ts

@@ -0,0 +1,66 @@
+/* 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 AddDomainRequest
+ */
+export interface AddDomainRequest {
+    /**
+     * The sending domain to add (will be lowercased and trimmed)
+     * @type {string}
+     * @memberof AddDomainRequest
+     */
+    domain: string;
+}
+
+/**
+ * Check if a given object implements the AddDomainRequest interface.
+ */
+export function instanceOfAddDomainRequest(value: object): value is AddDomainRequest {
+    if (!('domain' in value) || value['domain'] === undefined) return false;
+    return true;
+}
+
+export function AddDomainRequestFromJSON(json: any): AddDomainRequest {
+    return AddDomainRequestFromJSONTyped(json, false);
+}
+
+export function AddDomainRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddDomainRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domain': json['domain'],
+    };
+}
+
+export function AddDomainRequestToJSON(json: any): AddDomainRequest {
+    return AddDomainRequestToJSONTyped(json, false);
+}
+
+export function AddDomainRequestToJSONTyped(value?: AddDomainRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domain': value['domain'],
+    };
+}
+

package/src/src/models/DeleteDomainResponse.ts

@@ -0,0 +1,90 @@
+/* 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 { GetDomain200ResponseMeta } from './GetDomain200ResponseMeta';
+import {
+    GetDomain200ResponseMetaFromJSON,
+    GetDomain200ResponseMetaFromJSONTyped,
+    GetDomain200ResponseMetaToJSON,
+    GetDomain200ResponseMetaToJSONTyped,
+} from './GetDomain200ResponseMeta';
+import type { DeleteDomainResponseData } from './DeleteDomainResponseData';
+import {
+    DeleteDomainResponseDataFromJSON,
+    DeleteDomainResponseDataFromJSONTyped,
+    DeleteDomainResponseDataToJSON,
+    DeleteDomainResponseDataToJSONTyped,
+} from './DeleteDomainResponseData';
+
+/**
+ * 
+ * @export
+ * @interface DeleteDomainResponse
+ */
+export interface DeleteDomainResponse {
+    /**
+     * 
+     * @type {DeleteDomainResponseData}
+     * @memberof DeleteDomainResponse
+     */
+    data: DeleteDomainResponseData;
+    /**
+     * 
+     * @type {GetDomain200ResponseMeta}
+     * @memberof DeleteDomainResponse
+     */
+    meta: GetDomain200ResponseMeta;
+}
+
+/**
+ * Check if a given object implements the DeleteDomainResponse interface.
+ */
+export function instanceOfDeleteDomainResponse(value: object): value is DeleteDomainResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function DeleteDomainResponseFromJSON(json: any): DeleteDomainResponse {
+    return DeleteDomainResponseFromJSONTyped(json, false);
+}
+
+export function DeleteDomainResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteDomainResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': DeleteDomainResponseDataFromJSON(json['data']),
+        'meta': GetDomain200ResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function DeleteDomainResponseToJSON(json: any): DeleteDomainResponse {
+    return DeleteDomainResponseToJSONTyped(json, false);
+}
+
+export function DeleteDomainResponseToJSONTyped(value?: DeleteDomainResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': DeleteDomainResponseDataToJSON(value['data']),
+        'meta': GetDomain200ResponseMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/DeleteDomainResponseData.ts

@@ -0,0 +1,75 @@
+/* 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 DeleteDomainResponseData
+ */
+export interface DeleteDomainResponseData {
+    /**
+     * 
+     * @type {string}
+     * @memberof DeleteDomainResponseData
+     */
+    id: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeleteDomainResponseData
+     */
+    deleted: boolean;
+}
+
+/**
+ * Check if a given object implements the DeleteDomainResponseData interface.
+ */
+export function instanceOfDeleteDomainResponseData(value: object): value is DeleteDomainResponseData {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('deleted' in value) || value['deleted'] === undefined) return false;
+    return true;
+}
+
+export function DeleteDomainResponseDataFromJSON(json: any): DeleteDomainResponseData {
+    return DeleteDomainResponseDataFromJSONTyped(json, false);
+}
+
+export function DeleteDomainResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteDomainResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'deleted': json['deleted'],
+    };
+}
+
+export function DeleteDomainResponseDataToJSON(json: any): DeleteDomainResponseData {
+    return DeleteDomainResponseDataToJSONTyped(json, false);
+}
+
+export function DeleteDomainResponseDataToJSONTyped(value?: DeleteDomainResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'deleted': value['deleted'],
+    };
+}
+

package/src/src/models/DnsRecord.ts

@@ -0,0 +1,127 @@
+/* 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';
+/**
+ * A single DNS record that must be published for the sending domain to verify
+ * @export
+ * @interface DnsRecord
+ */
+export interface DnsRecord {
+    /**
+     * DNS record type
+     * @type {string}
+     * @memberof DnsRecord
+     */
+    type: DnsRecordTypeEnum;
+    /**
+     * DNS record name (host)
+     * @type {string}
+     * @memberof DnsRecord
+     */
+    name: string;
+    /**
+     * DNS record value
+     * @type {string}
+     * @memberof DnsRecord
+     */
+    value: string;
+    /**
+     * What this record is for — useful for partial failure reasoning
+     * (e.g. "SPF verified, DKIM #2 still pending") instead of treating
+     * the set as opaque.
+     * 
+     * @type {string}
+     * @memberof DnsRecord
+     */
+    purpose: DnsRecordPurposeEnum;
+    /**
+     * Whether this specific record has been observed in DNS
+     * @type {boolean}
+     * @memberof DnsRecord
+     */
+    verified: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const DnsRecordTypeEnum = {
+    TXT: 'TXT',
+    CNAME: 'CNAME'
+} as const;
+export type DnsRecordTypeEnum = typeof DnsRecordTypeEnum[keyof typeof DnsRecordTypeEnum];
+
+/**
+ * @export
+ */
+export const DnsRecordPurposeEnum = {
+    DOMAIN_VERIFICATION: 'domain_verification',
+    SPF: 'spf',
+    DMARC: 'dmarc',
+    DKIM: 'dkim'
+} as const;
+export type DnsRecordPurposeEnum = typeof DnsRecordPurposeEnum[keyof typeof DnsRecordPurposeEnum];
+
+
+/**
+ * Check if a given object implements the DnsRecord interface.
+ */
+export function instanceOfDnsRecord(value: object): value is DnsRecord {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('purpose' in value) || value['purpose'] === undefined) return false;
+    if (!('verified' in value) || value['verified'] === undefined) return false;
+    return true;
+}
+
+export function DnsRecordFromJSON(json: any): DnsRecord {
+    return DnsRecordFromJSONTyped(json, false);
+}
+
+export function DnsRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnsRecord {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'name': json['name'],
+        'value': json['value'],
+        'purpose': json['purpose'],
+        'verified': json['verified'],
+    };
+}
+
+export function DnsRecordToJSON(json: any): DnsRecord {
+    return DnsRecordToJSONTyped(json, false);
+}
+
+export function DnsRecordToJSONTyped(value?: DnsRecord | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'name': value['name'],
+        'value': value['value'],
+        'purpose': value['purpose'],
+        'verified': value['verified'],
+    };
+}
+

package/src/src/models/DomainListResponse.ts

@@ -0,0 +1,90 @@
+/* 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 { DomainListResponseMeta } from './DomainListResponseMeta';
+import {
+    DomainListResponseMetaFromJSON,
+    DomainListResponseMetaFromJSONTyped,
+    DomainListResponseMetaToJSON,
+    DomainListResponseMetaToJSONTyped,
+} from './DomainListResponseMeta';
+import type { DomainResponse } from './DomainResponse';
+import {
+    DomainResponseFromJSON,
+    DomainResponseFromJSONTyped,
+    DomainResponseToJSON,
+    DomainResponseToJSONTyped,
+} from './DomainResponse';
+
+/**
+ * 
+ * @export
+ * @interface DomainListResponse
+ */
+export interface DomainListResponse {
+    /**
+     * 
+     * @type {Array<DomainResponse>}
+     * @memberof DomainListResponse
+     */
+    data: Array<DomainResponse>;
+    /**
+     * 
+     * @type {DomainListResponseMeta}
+     * @memberof DomainListResponse
+     */
+    meta: DomainListResponseMeta;
+}
+
+/**
+ * Check if a given object implements the DomainListResponse interface.
+ */
+export function instanceOfDomainListResponse(value: object): value is DomainListResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function DomainListResponseFromJSON(json: any): DomainListResponse {
+    return DomainListResponseFromJSONTyped(json, false);
+}
+
+export function DomainListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(DomainResponseFromJSON)),
+        'meta': DomainListResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function DomainListResponseToJSON(json: any): DomainListResponse {
+    return DomainListResponseToJSONTyped(json, false);
+}
+
+export function DomainListResponseToJSONTyped(value?: DomainListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(DomainResponseToJSON)),
+        'meta': DomainListResponseMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/DomainListResponseMeta.ts

@@ -0,0 +1,89 @@
+/* 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 DomainListResponseMeta
+ */
+export interface DomainListResponseMeta {
+    /**
+     * 
+     * @type {string}
+     * @memberof DomainListResponseMeta
+     */
+    requestId?: string;
+    /**
+     * Account-wide domain count (across all projects)
+     * @type {number}
+     * @memberof DomainListResponseMeta
+     */
+    count?: number;
+    /**
+     * Per-account domain limit from the current plan
+     * @type {number}
+     * @memberof DomainListResponseMeta
+     */
+    limit?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof DomainListResponseMeta
+     */
+    plan?: string;
+}
+
+/**
+ * Check if a given object implements the DomainListResponseMeta interface.
+ */
+export function instanceOfDomainListResponseMeta(value: object): value is DomainListResponseMeta {
+    return true;
+}
+
+export function DomainListResponseMetaFromJSON(json: any): DomainListResponseMeta {
+    return DomainListResponseMetaFromJSONTyped(json, false);
+}
+
+export function DomainListResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainListResponseMeta {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+        'count': json['count'] == null ? undefined : json['count'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+        'plan': json['plan'] == null ? undefined : json['plan'],
+    };
+}
+
+export function DomainListResponseMetaToJSON(json: any): DomainListResponseMeta {
+    return DomainListResponseMetaToJSONTyped(json, false);
+}
+
+export function DomainListResponseMetaToJSONTyped(value?: DomainListResponseMeta | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'request_id': value['requestId'],
+        'count': value['count'],
+        'limit': value['limit'],
+        'plan': value['plan'],
+    };
+}
+