@distilled.cloud/neon 0.0.0 → 0.2.3

package/src/operations/recoverProject.ts

@@ -0,0 +1,179 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RecoverProjectInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "POST", path: "/projects/{project_id}/recover" }));
+export type RecoverProjectInput = typeof RecoverProjectInput.Type;
+
+// Output Schema
+export const RecoverProjectOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project: Schema.Struct({
+    data_storage_bytes_hour: Schema.Number,
+    data_transfer_bytes: Schema.Number,
+    written_data_bytes: Schema.Number,
+    compute_time_seconds: Schema.Number,
+    active_time_seconds: Schema.Number,
+    cpu_used_sec: Schema.Number,
+    id: Schema.String,
+    platform_id: Schema.String,
+    region_id: Schema.String,
+    name: Schema.String,
+    provisioner: Schema.String,
+    default_endpoint_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),
+        ),
+        autoscaling_limit_min_cu: Schema.optional(Schema.Number),
+        autoscaling_limit_max_cu: Schema.optional(Schema.Number),
+        suspend_timeout_seconds: Schema.optional(Schema.Number),
+      }),
+    ),
+    settings: Schema.optional(
+      Schema.Struct({
+        quota: Schema.optional(
+          Schema.Struct({
+            active_time_seconds: Schema.optional(Schema.Number),
+            compute_time_seconds: Schema.optional(Schema.Number),
+            written_data_bytes: Schema.optional(Schema.Number),
+            data_transfer_bytes: Schema.optional(Schema.Number),
+            logical_size_bytes: Schema.optional(Schema.Number),
+          }),
+        ),
+        allowed_ips: Schema.optional(
+          Schema.Struct({
+            ips: Schema.optional(Schema.Array(Schema.String)),
+            protected_branches_only: Schema.optional(Schema.Boolean),
+          }),
+        ),
+        enable_logical_replication: Schema.optional(Schema.Boolean),
+        maintenance_window: Schema.optional(
+          Schema.Struct({
+            weekdays: Schema.Array(Schema.Number),
+            start_time: Schema.String,
+            end_time: Schema.String,
+          }),
+        ),
+        block_public_connections: Schema.optional(Schema.Boolean),
+        block_vpc_connections: Schema.optional(Schema.Boolean),
+        audit_log_level: Schema.optional(
+          Schema.Literals(["base", "extended", "full"]),
+        ),
+        hipaa: Schema.optional(Schema.Boolean),
+        preload_libraries: Schema.optional(
+          Schema.Struct({
+            use_defaults: Schema.optional(Schema.Boolean),
+            enabled_libraries: Schema.optional(Schema.Array(Schema.String)),
+          }),
+        ),
+      }),
+    ),
+    pg_version: Schema.Number,
+    proxy_host: Schema.String,
+    branch_logical_size_limit: Schema.Number,
+    branch_logical_size_limit_bytes: Schema.Number,
+    store_passwords: Schema.Boolean,
+    maintenance_starts_at: Schema.optional(Schema.String),
+    creation_source: Schema.String,
+    history_retention_seconds: Schema.Number,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    synthetic_storage_size: Schema.optional(Schema.Number),
+    consumption_period_start: Schema.String,
+    consumption_period_end: Schema.String,
+    quota_reset_at: Schema.optional(Schema.String),
+    owner_id: Schema.String,
+    owner: Schema.optional(
+      Schema.Struct({
+        email: Schema.String,
+        name: Schema.String,
+        branches_limit: Schema.Number,
+        subscription_type: Schema.Literals([
+          "UNKNOWN",
+          "direct_sales",
+          "direct_sales_v3",
+          "aws_marketplace",
+          "free_v2",
+          "free_v3",
+          "launch",
+          "launch_v3",
+          "scale",
+          "scale_v3",
+          "business",
+          "vercel_pg_legacy",
+        ]),
+      }),
+    ),
+    compute_last_active_at: Schema.optional(Schema.String),
+    org_id: Schema.optional(Schema.String),
+    maintenance_scheduled_for: Schema.optional(Schema.String),
+    hipaa_enabled_at: Schema.optional(Schema.String),
+  }),
+  branches: Schema.Array(
+    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,
+          }),
+        ),
+      ),
+    }),
+  ),
+});
+export type RecoverProjectOutput = typeof RecoverProjectOutput.Type;
+
+// The operation
+/**
+ * Recover a deleted project
+ *
+ * Recovers a deleted project during the deletion grace period.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ *
+ * @param project_id - The Neon project ID
+ */
+export const recoverProject = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RecoverProjectInput,
+  outputSchema: RecoverProjectOutput,
+}));

