@hookdeck/outpost-sdk 0.2.0 → 0.4.0

package/src/models/components/destinationcreateazureservicebus.ts

@@ -0,0 +1,149 @@
+/*
+ * 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";
+import {
+  AzureServiceBusConfig,
+  AzureServiceBusConfig$inboundSchema,
+  AzureServiceBusConfig$Outbound,
+  AzureServiceBusConfig$outboundSchema,
+} from "./azureservicebusconfig.js";
+import {
+  AzureServiceBusCredentials,
+  AzureServiceBusCredentials$inboundSchema,
+  AzureServiceBusCredentials$Outbound,
+  AzureServiceBusCredentials$outboundSchema,
+} from "./azureservicebuscredentials.js";
+import {
+  Topics,
+  Topics$inboundSchema,
+  Topics$Outbound,
+  Topics$outboundSchema,
+} from "./topics.js";
+
+/**
+ * Type of the destination. Must be 'azure_servicebus'.
+ */
+export const DestinationCreateAzureServiceBusType = {
+  AzureServicebus: "azure_servicebus",
+} as const;
+/**
+ * Type of the destination. Must be 'azure_servicebus'.
+ */
+export type DestinationCreateAzureServiceBusType = ClosedEnum<
+  typeof DestinationCreateAzureServiceBusType
+>;
+
+export type DestinationCreateAzureServiceBus = {
+  /**
+   * Optional user-provided ID. A UUID will be generated if empty.
+   */
+  id?: string | undefined;
+  /**
+   * Type of the destination. Must be 'azure_servicebus'.
+   */
+  type: DestinationCreateAzureServiceBusType;
+  /**
+   * "*" or an array of enabled topics.
+   */
+  topics: Topics;
+  config: AzureServiceBusConfig;
+  credentials: AzureServiceBusCredentials;
+};
+
+/** @internal */
+export const DestinationCreateAzureServiceBusType$inboundSchema:
+  z.ZodNativeEnum<typeof DestinationCreateAzureServiceBusType> = z.nativeEnum(
+    DestinationCreateAzureServiceBusType,
+  );
+
+/** @internal */
+export const DestinationCreateAzureServiceBusType$outboundSchema:
+  z.ZodNativeEnum<typeof DestinationCreateAzureServiceBusType> =
+    DestinationCreateAzureServiceBusType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DestinationCreateAzureServiceBusType$ {
+  /** @deprecated use `DestinationCreateAzureServiceBusType$inboundSchema` instead. */
+  export const inboundSchema =
+    DestinationCreateAzureServiceBusType$inboundSchema;
+  /** @deprecated use `DestinationCreateAzureServiceBusType$outboundSchema` instead. */
+  export const outboundSchema =
+    DestinationCreateAzureServiceBusType$outboundSchema;
+}
+
+/** @internal */
+export const DestinationCreateAzureServiceBus$inboundSchema: z.ZodType<
+  DestinationCreateAzureServiceBus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  type: DestinationCreateAzureServiceBusType$inboundSchema,
+  topics: Topics$inboundSchema,
+  config: AzureServiceBusConfig$inboundSchema,
+  credentials: AzureServiceBusCredentials$inboundSchema,
+});
+
+/** @internal */
+export type DestinationCreateAzureServiceBus$Outbound = {
+  id?: string | undefined;
+  type: string;
+  topics: Topics$Outbound;
+  config: AzureServiceBusConfig$Outbound;
+  credentials: AzureServiceBusCredentials$Outbound;
+};
+
+/** @internal */
+export const DestinationCreateAzureServiceBus$outboundSchema: z.ZodType<
+  DestinationCreateAzureServiceBus$Outbound,
+  z.ZodTypeDef,
+  DestinationCreateAzureServiceBus
+> = z.object({
+  id: z.string().optional(),
+  type: DestinationCreateAzureServiceBusType$outboundSchema,
+  topics: Topics$outboundSchema,
+  config: AzureServiceBusConfig$outboundSchema,
+  credentials: AzureServiceBusCredentials$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DestinationCreateAzureServiceBus$ {
+  /** @deprecated use `DestinationCreateAzureServiceBus$inboundSchema` instead. */
+  export const inboundSchema = DestinationCreateAzureServiceBus$inboundSchema;
+  /** @deprecated use `DestinationCreateAzureServiceBus$outboundSchema` instead. */
+  export const outboundSchema = DestinationCreateAzureServiceBus$outboundSchema;
+  /** @deprecated use `DestinationCreateAzureServiceBus$Outbound` instead. */
+  export type Outbound = DestinationCreateAzureServiceBus$Outbound;
+}
+
+export function destinationCreateAzureServiceBusToJSON(
+  destinationCreateAzureServiceBus: DestinationCreateAzureServiceBus,
+): string {
+  return JSON.stringify(
+    DestinationCreateAzureServiceBus$outboundSchema.parse(
+      destinationCreateAzureServiceBus,
+    ),
+  );
+}
+
+export function destinationCreateAzureServiceBusFromJSON(
+  jsonString: string,
+): SafeParseResult<DestinationCreateAzureServiceBus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DestinationCreateAzureServiceBus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DestinationCreateAzureServiceBus' from JSON`,
+  );
+}

