@distilled.cloud/neon 0.0.0-john

package/src/operations/restoreSnapshot.ts

@@ -0,0 +1,187 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RestoreSnapshotInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+  snapshot_id: Schema.String.pipe(T.PathParam()),
+  name: Schema.optional(Schema.String),
+  target_branch_id: Schema.optional(Schema.String),
+  finalize_restore: Schema.optional(Schema.Boolean),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/projects/{project_id}/snapshots/{snapshot_id}/restore",
+  }),
+);
+export type RestoreSnapshotInput = typeof RestoreSnapshotInput.Type;
+
+// Output Schema
+export const RestoreSnapshotOutput = /*@__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.optional(
+    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,
+    }),
+  ),
+});
+export type RestoreSnapshotOutput = typeof RestoreSnapshotOutput.Type;
+
+// The operation
+/**
+ * Restore snapshot
+ *
+ * Restore the specified snapshot to a new branch and optionally finalize the restore operation.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param snapshot_id - The snapshot ID
+ * @param name - DEPRECATED. Use the `name` field in the request body instead.
+A name for the newly restored branch. If omitted, a default name will be generated.
+
+ */
+export const restoreSnapshot = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RestoreSnapshotInput,
+  outputSchema: RestoreSnapshotOutput,
+}));

package/src/operations/revokeApiKey.ts

@@ -0,0 +1,39 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RevokeApiKeyInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  key_id: Schema.Number.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "DELETE", path: "/api_keys/{key_id}" }));
+export type RevokeApiKeyInput = typeof RevokeApiKeyInput.Type;
+
+// Output Schema
+export const RevokeApiKeyOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.Number,
+  name: Schema.String,
+  created_at: Schema.String,
+  created_by: Schema.String,
+  last_used_at: Schema.optional(Schema.NullOr(Schema.String)),
+  last_used_from_addr: Schema.String,
+  revoked: Schema.Boolean,
+});
+export type RevokeApiKeyOutput = typeof RevokeApiKeyOutput.Type;
+
+// The operation
+/**
+ * Revoke API key
+ *
+ * Revokes the specified API key.
+ * An API key that is no longer needed can be revoked.
+ * This action cannot be reversed.
+ * You can obtain `key_id` values by listing the API keys for your Neon account.
+ * API keys can also be managed in the Neon Console.
+ * See [Manage API keys](https://neon.tech/docs/manage/api-keys/).
+ *
+ * @param key_id - The API key ID
+ */
+export const revokeApiKey = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RevokeApiKeyInput,
+  outputSchema: RevokeApiKeyOutput,
+}));

package/src/operations/revokeOrgApiKey.ts

@@ -0,0 +1,47 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RevokeOrgApiKeyInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  org_id: Schema.String.pipe(T.PathParam()),
+  key_id: Schema.Number.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "DELETE",
+    path: "/organizations/{org_id}/api_keys/{key_id}",
+  }),
+);
+export type RevokeOrgApiKeyInput = typeof RevokeOrgApiKeyInput.Type;
+
+// Output Schema
+export const RevokeOrgApiKeyOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.Number,
+  name: Schema.String,
+  created_at: Schema.String,
+  created_by: Schema.String,
+  last_used_at: Schema.optional(Schema.NullOr(Schema.String)),
+  last_used_from_addr: Schema.String,
+  revoked: Schema.Boolean,
+  project_id: Schema.optional(Schema.String),
+});
+export type RevokeOrgApiKeyOutput = typeof RevokeOrgApiKeyOutput.Type;
+
+// The operation
+/**
+ * Revoke organization API key
+ *
+ * Revokes the specified organization API key.
+ * An API key that is no longer needed can be revoked.
+ * This action cannot be reversed.
+ * You can obtain `key_id` values by listing the API keys for an organization.
+ * API keys can also be managed in the Neon Console.
+ * See [Manage API keys](https://neon.tech/docs/manage/api-keys/).
+ *
+ * @param org_id - The Neon organization ID
+ * @param key_id - The API key ID
+ */
+export const revokeOrgApiKey = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RevokeOrgApiKeyInput,
+  outputSchema: RevokeOrgApiKeyOutput,
+}));

