magicbell-js 0.0.4 → 0.2.0

package/src/project-client/services/jwt/jwt-service.ts

@@ -1,233 +0,0 @@
-import { z } from 'zod';
-
-import { Environment } from '../../http/environment.js';
-import { SerializationStyle } from '../../http/serialization/base-serializer.js';
-import { RequestBuilder } from '../../http/transport/request-builder.js';
-import { ContentType, HttpResponse, RequestConfig } from '../../http/types.js';
-import { BaseService } from '../base-service.js';
-import { AccessTokenCollection, accessTokenCollectionResponse } from './models/access-token-collection.js';
-import { CreateProjectTokenRequest, createProjectTokenRequestRequest } from './models/create-project-token-request.js';
-import { CreateTokenResponse, createTokenResponseResponse } from './models/create-token-response.js';
-import { CreateUserTokenRequest, createUserTokenRequestRequest } from './models/create-user-token-request.js';
-import { DiscardTokenResponse, discardTokenResponseResponse } from './models/discard-token-response.js';
-import { FetchProjectTokensParams, FetchUserTokensParams } from './request-params.js';
-
-export class JwtService extends BaseService {
-  /**
-   * Retrieves a list of all active project-level JWT tokens. Returns a paginated list showing token metadata including creation date, last used date, and expiration time. For security reasons, the actual token values are not included in the response.
-   * @param {number} [params.limit] -
-   * @param {string} [params.startingAfter] -
-   * @param {string} [params.endingBefore] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<AccessTokenCollection>>} OK
-   */
-  async fetchProjectTokens(
-    params?: FetchProjectTokensParams,
-    requestConfig?: RequestConfig,
-  ): Promise<HttpResponse<AccessTokenCollection>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('GET')
-      .setPath('/jwt/project')
-      .setRequestSchema(z.any())
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: accessTokenCollectionResponse,
-        contentType: ContentType.Json,
-        status: 200,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addQueryParam({
-        key: 'limit',
-        value: params?.limit,
-      })
-      .addQueryParam({
-        key: 'starting_after',
-        value: params?.startingAfter,
-      })
-      .addQueryParam({
-        key: 'ending_before',
-        value: params?.endingBefore,
-      })
-      .build();
-    return this.client.call<AccessTokenCollection>(request);
-  }
-
-  /**
-   * Creates a new project-level JWT token. These tokens provide project-wide access and should be carefully managed. Only administrators can create project tokens. The returned token should be securely stored as it cannot be retrieved again after creation.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<CreateTokenResponse>>} Created
-   */
-  async createProjectJwt(
-    body: CreateProjectTokenRequest,
-    requestConfig?: RequestConfig,
-  ): Promise<HttpResponse<CreateTokenResponse>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('POST')
-      .setPath('/jwt/project')
-      .setRequestSchema(createProjectTokenRequestRequest)
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: createTokenResponseResponse,
-        contentType: ContentType.Json,
-        status: 201,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addHeaderParam({ key: 'Content-Type', value: 'application/json' })
-      .addBody(body)
-      .build();
-    return this.client.call<CreateTokenResponse>(request);
-  }
-
-  /**
-   * Immediately revokes a project-level JWT token. Once revoked, any requests using this token will be rejected. This action is immediate and cannot be undone. Active sessions using this token will be terminated.
-   * @param {string} tokenId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<DiscardTokenResponse>>} OK
-   */
-  async discardProjectJwt(tokenId: string, requestConfig?: RequestConfig): Promise<HttpResponse<DiscardTokenResponse>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('DELETE')
-      .setPath('/jwt/project/{token_id}')
-      .setRequestSchema(z.any())
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: discardTokenResponseResponse,
-        contentType: ContentType.Json,
-        status: 200,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addPathParam({
-        key: 'token_id',
-        value: tokenId,
-      })
-      .build();
-    return this.client.call<DiscardTokenResponse>(request);
-  }
-
-  /**
-   * Issues a new user-specific JWT token. These tokens are scoped to individual user permissions and access levels. Only administrators can create user tokens. The token is returned only once at creation time and cannot be retrieved later.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<CreateTokenResponse>>} Created
-   */
-  async createUserJwt(
-    body: CreateUserTokenRequest,
-    requestConfig?: RequestConfig,
-  ): Promise<HttpResponse<CreateTokenResponse>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('POST')
-      .setPath('/jwt/user')
-      .setRequestSchema(createUserTokenRequestRequest)
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: createTokenResponseResponse,
-        contentType: ContentType.Json,
-        status: 201,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addHeaderParam({ key: 'Content-Type', value: 'application/json' })
-      .addBody(body)
-      .build();
-    return this.client.call<CreateTokenResponse>(request);
-  }
-
-  /**
-   * Revokes a specific user's JWT token. This immediately invalidates the token and terminates any active sessions using it. This action cannot be undone. Administrators should use this to revoke access when needed for security purposes.
-   * @param {string} tokenId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<DiscardTokenResponse>>} OK
-   */
-  async discardUserJwt(tokenId: string, requestConfig?: RequestConfig): Promise<HttpResponse<DiscardTokenResponse>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('DELETE')
-      .setPath('/jwt/user/{token_id}')
-      .setRequestSchema(z.any())
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: discardTokenResponseResponse,
-        contentType: ContentType.Json,
-        status: 200,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addPathParam({
-        key: 'token_id',
-        value: tokenId,
-      })
-      .build();
-    return this.client.call<DiscardTokenResponse>(request);
-  }
-
-  /**
-   * Lists all JWT tokens associated with a specific user. Returns token metadata including creation time, last access time, and expiration date. Administrators can use this to audit user token usage and manage active sessions. Token values are not included in the response for security reasons.
-   * @param {string} userId -
-   * @param {number} [params.limit] -
-   * @param {string} [params.startingAfter] -
-   * @param {string} [params.endingBefore] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<AccessTokenCollection>>} OK
-   */
-  async fetchUserTokens(
-    userId: string,
-    params?: FetchUserTokensParams,
-    requestConfig?: RequestConfig,
-  ): Promise<HttpResponse<AccessTokenCollection>> {
-    const request = new RequestBuilder()
-      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
-      .setConfig(this.config)
-      .setMethod('GET')
-      .setPath('/jwt/user/{user_id}')
-      .setRequestSchema(z.any())
-      .addAccessTokenAuth(this.config.token, 'Bearer')
-      .setRequestContentType(ContentType.Json)
-      .addResponse({
-        schema: accessTokenCollectionResponse,
-        contentType: ContentType.Json,
-        status: 200,
-      })
-      .setRetryAttempts(this.config, requestConfig)
-      .setRetryDelayMs(this.config, requestConfig)
-      .setResponseValidation(this.config, requestConfig)
-      .addPathParam({
-        key: 'user_id',
-        value: userId,
-      })
-      .addQueryParam({
-        key: 'limit',
-        value: params?.limit,
-      })
-      .addQueryParam({
-        key: 'starting_after',
-        value: params?.startingAfter,
-      })
-      .addQueryParam({
-        key: 'ending_before',
-        value: params?.endingBefore,
-      })
-      .build();
-    return this.client.call<AccessTokenCollection>(request);
-  }
-}

