magicbell-js 0.0.3 → 0.1.0

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

@@ -0,0 +1,279 @@
+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 {
+  WebPushTokenPayload,
+  webPushTokenPayloadRequest,
+  webPushTokenPayloadResponse,
+} from '../common/web-push-token-payload.js';
+import {
+  InboxConfigPayload,
+  inboxConfigPayloadRequest,
+  inboxConfigPayloadResponse,
+} from './models/inbox-config-payload.js';
+import {
+  SlackFinishInstallResponse,
+  slackFinishInstallResponseRequest,
+} from './models/slack-finish-install-response.js';
+import { SlackInstallation, slackInstallationRequest, slackInstallationResponse } from './models/slack-installation.js';
+import { SlackStartInstall, slackStartInstallRequest } from './models/slack-start-install.js';
+import {
+  SlackStartInstallResponseContent,
+  slackStartInstallResponseContentResponse,
+} from './models/slack-start-install-response-content.js';
+import {
+  TemplatesInstallation,
+  templatesInstallationRequest,
+  templatesInstallationResponse,
+} from './models/templates-installation.js';
+import {
+  WebPushStartInstallationResponse,
+  webPushStartInstallationResponseResponse,
+} from './models/web-push-start-installation-response.js';
+
+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>>} Created
+   */
+  async saveInboxInstallation(
+    body: InboxConfigPayload,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<InboxConfigPayload>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/inbox/installations')
+      .setRequestSchema(inboxConfigPayloadRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: inboxConfigPayloadResponse,
+        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<InboxConfigPayload>(request);
+  }
+
+  /**
+   * Initiates the installation flow for a 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
+   */
+  async startInboxInstallation(requestConfig?: RequestConfig): Promise<HttpResponse<InboxConfigPayload>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/inbox/installations/start')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: inboxConfigPayloadResponse,
+        contentType: ContentType.Json,
+        status: 201,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .build();
+    return this.client.call<InboxConfigPayload>(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>>} Created
+   */
+  async saveSlackInstallation(
+    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('POST')
+      .setPath('/integrations/slack/installations')
+      .setRequestSchema(slackInstallationRequest)
+      .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);
+  }
+
+  /**
+   * Completes the installation flow for a 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
+   */
+  async finishSlackInstallation(
+    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/slack/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 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
+   */
+  async startSlackInstallation(
+    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/slack/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 templates 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<TemplatesInstallation>>} Created
+   */
+  async saveTemplatesInstallation(
+    body: TemplatesInstallation,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<TemplatesInstallation>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/templates/installations')
+      .setRequestSchema(templatesInstallationRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: templatesInstallationResponse,
+        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<TemplatesInstallation>(request);
+  }
+
+  /**
+   * 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>>} Created
+   */
+  async saveWebPushInstallation(
+    body: WebPushTokenPayload,
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<WebPushTokenPayload>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/web_push/installations')
+      .setRequestSchema(webPushTokenPayloadRequest)
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: webPushTokenPayloadResponse,
+        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<WebPushTokenPayload>(request);
+  }
+
+  /**
+   * 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
+   */
+  async startWebPushInstallation(
+    requestConfig?: RequestConfig,
+  ): Promise<HttpResponse<WebPushStartInstallationResponse>> {
+    const request = new RequestBuilder()
+      .setBaseUrl(requestConfig?.baseUrl || this.config.baseUrl || this.config.environment || Environment.DEFAULT)
+      .setConfig(this.config)
+      .setMethod('POST')
+      .setPath('/integrations/web_push/installations/start')
+      .setRequestSchema(z.any())
+      .addAccessTokenAuth(this.config.token, 'Bearer')
+      .setRequestContentType(ContentType.Json)
+      .addResponse({
+        schema: webPushStartInstallationResponseResponse,
+        contentType: ContentType.Json,
+        status: 201,
+      })
+      .setRetryAttempts(this.config, requestConfig)
+      .setRetryDelayMs(this.config, requestConfig)
+      .setResponseValidation(this.config, requestConfig)
+      .build();
+    return this.client.call<WebPushStartInstallationResponse>(request);
+  }
+}

package/src/user-client/services/integrations/models/authed-user.ts

@@ -0,0 +1,75 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const authedUser = z.lazy(() => {
+  return z.object({
+    accessToken: z.string().optional(),
+    expiresIn: z.number().optional(),
+    id: z.string(),
+    refreshToken: z.string().optional(),
+    scope: z.string().optional(),
+    tokenType: z.string().optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {AuthedUser} authedUser
+ * @property {string}
+ * @property {number}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type AuthedUser = z.infer<typeof authedUser>;
+
+/**
+ * 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 authedUserResponse = z.lazy(() => {
+  return z
+    .object({
+      access_token: z.string().optional(),
+      expires_in: z.number().optional(),
+      id: z.string(),
+      refresh_token: z.string().optional(),
+      scope: z.string().optional(),
+      token_type: z.string().optional(),
+    })
+    .transform((data) => ({
+      accessToken: data['access_token'],
+      expiresIn: data['expires_in'],
+      id: data['id'],
+      refreshToken: data['refresh_token'],
+      scope: data['scope'],
+      tokenType: data['token_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 authedUserRequest = z.lazy(() => {
+  return z
+    .object({
+      accessToken: z.string().optional(),
+      expiresIn: z.number().optional(),
+      id: z.string(),
+      refreshToken: z.string().optional(),
+      scope: z.string().optional(),
+      tokenType: z.string().optional(),
+    })
+    .transform((data) => ({
+      access_token: data['accessToken'],
+      expires_in: data['expiresIn'],
+      id: data['id'],
+      refresh_token: data['refreshToken'],
+      scope: data['scope'],
+      token_type: data['tokenType'],
+    }));
+});

package/src/user-client/services/integrations/models/banner.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const banner = z.lazy(() => {
+  return z.object({
+    backgroundColor: z.string(),
+    backgroundOpacity: z.number().optional(),
+    fontSize: z.string(),
+    textColor: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Banner} banner
+ * @property {string}
+ * @property {number}
+ * @property {string}
+ * @property {string}
+ */
+export type Banner = z.infer<typeof banner>;
+
+/**
+ * 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 bannerResponse = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+      backgroundOpacity: z.number().optional(),
+      fontSize: z.string(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+      backgroundOpacity: data['backgroundOpacity'],
+      fontSize: data['fontSize'],
+      textColor: data['textColor'],
+    }));
+});
+
+/**
+ * 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 bannerRequest = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+      backgroundOpacity: z.number().optional(),
+      fontSize: z.string(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+      backgroundOpacity: data['backgroundOpacity'],
+      fontSize: data['fontSize'],
+      textColor: data['textColor'],
+    }));
+});

package/src/user-client/services/integrations/models/default-hover.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const defaultHover = z.lazy(() => {
+  return z.object({
+    backgroundColor: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {DefaultHover} defaultHover
+ * @property {string}
+ */
+export type DefaultHover = z.infer<typeof defaultHover>;
+
+/**
+ * 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 defaultHoverResponse = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+    }));
+});
+
+/**
+ * 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 defaultHoverRequest = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+    }));
+});

package/src/user-client/services/integrations/models/default-state.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const defaultState = z.lazy(() => {
+  return z.object({
+    color: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {DefaultState} defaultState
+ * @property {string}
+ */
+export type DefaultState = z.infer<typeof defaultState>;
+
+/**
+ * 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 defaultStateResponse = z.lazy(() => {
+  return z
+    .object({
+      color: z.string(),
+    })
+    .transform((data) => ({
+      color: data['color'],
+    }));
+});
+
+/**
+ * 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 defaultStateRequest = z.lazy(() => {
+  return z
+    .object({
+      color: z.string(),
+    })
+    .transform((data) => ({
+      color: data['color'],
+    }));
+});

package/src/user-client/services/integrations/models/default_.ts

@@ -0,0 +1,90 @@
+import { z } from 'zod';
+
+import { DefaultHover, defaultHover, defaultHoverRequest, defaultHoverResponse } from './default-hover.js';
+import { DefaultState, defaultState, defaultStateRequest, defaultStateResponse } from './default-state.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const default_ = z.lazy(() => {
+  return z.object({
+    backgroundColor: z.string(),
+    borderRadius: z.string(),
+    fontFamily: z.string(),
+    fontSize: z.string(),
+    hover: defaultHover.optional(),
+    margin: z.string(),
+    state: defaultState.optional(),
+    textColor: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Default_} default_
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ * @property {DefaultHover}
+ * @property {string}
+ * @property {DefaultState}
+ * @property {string}
+ */
+export type Default_ = z.infer<typeof default_>;
+
+/**
+ * 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 defaultResponse = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+      borderRadius: z.string(),
+      fontFamily: z.string(),
+      fontSize: z.string(),
+      hover: defaultHoverResponse.optional(),
+      margin: z.string(),
+      state: defaultStateResponse.optional(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+      borderRadius: data['borderRadius'],
+      fontFamily: data['fontFamily'],
+      fontSize: data['fontSize'],
+      hover: data['hover'],
+      margin: data['margin'],
+      state: data['state'],
+      textColor: data['textColor'],
+    }));
+});
+
+/**
+ * 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 defaultRequest = z.lazy(() => {
+  return z
+    .object({
+      backgroundColor: z.string(),
+      borderRadius: z.string(),
+      fontFamily: z.string(),
+      fontSize: z.string(),
+      hover: defaultHoverRequest.optional(),
+      margin: z.string(),
+      state: defaultStateRequest.optional(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      backgroundColor: data['backgroundColor'],
+      borderRadius: data['borderRadius'],
+      fontFamily: data['fontFamily'],
+      fontSize: data['fontSize'],
+      hover: data['hover'],
+      margin: data['margin'],
+      state: data['state'],
+      textColor: data['textColor'],
+    }));
+});

package/src/user-client/services/integrations/models/dialog.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const dialog = z.lazy(() => {
+  return z.object({
+    accentColor: z.string(),
+    backgroundColor: z.string(),
+    textColor: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {Dialog} dialog
+ * @property {string}
+ * @property {string}
+ * @property {string}
+ */
+export type Dialog = z.infer<typeof dialog>;
+
+/**
+ * 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 dialogResponse = z.lazy(() => {
+  return z
+    .object({
+      accentColor: z.string(),
+      backgroundColor: z.string(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      accentColor: data['accentColor'],
+      backgroundColor: data['backgroundColor'],
+      textColor: data['textColor'],
+    }));
+});
+
+/**
+ * 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 dialogRequest = z.lazy(() => {
+  return z
+    .object({
+      accentColor: z.string(),
+      backgroundColor: z.string(),
+      textColor: z.string(),
+    })
+    .transform((data) => ({
+      accentColor: data['accentColor'],
+      backgroundColor: data['backgroundColor'],
+      textColor: data['textColor'],
+    }));
+});