@documenso/sdk-typescript 0.1.1

package/src/models/components/security.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 Security = {
+  apiKey?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  apiKey: z.string().optional(),
+});
+
+/** @internal */
+export type Security$Outbound = {
+  apiKey?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  apiKey: 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 Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' 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/errorbadrequest.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 "./sdkvalidationerror.js";
+
+export type Issues = {
+  message: string;
+};
+
+/**
+ * The error information
+ */
+export type ErrorBADREQUESTData = {
+  /**
+   * The error message
+   */
+  message: string;
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<Issues> | undefined;
+};
+
+/**
+ * The error information
+ */
+export class ErrorBADREQUEST extends Error {
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<Issues> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorBADREQUESTData;
+
+  constructor(err: ErrorBADREQUESTData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.code = err.code;
+    if (err.issues != null) this.issues = err.issues;
+
+    this.name = "ErrorBADREQUEST";
+  }
+}
+
+/** @internal */
+export const Issues$inboundSchema: z.ZodType<Issues, z.ZodTypeDef, unknown> = z
+  .object({
+    message: z.string(),
+  });
+
+/** @internal */
+export type Issues$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const Issues$outboundSchema: z.ZodType<
+  Issues$Outbound,
+  z.ZodTypeDef,
+  Issues
+> = z.object({
+  message: 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 Issues$ {
+  /** @deprecated use `Issues$inboundSchema` instead. */
+  export const inboundSchema = Issues$inboundSchema;
+  /** @deprecated use `Issues$outboundSchema` instead. */
+  export const outboundSchema = Issues$outboundSchema;
+  /** @deprecated use `Issues$Outbound` instead. */
+  export type Outbound = Issues$Outbound;
+}
+
+export function issuesToJSON(issues: Issues): string {
+  return JSON.stringify(Issues$outboundSchema.parse(issues));
+}
+
+export function issuesFromJSON(
+  jsonString: string,
+): SafeParseResult<Issues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Issues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Issues' from JSON`,
+  );
+}
+
+/** @internal */
+export const ErrorBADREQUEST$inboundSchema: z.ZodType<
+  ErrorBADREQUEST,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  code: z.string(),
+  issues: z.array(z.lazy(() => Issues$inboundSchema)).optional(),
+})
+  .transform((v) => {
+    return new ErrorBADREQUEST(v);
+  });
+
+/** @internal */
+export type ErrorBADREQUEST$Outbound = {
+  message: string;
+  code: string;
+  issues?: Array<Issues$Outbound> | undefined;
+};
+
+/** @internal */
+export const ErrorBADREQUEST$outboundSchema: z.ZodType<
+  ErrorBADREQUEST$Outbound,
+  z.ZodTypeDef,
+  ErrorBADREQUEST
+> = z.instanceof(ErrorBADREQUEST)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+    code: z.string(),
+    issues: z.array(z.lazy(() => Issues$outboundSchema)).optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ErrorBADREQUEST$ {
+  /** @deprecated use `ErrorBADREQUEST$inboundSchema` instead. */
+  export const inboundSchema = ErrorBADREQUEST$inboundSchema;
+  /** @deprecated use `ErrorBADREQUEST$outboundSchema` instead. */
+  export const outboundSchema = ErrorBADREQUEST$outboundSchema;
+  /** @deprecated use `ErrorBADREQUEST$Outbound` instead. */
+  export type Outbound = ErrorBADREQUEST$Outbound;
+}

