@distilled.cloud/neon 0.0.0 → 0.2.0-alpha

package/src/operations/createBranchNeonAuthNewUser.ts

@@ -0,0 +1,43 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateBranchNeonAuthNewUserInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String.pipe(T.PathParam()),
+    branch_id: Schema.String.pipe(T.PathParam()),
+    email: Schema.String,
+    name: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/projects/{project_id}/branches/{branch_id}/auth/users",
+    }),
+  );
+export type CreateBranchNeonAuthNewUserInput =
+  typeof CreateBranchNeonAuthNewUserInput.Type;
+
+// Output Schema
+export const CreateBranchNeonAuthNewUserOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+  });
+export type CreateBranchNeonAuthNewUserOutput =
+  typeof CreateBranchNeonAuthNewUserOutput.Type;
+
+// The operation
+/**
+ * Create new auth user
+ *
+ * Creates a new user in Neon Auth.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const createBranchNeonAuthNewUser = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateBranchNeonAuthNewUserInput,
+    outputSchema: CreateBranchNeonAuthNewUserOutput,
+  }),
+);

package/src/operations/createNeonAuth.ts

@@ -0,0 +1,45 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateNeonAuthInput = /*@__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"]),
+  database_name: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/projects/{project_id}/branches/{branch_id}/auth",
+  }),
+);
+export type CreateNeonAuthInput = typeof CreateNeonAuthInput.Type;
+
+// Output Schema
+export const CreateNeonAuthOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  auth_provider: Schema.Literals(["mock", "stack", "stack_v2", "better_auth"]),
+  auth_provider_project_id: Schema.String,
+  pub_client_key: Schema.String,
+  secret_server_key: Schema.String,
+  jwks_url: Schema.String,
+  schema_name: Schema.String,
+  table_name: Schema.String,
+  base_url: Schema.optional(Schema.String),
+});
+export type CreateNeonAuthOutput = typeof CreateNeonAuthOutput.Type;
+
+// The operation
+/**
+ * Enable Neon Auth for the branch
+ *
+ * Enables Neon Auth integrationfor the branch.
+ * You can obtain the `project_id` and `branch_id` by listing the projects and branches for your Neon account.
+ *
+ * @param project_id - The Neon project ID
+ * @param branch_id - The Neon branch ID
+ */
+export const createNeonAuth = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateNeonAuthInput,
+  outputSchema: CreateNeonAuthOutput,
+}));

package/src/operations/createNeonAuthProviderSDKKeys.ts

@@ -0,0 +1,50 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateNeonAuthProviderSDKKeysInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    project_id: Schema.String,
+    auth_provider: Schema.Literals([
+      "mock",
+      "stack",
+      "stack_v2",
+      "better_auth",
+    ]),
+  }).pipe(T.Http({ method: "POST", path: "/projects/auth/keys" }));
+export type CreateNeonAuthProviderSDKKeysInput =
+  typeof CreateNeonAuthProviderSDKKeysInput.Type;
+
+// Output Schema
+export const CreateNeonAuthProviderSDKKeysOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    auth_provider: Schema.Literals([
+      "mock",
+      "stack",
+      "stack_v2",
+      "better_auth",
+    ]),
+    auth_provider_project_id: Schema.String,
+    pub_client_key: Schema.String,
+    secret_server_key: Schema.String,
+    jwks_url: Schema.String,
+    schema_name: Schema.String,
+    table_name: Schema.String,
+    base_url: Schema.optional(Schema.String),
+  });
+export type CreateNeonAuthProviderSDKKeysOutput =
+  typeof CreateNeonAuthProviderSDKKeysOutput.Type;
+
+// The operation
+/**
+ * Create Auth Provider SDK keys
+ *
+ * Generates SDK or API Keys for the auth provider. These might be called different things depending
+ * on the auth provider you're using, but are generally used for setting up the frontend and backend SDKs.
+ */
+export const createNeonAuthProviderSDKKeys =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: CreateNeonAuthProviderSDKKeysInput,
+    outputSchema: CreateNeonAuthProviderSDKKeysOutput,
+  }));

package/src/operations/createOrgApiKey.ts

