@hookdeck/outpost-sdk 0.2.0 → 0.4.0

package/src/models/errors/ratelimitederror.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 client being rate limited by the server
@@ -18,19 +19,19 @@ export type RateLimitedErrorData = {
 /**
  * Status codes relating to the client being rate limited by the server
  */
-export class RateLimitedError extends Error {
+export class RateLimitedError extends OutpostError {
   additionalProperties: { [k: string]: any } = {};
 
   /** The original data that was passed to this error instance. */
   data$: RateLimitedErrorData;
 
-  constructor(err: RateLimitedErrorData) {
-    const message = "message" in err && typeof err.message === "string"
-      ? err.message
-      : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+  constructor(
+    err: RateLimitedErrorData,
+    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 RateLimitedError$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 RateLimitedError(v);
+    return new RateLimitedError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { OutpostError } from "./outposterror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends OutpostError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/timeouterror.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";
 
 /**
  * Timeouts occurred with the request
@@ -18,19 +19,19 @@ export type TimeoutErrorData = {
 /**
  * Timeouts occurred with the request
  */
-export class TimeoutError extends Error {
+export class TimeoutError extends OutpostError {
   additionalProperties: { [k: string]: any } = {};
 
   /** The original data that was passed to this error instance. */
   data$: TimeoutErrorData;
 
-  constructor(err: TimeoutErrorData) {
-    const message = "message" in err && typeof err.message === "string"
-      ? err.message
-      : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+  constructor(
+    err: TimeoutErrorData,
+    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 TimeoutError$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 TimeoutError(v);
+    return new TimeoutError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/unauthorizederror.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 client was not authenticated correctly for the request they want to make
@@ -18,19 +19,19 @@ export type UnauthorizedErrorData = {
 /**
  * A collection of codes that generally means the client was not authenticated correctly for the request they want to make
  */
-export class UnauthorizedError extends Error {
+export class UnauthorizedError extends OutpostError {
   additionalProperties: { [k: string]: any } = {};
 
   /** The original data that was passed to this error instance. */
   data$: UnauthorizedErrorData;
 
-  constructor(err: UnauthorizedErrorData) {
-    const message = "message" in err && typeof err.message === "string"
-      ? err.message
-      : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+  constructor(
+    err: UnauthorizedErrorData,
+    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 UnauthorizedError$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 UnauthorizedError(v);
+    return new UnauthorizedError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/operations/getdestinationtypeschema.ts

@@ -17,6 +17,7 @@ export const GetDestinationTypeSchemaType = {
   Rabbitmq: "rabbitmq",
   Hookdeck: "hookdeck",
   AwsKinesis: "aws_kinesis",
+  AwsS3: "aws_s3",
 } as const;
 /**
  * The type of the destination.

package/src/models/operations/gettenantdestinationtypeschema.ts

@@ -22,6 +22,7 @@ export const GetTenantDestinationTypeSchemaType = {
   Rabbitmq: "rabbitmq",
   Hookdeck: "hookdeck",
   AwsKinesis: "aws_kinesis",
+  AwsS3: "aws_s3",
 } as const;
 /**
  * The type of the destination.

package/src/models/operations/listtenantdestinations.ts

@@ -19,6 +19,7 @@ export const ListTenantDestinationsTypeEnum2 = {
   Rabbitmq: "rabbitmq",
   Hookdeck: "hookdeck",
   AwsKinesis: "aws_kinesis",
+  AwsS3: "aws_s3",
 } as const;
 export type ListTenantDestinationsTypeEnum2 = ClosedEnum<
   typeof ListTenantDestinationsTypeEnum2
@@ -30,6 +31,7 @@ export const ListTenantDestinationsTypeEnum1 = {
   Rabbitmq: "rabbitmq",
   Hookdeck: "hookdeck",
   AwsKinesis: "aws_kinesis",
+  AwsS3: "aws_s3",
 } as const;
 export type ListTenantDestinationsTypeEnum1 = ClosedEnum<
   typeof ListTenantDestinationsTypeEnum1

package/src/models/operations/listtenantevents.ts

@@ -7,6 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListTenantEventsGlobals = {
@@ -43,6 +44,49 @@ export type ListTenantEventsRequest = {
    * Filter events by delivery status.
    */
   status?: ListTenantEventsStatus | undefined;
+  /**
+   * Cursor for next page of results
+   */
+  next?: string | undefined;
+  /**
+   * Cursor for previous page of results
+   */
+  prev?: string | undefined;
+  /**
+   * Number of items per page (default 100, max 1000)
+   */
+  limit?: number | undefined;
+  /**
+   * Start time filter (RFC3339 format)
+   */
+  start?: Date | undefined;
+  /**
+   * End time filter (RFC3339 format)
+   */
+  end?: Date | undefined;
+};
+
+/**
+ * A paginated list of events.
+ */
+export type ListTenantEventsResponseBody = {
+  /**
+   * Total number of items across all pages
+   */
+  count: number;
+  data: Array<components.Event>;
+  /**
+   * Cursor for next page (empty string if no next page)
+   */
+  nextCursor: string;
+  /**
+   * Cursor for previous page (empty string if no previous page)
+   */
+  prevCursor: string;
+};
+
+export type ListTenantEventsResponse = {
+  result: ListTenantEventsResponseBody;
 };
 
 /** @internal */
@@ -181,6 +225,13 @@ export const ListTenantEventsRequest$inboundSchema: z.ZodType<
   tenant_id: z.string().optional(),
   destination_id: z.union([z.string(), z.array(z.string())]).optional(),
   status: ListTenantEventsStatus$inboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  end: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "tenant_id": "tenantId",
@@ -193,6 +244,11 @@ export type ListTenantEventsRequest$Outbound = {
   tenant_id?: string | undefined;
   destination_id?: string | Array<string> | undefined;
   status?: string | undefined;
+  next?: string | undefined;
+  prev?: string | undefined;
+  limit: number;
+  start?: string | undefined;
+  end?: string | undefined;
 };
 
 /** @internal */
@@ -204,6 +260,11 @@ export const ListTenantEventsRequest$outboundSchema: z.ZodType<
   tenantId: z.string().optional(),
   destinationId: z.union([z.string(), z.array(z.string())]).optional(),
   status: ListTenantEventsStatus$outboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.date().transform(v => v.toISOString()).optional(),
+  end: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",
@@ -241,3 +302,140 @@ export function listTenantEventsRequestFromJSON(
     `Failed to parse 'ListTenantEventsRequest' from JSON`,
   );
 }
+
+/** @internal */
+export const ListTenantEventsResponseBody$inboundSchema: z.ZodType<
+  ListTenantEventsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  data: z.array(components.Event$inboundSchema),
+  next: z.string(),
+  prev: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "next": "nextCursor",
+    "prev": "prevCursor",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsResponseBody$Outbound = {
+  count: number;
+  data: Array<components.Event$Outbound>;
+  next: string;
+  prev: string;
+};
+
+/** @internal */
+export const ListTenantEventsResponseBody$outboundSchema: z.ZodType<
+  ListTenantEventsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListTenantEventsResponseBody
+> = z.object({
+  count: z.number().int(),
+  data: z.array(components.Event$outboundSchema),
+  nextCursor: z.string(),
+  prevCursor: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    nextCursor: "next",
+    prevCursor: "prev",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsResponseBody$ {
+  /** @deprecated use `ListTenantEventsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListTenantEventsResponseBody$inboundSchema;
+  /** @deprecated use `ListTenantEventsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListTenantEventsResponseBody$outboundSchema;
+  /** @deprecated use `ListTenantEventsResponseBody$Outbound` instead. */
+  export type Outbound = ListTenantEventsResponseBody$Outbound;
+}
+
+export function listTenantEventsResponseBodyToJSON(
+  listTenantEventsResponseBody: ListTenantEventsResponseBody,
+): string {
+  return JSON.stringify(
+    ListTenantEventsResponseBody$outboundSchema.parse(
+      listTenantEventsResponseBody,
+    ),
+  );
+}
+
+export function listTenantEventsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantEventsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTenantEventsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantEventsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantEventsResponse$inboundSchema: z.ZodType<
+  ListTenantEventsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListTenantEventsResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsResponse$Outbound = {
+  Result: ListTenantEventsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListTenantEventsResponse$outboundSchema: z.ZodType<
+  ListTenantEventsResponse$Outbound,
+  z.ZodTypeDef,
+  ListTenantEventsResponse
+> = z.object({
+  result: z.lazy(() => ListTenantEventsResponseBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsResponse$ {
+  /** @deprecated use `ListTenantEventsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListTenantEventsResponse$inboundSchema;
+  /** @deprecated use `ListTenantEventsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListTenantEventsResponse$outboundSchema;
+  /** @deprecated use `ListTenantEventsResponse$Outbound` instead. */
+  export type Outbound = ListTenantEventsResponse$Outbound;
+}
+
+export function listTenantEventsResponseToJSON(
+  listTenantEventsResponse: ListTenantEventsResponse,
+): string {
+  return JSON.stringify(
+    ListTenantEventsResponse$outboundSchema.parse(listTenantEventsResponse),
+  );
+}
+
+export function listTenantEventsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantEventsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTenantEventsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantEventsResponse' from JSON`,
+  );
+}