@distilled.cloud/neon 0.0.0-john

package/src/operations/createProjectBranch.ts

@@ -0,0 +1,214 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectBranchInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "POST", path: "/projects/{project_id}/branches" }));
+export type CreateProjectBranchInput = typeof CreateProjectBranchInput.Type;
+
+// Output Schema
+export const CreateProjectBranchOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    branch: Schema.Struct({
+      id: Schema.String,
+      project_id: Schema.String,
+      parent_id: Schema.optional(Schema.String),
+      parent_lsn: Schema.optional(Schema.String),
+      parent_timestamp: Schema.optional(Schema.String),
+      name: Schema.String,
+      current_state: Schema.String,
+      pending_state: Schema.optional(Schema.String),
+      state_changed_at: Schema.String,
+      logical_size: Schema.optional(Schema.Number),
+      creation_source: Schema.String,
+      primary: Schema.optional(Schema.Boolean),
+      default: Schema.Boolean,
+      protected: Schema.Boolean,
+      cpu_used_sec: Schema.Number,
+      compute_time_seconds: Schema.Number,
+      active_time_seconds: Schema.Number,
+      written_data_bytes: Schema.Number,
+      data_transfer_bytes: Schema.Number,
+      created_at: Schema.String,
+      updated_at: Schema.String,
+      ttl_interval_seconds: Schema.optional(Schema.Number),
+      expires_at: Schema.optional(Schema.String),
+      last_reset_at: Schema.optional(Schema.String),
+      created_by: Schema.optional(
+        Schema.Struct({
+          name: Schema.optional(Schema.String),
+          image: Schema.optional(Schema.String),
+        }),
+      ),
+      init_source: Schema.optional(Schema.String),
+      restore_status: Schema.optional(Schema.String),
+      restored_from: Schema.optional(Schema.String),
+      restored_as: Schema.optional(Schema.String),
+      restricted_actions: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            reason: Schema.String,
+          }),
+        ),
+      ),
+    }),
+    endpoints: Schema.Array(
+      Schema.Struct({
+        host: Schema.String,
+        id: Schema.String,
+        name: Schema.optional(Schema.String),
+        project_id: Schema.String,
+        branch_id: Schema.String,
+        autoscaling_limit_min_cu: Schema.Number,
+        autoscaling_limit_max_cu: Schema.Number,
+        region_id: Schema.String,
+        type: Schema.Literals(["read_only", "read_write"]),
+        current_state: Schema.Literals(["init", "active", "idle"]),
+        pending_state: Schema.optional(
+          Schema.Literals(["init", "active", "idle"]),
+        ),
+        settings: Schema.Struct({
+          pg_settings: Schema.optional(
+            Schema.Record(Schema.String, Schema.String),
+          ),
+          pgbouncer_settings: Schema.optional(
+            Schema.Record(Schema.String, Schema.String),
+          ),
+          preload_libraries: Schema.optional(
+            Schema.Struct({
+              use_defaults: Schema.optional(Schema.Boolean),
+              enabled_libraries: Schema.optional(Schema.Array(Schema.String)),
+            }),
+          ),
+        }),
+        pooler_enabled: Schema.Boolean,
+        pooler_mode: Schema.Literals(["transaction"]),
+        disabled: Schema.Boolean,
+        passwordless_access: Schema.Boolean,
+        last_active: Schema.optional(Schema.String),
+        creation_source: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        started_at: Schema.optional(Schema.String),
+        suspended_at: Schema.optional(Schema.String),
+        proxy_host: Schema.String,
+        suspend_timeout_seconds: Schema.Number,
+        provisioner: Schema.String,
+        compute_release_version: Schema.optional(Schema.String),
+      }),
+    ),
+    operations: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        project_id: Schema.String,
+        branch_id: Schema.optional(Schema.String),
+        endpoint_id: Schema.optional(Schema.String),
+        action: Schema.Literals([
+          "create_compute",
+          "create_timeline",
+          "start_compute",
+          "suspend_compute",
+          "apply_config",
+          "check_availability",
+          "delete_timeline",
+          "create_branch",
+          "import_data",
+          "tenant_ignore",
+          "tenant_attach",
+          "tenant_detach",
+          "tenant_reattach",
+          "replace_safekeeper",
+          "disable_maintenance",
+          "apply_storage_config",
+          "prepare_secondary_pageserver",
+          "switch_pageserver",
+          "detach_parent_branch",
+          "timeline_archive",
+          "timeline_unarchive",
+          "start_reserved_compute",
+          "sync_dbs_and_roles_from_compute",
+          "apply_schema_from_branch",
+          "timeline_mark_invisible",
+          "prewarm_replica",
+          "promote_replica",
+          "set_storage_non_dirty",
+          "swap_binding_id",
+        ]),
+        status: Schema.Literals([
+          "scheduling",
+          "running",
+          "finished",
+          "failed",
+          "error",
+          "cancelling",
+          "cancelled",
+          "skipped",
+        ]),
+        error: Schema.optional(Schema.String),
+        failures_count: Schema.Number,
+        retry_at: Schema.optional(Schema.String),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        total_duration_ms: Schema.Number,
+      }),
+    ),
+    roles: Schema.Array(
+      Schema.Struct({
+        branch_id: Schema.String,
+        name: Schema.String,
+        password: Schema.optional(Schema.String),
+        protected: Schema.optional(Schema.Boolean),
+        authentication_method: Schema.optional(Schema.String),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+    databases: Schema.Array(
+      Schema.Struct({
+        id: Schema.Number,
+        branch_id: Schema.String,
+        name: Schema.String,
+        owner_name: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+    connection_uris: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          connection_uri: Schema.String,
+          connection_parameters: Schema.Struct({
+            database: Schema.String,
+            password: Schema.String,
+            role: Schema.String,
+            host: Schema.String,
+            pooler_host: Schema.String,
+          }),
+        }),
+      ),
+    ),
+  });
+export type CreateProjectBranchOutput = typeof CreateProjectBranchOutput.Type;
+
+// The operation
+/**
+ * Create branch
+ *
+ * Creates a branch in the specified project.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * This method does not require a request body, but you can specify one to create a compute endpoint for the branch or to select a non-default parent branch.
+ * By default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated.
+ * To access the branch, you must add an endpoint object. A `read_write` endpoint allows you to perform read and write operations on the branch.
+ * Each branch supports one read-write endpoint and multiple read-only endpoints.
+ * For related information, see [Manage branches](https://neon.tech/docs/manage/branches/).
+ *
+ * @param project_id - The Neon project ID
+ */
+export const createProjectBranch = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateProjectBranchInput,
+  outputSchema: CreateProjectBranchOutput,
+}));

