@distilled.cloud/neon 0.0.0 → 0.2.3

package/src/operations/getNeonAuthPluginConfigs.ts

@@ -0,0 +1,74 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetNeonAuthPluginConfigsInput =
+  /*@__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}/auth/plugins",
+    }),
+  );
+export type GetNeonAuthPluginConfigsInput =
+  typeof GetNeonAuthPluginConfigsInput.Type;
+
+// Output Schema
+export const GetNeonAuthPluginConfigsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.optional(
+      Schema.Struct({
+        enabled: Schema.Boolean,
+        organization_limit: Schema.Number,
+        membership_limit: Schema.Number,
+        creator_role: Schema.Literals(["admin", "owner"]),
+        send_invitation_email: Schema.Boolean,
+      }),
+    ),
+    email_provider: Schema.optional(Schema.Unknown),
+    email_and_password: Schema.optional(
+      Schema.Struct({
+        enabled: Schema.Boolean,
+        email_verification_method: Schema.Literals(["link", "otp"]),
+        require_email_verification: Schema.Boolean,
+        auto_sign_in_after_verification: Schema.Boolean,
+        send_verification_email_on_sign_up: Schema.Boolean,
+        send_verification_email_on_sign_in: Schema.Boolean,
+        disable_sign_up: Schema.Boolean,
+      }),
+    ),
+    oauth_providers: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          id: Schema.Literals(["google", "github", "microsoft", "vercel"]),
+          type: Schema.Literals(["standard", "shared"]),
+          client_id: Schema.optional(Schema.String),
+          client_secret: Schema.optional(Schema.String),
+        }),
+      ),
+    ),
+    allow_localhost: Schema.optional(Schema.Boolean),
+  });
+export type GetNeonAuthPluginConfigsOutput =
+  typeof GetNeonAuthPluginConfigsOutput.Type;
+
+// The operation
+/**
+ * Get all plugin configurations
+ *
+ * Returns all plugin configurations for Neon Auth in a single response.
+ * This endpoint aggregates organization, email provider, email and password,
+ * OAuth providers, and localhost settings.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const getNeonAuthPluginConfigs = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetNeonAuthPluginConfigsInput,
+    outputSchema: GetNeonAuthPluginConfigsOutput,
+  }),
+);

package/src/operations/getNeonAuthWebhookConfig.ts

@@ -0,0 +1,53 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetNeonAuthWebhookConfigInput =
+  /*@__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}/auth/webhooks",
+    }),
+  );
+export type GetNeonAuthWebhookConfigInput =
+  typeof GetNeonAuthWebhookConfigInput.Type;
+
+// Output Schema
+export const GetNeonAuthWebhookConfigOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    enabled: Schema.Boolean,
+    webhook_url: Schema.optional(Schema.String),
+    enabled_events: Schema.optional(
+      Schema.Array(
+        Schema.Literals([
+          "user.before_create",
+          "user.created",
+          "send.otp",
+          "send.magic_link",
+        ]),
+      ),
+    ),
+    timeout_seconds: Schema.optional(Schema.Number),
+  });
+export type GetNeonAuthWebhookConfigOutput =
+  typeof GetNeonAuthWebhookConfigOutput.Type;
+
+// The operation
+/**
+ * Get webhook configuration for Neon Auth
+ *
+ * Returns the webhook configuration for Neon Auth.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const getNeonAuthWebhookConfig = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetNeonAuthWebhookConfigInput,
+    outputSchema: GetNeonAuthWebhookConfigOutput,
+  }),
+);

package/src/operations/getOrganization.ts

@@ -0,0 +1,35 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetOrganizationInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  org_id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/organizations/{org_id}" }));
+export type GetOrganizationInput = typeof GetOrganizationInput.Type;
+
+// Output Schema
+export const GetOrganizationOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  handle: Schema.String,
+  plan: Schema.String,
+  created_at: Schema.String,
+  managed_by: Schema.String,
+  updated_at: Schema.String,
+  allow_hipaa_projects: Schema.optional(Schema.Boolean),
+});
+export type GetOrganizationOutput = typeof GetOrganizationOutput.Type;
+
+// The operation
+/**
+ * Retrieve organization details
+ *
+ * Retrieves information about the specified organization.
+ *
+ * @param org_id - The Neon organization ID
+ */
+export const getOrganization = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetOrganizationInput,
+  outputSchema: GetOrganizationOutput,
+}));

