@distilled.cloud/planetscale 0.0.0 → 0.2.3

package/src/operations/getQueryPatternsReport.ts

@@ -0,0 +1,43 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetQueryPatternsReportInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    branch: Schema.String.pipe(T.PathParam()),
+    id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download",
+    }),
+  );
+export type GetQueryPatternsReportInput =
+  typeof GetQueryPatternsReportInput.Type;
+
+// Output Schema
+export const GetQueryPatternsReportOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Void;
+export type GetQueryPatternsReportOutput =
+  typeof GetQueryPatternsReportOutput.Type;
+
+// The operation
+/**
+ * Download a finished query patterns report
+ *
+ * @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 id - The ID of the query patterns report
+ */
+export const getQueryPatternsReport = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetQueryPatternsReportInput,
+    outputSchema: GetQueryPatternsReportOutput,
+    errors: [Forbidden, NotFound] as const,
+  }),
+);

package/src/operations/getQueryPatternsReportStatus.ts

@@ -0,0 +1,54 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetQueryPatternsReportStatusInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    branch: Schema.String.pipe(T.PathParam()),
+    id: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}",
+    }),
+  );
+export type GetQueryPatternsReportStatusInput =
+  typeof GetQueryPatternsReportStatusInput.Type;
+
+// Output Schema
+export const GetQueryPatternsReportStatusOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    state: Schema.Literals(["pending", "completed", "failed"]),
+    created_at: Schema.String,
+    finished_at: Schema.String,
+    url: Schema.String,
+    download_url: Schema.String,
+    actor: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+  });
+export type GetQueryPatternsReportStatusOutput =
+  typeof GetQueryPatternsReportStatusOutput.Type;
+
+// The operation
+/**
+ * Show the status of a query patterns report
+ *
+ * @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 id - The ID of the query patterns report
+ */
+export const getQueryPatternsReportStatus =
+  /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+    inputSchema: GetQueryPatternsReportStatusInput,
+    outputSchema: GetQueryPatternsReportStatusOutput,
+    errors: [Forbidden, NotFound] as const,
+  }));

package/src/operations/getRole.ts

@@ -0,0 +1,89 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetRoleInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  branch: Schema.String.pipe(T.PathParam()),
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
+  }),
+);
+export type GetRoleInput = typeof GetRoleInput.Type;
+
+// Output Schema
+export const GetRoleOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  access_host_url: Schema.String,
+  private_access_host_url: Schema.String,
+  private_connection_service_name: Schema.String,
+  username: Schema.String,
+  password: Schema.String,
+  database_name: Schema.String,
+  created_at: Schema.String,
+  updated_at: Schema.String,
+  deleted_at: Schema.String,
+  expires_at: Schema.String,
+  dropped_at: Schema.String,
+  disabled_at: Schema.String,
+  drop_failed: Schema.String,
+  expired: Schema.Boolean,
+  default: Schema.Boolean,
+  ttl: Schema.Number,
+  inherited_roles: Schema.Array(
+    Schema.Literals([
+      "pscale_managed",
+      "pg_checkpoint",
+      "pg_create_subscription",
+      "pg_maintain",
+      "pg_monitor",
+      "pg_read_all_data",
+      "pg_read_all_settings",
+      "pg_read_all_stats",
+      "pg_signal_backend",
+      "pg_stat_scan_tables",
+      "pg_use_reserved_connections",
+      "pg_write_all_data",
+      "postgres",
+    ]),
+  ),
+  branch: Schema.Struct({
+    id: Schema.String,
+    name: 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,
+  }),
+  query_safety_settings: Schema.Struct({
+    require_where_on_delete: Schema.Literals(["off", "warn", "on"]),
+    require_where_on_update: Schema.Literals(["off", "warn", "on"]),
+  }),
+});
+export type GetRoleOutput = typeof GetRoleOutput.Type;
+
+// The operation
+/**
+ * Get a role
+ *
+ * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
+ * @param database - Database name slug from `list_databases`. Example: `app-db`.
+ * @param branch - Branch name from `list_branches`. Example: `main`.
+ * @param id - The ID of the role
+ */
+export const getRole = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetRoleInput,
+  outputSchema: GetRoleOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/getSchemaRecommendation.ts

@@ -0,0 +1,75 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetSchemaRecommendationInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    number: Schema.Number.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/schema-recommendations/{number}",
+    }),
+  );
+export type GetSchemaRecommendationInput =
+  typeof GetSchemaRecommendationInput.Type;
+
+// Output Schema
+export const GetSchemaRecommendationOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    html_url: Schema.String,
+    title: Schema.String,
+    table_name: Schema.String,
+    keyspace: Schema.String,
+    ddl_statement: Schema.String,
+    number: Schema.Number,
+    state: Schema.Literals(["open", "applied", "dismissed", "stale"]),
+    recommendation_type: Schema.Literals([
+      "unused_table",
+      "unused_index",
+      "duplicate_index",
+      "sequence_overflow",
+      "sequence_overflow_foreign_key",
+      "new_index",
+      "encoding_upgrade",
+      "bloated_table",
+      "bloated_index",
+    ]),
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    applied_at: Schema.String,
+    dismissed_at: Schema.String,
+    closed_by_deploy_request: Schema.Struct({
+      id: Schema.String,
+      branch_id: Schema.String,
+      number: Schema.Number,
+    }),
+    dismissed_by: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+  });
+export type GetSchemaRecommendationOutput =
+  typeof GetSchemaRecommendationOutput.Type;
+
+// The operation
+/**
+ * Get a schema recommendation
+ *
+ * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
+ * @param database - Database name slug from `list_databases`. Example: `app-db`.
+ * @param number - Schema recommendation sequence number. Example: `42`.
+ */
+export const getSchemaRecommendation = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: GetSchemaRecommendationInput,
+    outputSchema: GetSchemaRecommendationOutput,
+    errors: [Forbidden, NotFound] as const,
+  }),
+);

