svix 2.3.0 → 2.5.0

package/src/models/destinationIn.ts

@@ -0,0 +1,303 @@
+// this file is @generated
+import {
+  type AzureBlobStorageConfigIn,
+  AzureBlobStorageConfigInSerializer,
+} from "./azureBlobStorageConfigIn";
+import { type BigQueryConfigIn, BigQueryConfigInSerializer } from "./bigQueryConfigIn";
+import {
+  type ClickhouseConfigIn,
+  ClickhouseConfigInSerializer,
+} from "./clickhouseConfigIn";
+import {
+  type DestinationStatusIn,
+  DestinationStatusInSerializer,
+} from "./destinationStatusIn";
+import {
+  type EventBridgeConfigIn,
+  EventBridgeConfigInSerializer,
+} from "./eventBridgeConfigIn";
+import {
+  type FifoEndpointConfigIn,
+  FifoEndpointConfigInSerializer,
+} from "./fifoEndpointConfigIn";
+import {
+  type GoogleCloudPubSubConfigIn,
+  GoogleCloudPubSubConfigInSerializer,
+} from "./googleCloudPubSubConfigIn";
+import {
+  type GoogleCloudStorageConfigIn,
+  GoogleCloudStorageConfigInSerializer,
+} from "./googleCloudStorageConfigIn";
+import {
+  type OtelTracingConfigIn,
+  OtelTracingConfigInSerializer,
+} from "./otelTracingConfigIn";
+import { type PostgresConfigIn, PostgresConfigInSerializer } from "./postgresConfigIn";
+import { type RabbitMqConfigIn, RabbitMqConfigInSerializer } from "./rabbitMqConfigIn";
+import { type RedshiftConfigIn, RedshiftConfigInSerializer } from "./redshiftConfigIn";
+import { type S3ConfigIn, S3ConfigInSerializer } from "./s3ConfigIn";
+import { type SnowflakeConfigIn, SnowflakeConfigInSerializer } from "./snowflakeConfigIn";
+import { type SnsConfigIn, SnsConfigInSerializer } from "./snsConfigIn";
+import { type SqsConfigIn, SqsConfigInSerializer } from "./sqsConfigIn";
+
+interface _DestinationInFields {
+  /** An optional unique identifier for the destination. */
+  uid?: string | null;
+  /**
+   * Whether the destination will receive events.
+   *
+   * If the destination is `enabled`, events sent to the application will be dispatched to the destination in order.
+   *
+   * If the destination is `disabled`, events will not be dispatched until the destination is reenabled.
+   */
+  status?: DestinationStatusIn;
+  /** How many events will be batched in a request to the destination. */
+  batchSize?: number;
+  /**
+   * How long to wait before a batch of events is sent, if the `batchSize` is not reached.
+   *
+   * For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, a request is sent after 10 seconds or 100 events, whichever comes first.
+   *
+   * Note that an empty batch is never sent to the destination.
+   */
+  maxWaitSecs?: number;
+  /** A list of event types that filter which events are dispatched to the destination. An empty list (or null) will not filter out any events. */
+  eventTypes?: string[];
+  /** A list of channels that filter which events are dispatched to the destination. An empty list (or null) will not filter out any events. */
+  channels?: string[];
+  metadata?: { [key: string]: string };
+}
+
+// biome-ignore lint/suspicious/noEmptyInterface: backwards compat
+interface DestinationInPollingEndpointConfig {}
+
+interface DestinationInPollingEndpoint {
+  type: "pollingEndpoint";
+  config?: DestinationInPollingEndpointConfig;
+}
+
+interface DestinationInAzureBlobStorage {
+  type: "azureBlobStorage";
+  config: AzureBlobStorageConfigIn;
+}
+
+interface DestinationInOtelTracing {
+  type: "otelTracing";
+  config: OtelTracingConfigIn;
+}
+
+interface DestinationInFifoEndpoint {
+  type: "fifoEndpoint";
+  config: FifoEndpointConfigIn;
+}
+
+interface DestinationInAmazonS3 {
+  type: "amazonS3";
+  config: S3ConfigIn;
+}
+
+interface DestinationInGoogleCloudStorage {
+  type: "googleCloudStorage";
+  config: GoogleCloudStorageConfigIn;
+}
+
+interface DestinationInGoogleCloudPubSub {
+  type: "googleCloudPubSub";
+  config: GoogleCloudPubSubConfigIn;
+}
+
+interface DestinationInSqs {
+  type: "sqs";
+  config: SqsConfigIn;
+}
+
+interface DestinationInSns {
+  type: "sns";
+  config: SnsConfigIn;
+}
+
+interface DestinationInBigQuery {
+  type: "bigQuery";
+  config: BigQueryConfigIn;
+}
+
+interface DestinationInClickhouse {
+  type: "clickhouse";
+  config: ClickhouseConfigIn;
+}
+
+interface DestinationInEventBridge {
+  type: "eventBridge";
+  config: EventBridgeConfigIn;
+}
+
+interface DestinationInSnowflake {
+  type: "snowflake";
+  config: SnowflakeConfigIn;
+}
+
+interface DestinationInRabbitMq {
+  type: "rabbitMq";
+  config: RabbitMqConfigIn;
+}
+
+interface DestinationInRedshift {
+  type: "redshift";
+  config: RedshiftConfigIn;
+}
+
+interface DestinationInPostgres {
+  type: "postgres";
+  config: PostgresConfigIn;
+}
+
+/** The destination's type and type-specific configuration. */
+export type DestinationIn = _DestinationInFields &
+  (
+    | DestinationInPollingEndpoint
+    | DestinationInAzureBlobStorage
+    | DestinationInOtelTracing
+    | DestinationInFifoEndpoint
+    | DestinationInAmazonS3
+    | DestinationInGoogleCloudStorage
+    | DestinationInGoogleCloudPubSub
+    | DestinationInSqs
+    | DestinationInSns
+    | DestinationInBigQuery
+    | DestinationInClickhouse
+    | DestinationInEventBridge
+    | DestinationInSnowflake
+    | DestinationInRabbitMq
+    | DestinationInRedshift
+    | DestinationInPostgres
+  );
+
+export const DestinationInSerializer = {
+  _fromJsonObject(object: any): DestinationIn {
+    const type = object["type"];
+
+    function getConfig(type: string): any {
+      switch (type) {
+        case "pollingEndpoint":
+          return {};
+        case "azureBlobStorage":
+          return AzureBlobStorageConfigInSerializer._fromJsonObject(object["config"]);
+        case "otelTracing":
+          return OtelTracingConfigInSerializer._fromJsonObject(object["config"]);
+        case "fifoEndpoint":
+          return FifoEndpointConfigInSerializer._fromJsonObject(object["config"]);
+        case "amazonS3":
+          return S3ConfigInSerializer._fromJsonObject(object["config"]);
+        case "googleCloudStorage":
+          return GoogleCloudStorageConfigInSerializer._fromJsonObject(object["config"]);
+        case "googleCloudPubSub":
+          return GoogleCloudPubSubConfigInSerializer._fromJsonObject(object["config"]);
+        case "sqs":
+          return SqsConfigInSerializer._fromJsonObject(object["config"]);
+        case "sns":
+          return SnsConfigInSerializer._fromJsonObject(object["config"]);
+        case "bigQuery":
+          return BigQueryConfigInSerializer._fromJsonObject(object["config"]);
+        case "clickhouse":
+          return ClickhouseConfigInSerializer._fromJsonObject(object["config"]);
+        case "eventBridge":
+          return EventBridgeConfigInSerializer._fromJsonObject(object["config"]);
+        case "snowflake":
+          return SnowflakeConfigInSerializer._fromJsonObject(object["config"]);
+        case "rabbitMq":
+          return RabbitMqConfigInSerializer._fromJsonObject(object["config"]);
+        case "redshift":
+          return RedshiftConfigInSerializer._fromJsonObject(object["config"]);
+        case "postgres":
+          return PostgresConfigInSerializer._fromJsonObject(object["config"]);
+        default:
+          throw new Error(`Unexpected type: ${type}`);
+      }
+    }
+
+    return {
+      type,
+      config: getConfig(type),
+      uid: object["uid"],
+      status:
+        object["status"] != null
+          ? DestinationStatusInSerializer._fromJsonObject(object["status"])
+          : undefined,
+      batchSize: object["batchSize"],
+      maxWaitSecs: object["maxWaitSecs"],
+      eventTypes: object["eventTypes"],
+      channels: object["channels"],
+      metadata: object["metadata"],
+    };
+  },
+
+  _toJsonObject(self: DestinationIn): any {
+    // biome-ignore lint/suspicious/noImplicitAnyLet: the return type needs to be any
+    let config;
+    switch (self.type) {
+      case "pollingEndpoint":
+        config = {};
+        break;
+      case "azureBlobStorage":
+        config = AzureBlobStorageConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "otelTracing":
+        config = OtelTracingConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "fifoEndpoint":
+        config = FifoEndpointConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "amazonS3":
+        config = S3ConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "googleCloudStorage":
+        config = GoogleCloudStorageConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "googleCloudPubSub":
+        config = GoogleCloudPubSubConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "sqs":
+        config = SqsConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "sns":
+        config = SnsConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "bigQuery":
+        config = BigQueryConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "clickhouse":
+        config = ClickhouseConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "eventBridge":
+        config = EventBridgeConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "snowflake":
+        config = SnowflakeConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "rabbitMq":
+        config = RabbitMqConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "redshift":
+        config = RedshiftConfigInSerializer._toJsonObject(self.config);
+        break;
+      case "postgres":
+        config = PostgresConfigInSerializer._toJsonObject(self.config);
+        break;
+    }
+
+    return {
+      type: self.type,
+      config: config,
+      uid: self.uid,
+      status:
+        self.status != null
+          ? DestinationStatusInSerializer._toJsonObject(self.status)
+          : undefined,
+      batchSize: self.batchSize,
+      maxWaitSecs: self.maxWaitSecs,
+      eventTypes: self.eventTypes,
+      channels: self.channels,
+      metadata: self.metadata,
+    };
+  },
+};