package/src/operations/createProjectBranchAnonymized.ts

@@ -0,0 +1,222 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectBranchAnonymizedInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branch_anonymized",
+    }),
+  );
+export type CreateProjectBranchAnonymizedInput =
+  typeof CreateProjectBranchAnonymizedInput.Type;
+
+// Output Schema
+export const CreateProjectBranchAnonymizedOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    branch: Schema.Struct({
+      id: Schema.String,
+      project_id: Schema.String,
+      parent_id: Schema.optional(Schema.String),
+      parent_lsn: Schema.optional(Schema.String),
+      parent_timestamp: Schema.optional(Schema.String),
+      name: Schema.String,
+      current_state: Schema.String,
+      pending_state: Schema.optional(Schema.String),
+      state_changed_at: Schema.String,
+      logical_size: Schema.optional(Schema.Number),
+      creation_source: Schema.String,
+      primary: Schema.optional(Schema.Boolean),
+      default: Schema.Boolean,
+      protected: Schema.Boolean,
+      cpu_used_sec: Schema.Number,
+      compute_time_seconds: Schema.Number,
+      active_time_seconds: Schema.Number,
+      written_data_bytes: Schema.Number,
+      data_transfer_bytes: Schema.Number,
+      created_at: Schema.String,
+      updated_at: Schema.String,
+      ttl_interval_seconds: Schema.optional(Schema.Number),
+      expires_at: Schema.optional(Schema.String),
+      last_reset_at: Schema.optional(Schema.String),
+      created_by: Schema.optional(
+        Schema.Struct({
+          name: Schema.optional(Schema.String),
+          image: Schema.optional(Schema.String),
+        }),
+      ),
+      init_source: Schema.optional(Schema.String),
+      restore_status: Schema.optional(Schema.String),
+      restored_from: Schema.optional(Schema.String),
+      restored_as: Schema.optional(Schema.String),
+      restricted_actions: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            reason: Schema.String,
+          }),
+        ),
+      ),
+    }),
+    endpoints: Schema.Array(
+      Schema.Struct({
+        host: Schema.String,
+        id: Schema.String,
+        name: Schema.optional(Schema.String),
+        project_id: Schema.String,
+        branch_id: Schema.String,
+        autoscaling_limit_min_cu: Schema.Number,
+        autoscaling_limit_max_cu: Schema.Number,
+        region_id: Schema.String,
+        type: Schema.Literals(["read_only", "read_write"]),
+        current_state: Schema.Literals(["init", "active", "idle"]),
+        pending_state: Schema.optional(
+          Schema.Literals(["init", "active", "idle"]),
+        ),
+        settings: Schema.Struct({
+          pg_settings: Schema.optional(
+            Schema.Record(Schema.String, Schema.String),
+          ),
+          pgbouncer_settings: Schema.optional(
+            Schema.Record(Schema.String, Schema.String),
+          ),
+          preload_libraries: Schema.optional(
+            Schema.Struct({
+              use_defaults: Schema.optional(Schema.Boolean),
+              enabled_libraries: Schema.optional(Schema.Array(Schema.String)),
+            }),
+          ),
+        }),
+        pooler_enabled: Schema.Boolean,
+        pooler_mode: Schema.Literals(["transaction"]),
+        disabled: Schema.Boolean,
+        passwordless_access: Schema.Boolean,
+        last_active: Schema.optional(Schema.String),
+        creation_source: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        started_at: Schema.optional(Schema.String),
+        suspended_at: Schema.optional(Schema.String),
+        proxy_host: Schema.String,
+        suspend_timeout_seconds: Schema.Number,
+        provisioner: Schema.String,
+        compute_release_version: Schema.optional(Schema.String),
+      }),
+    ),
+    operations: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        project_id: Schema.String,
+        branch_id: Schema.optional(Schema.String),
+        endpoint_id: Schema.optional(Schema.String),
+        action: Schema.Literals([
+          "create_compute",
+          "create_timeline",
+          "start_compute",
+          "suspend_compute",
+          "apply_config",
+          "check_availability",
+          "delete_timeline",
+          "create_branch",
+          "import_data",
+          "tenant_ignore",
+          "tenant_attach",
+          "tenant_detach",
+          "tenant_reattach",
+          "replace_safekeeper",
+          "disable_maintenance",
+          "apply_storage_config",
+          "prepare_secondary_pageserver",
+          "switch_pageserver",
+          "detach_parent_branch",
+          "timeline_archive",
+          "timeline_unarchive",
+          "start_reserved_compute",
+          "sync_dbs_and_roles_from_compute",
+          "apply_schema_from_branch",
+          "timeline_mark_invisible",
+          "prewarm_replica",
+          "promote_replica",
+          "set_storage_non_dirty",
+          "swap_binding_id",
+        ]),
+        status: Schema.Literals([
+          "scheduling",
+          "running",
+          "finished",
+          "failed",
+          "error",
+          "cancelling",
+          "cancelled",
+          "skipped",
+        ]),
+        error: Schema.optional(Schema.String),
+        failures_count: Schema.Number,
+        retry_at: Schema.optional(Schema.String),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        total_duration_ms: Schema.Number,
+      }),
+    ),
+    roles: Schema.Array(
+      Schema.Struct({
+        branch_id: Schema.String,
+        name: Schema.String,
+        password: Schema.optional(Schema.String),
+        protected: Schema.optional(Schema.Boolean),
+        authentication_method: Schema.optional(Schema.String),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+    databases: Schema.Array(
+      Schema.Struct({
+        id: Schema.Number,
+        branch_id: Schema.String,
+        name: Schema.String,
+        owner_name: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+    connection_uris: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          connection_uri: Schema.String,
+          connection_parameters: Schema.Struct({
+            database: Schema.String,
+            password: Schema.String,
+            role: Schema.String,
+            host: Schema.String,
+            pooler_host: Schema.String,
+          }),
+        }),
+      ),
+    ),
+  });
+export type CreateProjectBranchAnonymizedOutput =
+  typeof CreateProjectBranchAnonymizedOutput.Type;
+
+// The operation
+/**
+ * Create anonymized branch
+ *
+ * Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking.
+ * This allows developers to work with masked production data.
+ * Optionally, provide `masking_rules` to set initial masking rules for the branch
+ * and `start_anonymization` to automatically start anonymization after creation. This
+ * combines functionality of updating masking rules and starting anonymization into the
+ * branch creation request.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ */
+export const createProjectBranchAnonymized =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: CreateProjectBranchAnonymizedInput,
+    outputSchema: CreateProjectBranchAnonymizedOutput,
+  }));

