magicbell-js 1.2.0 → 1.4.0

package/src/user-client/services/channels/models/user-preferences.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+
+import { Categories, categories, categoriesRequest, categoriesResponse } from './categories.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const userPreferences = z.lazy(() => {
+  return z.object({
+    categories: z.array(categories).optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {UserPreferences} userPreferences
+ * @property {Categories[]}
+ */
+export type UserPreferences = z.infer<typeof userPreferences>;
+
+/**
+ * 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 userPreferencesResponse = z.lazy(() => {
+  return z
+    .object({
+      categories: z.array(categoriesResponse).optional(),
+    })
+    .transform((data) => ({
+      categories: data['categories'],
+    }));
+});
+
+/**
+ * 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 userPreferencesRequest = z.lazy(() => {
+  return z
+    .object({
+      categories: z.array(categoriesRequest).optional(),
+    })
+    .transform((data) => ({
+      categories: data['categories'],
+    }));
+});

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

@@ -22,6 +22,12 @@ export interface ListFcmTokensParams {
   endingBefore?: string;
 }
 
+export interface ListMagicbellSlackbotTokensParams {
+  limit?: number;
+  startingAfter?: string;
+  endingBefore?: string;
+}
+
 export interface ListSlackTokensParams {
   limit?: number;
   startingAfter?: string;

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

@@ -34,8 +34,8 @@ import {
 export class IntegrationsService extends BaseService {
   /**
    * Creates a new installation of a Inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<InboxConfigPayload>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<InboxConfigPayload>>} - OK
    */
   async saveInboxInstallation(
     body: InboxConfigPayload,
@@ -65,8 +65,8 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Initiates the installation flow for an Inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<InboxConfigPayload>>} Created
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<InboxConfigPayload>>} - Created
    */
   async startInboxInstallation(requestConfig?: RequestConfig): Promise<HttpResponse<InboxConfigPayload>> {
     const request = new RequestBuilder()
@@ -89,10 +89,103 @@ export class IntegrationsService extends BaseService {
     return this.client.call<InboxConfigPayload>(request);
   }
 
+  /**
+   * Creates a new installation of a MagicBell SlackBot integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackInstallation>>} - OK
+   */
+  async saveMagicbellSlackbotInstallation(
+    body: SlackInstallation,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<SlackInstallation>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('PUT')
+      .setPath('/integrations/magicbell_slackbot/installations')
+      .setRequestSchema(slackInstallationRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: slackInstallationResponse,
+        contentType: ContentType.Json,
+        status: 200,
+      })
+      .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<SlackInstallation>(request);
+  }
+
+  /**
+   * Completes the installation flow for the MagicBell SlackBot integration. This endpoint is typically called after the user has completed any required authorization steps with MagicBell SlackBot.
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackInstallation>>} - Created
+   */
+  async finishMagicbellSlackbotInstallation(
+    body: SlackFinishInstallResponse,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<SlackInstallation>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/magicbell_slackbot/installations/finish')
+      .setRequestSchema(slackFinishInstallResponseRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: slackInstallationResponse,
+        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<SlackInstallation>(request);
+  }
+
+  /**
+   * Initiates the installation flow for a MagicBell SlackBot integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackStartInstallResponseContent>>} - Created
+   */
+  async startMagicbellSlackbotInstallation(
+    body: SlackStartInstall,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<SlackStartInstallResponseContent>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/magicbell_slackbot/installations/start')
+      .setRequestSchema(slackStartInstallRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: slackStartInstallResponseContentResponse,
+        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<SlackStartInstallResponseContent>(request);
+  }
+
   /**
    * Creates a new installation of a Slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<SlackInstallation>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackInstallation>>} - OK
    */
   async saveSlackInstallation(
     body: SlackInstallation,
@@ -122,8 +215,8 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Completes the installation flow for the Slack integration. This endpoint is typically called after the user has completed any required authorization steps with Slack.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<SlackInstallation>>} Created
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackInstallation>>} - Created
    */
   async finishSlackInstallation(
     body: SlackFinishInstallResponse,
@@ -153,8 +246,8 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Initiates the installation flow for a Slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<SlackStartInstallResponseContent>>} Created
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<SlackStartInstallResponseContent>>} - Created
    */
   async startSlackInstallation(
     body: SlackStartInstall,
@@ -184,8 +277,8 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Creates a new installation of a Web Push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<WebPushTokenPayload>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<WebPushTokenPayload>>} - OK
    */
   async saveWebPushInstallation(
     body: WebPushTokenPayload,
@@ -215,8 +308,8 @@ export class IntegrationsService extends BaseService {
 
   /**
    * Initiates the installation flow for a Web Push integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<WebPushStartInstallationResponse>>} Created
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<WebPushStartInstallationResponse>>} - Created
    */
   async startWebPushInstallation(
     requestConfig?: RequestConfig,

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

@@ -23,8 +23,8 @@ export class NotificationsService extends BaseService {
    * @param {string} [params.status] -
    * @param {string} [params.category] -
    * @param {string} [params.topic] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<NotificationCollection>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<NotificationCollection>>} - OK
    */
   async listNotifications(
     params?: ListNotificationsParams,
@@ -78,8 +78,8 @@ export class NotificationsService extends BaseService {
    * Archive all notifications.
    * @param {string} [params.category] -
    * @param {string} [params.topic] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<any>>} No Content
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} - No Content
    */
   async archiveAllNotifications(
     params?: ArchiveAllNotificationsParams,
@@ -117,8 +117,8 @@ export class NotificationsService extends BaseService {
    * Marks all notifications as read.
    * @param {string} [params.category] -
    * @param {string} [params.topic] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<any>>} No Content
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<any>>} - No Content
    */
   async markAllNotificationsRead(
     params?: MarkAllNotificationsReadParams,
@@ -155,8 +155,8 @@ export class NotificationsService extends BaseService {
   /**
    * Gets a notification by ID.
    * @param {string} notificationId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<Notification>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<Notification>>} - OK
    */
   async fetchNotification(notificationId: string, requestConfig?: RequestConfig): Promise<HttpResponse<Notification>> {
     const request = new RequestBuilder()
@@ -186,8 +186,8 @@ export class NotificationsService extends BaseService {
   /**
    * Archive a notification.
    * @param {string} notificationId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<any>>} No Content
+   * @param {RequestConfig} [requestConfig] - 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()
@@ -217,8 +217,8 @@ export class NotificationsService extends BaseService {
   /**
    * 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
+   * @param {RequestConfig} [requestConfig] - 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()
@@ -248,8 +248,8 @@ export class NotificationsService extends BaseService {
   /**
    * Unarchives a notification.
    * @param {string} notificationId -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<any>>} No Content
+   * @param {RequestConfig} [requestConfig] - 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()
@@ -279,8 +279,8 @@ export class NotificationsService extends BaseService {
   /**
    * 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
+   * @param {RequestConfig} [requestConfig] - 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()

package/dist/commonjs/project-client/services/integrations/models/reply-to.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"reply-to.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/integrations/models/reply-to.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,OAAO;;;;;;;;;GAKlB,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;GAU1B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;GAUzB,CAAC"}

package/dist/commonjs/project-client/services/integrations/models/reply-to.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reply-to.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/integrations/models/reply-to.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;GAEG;AACU,QAAA,OAAO,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACjC,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACzC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,cAAc,GAAG,OAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACxC,OAAO,OAAC;SACL,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}

package/dist/esm/project-client/services/integrations/models/reply-to.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"reply-to.d.ts","sourceRoot":"","sources":["../../../../../../src/project-client/services/integrations/models/reply-to.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,OAAO;;;;;;;;;GAKlB,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;GAU1B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;GAUzB,CAAC"}

package/dist/esm/project-client/services/integrations/models/reply-to.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reply-to.js","sourceRoot":"","sources":["../../../../../../src/project-client/services/integrations/models/reply-to.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACjC,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAUH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACzC,OAAO,CAAC;SACL,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;IACxC,OAAO,CAAC;SACL,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC,CAAC,CAAC;AACR,CAAC,CAAC,CAAC"}