@distilled.cloud/neon 0.0.0 → 0.2.0-alpha

package/src/operations/deleteProjectJWKS.ts

@@ -0,0 +1,43 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteProjectJWKSInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    project_id: Schema.String.pipe(T.PathParam()),
+    jwks_id: Schema.String.pipe(T.PathParam()),
+  },
+).pipe(
+  T.Http({ method: "DELETE", path: "/projects/{project_id}/jwks/{jwks_id}" }),
+);
+export type DeleteProjectJWKSInput = typeof DeleteProjectJWKSInput.Type;
+
+// Output Schema
+export const DeleteProjectJWKSOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    project_id: Schema.String,
+    branch_id: Schema.optional(Schema.String),
+    jwks_url: Schema.String,
+    provider_name: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    jwt_audience: Schema.optional(Schema.String),
+    role_names: Schema.optional(Schema.Array(Schema.String)),
+  });
+export type DeleteProjectJWKSOutput = typeof DeleteProjectJWKSOutput.Type;
+
+// The operation
+/**
+ * Delete JWKS URL
+ *
+ * Deletes a JWKS URL from the specified project
+ *
+ * @param project_id - The Neon project ID
+ * @param jwks_id - The JWKS ID
+ */
+export const deleteProjectJWKS = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: DeleteProjectJWKSInput,
+  outputSchema: DeleteProjectJWKSOutput,
+}));

package/src/operations/deleteProjectVPCEndpoint.ts

@@ -0,0 +1,39 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteProjectVPCEndpointInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    vpc_endpoint_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      path: "/projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}",
+    }),
+  );
+export type DeleteProjectVPCEndpointInput =
+  typeof DeleteProjectVPCEndpointInput.Type;
+
+// Output Schema
+export const DeleteProjectVPCEndpointOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteProjectVPCEndpointOutput =
+  typeof DeleteProjectVPCEndpointOutput.Type;
+
+// The operation
+/**
+ * Delete VPC endpoint restriction
+ *
+ * Removes the specified VPC endpoint restriction from a Neon project.
+ *
+ * @param project_id - The Neon project ID
+ * @param vpc_endpoint_id - The VPC endpoint ID
+ */
+export const deleteProjectVPCEndpoint = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: DeleteProjectVPCEndpointInput,
+    outputSchema: DeleteProjectVPCEndpointOutput,
+  }),
+);

package/src/operations/deleteSnapshot.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DeleteSnapshotInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+  snapshot_id: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "DELETE",
+    path: "/projects/{project_id}/snapshots/{snapshot_id}",
+  }),
+);
+export type DeleteSnapshotInput = typeof DeleteSnapshotInput.Type;
+
+// Output Schema
+export const DeleteSnapshotOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DeleteSnapshotOutput = typeof DeleteSnapshotOutput.Type;
+
+// The operation
+/**
+ * Delete snapshot
+ *
+ * Delete the specified snapshot.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param snapshot_id - The snapshot ID
+ */
+export const deleteSnapshot = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: DeleteSnapshotInput,
+  outputSchema: DeleteSnapshotOutput,
+}));

package/src/operations/disableNeonAuth.ts

@@ -0,0 +1,32 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const DisableNeonAuthInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+  branch_id: Schema.String.pipe(T.PathParam()),
+  delete_data: Schema.optional(Schema.Boolean),
+}).pipe(
+  T.Http({
+    method: "DELETE",
+    path: "/projects/{project_id}/branches/{branch_id}/auth",
+  }),
+);
+export type DisableNeonAuthInput = typeof DisableNeonAuthInput.Type;
+
+// Output Schema
+export const DisableNeonAuthOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type DisableNeonAuthOutput = typeof DisableNeonAuthOutput.Type;
+
+// The operation
+/**
+ * Disables Neon Auth for the branch
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const disableNeonAuth = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: DisableNeonAuthInput,
+  outputSchema: DisableNeonAuthOutput,
+}));

package/src/operations/finalizeRestoreBranch.ts

@@ -0,0 +1,102 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const FinalizeRestoreBranchInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    name: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/finalize_restore",
+    }),
+  );
+export type FinalizeRestoreBranchInput = typeof FinalizeRestoreBranchInput.Type;
+
+// Output Schema
+export const FinalizeRestoreBranchOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    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 FinalizeRestoreBranchOutput =
+  typeof FinalizeRestoreBranchOutput.Type;
+
+// The operation
+/**
+ * Finalize restore
+ *
+ * Finalize the restore operation for a branch created from a snapshot.
+ * This operation updates the branch so it functions as the original branch it replaced.
+ * This includes:
+ * - Reassigning any computes from the original branch to the restored branch (this will restart the computes)
+ * - Renaming the restored branch to the original branch's name
+ * - Renaming the original branch so it no longer uses the original name
+ * This operation only applies to branches created using the `restoreSnapshot` endpoint with `finalize_restore: false`.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const finalizeRestoreBranch = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: FinalizeRestoreBranchInput,
+    outputSchema: FinalizeRestoreBranchOutput,
+  }),
+);

package/src/operations/getActiveRegions.ts

@@ -0,0 +1,36 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetActiveRegionsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/regions" }));
+export type GetActiveRegionsInput = typeof GetActiveRegionsInput.Type;
+
+// Output Schema
+export const GetActiveRegionsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    regions: Schema.Array(
+      Schema.Struct({
+        region_id: Schema.String,
+        name: Schema.String,
+        default: Schema.Boolean,
+        geo_lat: Schema.String,
+        geo_long: Schema.String,
+      }),
+    ),
+  },
+);
+export type GetActiveRegionsOutput = typeof GetActiveRegionsOutput.Type;
+
+// The operation
+/**
+ * List supported regions
+ *
+ * Lists supported Neon regions
+ */
+export const getActiveRegions = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetActiveRegionsInput,
+  outputSchema: GetActiveRegionsOutput,
+}));