package/src/operations/createProjectBranchDataAPI.ts

@@ -0,0 +1,64 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectBranchDataAPIInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    database_name: Schema.String.pipe(T.PathParam()),
+    auth_provider: Schema.optional(Schema.Literals(["neon_auth", "external"])),
+    jwks_url: Schema.optional(Schema.String),
+    provider_name: Schema.optional(Schema.String),
+    jwt_audience: Schema.optional(Schema.String),
+    add_default_grants: Schema.optional(Schema.Boolean),
+    skip_auth_schema: Schema.optional(Schema.Boolean),
+    settings: Schema.optional(
+      Schema.Struct({
+        db_aggregates_enabled: Schema.optional(Schema.Boolean),
+        db_anon_role: Schema.optional(Schema.String),
+        db_extra_search_path: Schema.optional(Schema.String),
+        db_max_rows: Schema.optional(Schema.Number),
+        db_schemas: Schema.optional(Schema.Array(Schema.String)),
+        jwt_role_claim_key: Schema.optional(Schema.String),
+        jwt_cache_max_lifetime: Schema.optional(Schema.Number),
+        openapi_mode: Schema.optional(Schema.String),
+        server_cors_allowed_origins: Schema.optional(Schema.String),
+        server_timing_enabled: Schema.optional(Schema.Boolean),
+      }),
+    ),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/data-api/{database_name}",
+    }),
+  );
+export type CreateProjectBranchDataAPIInput =
+  typeof CreateProjectBranchDataAPIInput.Type;
+
+// Output Schema
+export const CreateProjectBranchDataAPIOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    url: Schema.String,
+  });
+export type CreateProjectBranchDataAPIOutput =
+  typeof CreateProjectBranchDataAPIOutput.Type;
+
+// The operation
+/**
+ * Create Neon Data API
+ *
+ * Creates a new instance of Neon Data API in the specified branch.
+ * You can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ * @param database_name - The database name
+ */
+export const createProjectBranchDataAPI = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateProjectBranchDataAPIInput,
+    outputSchema: CreateProjectBranchDataAPIOutput,
+  }),
+);