@@ -0,0 +1,37 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateOrgApiKeyInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  org_id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "POST", path: "/organizations/{org_id}/api_keys" }));
+export type CreateOrgApiKeyInput = typeof CreateOrgApiKeyInput.Type;
+
+// Output Schema
+export const CreateOrgApiKeyOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.Number,
+  key: Schema.String,
+  name: Schema.String,
+  created_at: Schema.String,
+  created_by: Schema.String,
+  project_id: Schema.optional(Schema.String),
+});
+export type CreateOrgApiKeyOutput = typeof CreateOrgApiKeyOutput.Type;
+
+// The operation
+/**
+ * Create organization API key
+ *
+ * Creates an API key for the specified organization.
+ * The `key_name` is a user-specified name for the key.
+ * This method returns an `id` and `key`. The `key` is a randomly generated, 64-bit token required to access the Neon API.
+ * 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
+ */
+export const createOrgApiKey = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateOrgApiKeyInput,
+  outputSchema: CreateOrgApiKeyOutput,
+}));

package/src/operations/createOrganizationInvitations.ts

@@ -0,0 +1,53 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateOrganizationInvitationsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    org_id: Schema.String.pipe(T.PathParam()),
+    invitations: Schema.Array(
+      Schema.Struct({
+        email: Schema.String,
+        role: Schema.Literals(["admin", "member"]),
+      }),
+    ),
+  }).pipe(
+    T.Http({ method: "POST", path: "/organizations/{org_id}/invitations" }),
+  );
+export type CreateOrganizationInvitationsInput =
+  typeof CreateOrganizationInvitationsInput.Type;
+
+// Output Schema
+export const CreateOrganizationInvitationsOutput =
+  /*@__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 CreateOrganizationInvitationsOutput =
+  typeof CreateOrganizationInvitationsOutput.Type;
+
+// The operation
+/**
+ * Create organization invitations
+ *
+ * Creates invitations for a specific organization.
+ * If the invited user has an existing account, they automatically join as a member.
+ * If they don't yet have an account, they are invited to create one, after which they become a member.
+ * Each invited user receives an email notification.
+ *
+ * @param org_id - The Neon organization ID
+ */
+export const createOrganizationInvitations =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: CreateOrganizationInvitationsInput,
+    outputSchema: CreateOrganizationInvitationsOutput,
+  }));

package/src/operations/createProject.ts

@@ -0,0 +1,385 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+
+// Input Schema
+export const CreateProjectInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  project: Schema.Struct({
+    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)),
+          }),
+        ),
+      }),
+    ),
+    name: Schema.optional(Schema.String),
+    branch: Schema.optional(
+      Schema.Struct({
+        name: Schema.optional(Schema.String),
+        role_name: Schema.optional(Schema.String),
+        database_name: Schema.optional(Schema.String),
+        annotations: Schema.optional(
+          Schema.Record(Schema.String, Schema.String),
+        ),
+      }),
+    ),
+    autoscaling_limit_min_cu: Schema.optional(Schema.Number),
+    autoscaling_limit_max_cu: Schema.optional(Schema.Number),
+    provisioner: Schema.optional(Schema.String),
+    region_id: Schema.optional(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),
+      }),
+    ),
+    pg_version: Schema.optional(Schema.Number),
+    store_passwords: Schema.optional(Schema.Boolean),
+    history_retention_seconds: Schema.optional(Schema.Number),
+    org_id: Schema.optional(Schema.String),
+  }),
+}).pipe(T.Http({ method: "POST", path: "/projects" }));
+export type CreateProjectInput = typeof CreateProjectInput.Type;
+
+// Output Schema
+export const CreateProjectOutput = /*@__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),
+  }),
+  connection_uris: Schema.Array(
+    Schema.Struct({
+      connection_uri: Schema.String,
+      connection_parameters: Schema.Struct({
+        database: Schema.String,
+        password: Schema.String,
+        role: Schema.String,
+        host: Schema.String,
+        pooler_host: Schema.String,
+      }),
+    }),
+  ),
+  roles: Schema.Array(
+    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,
+    }),
+  ),
+  databases: Schema.Array(
+    Schema.Struct({
+      id: Schema.Number,
+      branch_id: Schema.String,
+      name: Schema.String,
+      owner_name: 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,
+    }),
+  ),
+  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.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),
+    }),
+  ),
+});
+export type CreateProjectOutput = typeof CreateProjectOutput.Type;
+
+// The operation
+/**
+ * Create project
+ *
+ * Creates a Neon project within an organization.
+ * You may need to specify an org_id parameter depending on your API key type.
+ * Plan limits define how many projects you can create.
+ * For more information, see [Manage projects](https://neon.tech/docs/manage/projects/).
+ * You can specify a region and Postgres version in the request body.
+ * Neon currently supports PostgreSQL 14, 15, 16, and 17.
+ * For supported regions and `region_id` values, see [Regions](https://neon.tech/docs/introduction/regions/).
+ */
+export const createProject = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateProjectInput,
+  outputSchema: CreateProjectOutput,
+}));