@distilled.cloud/planetscale 0.0.0-john

package/src/operations/createDatabasePostgresCidr.ts

@@ -0,0 +1,58 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound, UnprocessableEntity } from "../errors";
+
+// Input Schema
+export const CreateDatabasePostgresCidrInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    schema: Schema.optional(Schema.String),
+    role: Schema.optional(Schema.String),
+    cidrs: Schema.Array(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/organizations/{organization}/databases/{database}/cidrs",
+    }),
+  );
+export type CreateDatabasePostgresCidrInput =
+  typeof CreateDatabasePostgresCidrInput.Type;
+
+// Output Schema
+export const CreateDatabasePostgresCidrOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    schema: Schema.String,
+    role: Schema.String,
+    cidrs: Schema.Array(Schema.String),
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    deleted_at: Schema.String,
+    actor: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+  });
+export type CreateDatabasePostgresCidrOutput =
+  typeof CreateDatabasePostgresCidrOutput.Type;
+
+// The operation
+/**
+ * Create an IP restriction entry
+ *
+ * @param organization - The name of the organization the database belongs to
+ * @param database - The name of the database
+ * @param schema - The PostgreSQL schema to restrict access to. Leave empty or omit to allow access to all schemas.
+ * @param role - The PostgreSQL role to restrict access to. Leave empty or omit to allow access for all roles.
+ * @param cidrs - List of IPv4 CIDR ranges (e.g., ['192.168.1.0/24', '192.168.1.1/32']). Must contain at least one valid IPv4 address or range.
+ */
+export const createDatabasePostgresCidr = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateDatabasePostgresCidrInput,
+    outputSchema: CreateDatabasePostgresCidrOutput,
+    errors: [Forbidden, NotFound, UnprocessableEntity] as const,
+  }),
+);

package/src/operations/createDeployRequest.ts

