magicbell-js 0.0.3 → 0.0.4

package/src/user-client/services/integrations/models/web-push-start-installation-response.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const webPushStartInstallationResponse = z.lazy(() => {
+  return z.object({
+    authToken: z.string().min(8),
+    publicKey: z.string().min(8).max(128),
+  });
+});
+
+/**
+ *
+ * @typedef  {WebPushStartInstallationResponse} webPushStartInstallationResponse
+ * @property {string}
+ * @property {string}
+ */
+export type WebPushStartInstallationResponse = z.infer<typeof webPushStartInstallationResponse>;
+
+/**
+ * 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 webPushStartInstallationResponseResponse = z.lazy(() => {
+  return z
+    .object({
+      auth_token: z.string().min(8),
+      public_key: z.string().min(8).max(128),
+    })
+    .transform((data) => ({
+      authToken: data['auth_token'],
+      publicKey: data['public_key'],
+    }));
+});
+
+/**
+ * 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 webPushStartInstallationResponseRequest = z.lazy(() => {
+  return z
+    .object({
+      authToken: z.string().min(8),
+      publicKey: z.string().min(8).max(128),
+    })
+    .transform((data) => ({
+      auth_token: data['authToken'],
+      public_key: data['publicKey'],
+    }));
+});

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

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

package/src/user-client/services/notifications/models/index.ts

@@ -0,0 +1,2 @@
+export type { Notification } from './notification.js';
+export type { NotificationCollection } from './notification-collection.js';

package/src/user-client/services/notifications/models/notification-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { Notification, notification, notificationRequest, notificationResponse } from './notification.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const notificationCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(notification).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {NotificationCollection} notificationCollection
+ * @property {Notification[]}
+ * @property {Links}
+ */
+export type NotificationCollection = z.infer<typeof notificationCollection>;
+
+/**
+ * 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 notificationCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(notificationResponse).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 notificationCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(notificationRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/user-client/services/notifications/models/notification.ts

@@ -0,0 +1,129 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const notification = z.lazy(() => {
+  return z.object({
+    actionUrl: z.string().max(2048).optional().nullable(),
+    archivedAt: z.string().optional().nullable(),
+    category: z.string().max(100).optional().nullable(),
+    content: z.string().max(10485760).optional().nullable(),
+    createdAt: z.string(),
+    customAttributes: z.any().optional().nullable(),
+    discardedAt: z.string().optional().nullable(),
+    id: z.string(),
+    readAt: z.string().optional().nullable(),
+    seenAt: z.string().optional().nullable(),
+    sentAt: z.string().optional().nullable(),
+    title: z.string().min(1).max(255),
+    topic: z.string().max(100).optional().nullable(),
+    updatedAt: z.string(),
+    userId: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Notification} notification
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {any}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Notification = z.infer<typeof notification>;
+
+/**
+ * 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 notificationResponse = z.lazy(() => {
+  return z
+    .object({
+      action_url: z.string().max(2048).optional().nullable(),
+      archived_at: z.string().optional().nullable(),
+      category: z.string().max(100).optional().nullable(),
+      content: z.string().max(10485760).optional().nullable(),
+      created_at: z.string(),
+      custom_attributes: z.any().optional().nullable(),
+      discarded_at: z.string().optional().nullable(),
+      id: z.string(),
+      read_at: z.string().optional().nullable(),
+      seen_at: z.string().optional().nullable(),
+      sent_at: z.string().optional().nullable(),
+      title: z.string().min(1).max(255),
+      topic: z.string().max(100).optional().nullable(),
+      updated_at: z.string(),
+      user_id: z.string(),
+    })
+    .transform((data) => ({
+      actionUrl: data['action_url'],
+      archivedAt: data['archived_at'],
+      category: data['category'],
+      content: data['content'],
+      createdAt: data['created_at'],
+      customAttributes: data['custom_attributes'],
+      discardedAt: data['discarded_at'],
+      id: data['id'],
+      readAt: data['read_at'],
+      seenAt: data['seen_at'],
+      sentAt: data['sent_at'],
+      title: data['title'],
+      topic: data['topic'],
+      updatedAt: data['updated_at'],
+      userId: data['user_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 notificationRequest = z.lazy(() => {
+  return z
+    .object({
+      actionUrl: z.string().max(2048).optional().nullable(),
+      archivedAt: z.string().optional().nullable(),
+      category: z.string().max(100).optional().nullable(),
+      content: z.string().max(10485760).optional().nullable(),
+      createdAt: z.string(),
+      customAttributes: z.any().optional().nullable(),
+      discardedAt: z.string().optional().nullable(),
+      id: z.string(),
+      readAt: z.string().optional().nullable(),
+      seenAt: z.string().optional().nullable(),
+      sentAt: z.string().optional().nullable(),
+      title: z.string().min(1).max(255),
+      topic: z.string().max(100).optional().nullable(),
+      updatedAt: z.string(),
+      userId: z.string(),
+    })
+    .transform((data) => ({
+      action_url: data['actionUrl'],
+      archived_at: data['archivedAt'],
+      category: data['category'],
+      content: data['content'],
+      created_at: data['createdAt'],
+      custom_attributes: data['customAttributes'],
+      discarded_at: data['discardedAt'],
+      id: data['id'],
+      read_at: data['readAt'],
+      seen_at: data['seenAt'],
+      sent_at: data['sentAt'],
+      title: data['title'],
+      topic: data['topic'],
+      updated_at: data['updatedAt'],
+      user_id: data['userId'],
+    }));
+});

package/src/user-client/services/notifications/notifications-service.ts

@@ -0,0 +1,189 @@
+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 { NotificationCollection, notificationCollectionResponse } from './models/notification-collection.js';
+import { ListNotificationsParams } from './request-params.js';
+
+export class NotificationsService extends BaseService {
+  /**
+   * Lists all notifications for a user.
+   * @param {number} [params.limit] -
+   * @param {string} [params.startingAfter] -
+   * @param {string} [params.endingBefore] -
+   * @param {string} [params.status] -
+   * @param {string} [params.topic] -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<NotificationCollection>>} OK
+   */
+  async listNotifications(
+    params?: ListNotificationsParams,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<NotificationCollection>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('GET')
+      .setPath('/notifications')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: notificationCollectionResponse,
+        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,
+      })
+      .addQueryParam({
+        key: 'status',
+        value: params?.status,
+      })
+      .addQueryParam({
+        key: 'topic',
+        value: params?.topic,
+      })
+      .build();
+    return this.client.call<NotificationCollection>(request);
+  }
+
+  /**
+   * Archives a notification.
+   * @param {string} notificationId -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} No Content
+   */
+  async archiveNotification(notificationId: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/notifications/{notification_id}/archive')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: z.undefined(),
+        contentType: ContentType.NoContent,
+        status: 204,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .addPathParam({
+        key: 'notification_id',
+        value: notificationId,
+      })
+      .build();
+    return this.client.call<void>(request);
+  }
+
+  /**
+   * Marks a notification as read.
+   * @param {string} notificationId -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} No Content
+   */
+  async markNotificationRead(notificationId: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/notifications/{notification_id}/read')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: z.undefined(),
+        contentType: ContentType.NoContent,
+        status: 204,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .addPathParam({
+        key: 'notification_id',
+        value: notificationId,
+      })
+      .build();
+    return this.client.call<void>(request);
+  }
+
+  /**
+   * Unarchives a notification.
+   * @param {string} notificationId -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} No Content
+   */
+  async unarchiveNotification(notificationId: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/notifications/{notification_id}/unarchive')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: z.undefined(),
+        contentType: ContentType.NoContent,
+        status: 204,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .addPathParam({
+        key: 'notification_id',
+        value: notificationId,
+      })
+      .build();
+    return this.client.call<void>(request);
+  }
+
+  /**
+   * Marks a notification as unread.
+   * @param {string} notificationId -
+   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} No Content
+   */
+  async markNotificationUnread(notificationId: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/notifications/{notification_id}/unread')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: z.undefined(),
+        contentType: ContentType.NoContent,
+        status: 204,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .addPathParam({
+        key: 'notification_id',
+        value: notificationId,
+      })
+      .build();
+    return this.client.call<void>(request);
+  }
+}

package/src/user-client/services/notifications/request-params.ts

@@ -0,0 +1,7 @@
+export interface ListNotificationsParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+  status?: string;
+  topic?: string;
+}

package/src/user-client.ts

@@ -0,0 +1 @@
+export * from './user-client/index.js';