@amerged/ohmyhost-sdk 0.1.44 → 0.1.45

package/dist/generated/types.gen.d.ts

@@ -805,12 +805,58 @@ export type ProjectDatabaseAccessPage = {
     items: Array<ProjectDatabaseAccess>;
 };
 export type DatabaseWebhookEventType = "database.created" | "database.ready" | "database.woke" | "database.slept" | "database.suspended" | "database.resized" | "database.deleted";
+/**
+ * A platform event type, data.<topic> for the rows of one watched table, or data.* for every watched table. A bare * is not accepted and never matches data events.
+ */
+export type DatabaseWebhookEventPattern = DatabaseWebhookEventType | string;
+export type DatabaseWatchCreateRequest = {
+    environment: "dev" | "prod";
+    /**
+     * Schema of the table, public when omitted. The schemas pgcf, ohmyhost, information_schema and pg_* cannot be watched.
+     */
+    schema?: string;
+    /**
+     * Ordinary table owned by the application, created by a deployed migration.
+     */
+    table: string;
+    /**
+     * Columns published with every event, exactly as written; names are case-sensitive.
+     */
+    columns: Array<string>;
+    /**
+     * Row changes that publish an event; all three when omitted.
+     */
+    operations?: Array<"insert" | "update" | "delete">;
+};
+export type DatabaseWatch = {
+    id: string;
+    environment: "dev" | "prod";
+    schema: string;
+    table: string;
+    columns: Array<string>;
+    operations: Array<"insert" | "update" | "delete">;
+    /**
+     * Topic of the watched table, derived by the platform from its name.
+     */
+    topic: string;
+    /**
+     * Event type of the rows of the table; pass it to a database webhook.
+     */
+    event_type: string;
+};
+export type DatabaseWatchPage = {
+    items: Array<DatabaseWatch>;
+};
+export type DatabaseWatchDeleted = {
+    id: string;
+    deleted: true;
+};
 export type DatabaseWebhookCreateRequest = {
     /**
      * HTTPS receiver URL.
      */
     url: string;
-    event_types: Array<DatabaseWebhookEventType>;
+    event_types: Array<DatabaseWebhookEventPattern>;
     /**
      * Extra headers sent with every delivery. Names are case-insensitive and must be unique; content-type, host, content-length, connection, transfer-encoding, user-agent, te, upgrade, expect and any name starting with pgcf-, cf- or x-forwarded- are refused.
      */
@@ -822,7 +868,7 @@ export type DatabaseWebhook = {
     id: string;
     environment: "dev" | "prod";
     url: string;
-    event_types: Array<DatabaseWebhookEventType>;
+    event_types: Array<DatabaseWebhookEventPattern>;
     /**
      * Names of the extra headers only; their values are never returned.
      */
@@ -833,7 +879,7 @@ export type DatabaseWebhookCreated = {
     id: string;
     environment: "dev" | "prod";
     url: string;
-    event_types: Array<DatabaseWebhookEventType>;
+    event_types: Array<DatabaseWebhookEventPattern>;
     header_names: Array<string>;
     created_at: string;
     /**
@@ -851,7 +897,7 @@ export type DatabaseWebhookDeleted = {
 export type DatabaseWebhookDelivery = {
     id: string;
     event_id: string;
-    event_type: DatabaseWebhookEventType;
+    event_type: DatabaseWebhookEventType | string;
     webhook_id: string;
     state: "pending" | "delivered" | "dead_lettered";
     attempts: number;
@@ -1329,7 +1375,7 @@ export type ProblemDetails = {
     status: number;
     detail?: string;
     instance?: string;
-    code: "invalid_request" | "unauthenticated" | "forbidden" | "organization_required" | "resource_not_found" | "idempotency_key_reused" | "project_handle_unavailable" | "project_identity_unavailable" | "deployment_plan_expired" | "deployment_plan_incompatible" | "confirmation_expired" | "confirmation_invalid" | "etag_mismatch" | "promotion_source_stale" | "promotion_target_stale" | "promotion_invalid_target" | "mail_domain_conflict" | "mail_domain_required" | "mail_capacity_unavailable" | "storage_jurisdiction_conflict" | "shared_data_requires_promotion" | "production_deployment_required" | "framework_conversion_required" | "repository_configuration_missing" | "migration_filename_noncanonical" | "environment_secret_mutation_blocked" | "workers_runtime_incompatible" | "project_handle_invalid" | "project_handle_taken" | "project_handle_unchanged" | "project_rename_blocked" | "payload_too_large" | "rate_limited" | "insufficient_organization_credits" | "paid_plan_required" | "project_budget_exceeded" | "compute_performance_paid_required" | "compute_paid_required" | "compute_storage_shrink_requires_migration" | "compute_performance_unavailable" | "database_write_pending" | "database_access_limit" | "database_webhook_limit" | "database_schedule_limit" | "database_schedule_not_runnable" | "database_webhook_delivery_pending" | "compute_change_pending" | "compute_change_conflict" | "billing_purchase_conflict" | "billing_recharge_conflict" | "github_connection_required" | "github_connection_revoked" | "repository_not_installed" | "cloudflare_zone_not_bound" | "cloudflare_authorization_closed" | "project_notes_conflict" | "project_export_not_ready" | "powered_by_flag_required" | "interactive_login_required" | "api_key_creation_uncertain" | "api_key_permissions_unavailable" | "reconciliation_exhausted" | "service_unavailable" | "source_commit_not_found" | "domain_hostname_taken" | "domain_dns_conflict" | "data_change_blocked" | "data_change_in_progress" | "data_change_not_applicable" | "rollback_target_data_changed" | "project_domain_delete_required";
+    code: "invalid_request" | "unauthenticated" | "forbidden" | "organization_required" | "resource_not_found" | "idempotency_key_reused" | "project_handle_unavailable" | "project_identity_unavailable" | "deployment_plan_expired" | "deployment_plan_incompatible" | "confirmation_expired" | "confirmation_invalid" | "etag_mismatch" | "promotion_source_stale" | "promotion_target_stale" | "promotion_invalid_target" | "mail_domain_conflict" | "mail_domain_required" | "mail_capacity_unavailable" | "storage_jurisdiction_conflict" | "shared_data_requires_promotion" | "production_deployment_required" | "framework_conversion_required" | "repository_configuration_missing" | "migration_filename_noncanonical" | "environment_secret_mutation_blocked" | "workers_runtime_incompatible" | "project_handle_invalid" | "project_handle_taken" | "project_handle_unchanged" | "project_rename_blocked" | "payload_too_large" | "rate_limited" | "insufficient_organization_credits" | "paid_plan_required" | "project_budget_exceeded" | "compute_performance_paid_required" | "compute_paid_required" | "compute_storage_shrink_requires_migration" | "compute_performance_unavailable" | "database_write_pending" | "database_access_limit" | "database_webhook_limit" | "database_schedule_limit" | "database_schedule_not_runnable" | "database_webhook_delivery_pending" | "database_watch_limit" | "database_watch_table_unavailable" | "database_watch_column_unavailable" | "database_watch_events_unavailable" | "database_watch_conflict" | "compute_change_pending" | "compute_change_conflict" | "billing_purchase_conflict" | "billing_recharge_conflict" | "github_connection_required" | "github_connection_revoked" | "repository_not_installed" | "cloudflare_zone_not_bound" | "cloudflare_authorization_closed" | "project_notes_conflict" | "project_export_not_ready" | "powered_by_flag_required" | "interactive_login_required" | "api_key_creation_uncertain" | "api_key_permissions_unavailable" | "reconciliation_exhausted" | "service_unavailable" | "source_commit_not_found" | "domain_hostname_taken" | "domain_dns_conflict" | "data_change_blocked" | "data_change_in_progress" | "data_change_not_applicable" | "rollback_target_data_changed" | "project_domain_delete_required";
     request_id: string;
     retryable: boolean;
     /**
@@ -1545,6 +1591,10 @@ export type ProjectDataChangePlan = {
     created_at: string;
     expires_at: string;
 };
+/**
+ * A platform event type, data.<topic> for the rows of one watched table, or data.* for every watched table. A bare * is not accepted and never matches data events.
+ */
+export type DatabaseWebhookEventPatternWritable = DatabaseWebhookEventType | string;
 /**
  * Immutable pre-build deployment plan. It expires exactly 24 hours after creation.
  */
@@ -1625,6 +1675,10 @@ export type DatabaseWebhookId = string;
  * Database webhook delivery identifier.
  */
 export type DatabaseWebhookDeliveryId = string;
+/**
+ * Database watch identifier, derived from the watched schema and table.
+ */
+export type DatabaseWatchId = string;
 /**
  * Database schedule name, unique per project environment.
  */
@@ -7078,6 +7132,181 @@ export type RevokeProjectDatabaseAccessResponses = {
     200: ProjectDatabaseAccess;
 };
 export type RevokeProjectDatabaseAccessResponse = RevokeProjectDatabaseAccessResponses[keyof RevokeProjectDatabaseAccessResponses];
+export type ListProjectDatabaseWatchesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Optional caller-provided correlation identifier.
+         */
+        "X-Request-Id"?: string;
+    };
+    path: {
+        /**
+         * Project identifier.
+         */
+        project_id: Ulid;
+    };
+    query?: {
+        /**
+         * Application environment to read; dev when omitted.
+         */
+        environment?: "dev" | "prod";
+    };
+    url: "/v1/projects/{project_id}/database/watches";
+};
+export type ListProjectDatabaseWatchesErrors = {
+    /**
+     * The request failed.
+     */
+    400: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    401: ProblemDetails;
+    /**
+     * The resource does not exist or is not visible to the authenticated principal.
+     */
+    404: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    429: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    503: ProblemDetails;
+};
+export type ListProjectDatabaseWatchesError = ListProjectDatabaseWatchesErrors[keyof ListProjectDatabaseWatchesErrors];
+export type ListProjectDatabaseWatchesResponses = {
+    /**
+     * The database watches of the environment.
+     */
+    200: DatabaseWatchPage;
+};
+export type ListProjectDatabaseWatchesResponse = ListProjectDatabaseWatchesResponses[keyof ListProjectDatabaseWatchesResponses];
+export type CreateProjectDatabaseWatchData = {
+    body: DatabaseWatchCreateRequest;
+    headers: {
+        /**
+         * Optional caller-provided correlation identifier.
+         */
+        "X-Request-Id"?: string;
+        /**
+         * Identifies one mutation and its canonical request payload.
+         */
+        "Idempotency-Key": string;
+    };
+    path: {
+        /**
+         * Project identifier.
+         */
+        project_id: Ulid;
+    };
+    query?: never;
+    url: "/v1/projects/{project_id}/database/watches";
+};
+export type CreateProjectDatabaseWatchErrors = {
+    /**
+     * The request failed.
+     */
+    400: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    401: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    402: ProblemDetails;
+    /**
+     * The resource does not exist or is not visible to the authenticated principal.
+     */
+    404: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    409: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    429: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    503: ProblemDetails;
+};
+export type CreateProjectDatabaseWatchError = CreateProjectDatabaseWatchErrors[keyof CreateProjectDatabaseWatchErrors];
+export type CreateProjectDatabaseWatchResponses = {
+    /**
+     * The watch with the event type its deliveries carry.
+     */
+    201: DatabaseWatch;
+};
+export type CreateProjectDatabaseWatchResponse = CreateProjectDatabaseWatchResponses[keyof CreateProjectDatabaseWatchResponses];
+export type DeleteProjectDatabaseWatchData = {
+    body?: never;
+    headers: {
+        /**
+         * Optional caller-provided correlation identifier.
+         */
+        "X-Request-Id"?: string;
+        /**
+         * Identifies one mutation and its canonical request payload.
+         */
+        "Idempotency-Key": string;
+    };
+    path: {
+        /**
+         * Project identifier.
+         */
+        project_id: Ulid;
+        /**
+         * Database watch identifier, derived from the watched schema and table.
+         */
+        watch_id: string;
+    };
+    query: {
+        /**
+         * Application environment the mutation applies to.
+         */
+        environment: "dev" | "prod";
+    };
+    url: "/v1/projects/{project_id}/database/watches/{watch_id}";
+};
+export type DeleteProjectDatabaseWatchErrors = {
+    /**
+     * The request failed.
+     */
+    400: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    401: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    402: ProblemDetails;
+    /**
+     * The resource does not exist or is not visible to the authenticated principal.
+     */
+    404: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    429: ProblemDetails;
+    /**
+     * The request failed.
+     */
+    503: ProblemDetails;
+};
+export type DeleteProjectDatabaseWatchError = DeleteProjectDatabaseWatchErrors[keyof DeleteProjectDatabaseWatchErrors];
+export type DeleteProjectDatabaseWatchResponses = {
+    /**
+     * The identifier of the deleted watch.
+     */
+    200: DatabaseWatchDeleted;
+};
+export type DeleteProjectDatabaseWatchResponse = DeleteProjectDatabaseWatchResponses[keyof DeleteProjectDatabaseWatchResponses];
 export type ListProjectDatabaseWebhooksData = {
     body?: never;
     headers?: {