@@ -0,0 +1,251 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const CreateDeployRequestInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    branch: Schema.String,
+    into_branch: Schema.String,
+    notes: Schema.optional(Schema.String),
+    auto_cutover: Schema.optional(Schema.Boolean),
+    auto_delete_branch: Schema.optional(Schema.Boolean),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      path: "/organizations/{organization}/databases/{database}/deploy-requests",
+    }),
+  );
+export type CreateDeployRequestInput = typeof CreateDeployRequestInput.Type;
+
+// Output Schema
+export const CreateDeployRequestOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    number: Schema.Number,
+    actor: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+    closed_by: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+    branch: Schema.String,
+    branch_id: Schema.String,
+    branch_deleted: Schema.Boolean,
+    branch_deleted_by: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+    branch_deleted_at: Schema.String,
+    into_branch: Schema.String,
+    into_branch_sharded: Schema.Boolean,
+    into_branch_shard_count: Schema.Number,
+    approved: Schema.Boolean,
+    state: Schema.Literals(["open", "closed"]),
+    deployment_state: Schema.Literals([
+      "pending",
+      "ready",
+      "no_changes",
+      "queued",
+      "submitting",
+      "in_progress",
+      "pending_cutover",
+      "in_progress_vschema",
+      "in_progress_cancel",
+      "in_progress_cutover",
+      "complete",
+      "complete_cancel",
+      "complete_error",
+      "complete_pending_revert",
+      "in_progress_revert",
+      "in_progress_revert_vschema",
+      "complete_revert",
+      "complete_revert_error",
+      "cancelled",
+      "error",
+    ]),
+    deployment: Schema.Struct({
+      id: Schema.String,
+      auto_cutover: Schema.Boolean,
+      auto_delete_branch: Schema.Boolean,
+      created_at: Schema.String,
+      cutover_at: Schema.String,
+      cutover_expiring: Schema.Boolean,
+      deploy_check_errors: Schema.String,
+      finished_at: Schema.String,
+      queued_at: Schema.String,
+      ready_to_cutover_at: Schema.String,
+      started_at: Schema.String,
+      state: Schema.Literals([
+        "pending",
+        "ready",
+        "no_changes",
+        "queued",
+        "submitting",
+        "in_progress",
+        "pending_cutover",
+        "in_progress_vschema",
+        "in_progress_cancel",
+        "in_progress_cutover",
+        "complete",
+        "complete_cancel",
+        "complete_error",
+        "complete_pending_revert",
+        "in_progress_revert",
+        "in_progress_revert_vschema",
+        "complete_revert",
+        "complete_revert_error",
+        "cancelled",
+        "error",
+      ]),
+      submitted_at: Schema.String,
+      updated_at: Schema.String,
+      into_branch: Schema.String,
+      deploy_request_number: Schema.Number,
+      deployable: Schema.Boolean,
+      preceding_deployments: Schema.Array(
+        Schema.Record(Schema.String, Schema.Unknown),
+      ),
+      deploy_operations: Schema.Array(
+        Schema.Struct({
+          id: Schema.String,
+          state: Schema.Literals([
+            "pending",
+            "queued",
+            "in_progress",
+            "complete",
+            "cancelled",
+            "error",
+          ]),
+          keyspace_name: Schema.String,
+          table_name: Schema.String,
+          operation_name: Schema.String,
+          eta_seconds: Schema.Number,
+          progress_percentage: Schema.Number,
+          deploy_error_docs_url: Schema.String,
+          ddl_statement: Schema.String,
+          syntax_highlighted_ddl: Schema.String,
+          created_at: Schema.String,
+          updated_at: Schema.String,
+          throttled_at: Schema.String,
+          can_drop_data: Schema.Boolean,
+          table_locked: Schema.Boolean,
+          table_recently_used: Schema.Boolean,
+          table_recently_used_at: Schema.String,
+          removed_foreign_key_names: Schema.Array(Schema.String),
+          deploy_errors: Schema.String,
+        }),
+      ),
+      deploy_operation_summaries: Schema.Array(
+        Schema.Struct({
+          id: Schema.String,
+          created_at: Schema.String,
+          deploy_errors: Schema.String,
+          ddl_statement: Schema.String,
+          eta_seconds: Schema.Number,
+          keyspace_name: Schema.String,
+          operation_name: Schema.String,
+          progress_percentage: Schema.Number,
+          state: Schema.Literals([
+            "pending",
+            "in_progress",
+            "complete",
+            "cancelled",
+            "error",
+          ]),
+          syntax_highlighted_ddl: Schema.String,
+          table_name: Schema.String,
+          table_recently_used_at: Schema.String,
+          throttled_at: Schema.String,
+          removed_foreign_key_names: Schema.Array(Schema.String),
+          shard_count: Schema.Number,
+          shard_names: Schema.Array(Schema.String),
+          can_drop_data: Schema.Boolean,
+          table_recently_used: Schema.Boolean,
+          sharded: Schema.Boolean,
+          operations: Schema.Array(
+            Schema.Struct({
+              id: Schema.String,
+              shard: Schema.String,
+              state: Schema.Literals([
+                "pending",
+                "queued",
+                "in_progress",
+                "complete",
+                "cancelled",
+                "error",
+              ]),
+              progress_percentage: Schema.Number,
+              eta_seconds: Schema.Number,
+            }),
+          ),
+        }),
+      ),
+      lint_errors: Schema.Array(Schema.Record(Schema.String, Schema.Unknown)),
+      sequential_diff_dependencies: Schema.Array(
+        Schema.Record(Schema.String, Schema.Unknown),
+      ),
+      lookup_vindex_operations: Schema.Array(
+        Schema.Record(Schema.String, Schema.Unknown),
+      ),
+      throttler_configurations: Schema.Array(
+        Schema.Record(Schema.String, Schema.Unknown),
+      ),
+      deployment_revert_request: Schema.Record(Schema.String, Schema.Unknown),
+      actor: Schema.Struct({
+        id: Schema.String,
+        display_name: Schema.String,
+        avatar_url: Schema.String,
+      }),
+      cutover_actor: Schema.Struct({
+        id: Schema.String,
+        display_name: Schema.String,
+        avatar_url: Schema.String,
+      }),
+      cancelled_actor: Schema.Struct({
+        id: Schema.String,
+        display_name: Schema.String,
+        avatar_url: Schema.String,
+      }),
+      schema_last_updated_at: Schema.String,
+      table_locked: Schema.Boolean,
+      locked_table_name: Schema.String,
+      instant_ddl: Schema.Boolean,
+      instant_ddl_eligible: Schema.Boolean,
+    }),
+    num_comments: Schema.Number,
+    html_url: Schema.String,
+    notes: Schema.String,
+    html_body: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    closed_at: Schema.String,
+    deployed_at: Schema.String,
+  });
+export type CreateDeployRequestOutput = typeof CreateDeployRequestOutput.Type;
+
+// The operation
+/**
+ * Create a deploy request
+ *
+ * @param organization - The name of the deploy request's organization
+ * @param database - The name of the deploy request's database
+ * @param branch - The name of the branch the deploy request is created from
+ * @param into_branch - The name of the branch the deploy request will be merged into
+ * @param notes - Notes about the deploy request
+ * @param auto_cutover - Whether or not to enable auto_cutover for the deploy request. When enabled, will auto cutover to the new schema as soon as it is ready.
+ * @param auto_delete_branch - Whether or not to enable auto_delete_branch for the deploy request. When enabled, will delete the branch once the DR successfully completes.
+ */
+export const createDeployRequest = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateDeployRequestInput,
+  outputSchema: CreateDeployRequestOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/createKeyspace.ts

