emailr 0.1.0

package/src/lib/security.ts

@@ -0,0 +1,264 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as models from "../models/index.js";
+import { env } from "./env.js";
+
+type OAuth2PasswordFlow = {
+  username: string;
+  password: string;
+  clientID?: string | undefined;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
+export enum SecurityErrorCode {
+  Incomplete = "incomplete",
+  UnrecognisedSecurityType = "unrecognized_security_type",
+}
+
+export class SecurityError extends Error {
+  constructor(
+    public code: SecurityErrorCode,
+    message: string,
+  ) {
+    super(message);
+    this.name = "SecurityError";
+  }
+
+  static incomplete(): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.Incomplete,
+      "Security requirements not met in order to perform the operation",
+    );
+  }
+  static unrecognizedType(type: string): SecurityError {
+    return new SecurityError(
+      SecurityErrorCode.UnrecognisedSecurityType,
+      `Unrecognised security type: ${type}`,
+    );
+  }
+}
+
+export type SecurityState = {
+  basic: { username?: string | undefined; password?: string | undefined };
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
+};
+
+type SecurityInputBasic = {
+  type: "http:basic";
+  value:
+    | { username?: string | undefined; password?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputBearer = {
+  type: "http:bearer";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputAPIKey = {
+  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOIDC = {
+  type: "openIdConnect";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2 = {
+  type: "oauth2";
+  value: string | null | undefined;
+  fieldName: string;
+};
+
+type SecurityInputOAuth2ClientCredentials = {
+  type: "oauth2:client_credentials";
+  value:
+    | {
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
+    | null
+    | string
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
+  fieldName?: string;
+};
+
+type SecurityInputCustom = {
+  type: "http:custom";
+  value: any | null | undefined;
+  fieldName?: string;
+};
+
+export type SecurityInput =
+  | SecurityInputBasic
+  | SecurityInputBearer
+  | SecurityInputAPIKey
+  | SecurityInputOAuth2
+  | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
+  | SecurityInputOIDC
+  | SecurityInputCustom;
+
+export function resolveSecurity(
+  ...options: SecurityInput[][]
+): SecurityState | null {
+  const state: SecurityState = {
+    basic: {},
+    headers: {},
+    queryParams: {},
+    cookies: {},
+    oauth2: { type: "none" },
+  };
+
+  const option = options.find((opts) => {
+    return opts.every((o) => {
+      if (o.value == null) {
+        return false;
+      } else if (o.type === "http:basic") {
+        return o.value.username != null || o.value.password != null;
+      } else if (o.type === "http:custom") {
+        return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        if (typeof o.value == "string") {
+          return !!o.value;
+        }
+        return o.value.clientID != null || o.value.clientSecret != null;
+      } else if (typeof o.value === "string") {
+        return !!o.value;
+      } else {
+        throw new Error(
+          `Unrecognized security type: ${o.type} (value type: ${typeof o
+            .value})`,
+        );
+      }
+    });
+  });
+  if (option == null) {
+    return null;
+  }
+
+  option.forEach((spec) => {
+    if (spec.value == null) {
+      return;
+    }
+
+    const { type } = spec;
+
+    switch (type) {
+      case "apiKey:header":
+        state.headers[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:query":
+        state.queryParams[spec.fieldName] = spec.value;
+        break;
+      case "apiKey:cookie":
+        state.cookies[spec.fieldName] = spec.value;
+        break;
+      case "http:basic":
+        applyBasic(state, spec);
+        break;
+      case "http:custom":
+        break;
+      case "http:bearer":
+        applyBearer(state, spec);
+        break;
+      case "oauth2":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
+      case "oauth2:client_credentials":
+        break;
+      case "openIdConnect":
+        applyBearer(state, spec);
+        break;
+      default:
+        spec satisfies never;
+        throw SecurityError.unrecognizedType(type);
+    }
+  });
+
+  return state;
+}
+
+function applyBasic(
+  state: SecurityState,
+  spec: SecurityInputBasic,
+) {
+  if (spec.value == null) {
+    return;
+  }
+
+  state.basic = spec.value;
+}
+
+function applyBearer(
+  state: SecurityState,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
+) {
+  if (typeof spec.value !== "string" || !spec.value) {
+    return;
+  }
+
+  let value = spec.value;
+  if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+    value = `Bearer ${value}`;
+  }
+
+  if (spec.fieldName !== undefined) {
+    state.headers[spec.fieldName] = value;
+  }
+}
+
+export function resolveGlobalSecurity(
+  security: Partial<models.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearerAuth ?? env().EMAILR_BEARER_AUTH,
+      },
+    ],
+  );
+}
+
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
+  if (sec == null) {
+    return;
+  }
+
+  return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
+      if (!hasOwn.call(params, placeholder)) {
+        throw new Error(`Parameter '${placeholder}' is required`);
+      }
+
+      const value = params[placeholder];
+      if (typeof value !== "string" && typeof value !== "number") {
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
+      }
+
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
+}

package/src/models/adddomainrequest.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type AddDomainRequest = {
+  domain: string;
+  receivingSubdomain?: string | undefined;
+};
+
+/** @internal */
+export type AddDomainRequest$Outbound = {
+  domain: string;
+  receivingSubdomain: string;
+};
+
+/** @internal */
+export const AddDomainRequest$outboundSchema: z.ZodMiniType<
+  AddDomainRequest$Outbound,
+  AddDomainRequest
+> = z.object({
+  domain: z.string(),
+  receivingSubdomain: z._default(z.string(), "mail"),
+});
+
+export function addDomainRequestToJSON(
+  addDomainRequest: AddDomainRequest,
+): string {
+  return JSON.stringify(
+    AddDomainRequest$outboundSchema.parse(addDomainRequest),
+  );
+}

package/src/models/apikey.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ApiKey = {
+  id: string;
+  organizationId: string;
+  name: string;
+  /**
+   * Only returned when creating a new key
+   */
+  key?: string | undefined;
+  permissions: Array<string> | null;
+  lastUsedAt: Date | null;
+  createdBy: string | null;
+  createdAt: Date;
+  revokedAt: Date | null;
+};
+
+/** @internal */
+export const ApiKey$inboundSchema: z.ZodMiniType<ApiKey, unknown> = z.pipe(
+  z.object({
+    id: types.string(),
+    organization_id: types.string(),
+    name: types.string(),
+    key: types.optional(types.string()),
+    permissions: types.nullable(z.array(types.string())),
+    last_used_at: types.nullable(types.date()),
+    created_by: types.nullable(types.string()),
+    created_at: types.date(),
+    revoked_at: types.nullable(types.date()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+      "last_used_at": "lastUsedAt",
+      "created_by": "createdBy",
+      "created_at": "createdAt",
+      "revoked_at": "revokedAt",
+    });
+  }),
+);
+
+export function apiKeyFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKey, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKey$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKey' from JSON`,
+  );
+}