package/src/operations/createProjectBranchDatabase.ts

@@ -0,0 +1,111 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectBranchDatabaseInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    database: Schema.Struct({
+      name: Schema.String,
+      owner_name: Schema.String,
+    }),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/databases",
+    }),
+  );
+export type CreateProjectBranchDatabaseInput =
+  typeof CreateProjectBranchDatabaseInput.Type;
+
+// Output Schema
+export const CreateProjectBranchDatabaseOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    database: Schema.Struct({
+      id: Schema.Number,
+      branch_id: Schema.String,
+      name: Schema.String,
+      owner_name: Schema.String,
+      created_at: Schema.String,
+      updated_at: Schema.String,
+    }),
+    operations: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        project_id: Schema.String,
+        branch_id: Schema.optional(Schema.String),
+        endpoint_id: Schema.optional(Schema.String),
+        action: Schema.Literals([
+          "create_compute",
+          "create_timeline",
+          "start_compute",
+          "suspend_compute",
+          "apply_config",
+          "check_availability",
+          "delete_timeline",
+          "create_branch",
+          "import_data",
+          "tenant_ignore",
+          "tenant_attach",
+          "tenant_detach",
+          "tenant_reattach",
+          "replace_safekeeper",
+          "disable_maintenance",
+          "apply_storage_config",
+          "prepare_secondary_pageserver",
+          "switch_pageserver",
+          "detach_parent_branch",
+          "timeline_archive",
+          "timeline_unarchive",
+          "start_reserved_compute",
+          "sync_dbs_and_roles_from_compute",
+          "apply_schema_from_branch",
+          "timeline_mark_invisible",
+          "prewarm_replica",
+          "promote_replica",
+          "set_storage_non_dirty",
+          "swap_binding_id",
+        ]),
+        status: Schema.Literals([
+          "scheduling",
+          "running",
+          "finished",
+          "failed",
+          "error",
+          "cancelling",
+          "cancelled",
+          "skipped",
+        ]),
+        error: Schema.optional(Schema.String),
+        failures_count: Schema.Number,
+        retry_at: Schema.optional(Schema.String),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        total_duration_ms: Schema.Number,
+      }),
+    ),
+  });
+export type CreateProjectBranchDatabaseOutput =
+  typeof CreateProjectBranchDatabaseOutput.Type;
+
+// The operation
+/**
+ * Create database
+ *
+ * Creates a database in the specified branch.
+ * A branch can have multiple databases.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * You can obtain the `branch_id` by listing the project's branches.
+ * For related information, see [Manage databases](https://neon.tech/docs/manage/databases/).
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const createProjectBranchDatabase = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateProjectBranchDatabaseInput,
+    outputSchema: CreateProjectBranchDatabaseOutput,
+  }),
+);