@@ -0,0 +1,77 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const CreateKeyspaceInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  branch: Schema.String.pipe(T.PathParam()),
+  name: Schema.String,
+  cluster_size: Schema.String,
+  extra_replicas: Schema.optional(Schema.Number),
+  shards: Schema.optional(Schema.Number),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
+  }),
+);
+export type CreateKeyspaceInput = typeof CreateKeyspaceInput.Type;
+
+// Output Schema
+export const CreateKeyspaceOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  shards: Schema.Number,
+  sharded: Schema.Boolean,
+  replicas: Schema.Number,
+  extra_replicas: Schema.Number,
+  created_at: Schema.String,
+  updated_at: Schema.String,
+  cluster_name: Schema.String,
+  cluster_display_name: Schema.String,
+  resizing: Schema.Boolean,
+  resize_pending: Schema.Boolean,
+  config_change_in_progress: Schema.Boolean,
+  ready: Schema.Boolean,
+  metal: Schema.Boolean,
+  default: Schema.Boolean,
+  imported: Schema.Boolean,
+  vector_pool_allocation: Schema.NullOr(Schema.Number),
+  node_ttl_strategy: Schema.Literals([
+    "node_ttl_follow_maintenance",
+    "node_ttl_always",
+    "node_ttl_off",
+  ]),
+  replication_durability_constraints: Schema.Struct({
+    strategy: Schema.optional(Schema.Literals(["available", "lag", "always"])),
+  }),
+  vreplication_flags: Schema.Struct({
+    optimize_inserts: Schema.Boolean,
+    allow_no_blob_binlog_row_image: Schema.Boolean,
+    vplayer_batching: Schema.Boolean,
+  }),
+  mysqld_options: Schema.Record(Schema.String, Schema.Unknown),
+  vttablet_options: Schema.Record(Schema.String, Schema.Unknown),
+});
+export type CreateKeyspaceOutput = typeof CreateKeyspaceOutput.Type;
+
+// The operation
+/**
+ * Create a keyspace
+ *
+ * @param organization - The name of the organization the branch belongs to
+ * @param database - The name of the database the branch belongs to
+ * @param branch - The name of the branch
+ * @param name - The name of the keyspace
+ * @param cluster_size - The database cluster size name (e.g., 'PS_10', 'PS_80'). Use the 'List available cluster sizes' endpoint to get available options for your organization. /v1/organizations/:organization/cluster-size-skus
+ * @param extra_replicas - The number of additional replicas beyond the included default
+ * @param shards - The number of shards. Default: 1
+ */
+export const createKeyspace = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateKeyspaceInput,
+  outputSchema: CreateKeyspaceOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/createOauthToken.ts

