@hookdeck/outpost-sdk 0.0.2

package/src/models/components/tenant.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Tenant = {
+  /**
+   * User-defined system ID for the tenant.
+   */
+  id?: string | undefined;
+  /**
+   * Number of destinations associated with the tenant.
+   */
+  destinationsCount?: number | undefined;
+  /**
+   * List of subscribed topics across all destinations for this tenant.
+   */
+  topics?: Array<string> | undefined;
+  /**
+   * ISO Date when the tenant was created.
+   */
+  createdAt?: Date | undefined;
+};
+
+/** @internal */
+export const Tenant$inboundSchema: z.ZodType<Tenant, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    destinations_count: z.number().int().optional(),
+    topics: z.array(z.string()).optional(),
+    created_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "destinations_count": "destinationsCount",
+      "created_at": "createdAt",
+    });
+  });
+
+/** @internal */
+export type Tenant$Outbound = {
+  id?: string | undefined;
+  destinations_count?: number | undefined;
+  topics?: Array<string> | undefined;
+  created_at?: string | undefined;
+};
+
+/** @internal */
+export const Tenant$outboundSchema: z.ZodType<
+  Tenant$Outbound,
+  z.ZodTypeDef,
+  Tenant
+> = z.object({
+  id: z.string().optional(),
+  destinationsCount: z.number().int().optional(),
+  topics: z.array(z.string()).optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    destinationsCount: "destinations_count",
+    createdAt: "created_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Tenant$ {
+  /** @deprecated use `Tenant$inboundSchema` instead. */
+  export const inboundSchema = Tenant$inboundSchema;
+  /** @deprecated use `Tenant$outboundSchema` instead. */
+  export const outboundSchema = Tenant$outboundSchema;
+  /** @deprecated use `Tenant$Outbound` instead. */
+  export type Outbound = Tenant$Outbound;
+}
+
+export function tenantToJSON(tenant: Tenant): string {
+  return JSON.stringify(Tenant$outboundSchema.parse(tenant));
+}
+
+export function tenantFromJSON(
+  jsonString: string,
+): SafeParseResult<Tenant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tenant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tenant' from JSON`,
+  );
+}

package/src/models/components/tenanttoken.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TenantToken = {
+  /**
+   * JWT token scoped to the tenant for safe browser API calls.
+   */
+  token?: string | undefined;
+};
+
+/** @internal */
+export const TenantToken$inboundSchema: z.ZodType<
+  TenantToken,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string().optional(),
+});
+
+/** @internal */
+export type TenantToken$Outbound = {
+  token?: string | undefined;
+};
+
+/** @internal */
+export const TenantToken$outboundSchema: z.ZodType<
+  TenantToken$Outbound,
+  z.ZodTypeDef,
+  TenantToken
+> = z.object({
+  token: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenantToken$ {
+  /** @deprecated use `TenantToken$inboundSchema` instead. */
+  export const inboundSchema = TenantToken$inboundSchema;
+  /** @deprecated use `TenantToken$outboundSchema` instead. */
+  export const outboundSchema = TenantToken$outboundSchema;
+  /** @deprecated use `TenantToken$Outbound` instead. */
+  export type Outbound = TenantToken$Outbound;
+}
+
+export function tenantTokenToJSON(tenantToken: TenantToken): string {
+  return JSON.stringify(TenantToken$outboundSchema.parse(tenantToken));
+}
+
+export function tenantTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<TenantToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TenantToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TenantToken' from JSON`,
+  );
+}

package/src/models/components/topics.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const TopicsEnum = {
+  Wildcard: "*",
+} as const;
+export type TopicsEnum = ClosedEnum<typeof TopicsEnum>;
+
+/**
+ * "*" or an array of enabled topics.
+ */
+export type Topics = TopicsEnum | Array<string>;
+
+/** @internal */
+export const TopicsEnum$inboundSchema: z.ZodNativeEnum<typeof TopicsEnum> = z
+  .nativeEnum(TopicsEnum);
+
+/** @internal */
+export const TopicsEnum$outboundSchema: z.ZodNativeEnum<typeof TopicsEnum> =
+  TopicsEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsEnum$ {
+  /** @deprecated use `TopicsEnum$inboundSchema` instead. */
+  export const inboundSchema = TopicsEnum$inboundSchema;
+  /** @deprecated use `TopicsEnum$outboundSchema` instead. */
+  export const outboundSchema = TopicsEnum$outboundSchema;
+}
+
+/** @internal */
+export const Topics$inboundSchema: z.ZodType<Topics, z.ZodTypeDef, unknown> = z
+  .union([TopicsEnum$inboundSchema, z.array(z.string())]);
+
+/** @internal */
+export type Topics$Outbound = string | Array<string>;
+
+/** @internal */
+export const Topics$outboundSchema: z.ZodType<
+  Topics$Outbound,
+  z.ZodTypeDef,
+  Topics
+> = z.union([TopicsEnum$outboundSchema, z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Topics$ {
+  /** @deprecated use `Topics$inboundSchema` instead. */
+  export const inboundSchema = Topics$inboundSchema;
+  /** @deprecated use `Topics$outboundSchema` instead. */
+  export const outboundSchema = Topics$outboundSchema;
+  /** @deprecated use `Topics$Outbound` instead. */
+  export type Outbound = Topics$Outbound;
+}
+
+export function topicsToJSON(topics: Topics): string {
+  return JSON.stringify(Topics$outboundSchema.parse(topics));
+}
+
+export function topicsFromJSON(
+  jsonString: string,
+): SafeParseResult<Topics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Topics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Topics' from JSON`,
+  );
+}