package/src/models/components/destinationupdate.ts

@@ -12,6 +12,12 @@ import {
   DestinationUpdateAWSKinesis$Outbound,
   DestinationUpdateAWSKinesis$outboundSchema,
 } from "./destinationupdateawskinesis.js";
+import {
+  DestinationUpdateAwss3,
+  DestinationUpdateAwss3$inboundSchema,
+  DestinationUpdateAwss3$Outbound,
+  DestinationUpdateAwss3$outboundSchema,
+} from "./destinationupdateawss3.js";
 import {
   DestinationUpdateAWSSQS,
   DestinationUpdateAWSSQS$inboundSchema,
@@ -42,7 +48,8 @@ export type DestinationUpdate =
   | DestinationUpdateAWSSQS
   | DestinationUpdateRabbitMQ
   | DestinationUpdateHookdeck
-  | DestinationUpdateAWSKinesis;
+  | DestinationUpdateAWSKinesis
+  | DestinationUpdateAwss3;
 
 /** @internal */
 export const DestinationUpdate$inboundSchema: z.ZodType<
@@ -55,6 +62,7 @@ export const DestinationUpdate$inboundSchema: z.ZodType<
   DestinationUpdateRabbitMQ$inboundSchema,
   DestinationUpdateHookdeck$inboundSchema,
   DestinationUpdateAWSKinesis$inboundSchema,
+  DestinationUpdateAwss3$inboundSchema,
 ]);
 
 /** @internal */
@@ -63,7 +71,8 @@ export type DestinationUpdate$Outbound =
   | DestinationUpdateAWSSQS$Outbound
   | DestinationUpdateRabbitMQ$Outbound
   | DestinationUpdateHookdeck$Outbound
-  | DestinationUpdateAWSKinesis$Outbound;
+  | DestinationUpdateAWSKinesis$Outbound
+  | DestinationUpdateAwss3$Outbound;
 
 /** @internal */
 export const DestinationUpdate$outboundSchema: z.ZodType<
@@ -76,6 +85,7 @@ export const DestinationUpdate$outboundSchema: z.ZodType<
   DestinationUpdateRabbitMQ$outboundSchema,
   DestinationUpdateHookdeck$outboundSchema,
   DestinationUpdateAWSKinesis$outboundSchema,