package/src/operations/getOrganizationInvitations.ts

@@ -0,0 +1,45 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetOrganizationInvitationsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({ method: "GET", path: "/organizations/{org_id}/invitations" }),
+  );
+export type GetOrganizationInvitationsInput =
+  typeof GetOrganizationInvitationsInput.Type;
+
+// Output Schema
+export const GetOrganizationInvitationsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    invitations: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        email: Schema.String,
+        org_id: Schema.String,
+        invited_by: Schema.String,
+        invited_at: Schema.String,
+        role: Schema.Literals(["admin", "member"]),
+      }),
+    ),
+  });
+export type GetOrganizationInvitationsOutput =
+  typeof GetOrganizationInvitationsOutput.Type;
+
+// The operation
+/**
+ * Retrieve organization invitation details
+ *
+ * Retrieves information about extended invitations for the specified organization
+ *
+ * @param org_id - The Neon organization ID
+ */
+export const getOrganizationInvitations = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetOrganizationInvitationsInput,
+    outputSchema: GetOrganizationInvitationsOutput,
+  }),
+);

package/src/operations/getOrganizationMember.ts

@@ -0,0 +1,44 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetOrganizationMemberInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+    member_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{org_id}/members/{member_id}",
+    }),
+  );
+export type GetOrganizationMemberInput = typeof GetOrganizationMemberInput.Type;
+
+// Output Schema
+export const GetOrganizationMemberOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    user_id: Schema.String,
+    org_id: Schema.String,
+    role: Schema.Literals(["admin", "member"]),
+    joined_at: Schema.optional(Schema.String),
+  });
+export type GetOrganizationMemberOutput =
+  typeof GetOrganizationMemberOutput.Type;
+
+// The operation
+/**
+ * Retrieve organization member details
+ *
+ * Retrieves information about the specified organization member.
+ *
+ * @param org_id - The Neon organization ID
+ * @param member_id - The Neon organization member ID
+ */
+export const getOrganizationMember = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetOrganizationMemberInput,
+    outputSchema: GetOrganizationMemberOutput,
+  }),
+);

package/src/operations/getOrganizationMembers.ts

@@ -0,0 +1,47 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetOrganizationMembersInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/organizations/{org_id}/members" }));
+export type GetOrganizationMembersInput =
+  typeof GetOrganizationMembersInput.Type;
+
+// Output Schema
+export const GetOrganizationMembersOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    members: Schema.Array(
+      Schema.Struct({
+        member: Schema.Struct({
+          id: Schema.String,
+          user_id: Schema.String,
+          org_id: Schema.String,
+          role: Schema.Literals(["admin", "member"]),
+          joined_at: Schema.optional(Schema.String),
+        }),
+        user: Schema.Struct({
+          email: Schema.String,
+        }),
+      }),
+    ),
+  });
+export type GetOrganizationMembersOutput =
+  typeof GetOrganizationMembersOutput.Type;
+
+// The operation
+/**
+ * Retrieve organization members details
+ *
+ * Retrieves information about the specified organization members.
+ *
+ * @param org_id - The Neon organization ID
+ */
+export const getOrganizationMembers = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetOrganizationMembersInput,
+    outputSchema: GetOrganizationMembersOutput,
+  }),
+);

package/src/operations/getOrganizationVPCEndpointDetails.ts

@@ -0,0 +1,48 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetOrganizationVPCEndpointDetailsInput =
+  /*@__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: "GET",
+      path: "/organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}",
+    }),
+  );
+export type GetOrganizationVPCEndpointDetailsInput =
+  typeof GetOrganizationVPCEndpointDetailsInput.Type;
+
+// Output Schema
+export const GetOrganizationVPCEndpointDetailsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    vpc_endpoint_id: Schema.String,
+    label: Schema.String,
+    state: Schema.String,
+    num_restricted_projects: Schema.Number,
+    example_restricted_projects: Schema.Array(Schema.String),
+  });
+export type GetOrganizationVPCEndpointDetailsOutput =
+  typeof GetOrganizationVPCEndpointDetailsOutput.Type;
+
+// The operation
+/**
+ * Retrieve VPC endpoint details
+ *
+ * Retrieves the current state and configuration details of a specified VPC endpoint.
+ *
+ * @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 getOrganizationVPCEndpointDetails =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: GetOrganizationVPCEndpointDetailsInput,
+    outputSchema: GetOrganizationVPCEndpointDetailsOutput,
+  }));

package/src/operations/getProject.ts

@@ -0,0 +1,133 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetProjectInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project_id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/projects/{project_id}" }));
+export type GetProjectInput = typeof GetProjectInput.Type;
+
+// Output Schema
+export const GetProjectOutput = /*@__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),
+  }),
+});
+export type GetProjectOutput = typeof GetProjectOutput.Type;
+
+// The operation
+/**
+ * Retrieve project details
+ *
+ * Retrieves information about the specified project.
+ * You can obtain a `project_id` by listing the projects for an organization.
+ *
+ * @param project_id - The Neon project ID
+ */
+export const getProject = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetProjectInput,
+  outputSchema: GetProjectOutput,
+}));