@@ -0,0 +1,145 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound, UnprocessableEntity } from "../errors";
+import { SensitiveString } from "../sensitive";
+
+// Input Schema
+export const CreateOauthTokenInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  id: Schema.String.pipe(T.PathParam()),
+  client_id: Schema.String,
+  client_secret: Schema.String,
+  grant_type: Schema.Literals(["authorization_code", "refresh_token"]),
+  code: Schema.optional(Schema.String),
+  redirect_uri: Schema.optional(Schema.String),
+  refresh_token: Schema.optional(Schema.String),
+}).pipe(
+  T.Http({
+    method: "POST",
+    path: "/organizations/{organization}/oauth-applications/{id}/token",
+  }),
+);
+export type CreateOauthTokenInput = typeof CreateOauthTokenInput.Type;
+
+// Output Schema
+export const CreateOauthTokenOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    id: Schema.String,
+    name: Schema.String,
+    display_name: Schema.String,
+    token: SensitiveString,
+    plain_text_refresh_token: SensitiveString,
+    avatar_url: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    expires_at: Schema.String,
+    last_used_at: Schema.String,
+    actor_id: Schema.String,
+    actor_display_name: Schema.String,
+    actor_type: Schema.String,
+    service_token_accesses: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        access: Schema.String,
+        description: Schema.String,
+        resource_name: Schema.String,
+        resource_id: Schema.String,
+        resource_type: Schema.String,
+        resource: Schema.Struct({
+          id: Schema.String,
+          name: Schema.String,
+          created_at: Schema.String,
+          updated_at: Schema.String,
+          deleted_at: Schema.String,
+        }),
+      }),
+    ),
+    oauth_accesses_by_resource: Schema.Struct({
+      database: Schema.Struct({
+        databases: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            id: Schema.String,
+            organization: Schema.String,
+            url: Schema.String,
+          }),
+        ),
+        accesses: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            description: Schema.String,
+          }),
+        ),
+      }),
+      organization: Schema.Struct({
+        organizations: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            id: Schema.String,
+            url: Schema.String,
+          }),
+        ),
+        accesses: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            description: Schema.String,
+          }),
+        ),
+      }),
+      branch: Schema.Struct({
+        branches: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            id: Schema.String,
+            database: Schema.String,
+            organization: Schema.String,
+            url: Schema.String,
+          }),
+        ),
+        accesses: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            description: Schema.String,
+          }),
+        ),
+      }),
+      user: Schema.Struct({
+        users: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            id: Schema.String,
+          }),
+        ),
+        accesses: Schema.Array(
+          Schema.Struct({
+            name: Schema.String,
+            description: Schema.String,
+          }),
+        ),
+      }),
+    }),
+  },
+);
+export type CreateOauthTokenOutput = typeof CreateOauthTokenOutput.Type;
+
+// The operation
+/**
+ * Create or renew an OAuth token
+ *
+ * Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token
+ *
+ * @param organization - The name of the organization the OAuth application belongs to
+ * @param id - The ID of the OAuth application
+ * @param client_id - The OAuth application's client ID
+ * @param client_secret - The OAuth application's client secret
+ * @param grant_type - Whether an OAuth grant code or a refresh token is being exchanged for an OAuth token
+ * @param code - The OAuth grant code provided to your OAuth application's redirect URI. Required when grant_type is authorization_code
+ * @param redirect_uri - The OAuth application's redirect URI. Required when grant_type is authorization_code
+ * @param refresh_token - The refresh token from the original OAuth token grant. Required when grant_type is refresh_token
+ */
+export const createOauthToken = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateOauthTokenInput,
+  outputSchema: CreateOauthTokenOutput,
+  errors: [Forbidden, NotFound, UnprocessableEntity] as const,
+}));

package/src/operations/createOrganizationTeam.ts

@@ -0,0 +1,88 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import {
+  BadRequest,
+  Forbidden,
+  NotFound,
+  UnprocessableEntity,
+} from "../errors";
+
+// Input Schema
+export const CreateOrganizationTeamInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    name: Schema.String,
+    description: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({ method: "POST", path: "/organizations/{organization}/teams" }),
+  );
+export type CreateOrganizationTeamInput =
+  typeof CreateOrganizationTeamInput.Type;
+
+// Output Schema
+export const CreateOrganizationTeamOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    creator: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+    members: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        display_name: Schema.String,
+        name: Schema.String,
+        email: Schema.String,
+        avatar_url: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        two_factor_auth_configured: Schema.Boolean,
+        default_organization: Schema.Struct({
+          id: Schema.String,
+          name: Schema.String,
+          created_at: Schema.String,
+          updated_at: Schema.String,
+          deleted_at: Schema.String,
+        }),
+        sso: Schema.Boolean,
+        managed: Schema.Boolean,
+        directory_managed: Schema.Boolean,
+        email_verified: Schema.Boolean,
+      }),
+    ),
+    databases: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+        url: Schema.String,
+        branches_url: Schema.String,
+      }),
+    ),
+    name: Schema.String,
+    slug: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    description: Schema.String,
+    managed: Schema.Boolean,
+  });
+export type CreateOrganizationTeamOutput =
+  typeof CreateOrganizationTeamOutput.Type;
+
+// The operation
+/**
+ * Create an organization team
+ *
+ * @param organization - The name of the organization
+ * @param name - The name of the team
+ * @param description - A description of the team's purpose
+ */
+export const createOrganizationTeam = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: CreateOrganizationTeamInput,
+    outputSchema: CreateOrganizationTeamOutput,
+    errors: [BadRequest, Forbidden, NotFound, UnprocessableEntity] as const,
+  }),
+);