+  DestinationUpdateAwss3$outboundSchema,
 ]);
 
 /**

package/src/models/components/destinationupdateawss3.ts

@@ -0,0 +1,95 @@
+/*
+ * 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";
+import {
+  Awss3Config,
+  Awss3Config$inboundSchema,
+  Awss3Config$Outbound,
+  Awss3Config$outboundSchema,
+} from "./awss3config.js";
+import {
+  Awss3Credentials,
+  Awss3Credentials$inboundSchema,
+  Awss3Credentials$Outbound,
+  Awss3Credentials$outboundSchema,
+} from "./awss3credentials.js";
+import {
+  Topics,
+  Topics$inboundSchema,
+  Topics$Outbound,
+  Topics$outboundSchema,
+} from "./topics.js";
+
+export type DestinationUpdateAwss3 = {
+  /**
+   * "*" or an array of enabled topics.
+   */
+  topics?: Topics | undefined;
+  config?: Awss3Config | undefined;
+  credentials?: Awss3Credentials | undefined;
+};
+
+/** @internal */
+export const DestinationUpdateAwss3$inboundSchema: z.ZodType<
+  DestinationUpdateAwss3,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  topics: Topics$inboundSchema.optional(),
+  config: Awss3Config$inboundSchema.optional(),
+  credentials: Awss3Credentials$inboundSchema.optional(),
+});
+
+/** @internal */
+export type DestinationUpdateAwss3$Outbound = {
+  topics?: Topics$Outbound | undefined;
+  config?: Awss3Config$Outbound | undefined;
+  credentials?: Awss3Credentials$Outbound | undefined;
+};
+
+/** @internal */
+export const DestinationUpdateAwss3$outboundSchema: z.ZodType<
+  DestinationUpdateAwss3$Outbound,
+  z.ZodTypeDef,
+  DestinationUpdateAwss3
+> = z.object({
+  topics: Topics$outboundSchema.optional(),
+  config: Awss3Config$outboundSchema.optional(),
+  credentials: Awss3Credentials$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 DestinationUpdateAwss3$ {
+  /** @deprecated use `DestinationUpdateAwss3$inboundSchema` instead. */
+  export const inboundSchema = DestinationUpdateAwss3$inboundSchema;
+  /** @deprecated use `DestinationUpdateAwss3$outboundSchema` instead. */
+  export const outboundSchema = DestinationUpdateAwss3$outboundSchema;
+  /** @deprecated use `DestinationUpdateAwss3$Outbound` instead. */
+  export type Outbound = DestinationUpdateAwss3$Outbound;
+}
+
+export function destinationUpdateAwss3ToJSON(
+  destinationUpdateAwss3: DestinationUpdateAwss3,
+): string {
+  return JSON.stringify(
+    DestinationUpdateAwss3$outboundSchema.parse(destinationUpdateAwss3),
+  );
+}
+
+export function destinationUpdateAwss3FromJSON(
+  jsonString: string,
+): SafeParseResult<DestinationUpdateAwss3, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DestinationUpdateAwss3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DestinationUpdateAwss3' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -4,15 +4,23 @@
 
 export * from "./awskinesisconfig.js";
 export * from "./awskinesiscredentials.js";
+export * from "./awss3config.js";
+export * from "./awss3credentials.js";
 export * from "./awssqsconfig.js";
 export * from "./awssqscredentials.js";
+export * from "./azureservicebusconfig.js";
+export * from "./azureservicebuscredentials.js";
 export * from "./deliveryattempt.js";
 export * from "./destination.js";
 export * from "./destinationawskinesis.js";
+export * from "./destinationawss3.js";
 export * from "./destinationawssqs.js";
+export * from "./destinationazureservicebus.js";
 export * from "./destinationcreate.js";
 export * from "./destinationcreateawskinesis.js";
+export * from "./destinationcreateawss3.js";
 export * from "./destinationcreateawssqs.js";
+export * from "./destinationcreateazureservicebus.js";
 export * from "./destinationcreatehookdeck.js";
 export * from "./destinationcreaterabbitmq.js";
 export * from "./destinationcreatewebhook.js";
@@ -22,6 +30,7 @@ export * from "./destinationschemafield.js";
 export * from "./destinationtypeschema.js";
 export * from "./destinationupdate.js";
 export * from "./destinationupdateawskinesis.js";
+export * from "./destinationupdateawss3.js";
 export * from "./destinationupdateawssqs.js";
 export * from "./destinationupdatehookdeck.js";
 export * from "./destinationupdaterabbitmq.js";
@@ -31,6 +40,7 @@ export * from "./event.js";
 export * from "./hookdeckcredentials.js";
 export * from "./portalredirect.js";
 export * from "./publishrequest.js";
+export * from "./publishresponse.js";
 export * from "./rabbitmqconfig.js";
 export * from "./rabbitmqcredentials.js";
 export * from "./security.js";

package/src/models/components/publishresponse.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 PublishResponse = {
+  /**
+   * The ID of the event that was accepted for publishing. This will be the ID provided in the request's `id` field if present, otherwise it's a server-generated UUID.
+   */
+  id: string;
+};
+
+/** @internal */
+export const PublishResponse$inboundSchema: z.ZodType<
+  PublishResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+
+/** @internal */
+export type PublishResponse$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const PublishResponse$outboundSchema: z.ZodType<
+  PublishResponse$Outbound,
+  z.ZodTypeDef,
+  PublishResponse
+> = z.object({
+  id: 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 PublishResponse$ {
+  /** @deprecated use `PublishResponse$inboundSchema` instead. */
+  export const inboundSchema = PublishResponse$inboundSchema;
+  /** @deprecated use `PublishResponse$outboundSchema` instead. */
+  export const outboundSchema = PublishResponse$outboundSchema;
+  /** @deprecated use `PublishResponse$Outbound` instead. */
+  export type Outbound = PublishResponse$Outbound;
+}
+
+export function publishResponseToJSON(
+  publishResponse: PublishResponse,
+): string {
+  return JSON.stringify(PublishResponse$outboundSchema.parse(publishResponse));
+}
+
+export function publishResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PublishResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublishResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublishResponse' from JSON`,
+  );
+}

package/src/models/errors/apierror.ts

@@ -2,26 +2,39 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class APIError extends Error {
-  public readonly statusCode: number;
-  public readonly contentType: string;
+import { OutpostError } from "./outposterror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends OutpostError {
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      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;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "APIError";
   }
 }

package/src/models/errors/badrequesterror.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+import { OutpostError } from "./outposterror.js";
 
 /**
  * A collection of codes that generally means the end user got something wrong in making the request
@@ -18,19 +19,19 @@ export type BadRequestErrorData = {
 /**
  * A collection of codes that generally means the end user got something wrong in making the request
  */
-export class BadRequestError extends Error {
+export class BadRequestError extends OutpostError {
   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);
+  constructor(
+    err: BadRequestErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.additionalProperties != null) {
       this.additionalProperties = err.additionalProperties;
     }
@@ -47,13 +48,20 @@ export const BadRequestError$inboundSchema: z.ZodType<
 > = collectExtraKeys$(
   z.object({
     message: z.string().optional(),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
   })
     .catchall(z.any()),
   "additionalProperties",
   true,
 )
   .transform((v) => {
-    return new BadRequestError(v);
+    return new BadRequestError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -8,6 +8,7 @@ export * from "./httpclienterrors.js";
 export * from "./internalservererror.js";
 export * from "./notfounderror.js";
 export * from "./ratelimitederror.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./timeouterror.js";
 export * from "./unauthorizederror.js";

package/src/models/errors/internalservererror.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+import { OutpostError } from "./outposterror.js";
 
 /**
  * A collection of status codes that generally mean the server failed in an unexpected way
@@ -18,19 +19,19 @@ export type InternalServerErrorData = {
 /**
  * A collection of status codes that generally mean the server failed in an unexpected way
  */
-export class InternalServerError extends Error {
+export class InternalServerError extends OutpostError {
   additionalProperties: { [k: string]: any } = {};
 
   /** The original data that was passed to this error instance. */
   data$: InternalServerErrorData;
 
-  constructor(err: InternalServerErrorData) {
-    const message = "message" in err && typeof err.message === "string"
-      ? err.message
-      : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+  constructor(
+    err: InternalServerErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.additionalProperties != null) {
       this.additionalProperties = err.additionalProperties;
     }
@@ -47,13 +48,20 @@ export const InternalServerError$inboundSchema: z.ZodType<
 > = collectExtraKeys$(
   z.object({
     message: z.string().optional(),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
   })
     .catchall(z.any()),
   "additionalProperties",
   true,
 )
   .transform((v) => {
-    return new InternalServerError(v);
+    return new InternalServerError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/notfounderror.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { collectExtraKeys as collectExtraKeys$ } from "../../lib/schemas.js";
+import { OutpostError } from "./outposterror.js";
 
 /**
  * Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing
@@ -18,19 +19,19 @@ export type NotFoundErrorData = {
 /**
  * Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing
  */
-export class NotFoundError extends Error {
+export class NotFoundError extends OutpostError {
   additionalProperties: { [k: string]: any } = {};
 
   /** The original data that was passed to this error instance. */
   data$: NotFoundErrorData;
 
-  constructor(err: NotFoundErrorData) {
-    const message = "message" in err && typeof err.message === "string"
-      ? err.message
-      : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+  constructor(
+    err: NotFoundErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.additionalProperties != null) {
       this.additionalProperties = err.additionalProperties;
     }
@@ -47,13 +48,20 @@ export const NotFoundError$inboundSchema: z.ZodType<
 > = collectExtraKeys$(
   z.object({
     message: z.string().optional(),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
   })
     .catchall(z.any()),
   "additionalProperties",
   true,
 )
   .transform((v) => {
-    return new NotFoundError(v);
+    return new NotFoundError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/outposterror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class OutpostError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "OutpostError";
+  }
+}