package/src/project-client/services/jwt/models/access-token-collection.ts

@@ -1,54 +0,0 @@
-import { z } from 'zod';
-
-import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
-import { AccessToken, accessToken, accessTokenRequest, accessTokenResponse } from './access-token.js';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const accessTokenCollection = z.lazy(() => {
-  return z.object({
-    data: z.array(accessToken).optional(),
-    links: links.optional(),
-  });
-});
-
-/**
- *
- * @typedef  {AccessTokenCollection} accessTokenCollection
- * @property {AccessToken[]}
- * @property {Links}
- */
-export type AccessTokenCollection = z.infer<typeof accessTokenCollection>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const accessTokenCollectionResponse = z.lazy(() => {
-  return z
-    .object({
-      data: z.array(accessTokenResponse).optional(),
-      links: linksResponse.optional(),
-    })
-    .transform((data) => ({
-      data: data['data'],
-      links: data['links'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const accessTokenCollectionRequest = z.lazy(() => {
-  return z
-    .object({
-      data: z.array(accessTokenRequest).optional(),
-      links: linksRequest.optional(),
-    })
-    .transform((data) => ({
-      data: data['data'],
-      links: data['links'],
-    }));
-});

package/src/project-client/services/jwt/models/access-token.ts

@@ -1,69 +0,0 @@
-import { z } from 'zod';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const accessToken = z.lazy(() => {
-  return z.object({
-    createdAt: z.string(),
-    discardedAt: z.string().optional().nullable(),
-    expiresAt: z.string().optional(),
-    id: z.string().optional(),
-    name: z.string().optional().nullable(),
-  });
-});
-
-/**
- *
- * @typedef  {AccessToken} accessToken
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- */
-export type AccessToken = z.infer<typeof accessToken>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const accessTokenResponse = z.lazy(() => {
-  return z
-    .object({
-      created_at: z.string(),
-      discarded_at: z.string().optional().nullable(),
-      expires_at: z.string().optional(),
-      id: z.string().optional(),
-      name: z.string().optional().nullable(),
-    })
-    .transform((data) => ({
-      createdAt: data['created_at'],
-      discardedAt: data['discarded_at'],
-      expiresAt: data['expires_at'],
-      id: data['id'],
-      name: data['name'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const accessTokenRequest = z.lazy(() => {
-  return z
-    .object({
-      createdAt: z.string(),
-      discardedAt: z.string().optional().nullable(),
-      expiresAt: z.string().optional(),
-      id: z.string().optional(),
-      name: z.string().optional().nullable(),
-    })
-    .transform((data) => ({
-      created_at: data['createdAt'],
-      discarded_at: data['discardedAt'],
-      expires_at: data['expiresAt'],
-      id: data['id'],
-      name: data['name'],
-    }));
-});

package/src/project-client/services/jwt/models/create-project-token-request.ts

@@ -1,51 +0,0 @@
-import { z } from 'zod';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const createProjectTokenRequest = z.lazy(() => {
-  return z.object({
-    expiry: z.number().gte(1).optional().nullable(),
-    name: z.string().max(255),
-  });
-});
-
-/**
- *
- * @typedef  {CreateProjectTokenRequest} createProjectTokenRequest
- * @property {number} - The duration for which the token is valid (in seconds)
- * @property {string} - The name of the token.
- */
-export type CreateProjectTokenRequest = z.infer<typeof createProjectTokenRequest>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const createProjectTokenRequestResponse = z.lazy(() => {
-  return z
-    .object({
-      expiry: z.number().gte(1).optional().nullable(),
-      name: z.string().max(255),
-    })
-    .transform((data) => ({
-      expiry: data['expiry'],
-      name: data['name'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const createProjectTokenRequestRequest = z.lazy(() => {
-  return z
-    .object({
-      expiry: z.number().gte(1).optional().nullable(),
-      name: z.string().max(255),
-    })
-    .transform((data) => ({
-      expiry: data['expiry'],
-      name: data['name'],
-    }));
-});

package/src/project-client/services/jwt/models/create-token-response.ts

@@ -1,63 +0,0 @@
-import { z } from 'zod';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const createTokenResponse = z.lazy(() => {
-  return z.object({
-    createdAt: z.string(),
-    expiresAt: z.string().optional().nullable(),
-    token: z.string(),
-    tokenId: z.string(),
-  });
-});
-
-/**
- *
- * @typedef  {CreateTokenResponse} createTokenResponse
- * @property {string}
- * @property {string}
- * @property {string}
- * @property {string}
- */
-export type CreateTokenResponse = z.infer<typeof createTokenResponse>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const createTokenResponseResponse = z.lazy(() => {
-  return z
-    .object({
-      created_at: z.string(),
-      expires_at: z.string().optional().nullable(),
-      token: z.string(),
-      token_id: z.string(),
-    })
-    .transform((data) => ({
-      createdAt: data['created_at'],
-      expiresAt: data['expires_at'],
-      token: data['token'],
-      tokenId: data['token_id'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const createTokenResponseRequest = z.lazy(() => {
-  return z
-    .object({
-      createdAt: z.string(),
-      expiresAt: z.string().optional().nullable(),
-      token: z.string(),
-      tokenId: z.string(),
-    })
-    .transform((data) => ({
-      created_at: data['createdAt'],
-      expires_at: data['expiresAt'],
-      token: data['token'],
-      token_id: data['tokenId'],
-    }));
-});

package/src/project-client/services/jwt/models/create-user-token-request.ts

@@ -1,63 +0,0 @@
-import { z } from 'zod';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const createUserTokenRequest = z.lazy(() => {
-  return z.object({
-    email: z.string().max(255).optional().nullable(),
-    expiry: z.number().gte(1).optional().nullable(),
-    externalId: z.string().max(255).optional().nullable(),
-    name: z.string().max(255).optional().nullable(),
-  });
-});
-
-/**
- *
- * @typedef  {CreateUserTokenRequest} createUserTokenRequest
- * @property {string} - The user's email.
- * @property {number} - The duration for which the token is valid (in seconds)
- * @property {string} - A unique string that MagicBell can utilize to identify the user uniquely. We recommend setting this attribute to the ID of the user in your database. Provide the external id if the user's email is unavailable.
- * @property {string} - The name of the token.
- */
-export type CreateUserTokenRequest = z.infer<typeof createUserTokenRequest>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const createUserTokenRequestResponse = z.lazy(() => {
-  return z
-    .object({
-      email: z.string().max(255).optional().nullable(),
-      expiry: z.number().gte(1).optional().nullable(),
-      external_id: z.string().max(255).optional().nullable(),
-      name: z.string().max(255).optional().nullable(),
-    })
-    .transform((data) => ({
-      email: data['email'],
-      expiry: data['expiry'],
-      externalId: data['external_id'],
-      name: data['name'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const createUserTokenRequestRequest = z.lazy(() => {
-  return z
-    .object({
-      email: z.string().max(255).optional().nullable(),
-      expiry: z.number().gte(1).optional().nullable(),
-      externalId: z.string().max(255).optional().nullable(),
-      name: z.string().max(255).optional().nullable(),
-    })
-    .transform((data) => ({
-      email: data['email'],
-      expiry: data['expiry'],
-      external_id: data['externalId'],
-      name: data['name'],
-    }));
-});

package/src/project-client/services/jwt/models/discard-token-response.ts

@@ -1,51 +0,0 @@
-import { z } from 'zod';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const discardTokenResponse = z.lazy(() => {
-  return z.object({
-    discardedAt: z.string(),
-    tokenId: z.string(),
-  });
-});
-
-/**
- *
- * @typedef  {DiscardTokenResponse} discardTokenResponse
- * @property {string}
- * @property {string}
- */
-export type DiscardTokenResponse = z.infer<typeof discardTokenResponse>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const discardTokenResponseResponse = z.lazy(() => {
-  return z
-    .object({
-      discarded_at: z.string(),
-      token_id: z.string(),
-    })
-    .transform((data) => ({
-      discardedAt: data['discarded_at'],
-      tokenId: data['token_id'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const discardTokenResponseRequest = z.lazy(() => {
-  return z
-    .object({
-      discardedAt: z.string(),
-      tokenId: z.string(),
-    })
-    .transform((data) => ({
-      discarded_at: data['discardedAt'],
-      token_id: data['tokenId'],
-    }));
-});

package/src/project-client/services/jwt/models/index.ts

@@ -1,6 +0,0 @@
-export type { AccessToken } from './access-token.js';
-export type { AccessTokenCollection } from './access-token-collection.js';
-export type { CreateProjectTokenRequest } from './create-project-token-request.js';
-export type { CreateTokenResponse } from './create-token-response.js';
-export type { CreateUserTokenRequest } from './create-user-token-request.js';
-export type { DiscardTokenResponse } from './discard-token-response.js';

package/src/project-client/services/jwt/request-params.ts

@@ -1,11 +0,0 @@
-export interface FetchProjectTokensParams {
-  limit?: number;
-  startingAfter?: string;
-  endingBefore?: string;
-}
-
-export interface FetchUserTokensParams {
-  limit?: number;
-  startingAfter?: string;
-  endingBefore?: string;
-}

package/src/project-client/services/notifications/index.ts

@@ -1,2 +0,0 @@
-export * from './models/index.js';
-export { NotificationsService } from './notifications-service.js';

package/src/project-client/services/notifications/models/delivery-plan-collection.ts

@@ -1,54 +0,0 @@
-import { z } from 'zod';
-
-import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
-import { DeliveryPlan, deliveryPlan, deliveryPlanRequest, deliveryPlanResponse } from './delivery-plan.js';
-
-/**
- * The shape of the model inside the application code - what the users use
- */
-export const deliveryPlanCollection = z.lazy(() => {
-  return z.object({
-    data: z.array(deliveryPlan).optional(),
-    links: links.optional(),
-  });
-});
-
-/**
- *
- * @typedef  {DeliveryPlanCollection} deliveryPlanCollection
- * @property {DeliveryPlan[]}
- * @property {Links}
- */
-export type DeliveryPlanCollection = z.infer<typeof deliveryPlanCollection>;
-
-/**
- * The shape of the model mapping from the api schema into the application shape.
- * Is equal to application shape if all property names match the api schema
- */
-export const deliveryPlanCollectionResponse = z.lazy(() => {
-  return z
-    .object({
-      data: z.array(deliveryPlanResponse).optional(),
-      links: linksResponse.optional(),
-    })
-    .transform((data) => ({
-      data: data['data'],
-      links: data['links'],
-    }));
-});
-
-/**
- * The shape of the model mapping from the application shape into the api schema.
- * Is equal to application shape if all property names match the api schema
- */
-export const deliveryPlanCollectionRequest = z.lazy(() => {
-  return z
-    .object({
-      data: z.array(deliveryPlanRequest).optional(),
-      links: linksRequest.optional(),
-    })
-    .transform((data) => ({
-      data: data['data'],
-      links: data['links'],
-    }));
-});