package/src/operations/getServiceToken.ts

@@ -0,0 +1,131 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+import { SensitiveString } from "../sensitive";
+
+// Input Schema
+export const GetServiceTokenInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/service-tokens/{id}",
+  }),
+);
+export type GetServiceTokenInput = typeof GetServiceTokenInput.Type;
+
+// Output Schema
+export const GetServiceTokenOutput = /*@__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 GetServiceTokenOutput = typeof GetServiceTokenOutput.Type;
+
+// The operation
+/**
+ * Get a service token
+ *
+ * Get information about a service token.
+ *
+ * @param organization - The name of the organization
+ * @param id - The ID of the service token
+ */
+export const getServiceToken = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetServiceTokenInput,
+  outputSchema: GetServiceTokenOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/getWebhook.ts

@@ -0,0 +1,68 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetWebhookInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/databases/{database}/webhooks/{id}",
+  }),
+);
+export type GetWebhookInput = typeof GetWebhookInput.Type;
+
+// Output Schema
+export const GetWebhookOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String,
+  url: Schema.String,
+  secret: Schema.String,
+  enabled: Schema.Boolean,
+  last_sent_result: Schema.NullOr(Schema.String),
+  last_sent_success: Schema.NullOr(Schema.Boolean),
+  last_sent_at: Schema.NullOr(Schema.String),
+  created_at: Schema.String,
+  updated_at: Schema.String,
+  events: Schema.Array(
+    Schema.Literals([
+      "branch.ready",
+      "branch.anomaly",
+      "branch.out_of_memory",
+      "branch.primary_promoted",
+      "branch.schema_recommendation",
+      "branch.sleeping",
+      "branch.start_maintenance",
+      "cluster.storage",
+      "database.access_request",
+      "deploy_request.closed",
+      "deploy_request.errored",
+      "deploy_request.in_progress",
+      "deploy_request.opened",
+      "deploy_request.pending_cutover",
+      "deploy_request.queued",
+      "deploy_request.reverted",
+      "deploy_request.schema_applied",
+      "keyspace.storage",
+      "webhook.test",
+    ]),
+  ),
+});
+export type GetWebhookOutput = typeof GetWebhookOutput.Type;
+
+// The operation
+/**
+ * Get a webhook
+ *
+ * @param organization - The name of the organization
+ * @param database - The name of the database
+ * @param id - The ID of the webhook
+ */
+export const getWebhook = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetWebhookInput,
+  outputSchema: GetWebhookOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/getWorkflow.ts

@@ -0,0 +1,161 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const GetWorkflowInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  number: Schema.Number.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/databases/{database}/workflows/{number}",
+  }),
+);
+export type GetWorkflowInput = typeof GetWorkflowInput.Type;
+
+// Output Schema
+export const GetWorkflowOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  number: Schema.Number,
+  state: Schema.Literals([
+    "pending",
+    "copying",
+    "running",
+    "stopped",
+    "verifying_data",
+    "verified_data",
+    "switching_replicas",
+    "switched_replicas",
+    "switching_primaries",
+    "switched_primaries",
+    "reversing_traffic",
+    "reversing_traffic_for_cancel",
+    "cutting_over",
+    "cutover",
+    "reversed_cutover",
+    "completed",
+    "cancelling",
+    "cancelled",
+    "error",
+  ]),
+  created_at: Schema.String,
+  updated_at: Schema.String,
+  started_at: Schema.String,
+  completed_at: Schema.String,
+  cancelled_at: Schema.String,
+  reversed_at: Schema.String,
+  retried_at: Schema.String,
+  data_copy_completed_at: Schema.String,
+  cutover_at: Schema.String,
+  replicas_switched: Schema.Boolean,
+  primaries_switched: Schema.Boolean,
+  switch_replicas_at: Schema.String,
+  switch_primaries_at: Schema.String,
+  verify_data_at: Schema.String,
+  workflow_type: Schema.Literals(["move_tables"]),
+  workflow_subtype: Schema.String,
+  defer_secondary_keys: Schema.Boolean,
+  on_ddl: Schema.Literals(["IGNORE", "STOP", "EXEC", "EXEC_IGNORE"]),
+  workflow_errors: Schema.String,
+  may_retry: Schema.Boolean,
+  may_restart: Schema.Boolean,
+  verified_data_stale: Schema.Boolean,
+  sequence_tables_applied: Schema.Boolean,
+  actor: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  verify_data_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  reversed_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  switch_replicas_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  switch_primaries_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  cancelled_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  completed_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  retried_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  cutover_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  reversed_cutover_by: Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    avatar_url: Schema.String,
+  }),
+  branch: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    deleted_at: Schema.String,
+  }),
+  source_keyspace: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    deleted_at: Schema.String,
+  }),
+  target_keyspace: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    deleted_at: Schema.String,
+  }),
+  global_keyspace: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    deleted_at: Schema.String,
+  }),
+});
+export type GetWorkflowOutput = typeof GetWorkflowOutput.Type;
+
+// The operation
+/**
+ * Get a workflow
+ *
+ * @param organization - The name of the organization the workflow belongs to
+ * @param database - The name of the database the workflow belongs to
+ * @param number - The sequence number of the workflow
+ */
+export const getWorkflow = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetWorkflowInput,
+  outputSchema: GetWorkflowOutput,
+  errors: [Forbidden, NotFound] as const,
+}));