package/src/models/apikeylistitem.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ApiKeyListItem = {
+  id: string;
+  name: string;
+  permissions: Array<string> | null;
+  lastUsedAt: Date | null;
+  createdAt: Date;
+};
+
+/** @internal */
+export const ApiKeyListItem$inboundSchema: z.ZodMiniType<
+  ApiKeyListItem,
+  unknown
+> = z.pipe(
+  z.object({
+    id: types.string(),
+    name: types.string(),
+    permissions: types.nullable(z.array(types.string())),
+    last_used_at: types.nullable(types.date()),
+    created_at: types.date(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "last_used_at": "lastUsedAt",
+      "created_at": "createdAt",
+    });
+  }),
+);
+
+export function apiKeyListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKeyListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKeyListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKeyListItem' from JSON`,
+  );
+}

package/src/models/attachment.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type Attachment = {
+  filename: string;
+  /**
+   * Base64 encoded file content
+   */
+  content: string;
+  contentType?: string | undefined;
+};
+
+/** @internal */
+export type Attachment$Outbound = {
+  filename: string;
+  content: string;
+  contentType?: string | undefined;
+};
+
+/** @internal */
+export const Attachment$outboundSchema: z.ZodMiniType<
+  Attachment$Outbound,
+  Attachment
+> = z.object({
+  filename: z.string(),
+  content: z.string(),
+  contentType: z.optional(z.string()),
+});
+
+export function attachmentToJSON(attachment: Attachment): string {
+  return JSON.stringify(Attachment$outboundSchema.parse(attachment));
+}

