magicbell-js 1.2.0 → 1.4.0

package/src/project-client/services/integrations/models/smtp-config-from.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const smtpConfigFrom = z.lazy(() => {
+  return z.object({
+    email: z.string(),
+    name: z.string().optional(),
+  });
+});
+
+/**
+ * Default sender email address
+ * @typedef  {SmtpConfigFrom} smtpConfigFrom - Default sender email address - Default sender email address
+ * @property {string} - Sender email address
+ * @property {string} - Sender name
+ */
+export type SmtpConfigFrom = z.infer<typeof smtpConfigFrom>;
+
+/**
+ * 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 smtpConfigFromResponse = z.lazy(() => {
+  return z
+    .object({
+      email: z.string(),
+      name: z.string().optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      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 smtpConfigFromRequest = z.lazy(() => {
+  return z
+    .object({
+      email: z.string(),
+      name: z.string().optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      name: data['name'],
+    }));
+});

package/src/project-client/services/integrations/models/smtp-config-object-collection.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import {
+  SmtpConfigObject,
+  smtpConfigObject,
+  smtpConfigObjectRequest,
+  smtpConfigObjectResponse,
+} from './smtp-config-object.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const smtpConfigObjectCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(smtpConfigObject).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {SmtpConfigObjectCollection} smtpConfigObjectCollection
+ * @property {SmtpConfigObject[]}
+ * @property {Links}
+ */
+export type SmtpConfigObjectCollection = z.infer<typeof smtpConfigObjectCollection>;
+
+/**
+ * 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 smtpConfigObjectCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(smtpConfigObjectResponse).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 smtpConfigObjectCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(smtpConfigObjectRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/integrations/models/smtp-config-object.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+
+import { SmtpConfig, smtpConfig, smtpConfigRequest, smtpConfigResponse } from './smtp-config.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const smtpConfigObject = z.lazy(() => {
+  return z.object({
+    config: smtpConfig,
+    id: z.string(),
+    name: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {SmtpConfigObject} smtpConfigObject
+ * @property {SmtpConfig}
+ * @property {string}
+ * @property {string}
+ */
+export type SmtpConfigObject = z.infer<typeof smtpConfigObject>;
+
+/**
+ * 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 smtpConfigObjectResponse = z.lazy(() => {
+  return z
+    .object({
+      config: smtpConfigResponse,
+      id: z.string(),
+      name: z.string(),
+    })
+    .transform((data) => ({
+      config: data['config'],
+      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 smtpConfigObjectRequest = z.lazy(() => {
+  return z
+    .object({
+      config: smtpConfigRequest,
+      id: z.string(),
+      name: z.string(),
+    })
+    .transform((data) => ({
+      config: data['config'],
+      id: data['id'],
+      name: data['name'],
+    }));
+});

package/src/project-client/services/integrations/models/smtp-config-reply-to.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const smtpConfigReplyTo = z.lazy(() => {
+  return z.object({
+    email: z.string(),
+    name: z.string().optional(),
+  });
+});
+
+/**
+ * Reply-to email address
+ * @typedef  {SmtpConfigReplyTo} smtpConfigReplyTo - Reply-to email address - Reply-to email address
+ * @property {string} - Reply-to email address
+ * @property {string} - Reply-to name
+ */
+export type SmtpConfigReplyTo = z.infer<typeof smtpConfigReplyTo>;
+
+/**
+ * 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 smtpConfigReplyToResponse = z.lazy(() => {
+  return z
+    .object({
+      email: z.string(),
+      name: z.string().optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      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 smtpConfigReplyToRequest = z.lazy(() => {
+  return z
+    .object({
+      email: z.string(),
+      name: z.string().optional(),
+    })
+    .transform((data) => ({
+      email: data['email'],
+      name: data['name'],
+    }));
+});

package/src/project-client/services/integrations/models/smtp-config.ts

@@ -0,0 +1,89 @@
+import { z } from 'zod';
+
+import { SmtpConfigFrom, smtpConfigFrom, smtpConfigFromRequest, smtpConfigFromResponse } from './smtp-config-from.js';
+import {
+  SmtpConfigReplyTo,
+  smtpConfigReplyTo,
+  smtpConfigReplyToRequest,
+  smtpConfigReplyToResponse,
+} from './smtp-config-reply-to.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const smtpConfig = z.lazy(() => {
+  return z.object({
+    from: smtpConfigFrom,
+    host: z.string(),
+    password: z.string(),
+    port: z.number().gte(1).lte(65535),
+    replyTo: smtpConfigReplyTo.optional(),
+    security: z.string().optional(),
+    username: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {SmtpConfig} smtpConfig
+ * @property {SmtpConfigFrom} - Default sender email address
+ * @property {string} - SMTP server hostname
+ * @property {string} - SMTP authentication password
+ * @property {number} - SMTP server port
+ * @property {SmtpConfigReplyTo} - Reply-to email address
+ * @property {Security} - SMTP security/encryption method
+ * @property {string} - SMTP authentication username
+ */
+export type SmtpConfig = z.infer<typeof smtpConfig>;
+
+/**
+ * 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 smtpConfigResponse = z.lazy(() => {
+  return z
+    .object({
+      from: smtpConfigFromResponse,
+      host: z.string(),
+      password: z.string(),
+      port: z.number().gte(1).lte(65535),
+      reply_to: smtpConfigReplyToResponse.optional(),
+      security: z.string().optional(),
+      username: z.string(),
+    })
+    .transform((data) => ({
+      from: data['from'],
+      host: data['host'],
+      password: data['password'],
+      port: data['port'],
+      replyTo: data['reply_to'],
+      security: data['security'],
+      username: data['username'],
+    }));
+});
+
+/**
+ * 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 smtpConfigRequest = z.lazy(() => {
+  return z
+    .object({
+      from: smtpConfigFromRequest,
+      host: z.string(),
+      password: z.string(),
+      port: z.number().gte(1).lte(65535),
+      replyTo: smtpConfigReplyToRequest.optional(),
+      security: z.string().optional(),
+      username: z.string(),
+    })
+    .transform((data) => ({
+      from: data['from'],
+      host: data['host'],
+      password: data['password'],
+      port: data['port'],
+      reply_to: data['replyTo'],
+      security: data['security'],
+      username: data['username'],
+    }));
+});

package/src/project-client/services/integrations/models/stripe-config-collection.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+
+import { Links, links, linksRequest, linksResponse } from '../../common/links.js';
+import { StripeConfig, stripeConfig, stripeConfigRequest, stripeConfigResponse } from './stripe-config.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const stripeConfigCollection = z.lazy(() => {
+  return z.object({
+    data: z.array(stripeConfig).optional(),
+    links: links.optional(),
+  });
+});
+
+/**
+ *
+ * @typedef  {StripeConfigCollection} stripeConfigCollection
+ * @property {StripeConfig[]}
+ * @property {Links}
+ */
+export type StripeConfigCollection = z.infer<typeof stripeConfigCollection>;
+
+/**
+ * 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 stripeConfigCollectionResponse = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(stripeConfigResponse).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 stripeConfigCollectionRequest = z.lazy(() => {
+  return z
+    .object({
+      data: z.array(stripeConfigRequest).optional(),
+      links: linksRequest.optional(),
+    })
+    .transform((data) => ({
+      data: data['data'],
+      links: data['links'],
+    }));
+});

package/src/project-client/services/integrations/models/stripe-config-payload.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const stripeConfigPayload = z.lazy(() => {
+  return z.object({
+    id: z.string().optional(),
+    webhookSigningSecret: z.string().min(1).max(100),
+  });
+});
+
+/**
+ *
+ * @typedef  {StripeConfigPayload} stripeConfigPayload
+ * @property {string} - The unique identifier for this configuration
+ * @property {string} - The signing secret to verify incoming requests from Stripe
+ */
+export type StripeConfigPayload = z.infer<typeof stripeConfigPayload>;
+
+/**
+ * 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 stripeConfigPayloadResponse = z.lazy(() => {
+  return z
+    .object({
+      id: z.string().optional(),
+      webhook_signing_secret: z.string().min(1).max(100),
+    })
+    .transform((data) => ({
+      id: data['id'],
+      webhookSigningSecret: data['webhook_signing_secret'],
+    }));
+});
+
+/**
+ * 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 stripeConfigPayloadRequest = z.lazy(() => {
+  return z
+    .object({
+      id: z.string().optional(),
+      webhookSigningSecret: z.string().min(1).max(100),
+    })
+    .transform((data) => ({
+      id: data['id'],
+      webhook_signing_secret: data['webhookSigningSecret'],
+    }));
+});

package/src/project-client/services/integrations/models/stripe-config.ts

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+
+import {
+  StripeConfigPayload,
+  stripeConfigPayload,
+  stripeConfigPayloadRequest,
+  stripeConfigPayloadResponse,
+} from './stripe-config-payload.js';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const stripeConfig = z.lazy(() => {
+  return z.object({
+    config: stripeConfigPayload,
+    id: z.string(),
+    name: z.string(),
+  });
+});
+
+/**
+ *
+ * @typedef  {StripeConfig} stripeConfig
+ * @property {StripeConfigPayload}
+ * @property {string}
+ * @property {string}
+ */
+export type StripeConfig = z.infer<typeof stripeConfig>;
+
+/**
+ * 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 stripeConfigResponse = z.lazy(() => {
+  return z
+    .object({
+      config: stripeConfigPayloadResponse,
+      id: z.string(),
+      name: z.string(),
+    })
+    .transform((data) => ({
+      config: data['config'],
+      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 stripeConfigRequest = z.lazy(() => {
+  return z
+    .object({
+      config: stripeConfigPayloadRequest,
+      id: z.string(),
+      name: z.string(),
+    })
+    .transform((data) => ({
+      config: data['config'],
+      id: data['id'],
+      name: data['name'],
+    }));
+});

package/src/project-client/services/integrations/models/webpush-config-payload.ts

@@ -14,7 +14,7 @@ export const webpushConfigPayload = z.lazy(() => {
  *
  * @typedef  {WebpushConfigPayload} webpushConfigPayload
  * @property {string} - VAPID private key - from the pair you generated.
- * @property {string} - VAPID public key - generate one at https://tools.reactpwa.com/vapid.
+ * @property {string} - VAPID public key - generate one at https://magicbell.com/web-push/vapid-keys.
  */
 export type WebpushConfigPayload = z.infer<typeof webpushConfigPayload>;
 

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