package/src/operations/getProjectAdvisorSecurityIssues.ts

@@ -0,0 +1,56 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetProjectAdvisorSecurityIssuesInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.optional(Schema.String),
+    database_name: Schema.optional(Schema.String),
+    category: Schema.optional(Schema.String),
+    min_severity: Schema.optional(Schema.Literals(["INFO", "WARN", "ERROR"])),
+  }).pipe(T.Http({ method: "GET", path: "/projects/{project_id}/advisors" }));
+export type GetProjectAdvisorSecurityIssuesInput =
+  typeof GetProjectAdvisorSecurityIssuesInput.Type;
+
+// Output Schema
+export const GetProjectAdvisorSecurityIssuesOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    issues: Schema.Array(
+      Schema.Struct({
+        name: Schema.String,
+        title: Schema.String,
+        level: Schema.String,
+        facing: Schema.Literals(["EXTERNAL", "INTERNAL"]),
+        categories: Schema.Array(Schema.Literals(["SECURITY", "PERFORMANCE"])),
+        description: Schema.String,
+        detail: Schema.String,
+        remediation: Schema.String,
+        metadata: Schema.Record(Schema.String, Schema.Unknown),
+        cache_key: Schema.String,
+      }),
+    ),
+  });
+export type GetProjectAdvisorSecurityIssuesOutput =
+  typeof GetProjectAdvisorSecurityIssuesOutput.Type;
+
+// The operation
+/**
+ * Get advisor issues
+ *
+ * Analyzes the database for security and performance issues.
+ * Returns a list of issues categorized by severity (ERROR, WARN, INFO).
+ * Requires read access to the project.
+ *
+ * @param project_id - Neon project ID
+ * @param branch_id - Branch ID to analyze. If not specified, the project's default branch is used.
+ * @param database_name - Database name to analyze. Required if branch has multiple databases.
+ * @param category - Filter issues by category
+ * @param min_severity - Minimum severity level to include. For example, WARN returns WARN and ERROR issues, excluding INFO.
+ */
+export const getProjectAdvisorSecurityIssues =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: GetProjectAdvisorSecurityIssuesInput,
+    outputSchema: GetProjectAdvisorSecurityIssuesOutput,
+  }));

package/src/operations/getProjectBranch.ts

@@ -0,0 +1,96 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const GetProjectBranchInput = /*@__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}",
+  }),
+);
+export type GetProjectBranchInput = typeof GetProjectBranchInput.Type;
+
+// Output Schema
+export const GetProjectBranchOutput = /*@__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,
+          }),
+        ),
+      ),
+    }),
+    annotation: Schema.Struct({
+      object: Schema.Struct({
+        type: Schema.String,
+        id: Schema.String,
+      }),
+      value: Schema.Record(Schema.String, Schema.String),
+      created_at: Schema.optional(Schema.String),
+      updated_at: Schema.optional(Schema.String),
+    }),
+  },
+);
+export type GetProjectBranchOutput = typeof GetProjectBranchOutput.Type;
+
+// The operation
+/**
+ * Retrieve branch details
+ *
+ * Retrieves information about the specified branch.
+ * You can obtain a `project_id` by listing the projects for your Neon account.
+ * You can obtain a `branch_id` by listing the project's branches.
+ * A `branch_id` value has a `br-` prefix.
+ * Each Neon project is initially created with a root and default branch named `main`.
+ * A project can contain one or more branches.
+ * A parent branch is identified by a `parent_id` value, which is the `id` of the parent branch.
+ * For related 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 getProjectBranch = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetProjectBranchInput,
+  outputSchema: GetProjectBranchOutput,
+}));