@zyphr-dev/node-sdk 0.1.32 → 0.1.33

package/src/src/models/AddOrganizationMemberRequest.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';
+/**
+ * 
+ * @export
+ * @interface AddOrganizationMemberRequest
+ */
+export interface AddOrganizationMemberRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AddOrganizationMemberRequest
+     */
+    userId: string;
+    /**
+     * Opaque role string. Not interpreted by Zyphr in v1.
+     * @type {string}
+     * @memberof AddOrganizationMemberRequest
+     */
+    role?: string | null;
+}
+
+/**
+ * Check if a given object implements the AddOrganizationMemberRequest interface.
+ */
+export function instanceOfAddOrganizationMemberRequest(value: object): value is AddOrganizationMemberRequest {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function AddOrganizationMemberRequestFromJSON(json: any): AddOrganizationMemberRequest {
+    return AddOrganizationMemberRequestFromJSONTyped(json, false);
+}
+
+export function AddOrganizationMemberRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOrganizationMemberRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+        'role': json['role'] == null ? undefined : json['role'],
+    };
+}
+
+export function AddOrganizationMemberRequestToJSON(json: any): AddOrganizationMemberRequest {
+    return AddOrganizationMemberRequestToJSONTyped(json, false);
+}
+
+export function AddOrganizationMemberRequestToJSONTyped(value?: AddOrganizationMemberRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+        'role': value['role'],
+    };
+}
+

package/src/src/models/CreateOrganizationRequest.ts

@@ -0,0 +1,82 @@
+/* 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 CreateOrganizationRequest
+ */
+export interface CreateOrganizationRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateOrganizationRequest
+     */
+    name: string;
+    /**
+     * Optional human-friendly identifier, unique per environment when present.
+     * @type {string}
+     * @memberof CreateOrganizationRequest
+     */
+    slug?: string | null;
+    /**
+     * Integrator-owned opaque JSON.
+     * @type {object}
+     * @memberof CreateOrganizationRequest
+     */
+    metadata?: object;
+}
+
+/**
+ * Check if a given object implements the CreateOrganizationRequest interface.
+ */
+export function instanceOfCreateOrganizationRequest(value: object): value is CreateOrganizationRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateOrganizationRequestFromJSON(json: any): CreateOrganizationRequest {
+    return CreateOrganizationRequestFromJSONTyped(json, false);
+}
+
+export function CreateOrganizationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrganizationRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function CreateOrganizationRequestToJSON(json: any): CreateOrganizationRequest {
+    return CreateOrganizationRequestToJSONTyped(json, false);
+}
+
+export function CreateOrganizationRequestToJSONTyped(value?: CreateOrganizationRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'slug': value['slug'],
+        'metadata': value['metadata'],
+    };
+}
+

package/src/src/models/LoginRequest.ts