package/src/models/destinationOut.ts

@@ -0,0 +1,295 @@
+// this file is @generated
+import {
+  type AzureBlobStorageConfigOut,
+  AzureBlobStorageConfigOutSerializer,
+} from "./azureBlobStorageConfigOut";
+import { type BigQueryConfigOut, BigQueryConfigOutSerializer } from "./bigQueryConfigOut";
+import {
+  type ClickhouseConfigOut,
+  ClickhouseConfigOutSerializer,
+} from "./clickhouseConfigOut";
+import { type DestinationStatus, DestinationStatusSerializer } from "./destinationStatus";
+import {
+  type EventBridgeConfigOut,
+  EventBridgeConfigOutSerializer,
+} from "./eventBridgeConfigOut";
+import {
+  type GoogleCloudPubSubConfigOut,
+  GoogleCloudPubSubConfigOutSerializer,
+} from "./googleCloudPubSubConfigOut";
+import {
+  type GoogleCloudStorageConfigOut,
+  GoogleCloudStorageConfigOutSerializer,
+} from "./googleCloudStorageConfigOut";
+import {
+  type OtelTracingConfigOut,
+  OtelTracingConfigOutSerializer,
+} from "./otelTracingConfigOut";
+import { type PostgresConfigOut, PostgresConfigOutSerializer } from "./postgresConfigOut";
+import { type RabbitMqConfigOut, RabbitMqConfigOutSerializer } from "./rabbitMqConfigOut";
+import { type RedshiftConfigOut, RedshiftConfigOutSerializer } from "./redshiftConfigOut";
+import { type S3ConfigOut, S3ConfigOutSerializer } from "./s3ConfigOut";
+import { type SinkHttpConfigOut, SinkHttpConfigOutSerializer } from "./sinkHttpConfigOut";
+import {
+  type SnowflakeConfigOut,
+  SnowflakeConfigOutSerializer,
+} from "./snowflakeConfigOut";
+import { type SnsConfigOut, SnsConfigOutSerializer } from "./snsConfigOut";
+import { type SqsConfigOut, SqsConfigOutSerializer } from "./sqsConfigOut";
+
+interface _DestinationOutFields {
+  /** The Destination's ID. */
+  id: string;
+  /** The Destination's UID. */
+  uid?: string | null;
+  status: DestinationStatus;
+  currentIterator: string;
+  failureReason?: string | null;
+  createdAt: Date;
+  updatedAt: Date;
+  batchSize: number;
+  maxWaitSecs: number;
+  eventTypes?: string[];
+  channels?: string[];
+  nextRetryAt?: Date | null;
+  metadata: { [key: string]: string };
+}
+
+// biome-ignore lint/suspicious/noEmptyInterface: backwards compat
+interface DestinationOutPollingEndpointConfig {}
+
+interface DestinationOutPollingEndpoint {
+  type: "pollingEndpoint";
+  config?: DestinationOutPollingEndpointConfig;
+}
+
+interface DestinationOutAzureBlobStorage {
+  type: "azureBlobStorage";
+  config: AzureBlobStorageConfigOut;
+}
+
+interface DestinationOutOtelTracing {
+  type: "otelTracing";
+  config: OtelTracingConfigOut;
+}
+
+interface DestinationOutFifoEndpoint {
+  type: "fifoEndpoint";
+  config: SinkHttpConfigOut;
+}
+
+interface DestinationOutAmazonS3 {
+  type: "amazonS3";
+  config: S3ConfigOut;
+}
+
+interface DestinationOutSnowflake {
+  type: "snowflake";
+  config: SnowflakeConfigOut;
+}
+
+interface DestinationOutGoogleCloudStorage {
+  type: "googleCloudStorage";
+  config: GoogleCloudStorageConfigOut;
+}
+
+interface DestinationOutGoogleCloudPubSub {
+  type: "googleCloudPubSub";
+  config: GoogleCloudPubSubConfigOut;
+}
+
+interface DestinationOutRedshift {
+  type: "redshift";
+  config: RedshiftConfigOut;
+}
+
+interface DestinationOutBigQuery {
+  type: "bigQuery";
+  config: BigQueryConfigOut;
+}
+
+interface DestinationOutClickhouse {
+  type: "clickhouse";
+  config: ClickhouseConfigOut;
+}
+
+interface DestinationOutRabbitMq {
+  type: "rabbitMq";
+  config: RabbitMqConfigOut;
+}
+
+interface DestinationOutSqs {
+  type: "sqs";
+  config: SqsConfigOut;
+}
+
+interface DestinationOutEventBridge {
+  type: "eventBridge";
+  config: EventBridgeConfigOut;
+}
+
+interface DestinationOutSns {
+  type: "sns";
+  config: SnsConfigOut;
+}
+
+interface DestinationOutPostgres {
+  type: "postgres";
+  config: PostgresConfigOut;
+}
+
+export type DestinationOut = _DestinationOutFields &
+  (
+    | DestinationOutPollingEndpoint
+    | DestinationOutAzureBlobStorage
+    | DestinationOutOtelTracing
+    | DestinationOutFifoEndpoint
+    | DestinationOutAmazonS3
+    | DestinationOutSnowflake
+    | DestinationOutGoogleCloudStorage
+    | DestinationOutGoogleCloudPubSub
+    | DestinationOutRedshift
+    | DestinationOutBigQuery
+    | DestinationOutClickhouse
+    | DestinationOutRabbitMq
+    | DestinationOutSqs
+    | DestinationOutEventBridge
+    | DestinationOutSns
+    | DestinationOutPostgres
+  );
+
+export const DestinationOutSerializer = {
+  _fromJsonObject(object: any): DestinationOut {
+    const type = object["type"];
+
+    function getConfig(type: string): any {
+      switch (type) {
+        case "pollingEndpoint":
+          return {};
+        case "azureBlobStorage":
+          return AzureBlobStorageConfigOutSerializer._fromJsonObject(object["config"]);
+        case "otelTracing":
+          return OtelTracingConfigOutSerializer._fromJsonObject(object["config"]);
+        case "fifoEndpoint":
+          return SinkHttpConfigOutSerializer._fromJsonObject(object["config"]);
+        case "amazonS3":
+          return S3ConfigOutSerializer._fromJsonObject(object["config"]);
+        case "snowflake":
+          return SnowflakeConfigOutSerializer._fromJsonObject(object["config"]);
+        case "googleCloudStorage":
+          return GoogleCloudStorageConfigOutSerializer._fromJsonObject(object["config"]);
+        case "googleCloudPubSub":
+          return GoogleCloudPubSubConfigOutSerializer._fromJsonObject(object["config"]);
+        case "redshift":
+          return RedshiftConfigOutSerializer._fromJsonObject(object["config"]);
+        case "bigQuery":
+          return BigQueryConfigOutSerializer._fromJsonObject(object["config"]);
+        case "clickhouse":
+          return ClickhouseConfigOutSerializer._fromJsonObject(object["config"]);
+        case "rabbitMq":
+          return RabbitMqConfigOutSerializer._fromJsonObject(object["config"]);
+        case "sqs":
+          return SqsConfigOutSerializer._fromJsonObject(object["config"]);
+        case "eventBridge":
+          return EventBridgeConfigOutSerializer._fromJsonObject(object["config"]);
+        case "sns":
+          return SnsConfigOutSerializer._fromJsonObject(object["config"]);
+        case "postgres":
+          return PostgresConfigOutSerializer._fromJsonObject(object["config"]);
+        default:
+          throw new Error(`Unexpected type: ${type}`);
+      }
+    }
+
+    return {
+      type,
+      config: getConfig(type),
+      id: object["id"],
+      uid: object["uid"],
+      status: DestinationStatusSerializer._fromJsonObject(object["status"]),
+      currentIterator: object["currentIterator"],
+      failureReason: object["failureReason"],
+      createdAt: new Date(object["createdAt"]),
+      updatedAt: new Date(object["updatedAt"]),
+      batchSize: object["batchSize"],
+      maxWaitSecs: object["maxWaitSecs"],
+      eventTypes: object["eventTypes"],
+      channels: object["channels"],
+      nextRetryAt: object["nextRetryAt"] ? new Date(object["nextRetryAt"]) : null,
+      metadata: object["metadata"],
+    };
+  },
+
+  _toJsonObject(self: DestinationOut): any {
+    // biome-ignore lint/suspicious/noImplicitAnyLet: the return type needs to be any
+    let config;
+    switch (self.type) {
+      case "pollingEndpoint":
+        config = {};
+        break;
+      case "azureBlobStorage":
+        config = AzureBlobStorageConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "otelTracing":
+        config = OtelTracingConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "fifoEndpoint":
+        config = SinkHttpConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "amazonS3":
+        config = S3ConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "snowflake":
+        config = SnowflakeConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "googleCloudStorage":
+        config = GoogleCloudStorageConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "googleCloudPubSub":
+        config = GoogleCloudPubSubConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "redshift":
+        config = RedshiftConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "bigQuery":
+        config = BigQueryConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "clickhouse":
+        config = ClickhouseConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "rabbitMq":
+        config = RabbitMqConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "sqs":
+        config = SqsConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "eventBridge":
+        config = EventBridgeConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "sns":
+        config = SnsConfigOutSerializer._toJsonObject(self.config);
+        break;
+      case "postgres":
+        config = PostgresConfigOutSerializer._toJsonObject(self.config);
+        break;
+    }
+
+    return {
+      type: self.type,
+      config: config,
+      id: self.id,
+      uid: self.uid,
+      status: DestinationStatusSerializer._toJsonObject(self.status),
+      currentIterator: self.currentIterator,
+      failureReason: self.failureReason,
+      createdAt: self.createdAt,
+      updatedAt: self.updatedAt,
+      batchSize: self.batchSize,
+      maxWaitSecs: self.maxWaitSecs,
+      eventTypes: self.eventTypes,
+      channels: self.channels,
+      nextRetryAt: self.nextRetryAt,
+      metadata: self.metadata,
+    };
+  },
+};