package/src/models/errors/errorinternalservererror.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 "./sdkvalidationerror.js";
+
+export type ERRORINTERNALSERVERERRORIssues = {
+  message: string;
+};
+
+/**
+ * The error information
+ */
+export type ErrorinternalservererrorData = {
+  /**
+   * The error message
+   */
+  message: string;
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<ERRORINTERNALSERVERERRORIssues> | undefined;
+};
+
+/**
+ * The error information
+ */
+export class Errorinternalservererror extends Error {
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<ERRORINTERNALSERVERERRORIssues> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorinternalservererrorData;
+
+  constructor(err: ErrorinternalservererrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.code = err.code;
+    if (err.issues != null) this.issues = err.issues;
+
+    this.name = "Errorinternalservererror";
+  }
+}
+
+/** @internal */
+export const ERRORINTERNALSERVERERRORIssues$inboundSchema: z.ZodType<
+  ERRORINTERNALSERVERERRORIssues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+});
+
+/** @internal */
+export type ERRORINTERNALSERVERERRORIssues$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const ERRORINTERNALSERVERERRORIssues$outboundSchema: z.ZodType<
+  ERRORINTERNALSERVERERRORIssues$Outbound,
+  z.ZodTypeDef,
+  ERRORINTERNALSERVERERRORIssues
+> = z.object({
+  message: 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 ERRORINTERNALSERVERERRORIssues$ {
+  /** @deprecated use `ERRORINTERNALSERVERERRORIssues$inboundSchema` instead. */
+  export const inboundSchema = ERRORINTERNALSERVERERRORIssues$inboundSchema;
+  /** @deprecated use `ERRORINTERNALSERVERERRORIssues$outboundSchema` instead. */
+  export const outboundSchema = ERRORINTERNALSERVERERRORIssues$outboundSchema;
+  /** @deprecated use `ERRORINTERNALSERVERERRORIssues$Outbound` instead. */
+  export type Outbound = ERRORINTERNALSERVERERRORIssues$Outbound;
+}
+
+export function errorINTERNALSERVERERRORIssuesToJSON(
+  errorinternalservererrorIssues: ERRORINTERNALSERVERERRORIssues,
+): string {
+  return JSON.stringify(
+    ERRORINTERNALSERVERERRORIssues$outboundSchema.parse(
+      errorinternalservererrorIssues,
+    ),
+  );
+}
+
+export function errorINTERNALSERVERERRORIssuesFromJSON(
+  jsonString: string,
+): SafeParseResult<ERRORINTERNALSERVERERRORIssues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ERRORINTERNALSERVERERRORIssues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ERRORINTERNALSERVERERRORIssues' from JSON`,
+  );
+}
+
+/** @internal */
+export const Errorinternalservererror$inboundSchema: z.ZodType<
+  Errorinternalservererror,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  code: z.string(),
+  issues: z.array(z.lazy(() => ERRORINTERNALSERVERERRORIssues$inboundSchema))
+    .optional(),
+})
+  .transform((v) => {
+    return new Errorinternalservererror(v);
+  });
+
+/** @internal */
+export type Errorinternalservererror$Outbound = {
+  message: string;
+  code: string;
+  issues?: Array<ERRORINTERNALSERVERERRORIssues$Outbound> | undefined;
+};
+
+/** @internal */
+export const Errorinternalservererror$outboundSchema: z.ZodType<
+  Errorinternalservererror$Outbound,
+  z.ZodTypeDef,
+  Errorinternalservererror
+> = z.instanceof(Errorinternalservererror)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+    code: z.string(),
+    issues: z.array(z.lazy(() => ERRORINTERNALSERVERERRORIssues$outboundSchema))
+      .optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Errorinternalservererror$ {
+  /** @deprecated use `Errorinternalservererror$inboundSchema` instead. */
+  export const inboundSchema = Errorinternalservererror$inboundSchema;
+  /** @deprecated use `Errorinternalservererror$outboundSchema` instead. */
+  export const outboundSchema = Errorinternalservererror$outboundSchema;
+  /** @deprecated use `Errorinternalservererror$Outbound` instead. */
+  export type Outbound = Errorinternalservererror$Outbound;
+}

package/src/models/errors/errornotfound.ts