package/src/models/broadcast.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type Broadcast = {
+  id: string;
+  organizationId: string;
+  name: string;
+  subject: string;
+  fromEmail: string;
+  templateId: string | null;
+  segmentId: string | null;
+  status: string;
+  totalRecipients: number | null;
+  sentCount: number | null;
+  deliveredCount: number | null;
+  openedCount: number | null;
+  clickedCount: number | null;
+  bouncedCount: number | null;
+  scheduledAt: Date | null;
+  startedAt: Date | null;
+  completedAt: Date | null;
+  createdBy: string | null;
+  createdAt: Date;
+};
+
+/** @internal */
+export const Broadcast$inboundSchema: z.ZodMiniType<Broadcast, unknown> = z
+  .pipe(
+    z.object({
+      id: types.string(),
+      organization_id: types.string(),
+      name: types.string(),
+      subject: types.string(),
+      from_email: types.string(),
+      template_id: types.nullable(types.string()),
+      segment_id: types.nullable(types.string()),
+      status: types.string(),
+      total_recipients: types.nullable(types.number()),
+      sent_count: types.nullable(types.number()),
+      delivered_count: types.nullable(types.number()),
+      opened_count: types.nullable(types.number()),
+      clicked_count: types.nullable(types.number()),
+      bounced_count: types.nullable(types.number()),
+      scheduled_at: types.nullable(types.date()),
+      started_at: types.nullable(types.date()),
+      completed_at: types.nullable(types.date()),
+      created_by: types.nullable(types.string()),
+      created_at: types.date(),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "organization_id": "organizationId",
+        "from_email": "fromEmail",
+        "template_id": "templateId",
+        "segment_id": "segmentId",
+        "total_recipients": "totalRecipients",
+        "sent_count": "sentCount",
+        "delivered_count": "deliveredCount",
+        "opened_count": "openedCount",
+        "clicked_count": "clickedCount",
+        "bounced_count": "bouncedCount",
+        "scheduled_at": "scheduledAt",
+        "started_at": "startedAt",
+        "completed_at": "completedAt",
+        "created_by": "createdBy",
+        "created_at": "createdAt",
+      });
+    }),
+  );
+
+export function broadcastFromJSON(
+  jsonString: string,
+): SafeParseResult<Broadcast, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Broadcast$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Broadcast' from JSON`,
+  );
+}

package/src/models/bulkcreatecontactsrequest.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  CreateContactRequest,
+  CreateContactRequest$Outbound,
+  CreateContactRequest$outboundSchema,
+} from "./createcontactrequest.js";
+
+export type BulkCreateContactsRequest = {
+  contacts: Array<CreateContactRequest>;
+};
+
+/** @internal */
+export type BulkCreateContactsRequest$Outbound = {
+  contacts: Array<CreateContactRequest$Outbound>;
+};
+
+/** @internal */
+export const BulkCreateContactsRequest$outboundSchema: z.ZodMiniType<
+  BulkCreateContactsRequest$Outbound,
+  BulkCreateContactsRequest
+> = z.object({
+  contacts: z.array(CreateContactRequest$outboundSchema),
+});
+
+export function bulkCreateContactsRequestToJSON(
+  bulkCreateContactsRequest: BulkCreateContactsRequest,
+): string {
+  return JSON.stringify(
+    BulkCreateContactsRequest$outboundSchema.parse(bulkCreateContactsRequest),
+  );
+}

package/src/models/bulkcreatecontactsresponse.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BulkCreateContactsResponse = {
+  imported: number;
+  total: number;
+};
+
+/** @internal */
+export const BulkCreateContactsResponse$inboundSchema: z.ZodMiniType<
+  BulkCreateContactsResponse,
+  unknown
+> = z.object({
+  imported: types.number(),
+  total: types.number(),
+});
+
+export function bulkCreateContactsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkCreateContactsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BulkCreateContactsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkCreateContactsResponse' from JSON`,
+  );
+}

package/src/models/contact.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type Contact = {
+  id: string;
+  organizationId: string;
+  email: string;
+  firstName: string | null;
+  lastName: string | null;
+  metadata: { [k: string]: any | null } | null;
+  subscribed: boolean;
+  unsubscribedAt: Date | null;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const Contact$inboundSchema: z.ZodMiniType<Contact, unknown> = z.pipe(
+  z.object({
+    id: types.string(),
+    organization_id: types.string(),
+    email: types.string(),
+    first_name: types.nullable(types.string()),
+    last_name: types.nullable(types.string()),
+    metadata: types.nullable(z.record(z.string(), types.nullable(z.any()))),
+    subscribed: types.boolean(),
+    unsubscribed_at: types.nullable(types.date()),
+    created_at: types.date(),
+    updated_at: types.date(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+      "first_name": "firstName",
+      "last_name": "lastName",
+      "unsubscribed_at": "unsubscribedAt",
+      "created_at": "createdAt",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function contactFromJSON(
+  jsonString: string,
+): SafeParseResult<Contact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Contact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Contact' from JSON`,
+  );
+}