@distilled.cloud/neon 0.0.0 → 0.2.0-alpha

package/src/operations/createProjectBranchRole.ts

@@ -0,0 +1,113 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectBranchRoleInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    role: Schema.Struct({
+      name: Schema.String,
+      no_login: Schema.optional(Schema.Boolean),
+    }),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/roles",
+    }),
+  );
+export type CreateProjectBranchRoleInput =
+  typeof CreateProjectBranchRoleInput.Type;
+
+// Output Schema
+export const CreateProjectBranchRoleOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    role: 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,
+    }),
+    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 CreateProjectBranchRoleOutput =
+  typeof CreateProjectBranchRoleOutput.Type;
+
+// The operation
+/**
+ * Create role
+ *
+ * Creates a Postgres role in the specified branch.
+ * 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 roles](https://neon.tech/docs/manage/roles/).
+ * Connections established to the active compute endpoint will be dropped.
+ * If the compute endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const createProjectBranchRole = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateProjectBranchRoleInput,
+    outputSchema: CreateProjectBranchRoleOutput,
+  }),
+);

package/src/operations/createProjectEndpoint.ts

@@ -0,0 +1,169 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectEndpointInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    endpoint: Schema.Struct({
+      branch_id: Schema.String,
+      region_id: Schema.optional(Schema.String),
+      type: Schema.Literals(["read_only", "read_write"]),
+      settings: Schema.optional(
+        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)),
+            }),
+          ),
+        }),
+      ),
+      autoscaling_limit_min_cu: Schema.optional(Schema.Number),
+      autoscaling_limit_max_cu: Schema.optional(Schema.Number),
+      provisioner: Schema.optional(Schema.String),
+      pooler_enabled: Schema.optional(Schema.Boolean),
+      pooler_mode: Schema.optional(Schema.Literals(["transaction"])),
+      disabled: Schema.optional(Schema.Boolean),
+      passwordless_access: Schema.optional(Schema.Boolean),
+      suspend_timeout_seconds: Schema.optional(Schema.Number),
+      name: Schema.optional(Schema.String),
+    }),
+  }).pipe(T.Http({ method: "POST", path: "/projects/{project_id}/endpoints" }));
+export type CreateProjectEndpointInput = typeof CreateProjectEndpointInput.Type;
+
+// Output Schema
+export const CreateProjectEndpointOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    endpoint: 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,
+      }),
+    ),
+  });
+export type CreateProjectEndpointOutput =
+  typeof CreateProjectEndpointOutput.Type;
+
+// The operation
+/**
+ * Create compute endpoint
+ *
+ * Creates a compute endpoint for the specified branch.
+ * An endpoint is a Neon compute instance.
+ * There is a maximum of one read-write compute endpoint per branch.
+ * If the specified branch already has a read-write compute endpoint, the operation fails.
+ * A branch can have multiple read-only compute endpoints.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * You can obtain `branch_id` by listing the project's branches.
+ * A `branch_id` has a `br-` prefix.
+ * For supported regions and `region_id` values, see [Regions](https://neon.tech/docs/introduction/regions/).
+ * For more information about compute endpoints, see [Manage computes](https://neon.tech/docs/manage/endpoints/).
+ *
+ * @param project_id - The Neon project ID
+ */
+export const createProjectEndpoint = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateProjectEndpointInput,
+    outputSchema: CreateProjectEndpointOutput,
+  }),
+);

package/src/operations/createProjectTransferRequest.ts

@@ -0,0 +1,49 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectTransferRequestInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    ttl_seconds: Schema.optional(Schema.Number),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/transfer_requests",
+    }),
+  );
+export type CreateProjectTransferRequestInput =
+  typeof CreateProjectTransferRequestInput.Type;
+
+// Output Schema
+export const CreateProjectTransferRequestOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    project_id: Schema.String,
+    created_at: Schema.String,
+    expires_at: Schema.String,
+  });
+export type CreateProjectTransferRequestOutput =
+  typeof CreateProjectTransferRequestOutput.Type;
+
+// The operation
+/**
+ * Create a project transfer request
+ *
+ * Creates a transfer request for the specified project. A transfer request allows
+ * the project to be transferred to another account or organization. The request
+ * has an expiration time after which it can no longer be used. To accept/claim
+ * the transfer request, the recipient user/organization must call the
+ * `/projects/{project_id}/transfer_requests/{request_id}` API endpoint, or visit
+ * `https://console.neon.tech/app/claim?p={project_id}&tr={request_id}&ru={redirect_url}`
+ * in the Neon Console. The `ru` parameter is optional and can be used to redirect
+ * the user after accepting the transfer request.
+ *
+ * @param project_id - The Neon project ID
+ */
+export const createProjectTransferRequest =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: CreateProjectTransferRequestInput,
+    outputSchema: CreateProjectTransferRequestOutput,
+  }));

package/src/operations/createSnapshot.ts