package/src/operations/getAnonymizedBranchStatus.ts

@@ -0,0 +1,61 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetAnonymizedBranchStatusInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/projects/{project_id}/branches/{branch_id}/anonymized_status",
+    }),
+  );
+export type GetAnonymizedBranchStatusInput =
+  typeof GetAnonymizedBranchStatusInput.Type;
+
+// Output Schema
+export const GetAnonymizedBranchStatusOutput =
+  /*@__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 GetAnonymizedBranchStatusOutput =
+  typeof GetAnonymizedBranchStatusOutput.Type;
+
+// The operation
+/**
+ * Get anonymized branch status
+ *
+ * Retrieves the current status of an anonymized branch, including its state and progress information.
+ * This endpoint allows you to monitor the anonymization process from initialization through completion.
+ * 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.
+ * Only anonymized branches will have status information available.
+ * **Note**: This endpoint is currently in Beta.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID
+ */
+export const getAnonymizedBranchStatus = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetAnonymizedBranchStatusInput,
+    outputSchema: GetAnonymizedBranchStatusOutput,
+  }),
+);

package/src/operations/getAuthDetails.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetAuthDetailsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/auth" }));
+export type GetAuthDetailsInput = typeof GetAuthDetailsInput.Type;
+
+// Output Schema
+export const GetAuthDetailsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  account_id: Schema.String,
+  auth_method: Schema.Literals([
+    "keycloak",
+    "session_cookie",
+    "api_key_user",
+    "api_key_org",
+    "oauth",
+  ]),
+  auth_data: Schema.optional(Schema.String),
+});
+export type GetAuthDetailsOutput = typeof GetAuthDetailsOutput.Type;
+
+// The operation
+/**
+ * Get request authentication details
+ *
+ * Returns auth information about the passed credentials. It can refer to an API key, Bearer token or OAuth session.
+ */
+export const getAuthDetails = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetAuthDetailsInput,
+  outputSchema: GetAuthDetailsOutput,
+}));

package/src/operations/getAvailablePreloadLibraries.ts

@@ -0,0 +1,44 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetAvailablePreloadLibrariesInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/projects/{project_id}/available_preload_libraries",
+    }),
+  );
+export type GetAvailablePreloadLibrariesInput =
+  typeof GetAvailablePreloadLibrariesInput.Type;
+
+// Output Schema
+export const GetAvailablePreloadLibrariesOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    libraries: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          library_name: Schema.String,
+          description: Schema.String,
+          is_default: Schema.Boolean,
+          is_experimental: Schema.Boolean,
+          version: Schema.String,
+        }),
+      ),
+    ),
+  });
+export type GetAvailablePreloadLibrariesOutput =
+  typeof GetAvailablePreloadLibrariesOutput.Type;
+
+// The operation
+/**
+ * Return available shared preload libraries
+ */
+export const getAvailablePreloadLibraries =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: GetAvailablePreloadLibrariesInput,
+    outputSchema: GetAvailablePreloadLibrariesOutput,
+  }));

package/src/operations/getConnectionURI.ts

@@ -0,0 +1,45 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetConnectionURIInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+  branch_id: Schema.optional(Schema.String),
+  endpoint_id: Schema.optional(Schema.String),
+  database_name: Schema.String,
+  role_name: Schema.String,
+  pooled: Schema.optional(Schema.Boolean),
+}).pipe(
+  T.Http({ method: "GET", path: "/projects/{project_id}/connection_uri" }),
+);
+export type GetConnectionURIInput = typeof GetConnectionURIInput.Type;
+
+// Output Schema
+export const GetConnectionURIOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    uri: Schema.String,
+  },
+);
+export type GetConnectionURIOutput = typeof GetConnectionURIOutput.Type;
+
+// The operation
+/**
+ * Retrieve connection URI
+ *
+ * Retrieves a connection URI for the specified database.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * You can obtain the `database_name` by listing the databases for a branch.
+ * You can obtain a `role_name` by listing the roles for a branch.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The branch ID. Defaults to your project's default `branch_id` if not specified.
+ * @param endpoint_id - The endpoint ID. Defaults to the read-write `endpoint_id` associated with the `branch_id` if not specified.
+ * @param database_name - The database name
+ * @param role_name - The role name
+ * @param pooled - Adds the `-pooler` option to the connection URI when set to `true`, creating a pooled connection URI.
+ */
+export const getConnectionURI = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetConnectionURIInput,
+  outputSchema: GetConnectionURIOutput,
+}));