@@ -0,0 +1,162 @@
+/*
+ * 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 "./sdkvalidationerror.js";
+
+export type ErrorNOTFOUNDIssues = {
+  message: string;
+};
+
+/**
+ * The error information
+ */
+export type ErrorNOTFOUNDData = {
+  /**
+   * The error message
+   */
+  message: string;
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<ErrorNOTFOUNDIssues> | undefined;
+};
+
+/**
+ * The error information
+ */
+export class ErrorNOTFOUND extends Error {
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * An array of issues that were responsible for the error
+   */
+  issues?: Array<ErrorNOTFOUNDIssues> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorNOTFOUNDData;
+
+  constructor(err: ErrorNOTFOUNDData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.code = err.code;
+    if (err.issues != null) this.issues = err.issues;
+
+    this.name = "ErrorNOTFOUND";
+  }
+}
+
+/** @internal */
+export const ErrorNOTFOUNDIssues$inboundSchema: z.ZodType<
+  ErrorNOTFOUNDIssues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+});
+
+/** @internal */
+export type ErrorNOTFOUNDIssues$Outbound = {
+  message: string;
+};
+
+/** @internal */
+export const ErrorNOTFOUNDIssues$outboundSchema: z.ZodType<
+  ErrorNOTFOUNDIssues$Outbound,
+  z.ZodTypeDef,
+  ErrorNOTFOUNDIssues
+> = z.object({
+  message: 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 ErrorNOTFOUNDIssues$ {
+  /** @deprecated use `ErrorNOTFOUNDIssues$inboundSchema` instead. */
+  export const inboundSchema = ErrorNOTFOUNDIssues$inboundSchema;
+  /** @deprecated use `ErrorNOTFOUNDIssues$outboundSchema` instead. */
+  export const outboundSchema = ErrorNOTFOUNDIssues$outboundSchema;
+  /** @deprecated use `ErrorNOTFOUNDIssues$Outbound` instead. */
+  export type Outbound = ErrorNOTFOUNDIssues$Outbound;
+}
+
+export function errorNOTFOUNDIssuesToJSON(
+  errorNOTFOUNDIssues: ErrorNOTFOUNDIssues,
+): string {
+  return JSON.stringify(
+    ErrorNOTFOUNDIssues$outboundSchema.parse(errorNOTFOUNDIssues),
+  );
+}
+
+export function errorNOTFOUNDIssuesFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorNOTFOUNDIssues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorNOTFOUNDIssues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorNOTFOUNDIssues' from JSON`,
+  );
+}
+
+/** @internal */
+export const ErrorNOTFOUND$inboundSchema: z.ZodType<
+  ErrorNOTFOUND,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  code: z.string(),
+  issues: z.array(z.lazy(() => ErrorNOTFOUNDIssues$inboundSchema)).optional(),
+})
+  .transform((v) => {
+    return new ErrorNOTFOUND(v);
+  });
+
+/** @internal */
+export type ErrorNOTFOUND$Outbound = {
+  message: string;
+  code: string;
+  issues?: Array<ErrorNOTFOUNDIssues$Outbound> | undefined;
+};
+
+/** @internal */
+export const ErrorNOTFOUND$outboundSchema: z.ZodType<
+  ErrorNOTFOUND$Outbound,
+  z.ZodTypeDef,
+  ErrorNOTFOUND
+> = z.instanceof(ErrorNOTFOUND)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    message: z.string(),
+    code: z.string(),
+    issues: z.array(z.lazy(() => ErrorNOTFOUNDIssues$outboundSchema))
+      .optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ErrorNOTFOUND$ {
+  /** @deprecated use `ErrorNOTFOUND$inboundSchema` instead. */
+  export const inboundSchema = ErrorNOTFOUND$inboundSchema;
+  /** @deprecated use `ErrorNOTFOUND$outboundSchema` instead. */
+  export const outboundSchema = ErrorNOTFOUND$outboundSchema;
+  /** @deprecated use `ErrorNOTFOUND$Outbound` instead. */
+  export type Outbound = ErrorNOTFOUND$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";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./apierror.js";
+export * from "./errorbadrequest.js";
+export * from "./errorinternalservererror.js";
+export * from "./errornotfound.js";
+export * from "./httpclienterrors.js";
+export * from "./sdkvalidationerror.js";