package/src/models/components/webhookconfig.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type WebhookConfig = {
+  /**
+   * The URL to send the webhook events to.
+   */
+  url: string;
+};
+
+/** @internal */
+export const WebhookConfig$inboundSchema: z.ZodType<
+  WebhookConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+});
+
+/** @internal */
+export type WebhookConfig$Outbound = {
+  url: string;
+};
+
+/** @internal */
+export const WebhookConfig$outboundSchema: z.ZodType<
+  WebhookConfig$Outbound,
+  z.ZodTypeDef,
+  WebhookConfig
+> = z.object({
+  url: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookConfig$ {
+  /** @deprecated use `WebhookConfig$inboundSchema` instead. */
+  export const inboundSchema = WebhookConfig$inboundSchema;
+  /** @deprecated use `WebhookConfig$outboundSchema` instead. */
+  export const outboundSchema = WebhookConfig$outboundSchema;
+  /** @deprecated use `WebhookConfig$Outbound` instead. */
+  export type Outbound = WebhookConfig$Outbound;
+}
+
+export function webhookConfigToJSON(webhookConfig: WebhookConfig): string {
+  return JSON.stringify(WebhookConfig$outboundSchema.parse(webhookConfig));
+}
+
+export function webhookConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookConfig' from JSON`,
+  );
+}

package/src/models/components/webhookcredentials.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type WebhookCredentials = {
+  /**
+   * The secret used for signing webhook requests. Auto-generated if omitted on creation by admin. Read-only for tenants unless rotating.
+   */
+  secret?: string | undefined;
+  /**
+   * The previous secret used during rotation. Valid for 24 hours by default. Read-only.
+   */
+  previousSecret?: string | undefined;
+  /**
+   * ISO timestamp when the previous secret becomes invalid. Read-only.
+   */
+  previousSecretInvalidAt?: Date | undefined;
+};
+
+/** @internal */
+export const WebhookCredentials$inboundSchema: z.ZodType<
+  WebhookCredentials,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  secret: z.string().optional(),
+  previous_secret: z.string().optional(),
+  previous_secret_invalid_at: z.string().datetime({ offset: true }).transform(
+    v => new Date(v)
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "previous_secret": "previousSecret",
+    "previous_secret_invalid_at": "previousSecretInvalidAt",
+  });
+});
+
+/** @internal */
+export type WebhookCredentials$Outbound = {
+  secret?: string | undefined;
+  previous_secret?: string | undefined;
+  previous_secret_invalid_at?: string | undefined;
+};
+
+/** @internal */
+export const WebhookCredentials$outboundSchema: z.ZodType<
+  WebhookCredentials$Outbound,
+  z.ZodTypeDef,
+  WebhookCredentials
+> = z.object({
+  secret: z.string().optional(),
+  previousSecret: z.string().optional(),
+  previousSecretInvalidAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    previousSecret: "previous_secret",
+    previousSecretInvalidAt: "previous_secret_invalid_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCredentials$ {
+  /** @deprecated use `WebhookCredentials$inboundSchema` instead. */
+  export const inboundSchema = WebhookCredentials$inboundSchema;
+  /** @deprecated use `WebhookCredentials$outboundSchema` instead. */
+  export const outboundSchema = WebhookCredentials$outboundSchema;
+  /** @deprecated use `WebhookCredentials$Outbound` instead. */
+  export type Outbound = WebhookCredentials$Outbound;
+}
+
+export function webhookCredentialsToJSON(
+  webhookCredentials: WebhookCredentials,
+): string {
+  return JSON.stringify(
+    WebhookCredentials$outboundSchema.parse(webhookCredentials),
+  );
+}
+
+export function webhookCredentialsFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCredentials, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookCredentials$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCredentials' from JSON`,
+  );
+}