@@ -37,6 +37,16 @@ export interface LoginRequest {
      * @memberof LoginRequest
      */
     customClaims?: { [key: string]: any; };
+    /**
+     * Optional active organization for the resulting token (sc-5591).
+     * If specified the user must be a member; the token's org_id is set
+     * to it. If omitted and the user has 0 or 1 non-Default memberships,
+     * org_id is auto-populated. If 2+ memberships, omit and call
+     * switchOrganization to pick. Requires Pro/Enterprise.
+     * @type {string}
+     * @memberof LoginRequest
+     */
+    organizationId?: string;
 }
 
 /**
@@ -61,6 +71,7 @@ export function LoginRequestFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'email': json['email'],
         'password': json['password'],
         'customClaims': json['custom_claims'] == null ? undefined : json['custom_claims'],
+        'organizationId': json['organization_id'] == null ? undefined : json['organization_id'],
     };
 }
 
@@ -78,6 +89,7 @@ export function LoginRequestToJSONTyped(value?: LoginRequest | null, ignoreDiscr
         'email': value['email'],
         'password': value['password'],
         'custom_claims': value['customClaims'],
+        'organization_id': value['organizationId'],
     };
 }
 

package/src/src/models/Organization.ts

@@ -0,0 +1,137 @@
+/* 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 sub-tenant inside an Auth application × environment.
+ * @export
+ * @interface Organization
+ */
+export interface Organization {
+    /**
+     * 
+     * @type {string}
+     * @memberof Organization
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Organization
+     */
+    applicationId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Organization
+     */
+    environmentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Organization
+     */
+    name: string;
+    /**
+     * Optional human-friendly identifier, unique per environment when present.
+     * @type {string}
+     * @memberof Organization
+     */
+    slug?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof Organization
+     */
+    metadata: { [key: string]: any; };
+    /**
+     * True for the auto-created Default org per environment. Cannot be renamed or deleted via API.
+     * @type {boolean}
+     * @memberof Organization
+     */
+    isDefault: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Organization
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Organization
+     */
+    updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the Organization interface.
+ */
+export function instanceOfOrganization(value: object): value is Organization {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('applicationId' in value) || value['applicationId'] === undefined) return false;
+    if (!('environmentId' in value) || value['environmentId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function OrganizationFromJSON(json: any): Organization {
+    return OrganizationFromJSONTyped(json, false);
+}
+
+export function OrganizationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Organization {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'applicationId': json['application_id'],
+        'environmentId': json['environment_id'],
+        'name': json['name'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'metadata': json['metadata'],
+        'isDefault': json['is_default'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function OrganizationToJSON(json: any): Organization {
+    return OrganizationToJSONTyped(json, false);
+}
+
+export function OrganizationToJSONTyped(value?: Organization | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'application_id': value['applicationId'],
+        'environment_id': value['environmentId'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'metadata': value['metadata'],
+        'is_default': value['isDefault'],
+        'created_at': ((value['createdAt']).toISOString()),
+        'updated_at': ((value['updatedAt']).toISOString()),
+    };
+}
+

package/src/src/models/OrganizationListResponse.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 { Organization } from './Organization';
+import {
+    OrganizationFromJSON,
+    OrganizationFromJSONTyped,
+    OrganizationToJSON,
+    OrganizationToJSONTyped,
+} from './Organization';
+import type { OrganizationListResponseMeta } from './OrganizationListResponseMeta';
+import {
+    OrganizationListResponseMetaFromJSON,
+    OrganizationListResponseMetaFromJSONTyped,
+    OrganizationListResponseMetaToJSON,
+    OrganizationListResponseMetaToJSONTyped,
+} from './OrganizationListResponseMeta';
+
+/**
+ * 
+ * @export
+ * @interface OrganizationListResponse
+ */
+export interface OrganizationListResponse {
+    /**
+     * 
+     * @type {Array<Organization>}
+     * @memberof OrganizationListResponse
+     */
+    data: Array<Organization>;
+    /**
+     * 
+     * @type {OrganizationListResponseMeta}
+     * @memberof OrganizationListResponse
+     */
+    meta: OrganizationListResponseMeta;
+}
+
+/**
+ * Check if a given object implements the OrganizationListResponse interface.
+ */
+export function instanceOfOrganizationListResponse(value: object): value is OrganizationListResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function OrganizationListResponseFromJSON(json: any): OrganizationListResponse {
+    return OrganizationListResponseFromJSONTyped(json, false);
+}
+
+export function OrganizationListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrganizationListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(OrganizationFromJSON)),
+        'meta': OrganizationListResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function OrganizationListResponseToJSON(json: any): OrganizationListResponse {
+    return OrganizationListResponseToJSONTyped(json, false);
+}
+
+export function OrganizationListResponseToJSONTyped(value?: OrganizationListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(OrganizationToJSON)),
+        'meta': OrganizationListResponseMetaToJSON(value['meta']),
+    };
+}
+

package/src/src/models/OrganizationListResponseMeta.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';
+/**
+ * 
+ * @export
+ * @interface OrganizationListResponseMeta
+ */
+export interface OrganizationListResponseMeta {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationListResponseMeta
+     */
+    requestId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationListResponseMeta
+     */
+    nextCursor?: string | null;
+}
+
+/**
+ * Check if a given object implements the OrganizationListResponseMeta interface.
+ */
+export function instanceOfOrganizationListResponseMeta(value: object): value is OrganizationListResponseMeta {
+    return true;
+}
+
+export function OrganizationListResponseMetaFromJSON(json: any): OrganizationListResponseMeta {
+    return OrganizationListResponseMetaFromJSONTyped(json, false);
+}
+
+export function OrganizationListResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrganizationListResponseMeta {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+        'nextCursor': json['next_cursor'] == null ? undefined : json['next_cursor'],
+    };
+}
+
+export function OrganizationListResponseMetaToJSON(json: any): OrganizationListResponseMeta {
+    return OrganizationListResponseMetaToJSONTyped(json, false);
+}
+
+export function OrganizationListResponseMetaToJSONTyped(value?: OrganizationListResponseMeta | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'request_id': value['requestId'],
+        'next_cursor': value['nextCursor'],
+    };
+}
+

package/src/src/models/OrganizationMembersListResponse.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 { OrganizationListResponseMeta } from './OrganizationListResponseMeta';
+import {
+    OrganizationListResponseMetaFromJSON,
+    OrganizationListResponseMetaFromJSONTyped,
+    OrganizationListResponseMetaToJSON,
+    OrganizationListResponseMetaToJSONTyped,
+} from './OrganizationListResponseMeta';
+import type { OrganizationMembershipWithUser } from './OrganizationMembershipWithUser';
+import {
+    OrganizationMembershipWithUserFromJSON,
+    OrganizationMembershipWithUserFromJSONTyped,
+    OrganizationMembershipWithUserToJSON,
+    OrganizationMembershipWithUserToJSONTyped,
+} from './OrganizationMembershipWithUser';
+
+/**
+ * 
+ * @export
+ * @interface OrganizationMembersListResponse
+ */
+export interface OrganizationMembersListResponse {
+    /**
+     * 
+     * @type {Array<OrganizationMembershipWithUser>}
+     * @memberof OrganizationMembersListResponse
+     */
+    data: Array<OrganizationMembershipWithUser>;
+    /**
+     * 
+     * @type {OrganizationListResponseMeta}
+     * @memberof OrganizationMembersListResponse
+     */
+    meta: OrganizationListResponseMeta;
+}
+
+/**
+ * Check if a given object implements the OrganizationMembersListResponse interface.
+ */
+export function instanceOfOrganizationMembersListResponse(value: object): value is OrganizationMembersListResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function OrganizationMembersListResponseFromJSON(json: any): OrganizationMembersListResponse {
+    return OrganizationMembersListResponseFromJSONTyped(json, false);
+}
+
+export function OrganizationMembersListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrganizationMembersListResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(OrganizationMembershipWithUserFromJSON)),
+        'meta': OrganizationListResponseMetaFromJSON(json['meta']),
+    };
+}
+
+export function OrganizationMembersListResponseToJSON(json: any): OrganizationMembersListResponse {
+    return OrganizationMembersListResponseToJSONTyped(json, false);
+}
+
+export function OrganizationMembersListResponseToJSONTyped(value?: OrganizationMembersListResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(OrganizationMembershipWithUserToJSON)),
+        'meta': OrganizationListResponseMetaToJSON(value['meta']),
+    };
+}
+