package/src/operations/removeOrganizationMember.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RemoveOrganizationMemberInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+    member_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/organizations/{org_id}/members/{member_id}",
+    }),
+  );
+export type RemoveOrganizationMemberInput =
+  typeof RemoveOrganizationMemberInput.Type;
+
+// Output Schema
+export const RemoveOrganizationMemberOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({});
+export type RemoveOrganizationMemberOutput =
+  typeof RemoveOrganizationMemberOutput.Type;
+
+// The operation
+/**
+ * Remove member from the organization
+ *
+ * Remove member from the organization.
+ * Only an admin of the organization can perform this action.
+ * If another admin is being removed, it will not be allows in case it is the only admin left in the organization.
+ *
+ * @param org_id - The Neon organization ID
+ * @param member_id - The Neon organization member ID
+ */
+export const removeOrganizationMember = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RemoveOrganizationMemberInput,
+    outputSchema: RemoveOrganizationMemberOutput,
+  }),
+);

package/src/operations/resetProjectBranchRolePassword.ts

@@ -0,0 +1,113 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const ResetProjectBranchRolePasswordInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    role_name: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_password",
+    }),
+  );
+export type ResetProjectBranchRolePasswordInput =
+  typeof ResetProjectBranchRolePasswordInput.Type;
+
+// Output Schema
+export const ResetProjectBranchRolePasswordOutput =
+  /*@__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 ResetProjectBranchRolePasswordOutput =
+  typeof ResetProjectBranchRolePasswordOutput.Type;
+
+// The operation
+/**
+ * Reset role password
+ *
+ * Resets the password for the specified Postgres role.
+ * Returns a new password and operations. The new password is ready to use when the last operation finishes.
+ * The old password remains valid until last operation finishes.
+ * Connections to the compute endpoint are dropped. If idle,
+ * the compute endpoint becomes active for a short period of time.
+ * 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.
+ * You can obtain the `role_name` by listing the roles for a branch.
+ * For related information, see [Manage roles](https://neon.tech/docs/manage/roles/).
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ * @param role_name - The role name
+ */
+export const resetProjectBranchRolePassword =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: ResetProjectBranchRolePasswordInput,
+    outputSchema: ResetProjectBranchRolePasswordOutput,
+  }));

package/src/operations/restartProjectEndpoint.ts

@@ -0,0 +1,142 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RestartProjectEndpointInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    endpoint_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/endpoints/{endpoint_id}/restart",
+    }),
+  );
+export type RestartProjectEndpointInput =
+  typeof RestartProjectEndpointInput.Type;
+
+// Output Schema
+export const RestartProjectEndpointOutput =
+  /*@__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 RestartProjectEndpointOutput =
+  typeof RestartProjectEndpointOutput.Type;
+
+// The operation
+/**
+ * Restart compute endpoint
+ *
+ * Restart the specified compute endpoint: suspend immediately followed by start operations.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * You can obtain an `endpoint_id` by listing your project's compute endpoints.
+ * An `endpoint_id` has an `ep-` prefix.
+ * For information about compute endpoints, see [Manage computes](https://neon.tech/docs/manage/endpoints/).
+ *
+ * @param project_id - The Neon project ID
+ * @param endpoint_id - The endpoint ID
+ */
+export const restartProjectEndpoint = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RestartProjectEndpointInput,
+    outputSchema: RestartProjectEndpointOutput,
+  }),
+);

package/src/operations/restoreProjectBranch.ts

@@ -0,0 +1,141 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RestoreProjectBranchInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    source_branch_id: Schema.String,
+    source_lsn: Schema.optional(Schema.String),
+    source_timestamp: Schema.optional(Schema.String),
+    preserve_under_name: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/restore",
+    }),
+  );
+export type RestoreProjectBranchInput = typeof RestoreProjectBranchInput.Type;
+
+// Output Schema
+export const RestoreProjectBranchOutput =
+  /*@__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,
+          }),
+        ),
+      ),
+    }),
+    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 RestoreProjectBranchOutput = typeof RestoreProjectBranchOutput.Type;
+
+// The operation
+/**
+ * Restore branch
+ *
+ * Restores a branch to an earlier state in its own or another branch's history
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const restoreProjectBranch = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RestoreProjectBranchInput,
+    outputSchema: RestoreProjectBranchOutput,
+  }),
+);