@@ -8,6 +8,10 @@ export interface DeleteApnsIntegrationParams {
   id?: string;
 }
 
+export interface DeleteEventsourceIntegrationParams {
+  id?: string;
+}
+
 export interface DeleteExpoIntegrationParams {
   id?: string;
 }
@@ -16,10 +20,18 @@ export interface DeleteFcmIntegrationParams {
   id?: string;
 }
 
+export interface DeleteGithubIntegrationParams {
+  id?: string;
+}
+
 export interface DeleteInboxIntegrationParams {
   id?: string;
 }
 
+export interface DeleteMagicbellSlackbotIntegrationParams {
+  id?: string;
+}
+
 export interface DeleteMailgunIntegrationParams {
   id?: string;
 }
@@ -40,6 +52,14 @@ export interface DeleteSlackIntegrationParams {
   id?: string;
 }
 
+export interface DeleteSmtpIntegrationParams {
+  id?: string;
+}
+
+export interface DeleteStripeIntegrationParams {
+  id?: string;
+}
+
 export interface DeleteTwilioIntegrationParams {
   id?: string;
 }

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

@@ -17,8 +17,8 @@ export class UsersService extends BaseService {
    * @param {string} [params.startingAfter] -
    * @param {string} [params.endingBefore] -
    * @param {string} [params.query] -
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<UserCollection>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<UserCollection>>} - OK
    */
   async listUsers(params?: ListUsersParams, requestConfig?: RequestConfig): Promise<HttpResponse<UserCollection>> {
     const request = new RequestBuilder()
@@ -59,8 +59,8 @@ export class UsersService extends BaseService {
 
   /**
    * Creates or updates a user with the provided details. The user will be associated with the project specified in the request context.
-   * @param {RequestConfig} requestConfig - (Optional) The request configuration for retry and validation.
-   * @returns {Promise<HttpResponse<User>>} OK
+   * @param {RequestConfig} [requestConfig] - The request configuration for retry and validation.
+   * @returns {Promise<HttpResponse<User>>} - OK
    */
   async saveUser(body: User, requestConfig?: RequestConfig): Promise<HttpResponse<User>> {
     const request = new RequestBuilder()
@@ -88,8 +88,8 @@ export class UsersService extends BaseService {
   /**
    * Removes a user and all associated data from the project.
    * @param {string} userId -
-   * @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 deleteUser(userId: string, requestConfig?: RequestConfig): Promise<HttpResponse<void>> {
     const request = new RequestBuilder()

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

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

package/src/project-client/services/workflows/models/create-run-response.ts

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

package/src/project-client/services/workflows/models/execute-workflow-request.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+
+/**
+ * The shape of the model inside the application code - what the users use
+ */
+export const executeWorkflowRequest = z.lazy(() => {
+  return z.object({
+    input: z.any().optional().nullable(),
+    key: z.string().regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+  });
+});
+
+/**
+ *
+ * @typedef  {ExecuteWorkflowRequest} executeWorkflowRequest
+ * @property {any}
+ * @property {string}
+ */
+export type ExecuteWorkflowRequest = z.infer<typeof executeWorkflowRequest>;
+
+/**
+ * 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 executeWorkflowRequestResponse = z.lazy(() => {
+  return z
+    .object({
+      input: z.any().optional().nullable(),
+      key: z.string().regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+    })
+    .transform((data) => ({
+      input: data['input'],
+      key: data['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 executeWorkflowRequestRequest = z.lazy(() => {
+  return z
+    .object({
+      input: z.any().optional().nullable(),
+      key: z.string().regex(/^[A-Za-z0-9\_\.\-\:]+$/),
+    })
+    .transform((data) => ({
+      input: data['input'],
+      key: data['key'],
+    }));
+});