package/src/models/components/webhookcredentialsupdate.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type WebhookCredentialsUpdate = {
+  /**
+   * New secret (only allowed for admin).
+   */
+  secret?: string | undefined;
+  /**
+   * Previous secret for rotation (only allowed for admin).
+   */
+  previousSecret?: string | undefined;
+  /**
+   * Invalidation time for previous secret (only allowed for admin).
+   */
+  previousSecretInvalidAt?: Date | undefined;
+  /**
+   * Set to true to rotate the secret. The current secret becomes the previous_secret, and a new secret is generated. `previous_secret_invalid_at` defaults to 24h if not provided.
+   */
+  rotateSecret?: boolean | undefined;
+};
+
+/** @internal */
+export const WebhookCredentialsUpdate$inboundSchema: z.ZodType<
+  WebhookCredentialsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  secret: z.string().optional(),
+  previous_secret: z.string().optional(),
+  previous_secret_invalid_at: z.string().datetime({ offset: true }).transform(
+    v => new Date(v)
+  ).optional(),
+  rotate_secret: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "previous_secret": "previousSecret",
+    "previous_secret_invalid_at": "previousSecretInvalidAt",
+    "rotate_secret": "rotateSecret",
+  });
+});
+
+/** @internal */
+export type WebhookCredentialsUpdate$Outbound = {
+  secret?: string | undefined;
+  previous_secret?: string | undefined;
+  previous_secret_invalid_at?: string | undefined;
+  rotate_secret?: boolean | undefined;
+};
+
+/** @internal */
+export const WebhookCredentialsUpdate$outboundSchema: z.ZodType<
+  WebhookCredentialsUpdate$Outbound,
+  z.ZodTypeDef,
+  WebhookCredentialsUpdate
+> = z.object({
+  secret: z.string().optional(),
+  previousSecret: z.string().optional(),
+  previousSecretInvalidAt: z.date().transform(v => v.toISOString()).optional(),
+  rotateSecret: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    previousSecret: "previous_secret",
+    previousSecretInvalidAt: "previous_secret_invalid_at",
+    rotateSecret: "rotate_secret",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCredentialsUpdate$ {
+  /** @deprecated use `WebhookCredentialsUpdate$inboundSchema` instead. */
+  export const inboundSchema = WebhookCredentialsUpdate$inboundSchema;
+  /** @deprecated use `WebhookCredentialsUpdate$outboundSchema` instead. */
+  export const outboundSchema = WebhookCredentialsUpdate$outboundSchema;
+  /** @deprecated use `WebhookCredentialsUpdate$Outbound` instead. */
+  export type Outbound = WebhookCredentialsUpdate$Outbound;
+}
+
+export function webhookCredentialsUpdateToJSON(
+  webhookCredentialsUpdate: WebhookCredentialsUpdate,
+): string {
+  return JSON.stringify(
+    WebhookCredentialsUpdate$outboundSchema.parse(webhookCredentialsUpdate),
+  );
+}
+
+export function webhookCredentialsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCredentialsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookCredentialsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCredentialsUpdate' from JSON`,
+  );
+}

package/src/models/errors/apierror.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export class APIError extends Error {
+  public readonly statusCode: number;
+  public readonly contentType: string;
+
+  constructor(
+    message: string,
+    public readonly rawResponse: Response,
+    public readonly body: string = "",
+  ) {
+    const statusCode = rawResponse.status;
+    const contentType = rawResponse.headers.get("content-type") || "";
+    const bodyString = body.length > 0 ? `\n${body}` : "";
+
+    super(
+      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
+    );
+
+    this.statusCode = statusCode;
+    this.contentType = contentType;
+
+    this.name = "APIError";
+  }
+}

package/src/models/errors/badrequesterror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+
+/**
+ * A collection of codes that generally means the end user got something wrong in making the request
+ */
+export type BadRequestErrorData = {
+  message?: string | undefined;
+
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * A collection of codes that generally means the end user got something wrong in making the request
+ */
+export class BadRequestError extends Error {
+  additionalProperties: { [k: string]: any } = {};
+
+  /** The original data that was passed to this error instance. */
+  data$: BadRequestErrorData;
+
+  constructor(err: BadRequestErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.additionalProperties != null) {
+      this.additionalProperties = err.additionalProperties;
+    }
+
+    this.name = "BadRequestError";
+  }
+}
+
+/** @internal */
+export const BadRequestError$inboundSchema: z.ZodType<
+  BadRequestError,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    message: z.string().optional(),
+  })
+    .catchall(z.any()),
+  "additionalProperties",
+  true,
+)
+  .transform((v) => {
+    return new BadRequestError(v);
+  });
+
+/** @internal */
+export type BadRequestError$Outbound = {
+  message?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const BadRequestError$outboundSchema: z.ZodType<
+  BadRequestError$Outbound,
+  z.ZodTypeDef,
+  BadRequestError
+> = z.instanceof(BadRequestError)
+  .transform(v => v.data$)
+  .pipe(
+    z.object({
+      message: z.string().optional(),
+      additionalProperties: z.record(z.any()),
+    }).transform((v) => {
+      return {
+        ...v.additionalProperties,
+        ...remap$(v, {
+          additionalProperties: null,
+        }),
+      };
+    }),
+  );
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BadRequestError$ {
+  /** @deprecated use `BadRequestError$inboundSchema` instead. */
+  export const inboundSchema = BadRequestError$inboundSchema;
+  /** @deprecated use `BadRequestError$outboundSchema` instead. */
+  export const outboundSchema = BadRequestError$outboundSchema;
+  /** @deprecated use `BadRequestError$Outbound` instead. */
+  export type Outbound = BadRequestError$Outbound;
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}