magicbell-js 0.0.3 → 0.1.0

package/src/project-client/services/channels/models/web-push-token.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod';
+
+import { Keys, keys, keysRequest, keysResponse } from './keys.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushToken = z.lazy(() => {
+  return z.object({
+    createdAt: z.string(),
+    discardedAt: z.string().optional().nullable(),
+    endpoint: z.string(),
+    id: z.string(),
+    keys: keys,
+    updatedAt: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {WebPushToken} webPushToken
+ * @property {string}
+ * @property {string}
+ * @property {string} - The push subscription URL obtained from PushSubscription.endpoint after calling registration.pushManager.subscribe(). This is the unique URL for this device that push messages will be sent to.
+ * @property {string}
+ * @property {Keys} - The encryption keys from the PushSubscription.getKey() method, needed to encrypt push messages for this subscription.
+ * @property {string}
+ */
+export type WebPushToken = z.infer<typeof webPushToken>;
+
+/**
+ * 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 webPushTokenResponse = z.lazy(() => {
+  return z
+    .object({
+      created_at: z.string(),
+      discarded_at: z.string().optional().nullable(),
+      endpoint: z.string(),
+      id: z.string(),
+      keys: keysResponse,
+      updated_at: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      createdAt: data['created_at'],
+      discardedAt: data['discarded_at'],
+      endpoint: data['endpoint'],
+      id: data['id'],
+      keys: data['keys'],
+      updatedAt: data['updated_at'],
+    }));
+});
+
+/**
+ * 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 webPushTokenRequest = z.lazy(() => {
+  return z
+    .object({
+      createdAt: z.string(),
+      discardedAt: z.string().optional().nullable(),
+      endpoint: z.string(),
+      id: z.string(),
+      keys: keysRequest,
+      updatedAt: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      created_at: data['createdAt'],
+      discarded_at: data['discardedAt'],
+      endpoint: data['endpoint'],
+      id: data['id'],
+      keys: data['keys'],
+      updated_at: data['updatedAt'],
+    }));
+});

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

@@ -0,0 +1,45 @@
+export interface GetDeliveryconfigParams {
+  key?: string;
+}
+
+export interface GetInAppInboxUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushApnsUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushExpoUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetMobilePushFcmUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetSlackUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetTeamsUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
+export interface GetWebPushUserTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}

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

@@ -0,0 +1 @@
+export type { Links } from './links.js';

package/src/project-client/services/common/links.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const links = z.lazy(() => {
+  return z.object({
+    first: z.string().optional(),
+    next: z.string().optional().nullable(),
+    prev: z.string().optional().nullable(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Links} links
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Links = z.infer<typeof links>;
+
+/**
+ * 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 linksResponse = z.lazy(() => {
+  return z
+    .object({
+      first: z.string().optional(),
+      next: z.string().optional().nullable(),
+      prev: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      first: data['first'],
+      next: data['next'],
+      prev: data['prev'],
+    }));
+});
+
+/**
+ * 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 linksRequest = z.lazy(() => {
+  return z
+    .object({
+      first: z.string().optional(),
+      next: z.string().optional().nullable(),
+      prev: z.string().optional().nullable(),
+    })
+    .transform((data) => ({
+      first: data['first'],
+      next: data['next'],
+      prev: data['prev'],
+    }));
+});

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

@@ -0,0 +1,85 @@
+import { z } from 'zod';
+
+import { Environment } from '../../http/environment.js';
+import { ThrowableError } from '../../http/errors/throwable-error.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 { Event, eventResponse } from './models/event.js';
+import { EventCollection, eventCollectionResponse } from './models/event-collection.js';
+import { ListEventsParams } from './request-params.js';
+
+export class EventsService extends BaseService {
+  /**
+   * Retrieves a paginated list of events for the project.
+   * @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<EventCollection>>} OK
+   */
+  async listEvents(params?: ListEventsParams, requestConfig?: RequestConfig): Promise<HttpResponse<EventCollection>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('GET')
+      .setPath('/events')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: eventCollectionResponse,
+        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<EventCollection>(request);
+  }
+
+  /**
+   * Retrieves a project event by its ID.
+   * @param {string} id -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<Event>>} OK
+   */
+  async getEvent(id: string, requestConfig?: RequestConfig): Promise<HttpResponse<Event>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('GET')
+      .setPath('/events/{id}')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: eventResponse,
+        contentType: ContentType.Json,
+        status: 200,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .addPathParam({
+        key: 'id',
+        value: id,
+      })
+      .build();
+    return this.client.call<Event>(request);
+  }
+}

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

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

package/src/project-client/services/events/models/event-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { Event, event, eventRequest, eventResponse } from './event.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const eventCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(event).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {EventCollection} eventCollection
+ * @property {Event[]}
+ * @property {Links}
+ */
+export type EventCollection = z.infer<typeof eventCollection>;
+
+/**
+ * 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 eventCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(eventResponse).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 eventCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(eventRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/events/models/event.ts

@@ -0,0 +1,81 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const event = z.lazy(() => {
+  return z.object({
+    code: z.number().optional(),
+    context: z.any().optional().nullable(),
+    id: z.string(),
+    level: z.string().optional(),
+    log: z.string().optional().nullable(),
+    timestamp: z.string(),
+    type: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Event} event
+ * @property {number}
+ * @property {any}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Event = z.infer<typeof event>;
+
+/**
+ * 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 eventResponse = z.lazy(() => {
+  return z
+    .object({
+      code: z.number().optional(),
+      context: z.any().optional().nullable(),
+      id: z.string(),
+      level: z.string().optional(),
+      log: z.string().optional().nullable(),
+      timestamp: z.string(),
+      type: z.string(),
+    })
+    .transform((data) => ({
+      code: data['code'],
+      context: data['context'],
+      id: data['id'],
+      level: data['level'],
+      log: data['log'],
+      timestamp: data['timestamp'],
+      type: data['type'],
+    }));
+});
+
+/**
+ * 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 eventRequest = z.lazy(() => {
+  return z
+    .object({
+      code: z.number().optional(),
+      context: z.any().optional().nullable(),
+      id: z.string(),
+      level: z.string().optional(),
+      log: z.string().optional().nullable(),
+      timestamp: z.string(),
+      type: z.string(),
+    })
+    .transform((data) => ({
+      code: data['code'],
+      context: data['context'],
+      id: data['id'],
+      level: data['level'],
+      log: data['log'],
+      timestamp: data['timestamp'],
+      type: data['type'],
+    }));
+});

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

@@ -0,0 +1,2 @@
+export type { Event } from './event.js';
+export type { EventCollection } from './event-collection.js';

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

@@ -0,0 +1,5 @@
+export interface ListEventsParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}

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

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