@@ -0,0 +1,115 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateSnapshotInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+  branch_id: Schema.String.pipe(T.PathParam()),
+  lsn: Schema.optional(Schema.String),
+  timestamp: Schema.optional(Schema.String),
+  name: Schema.optional(Schema.String),
+  expires_at: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/projects/{project_id}/branches/{branch_id}/snapshot",
+  }),
+);
+export type CreateSnapshotInput = typeof CreateSnapshotInput.Type;
+
+// Output Schema
+export const CreateSnapshotOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  snapshot: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    lsn: Schema.optional(Schema.String),
+    timestamp: Schema.optional(Schema.String),
+    source_branch_id: Schema.optional(Schema.String),
+    created_at: Schema.String,
+    expires_at: Schema.optional(Schema.String),
+    manual: Schema.optional(Schema.Boolean),
+  }),
+  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 CreateSnapshotOutput = typeof CreateSnapshotOutput.Type;
+
+// The operation
+/**
+ * Create snapshot
+ *
+ * Create a snapshot from the specified branch using the provided parameters.
+ * This endpoint may initiate an asynchronous operation.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ * @param lsn - The target Log Sequence Number (LSN) to take the snapshot from.
+Must fall within the restore window. Cannot be used with `timestamp`
+
+ * @param timestamp - The target timestamp for the snapshot. Must fall within the restore window.
+Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z). Cannot be used with `lsn`.
+
+ * @param name - A name for the snapshot.
+ * @param expires_at - The time at which the snapshot will be automatically deleted.
+Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z).
+
+ */
+export const createSnapshot = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateSnapshotInput,
+  outputSchema: CreateSnapshotOutput,
+}));

package/src/operations/deleteBranchNeonAuthOauthProvider.ts

@@ -0,0 +1,40 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteBranchNeonAuthOauthProviderInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    oauth_provider_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}",
+    }),
+  );
+export type DeleteBranchNeonAuthOauthProviderInput =
+  typeof DeleteBranchNeonAuthOauthProviderInput.Type;
+
+// Output Schema
+export const DeleteBranchNeonAuthOauthProviderOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteBranchNeonAuthOauthProviderOutput =
+  typeof DeleteBranchNeonAuthOauthProviderOutput.Type;
+
+// The operation
+/**
+ * Delete OAuth provider
+ *
+ * Deletes a OAuth provider from the specified project.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ * @param oauth_provider_id - The OAuth provider ID
+ */
+export const deleteBranchNeonAuthOauthProvider =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: DeleteBranchNeonAuthOauthProviderInput,
+    outputSchema: DeleteBranchNeonAuthOauthProviderOutput,
+  }));

package/src/operations/deleteBranchNeonAuthTrustedDomain.ts

@@ -0,0 +1,49 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteBranchNeonAuthTrustedDomainInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    auth_provider: Schema.Literals([
+      "mock",
+      "stack",
+      "stack_v2",
+      "better_auth",
+    ]),
+    domains: Schema.Array(
+      Schema.Struct({
+        domain: Schema.String,
+      }),
+    ),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/projects/{project_id}/branches/{branch_id}/auth/domains",
+    }),
+  );
+export type DeleteBranchNeonAuthTrustedDomainInput =
+  typeof DeleteBranchNeonAuthTrustedDomainInput.Type;
+
+// Output Schema
+export const DeleteBranchNeonAuthTrustedDomainOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteBranchNeonAuthTrustedDomainOutput =
+  typeof DeleteBranchNeonAuthTrustedDomainOutput.Type;
+
+// The operation
+/**
+ * Delete domain from redirect_uri whitelist
+ *
+ * Deletes a domain from the redirect_uri whitelist for the specified project.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const deleteBranchNeonAuthTrustedDomain =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: DeleteBranchNeonAuthTrustedDomainInput,
+    outputSchema: DeleteBranchNeonAuthTrustedDomainOutput,
+  }));

package/src/operations/deleteBranchNeonAuthUser.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteBranchNeonAuthUserInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    auth_user_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}",
+    }),
+  );
+export type DeleteBranchNeonAuthUserInput =
+  typeof DeleteBranchNeonAuthUserInput.Type;
+
+// Output Schema
+export const DeleteBranchNeonAuthUserOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteBranchNeonAuthUserOutput =
+  typeof DeleteBranchNeonAuthUserOutput.Type;
+
+// The operation
+/**
+ * Delete auth user
+ *
+ * Deletes the auth user for the specified project.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ * @param auth_user_id - The Neon user ID
+ */
+export const deleteBranchNeonAuthUser = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: DeleteBranchNeonAuthUserInput,
+    outputSchema: DeleteBranchNeonAuthUserOutput,
+  }),
+);

package/src/operations/deleteOrganizationVPCEndpoint.ts

@@ -0,0 +1,44 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteOrganizationVPCEndpointInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+    region_id: Schema.String.pipe(T.PathParam()),
+    vpc_endpoint_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}",
+    }),
+  );
+export type DeleteOrganizationVPCEndpointInput =
+  typeof DeleteOrganizationVPCEndpointInput.Type;
+
+// Output Schema
+export const DeleteOrganizationVPCEndpointOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteOrganizationVPCEndpointOutput =
+  typeof DeleteOrganizationVPCEndpointOutput.Type;
+
+// The operation
+/**
+ * Delete VPC endpoint
+ *
+ * Deletes the VPC endpoint from the specified Neon organization.
+ * If you delete a VPC endpoint from a Neon organization, that VPC endpoint cannot
+ * be added back to the Neon organization.
+ *
+ * @param org_id - The Neon organization ID
+ * @param region_id - The Neon region ID.
+Azure regions are currently not supported.
+
+ * @param vpc_endpoint_id - The VPC endpoint ID
+ */
+export const deleteOrganizationVPCEndpoint =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: DeleteOrganizationVPCEndpointInput,
+    outputSchema: DeleteOrganizationVPCEndpointOutput,
+  }));