package/src/operations/getConsumptionHistoryPerAccount.ts

@@ -0,0 +1,103 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetConsumptionHistoryPerAccountInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    from: Schema.String,
+    to: Schema.String,
+    granularity: Schema.String,
+    org_id: Schema.optional(Schema.String),
+    include_v1_metrics: Schema.optional(Schema.Boolean),
+    metrics: Schema.optional(Schema.String),
+  }).pipe(T.Http({ method: "GET", path: "/consumption_history/account" }));
+export type GetConsumptionHistoryPerAccountInput =
+  typeof GetConsumptionHistoryPerAccountInput.Type;
+
+// Output Schema
+export const GetConsumptionHistoryPerAccountOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    periods: Schema.Array(
+      Schema.Struct({
+        period_id: Schema.String,
+        period_plan: Schema.String,
+        period_start: Schema.String,
+        period_end: Schema.optional(Schema.String),
+        consumption: Schema.Array(
+          Schema.Struct({
+            timeframe_start: Schema.String,
+            timeframe_end: Schema.String,
+            active_time_seconds: Schema.Number,
+            compute_time_seconds: Schema.Number,
+            written_data_bytes: Schema.Number,
+            synthetic_storage_size_bytes: Schema.Number,
+            data_storage_bytes_hour: Schema.optional(Schema.Number),
+            logical_size_bytes: Schema.optional(Schema.Number),
+            logical_size_bytes_hour: Schema.optional(Schema.Number),
+          }),
+        ),
+      }),
+    ),
+  });
+export type GetConsumptionHistoryPerAccountOutput =
+  typeof GetConsumptionHistoryPerAccountOutput.Type;
+
+// The operation
+/**
+ * Retrieve account consumption metrics (legacy plans)
+ *
+ * Retrieves consumption metrics for Scale and Enterprise plan accounts, and for legacy Scale, Business, and Enterprise plan accounts.
+ * Consumption history begins at the time the account was upgraded to a supported plan.
+ *
+ * @param from - Specify the start `date-time` for the consumption period.
+The `date-time` value is rounded according to the specified `granularity`.
+For example, `2024-03-15T15:30:00Z` for `daily` granularity will be rounded to `2024-03-15T00:00:00Z`.
+The specified `date-time` value must respect the specified granularity:
+- For `hourly`, consumption metrics are limited to the last 168 hours.
+- For `daily`, consumption metrics are limited to the last 60 days.
+- For `monthly`, consumption metrics are limited to the past year.
+
+The consumption history is available starting from `March 1, 2024, at 00:00:00 UTC`.
+
+ * @param to - Specify the end `date-time` for the consumption period.
+The `date-time` value is rounded according to the specified granularity.
+For example, `2024-03-15T15:30:00Z` for `daily` granularity will be rounded to `2024-03-15T00:00:00Z`.
+The specified `date-time` value must respect the specified granularity:
+- For `hourly`, consumption metrics are limited to the last 168 hours.
+- For `daily`, consumption metrics are limited to the last 60 days.
+- For `monthly`, consumption metrics are limited to the past year.
+
+ * @param granularity - Specify the granularity of consumption metrics.
+Hourly, daily, and monthly metrics are available for the last 168 hours, 60 days,
+and 1 year, respectively.
+
+ * @param org_id - Specify the organization for which the consumption metrics should be returned.
+If this parameter is not provided, the endpoint will return the metrics for the
+authenticated user's account.
+
+ * @param include_v1_metrics - The field is deprecated. Please use `metrics` instead.
+If `metrics` is specified, this field is ignored.
+Include metrics utilized in previous pricing models.
+- **data_storage_bytes_hour**: The sum of the maximum observed storage values for each hour
+  for each project, which never decreases.
+
+ * @param metrics - Specify a list of metrics to include in the response.
+If omitted, active_time, compute_time, written_data, synthetic_storage_size are returned.
+Possible values:
+- `active_time_seconds`
+- `compute_time_seconds`
+- `written_data_bytes`
+- `synthetic_storage_size_bytes`
+- `data_storage_bytes_hour`
+
+A list of metrics can be specified as an array of parameter values or as a comma-separated list in a single parameter value.
+- As an array of parameter values: `metrics=cpu_seconds&metrics=ram_bytes`
+- As a comma-separated list in a single parameter value: `metrics=cpu_seconds,ram_bytes`
+
+ */
+export const getConsumptionHistoryPerAccount =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: GetConsumptionHistoryPerAccountInput,
+    outputSchema: GetConsumptionHistoryPerAccountOutput,
+  }));