package/src/operations/revokePermissionFromProject.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const RevokePermissionFromProjectInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    permission_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/projects/{project_id}/permissions/{permission_id}",
+    }),
+  );
+export type RevokePermissionFromProjectInput =
+  typeof RevokePermissionFromProjectInput.Type;
+
+// Output Schema
+export const RevokePermissionFromProjectOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    granted_to_email: Schema.String,
+    granted_at: Schema.String,
+    revoked_at: Schema.optional(Schema.String),
+  });
+export type RevokePermissionFromProjectOutput =
+  typeof RevokePermissionFromProjectOutput.Type;
+
+// The operation
+/**
+ * Revoke project access
+ *
+ * Revokes project access from the user associated with the specified permission `id`. You can retrieve a user's permission `id` by listing project access.
+ */
+export const revokePermissionFromProject = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RevokePermissionFromProjectInput,
+    outputSchema: RevokePermissionFromProjectOutput,
+  }),
+);

package/src/operations/sendNeonAuthTestEmail.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const SendNeonAuthTestEmailInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/auth/send_test_email",
+    }),
+  );
+export type SendNeonAuthTestEmailInput = typeof SendNeonAuthTestEmailInput.Type;
+
+// Output Schema
+export const SendNeonAuthTestEmailOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    success: Schema.Boolean,
+    error_message: Schema.optional(Schema.String),
+  });
+export type SendNeonAuthTestEmailOutput =
+  typeof SendNeonAuthTestEmailOutput.Type;
+
+// The operation
+/**
+ * Send test email
+ *
+ * Sends a test email to the specified email address.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const sendNeonAuthTestEmail = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: SendNeonAuthTestEmailInput,
+    outputSchema: SendNeonAuthTestEmailOutput,
+  }),
+);

package/src/operations/setDefaultProjectBranch.ts

@@ -0,0 +1,143 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const SetDefaultProjectBranchInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/set_as_default",
+    }),
+  );
+export type SetDefaultProjectBranchInput =
+  typeof SetDefaultProjectBranchInput.Type;
+
+// Output Schema
+export const SetDefaultProjectBranchOutput =
+  /*@__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 SetDefaultProjectBranchOutput =
+  typeof SetDefaultProjectBranchOutput.Type;
+
+// The operation
+/**
+ * Set branch as default
+ *
+ * Sets the specified branch as the project's default branch.
+ * The default designation is automatically removed from the previous default 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 more information, see [Manage branches](https://neon.tech/docs/manage/branches/).
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const setDefaultProjectBranch = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: SetDefaultProjectBranchInput,
+    outputSchema: SetDefaultProjectBranchOutput,
+  }),
+);

package/src/operations/setSnapshotSchedule.ts

@@ -0,0 +1,45 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const SetSnapshotScheduleInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    schedule: Schema.Array(
+      Schema.Struct({
+        frequency: Schema.String,
+        hour: Schema.optional(Schema.Number),
+        day: Schema.optional(Schema.Number),
+        month: Schema.optional(Schema.Number),
+        retention_seconds: Schema.optional(Schema.Number),
+      }),
+    ),
+  }).pipe(
+    T.Http({
+      method: "PUT",
+      path: "/projects/{project_id}/branches/{branch_id}/backup_schedule",
+    }),
+  );
+export type SetSnapshotScheduleInput = typeof SetSnapshotScheduleInput.Type;
+
+// Output Schema
+export const SetSnapshotScheduleOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({});
+export type SetSnapshotScheduleOutput = typeof SetSnapshotScheduleOutput.Type;
+
+// The operation
+/**
+ * Update backup schedule
+ *
+ * Update the backup schedule for the specified branch.
+ * **Note** : This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const setSnapshotSchedule = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: SetSnapshotScheduleInput,
+  outputSchema: SetSnapshotScheduleOutput,
+}));

package/src/operations/startAnonymization.ts

@@ -0,0 +1,57 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const StartAnonymizationInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/anonymize",
+    }),
+  );
+export type StartAnonymizationInput = typeof StartAnonymizationInput.Type;
+
+// Output Schema
+export const StartAnonymizationOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String,
+    branch_id: Schema.String,
+    state: Schema.String,
+    status_message: Schema.optional(Schema.String),
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    failed_at: Schema.optional(Schema.String),
+    last_run: Schema.optional(
+      Schema.Struct({
+        started_at: Schema.optional(Schema.String),
+        completed_at: Schema.optional(Schema.String),
+        triggered_by: Schema.optional(Schema.String),
+        triggered_by_username: Schema.optional(Schema.String),
+        masked_columns: Schema.optional(Schema.Number),
+      }),
+    ),
+  });
+export type StartAnonymizationOutput = typeof StartAnonymizationOutput.Type;
+
+// The operation
+/**
+ * Start anonymization
+ *
+ * Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state.
+ * This will apply all defined masking rules to anonymize sensitive data in the branch 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.
+ * The branch must be an anonymized branch to start anonymization.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const startAnonymization = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: StartAnonymizationInput,
+  outputSchema: StartAnonymizationOutput,
+}));