@distilled.cloud/planetscale 0.0.0 → 0.2.3

package/src/operations/listOauthTokens.ts

@@ -0,0 +1,143 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListOauthTokensInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  application_id: Schema.String.pipe(T.PathParam()),
+  page: Schema.optional(Schema.Number),
+  per_page: Schema.optional(Schema.Number),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/oauth-applications/{application_id}/tokens",
+  }),
+);
+export type ListOauthTokensInput = typeof ListOauthTokensInput.Type;
+
+// Output Schema
+export const ListOauthTokensOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  current_page: Schema.Number,
+  next_page: Schema.NullOr(Schema.Number),
+  next_page_url: Schema.NullOr(Schema.String),
+  prev_page: Schema.NullOr(Schema.Number),
+  prev_page_url: Schema.NullOr(Schema.String),
+  data: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      name: Schema.String,
+      display_name: Schema.String,
+      token: Schema.String,
+      plain_text_refresh_token: Schema.String,
+      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 ListOauthTokensOutput = typeof ListOauthTokensOutput.Type;
+
+// The operation
+/**
+ * List OAuth tokens
+ *
+ * List OAuth tokens created by an OAuth application
+ *
+ * @param organization - The name of the organization the OAuth application belongs to
+ * @param application_id - The ID of the OAuth application
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listOauthTokens = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListOauthTokensInput,
+  outputSchema: ListOauthTokensOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/listOrganizationMembers.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 ListOrganizationMembersInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    q: Schema.optional(Schema.String),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
+  }).pipe(
+    T.Http({ method: "GET", path: "/organizations/{organization}/members" }),
+  );
+export type ListOrganizationMembersInput =
+  typeof ListOrganizationMembersInput.Type;
+
+// Output Schema
+export const ListOrganizationMembersOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.NullOr(Schema.Number),
+    next_page_url: Schema.NullOr(Schema.String),
+    prev_page: Schema.NullOr(Schema.Number),
+    prev_page_url: Schema.NullOr(Schema.String),
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        user: Schema.Struct({
+          id: Schema.String,
+          display_name: Schema.String,
+          name: Schema.optional(Schema.NullOr(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.optional(
+            Schema.Struct({
+              id: Schema.String,
+              name: Schema.String,
+              created_at: Schema.String,
+              updated_at: Schema.String,
+              deleted_at: Schema.String,
+            }),
+          ),
+          sso: Schema.optional(Schema.Boolean),
+          managed: Schema.optional(Schema.Boolean),
+          directory_managed: Schema.optional(Schema.Boolean),
+          email_verified: Schema.optional(Schema.Boolean),
+        }),
+        role: Schema.Literals(["member", "admin"]),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+  });
+export type ListOrganizationMembersOutput =
+  typeof ListOrganizationMembersOutput.Type;
+
+// The operation
+/**
+ * List organization members
+ *
+ * @param organization - The name of the organization
+ * @param q - Search term to filter members by name or email
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listOrganizationMembers = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListOrganizationMembersInput,
+    outputSchema: ListOrganizationMembersOutput,
+    errors: [Forbidden, NotFound] as const,
+  }),
+);

package/src/operations/listOrganizationTeamMembers.ts

@@ -0,0 +1,128 @@
+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 ListOrganizationTeamMembersInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    team: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/teams/{team}/members",
+    }),
+  );
+export type ListOrganizationTeamMembersInput =
+  typeof ListOrganizationTeamMembersInput.Type;
+
+// Output Schema
+export const ListOrganizationTeamMembersOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.NullOr(Schema.Number),
+    next_page_url: Schema.NullOr(Schema.String),
+    prev_page: Schema.NullOr(Schema.Number),
+    prev_page_url: Schema.NullOr(Schema.String),
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        user: 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,
+        }),
+        actor: Schema.Struct({
+          id: Schema.String,
+          display_name: Schema.String,
+          avatar_url: Schema.String,
+        }),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        passwords: Schema.Array(
+          Schema.Struct({
+            id: Schema.String,
+            name: Schema.String,
+            role: Schema.Literals(["reader", "writer", "admin", "readwriter"]),
+            cidrs: Schema.Array(Schema.String),
+            created_at: Schema.String,
+            deleted_at: Schema.String,
+            expires_at: Schema.String,
+            last_used_at: Schema.String,
+            expired: Schema.Boolean,
+            direct_vtgate: Schema.Boolean,
+            direct_vtgate_addresses: Schema.Array(Schema.String),
+            ttl_seconds: Schema.Number,
+            access_host_url: Schema.String,
+            access_host_regional_url: Schema.String,
+            access_host_regional_urls: Schema.Array(Schema.String),
+            actor: Schema.Struct({
+              id: Schema.String,
+              display_name: Schema.String,
+              avatar_url: Schema.String,
+            }),
+            region: Schema.Struct({
+              id: Schema.String,
+              provider: Schema.String,
+              enabled: Schema.Boolean,
+              public_ip_addresses: Schema.Array(Schema.String),
+              display_name: Schema.String,
+              location: Schema.String,
+              slug: Schema.String,
+              current_default: Schema.Boolean,
+            }),
+            username: Schema.String,
+            plain_text: Schema.String,
+            replica: Schema.Boolean,
+            renewable: Schema.Boolean,
+            database_branch: Schema.Struct({
+              name: Schema.String,
+              id: Schema.String,
+              production: Schema.Boolean,
+              mysql_edge_address: Schema.String,
+              private_edge_connectivity: Schema.Boolean,
+            }),
+          }),
+        ),
+      }),
+    ),
+  });
+export type ListOrganizationTeamMembersOutput =
+  typeof ListOrganizationTeamMembersOutput.Type;
+
+// The operation
+/**
+ * List team members
+ *
+ * @param organization - The name of the organization
+ * @param team - The slug of the team
+ */
+export const listOrganizationTeamMembers = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListOrganizationTeamMembersInput,
+    outputSchema: ListOrganizationTeamMembersOutput,
+    errors: [BadRequest, Forbidden, NotFound, UnprocessableEntity] as const,
+  }),
+);

package/src/operations/listOrganizationTeams.ts

@@ -0,0 +1,94 @@
+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 ListOrganizationTeamsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    q: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({ method: "GET", path: "/organizations/{organization}/teams" }),
+  );
+export type ListOrganizationTeamsInput = typeof ListOrganizationTeamsInput.Type;
+
+// Output Schema
+export const ListOrganizationTeamsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.NullOr(Schema.Number),
+    next_page_url: Schema.NullOr(Schema.String),
+    prev_page: Schema.NullOr(Schema.Number),
+    prev_page_url: Schema.NullOr(Schema.String),
+    data: Schema.Array(
+      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 ListOrganizationTeamsOutput =
+  typeof ListOrganizationTeamsOutput.Type;
+
+// The operation
+/**
+ * List teams in an organization
+ *
+ * @param organization - The name of the organization
+ * @param q - Search term to filter teams by name
+ */
+export const listOrganizationTeams = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListOrganizationTeamsInput,
+    outputSchema: ListOrganizationTeamsOutput,
+    errors: [BadRequest, Forbidden, NotFound, UnprocessableEntity] as const,
+  }),
+);

package/src/operations/listOrganizations.ts

@@ -0,0 +1,63 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListOrganizationsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
+  },
+).pipe(T.Http({ method: "GET", path: "/organizations" }));
+export type ListOrganizationsInput = typeof ListOrganizationsInput.Type;
+
+// Output Schema
+export const ListOrganizationsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.NullOr(Schema.Number),
+    next_page_url: Schema.NullOr(Schema.String),
+    prev_page: Schema.NullOr(Schema.Number),
+    prev_page_url: Schema.NullOr(Schema.String),
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+        billing_email: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        plan: Schema.String,
+        valid_billing_info: Schema.Boolean,
+        sso: Schema.Boolean,
+        sso_directory: Schema.Boolean,
+        single_tenancy: Schema.Boolean,
+        managed_tenancy: Schema.Boolean,
+        has_past_due_invoices: Schema.optional(Schema.Boolean),
+        database_count: Schema.Number,
+        sso_portal_url: Schema.optional(Schema.String),
+        features: Schema.Record(Schema.String, Schema.Unknown),
+        idp_managed_roles: Schema.Boolean,
+        invoice_budget_amount: Schema.String,
+        keyspace_shard_limit: Schema.Number,
+        has_card: Schema.Boolean,
+        payment_info_required: Schema.Boolean,
+      }),
+    ),
+  });
+export type ListOrganizationsOutput = typeof ListOrganizationsOutput.Type;
+
+// The operation
+/**
+ * List organizations
+ *
+ * When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to.
+ *
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listOrganizations = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListOrganizationsInput,
+  outputSchema: ListOrganizationsOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/listParameters.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 ListParametersInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  branch: Schema.String.pipe(T.PathParam()),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/databases/{database}/branches/{branch}/parameters",
+  }),
+);
+export type ListParametersInput = typeof ListParametersInput.Type;
+
+// Output Schema
+export const ListParametersOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    display_name: Schema.String,
+    namespace: Schema.Literals(["patroni", "pgconf", "pgbouncer"]),
+    category: Schema.String,
+    description: Schema.String,
+    extension: Schema.Boolean,
+    immutable: Schema.Boolean,
+    parameter_type: Schema.Literals([
+      "array",
+      "boolean",
+      "bytes",
+      "float",
+      "integer",
+      "seconds",
+      "select",
+      "string",
+      "time",
+    ]),
+    default_value: Schema.String,
+    value: Schema.String,
+    required: Schema.Boolean,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    restart: Schema.Boolean,
+    max: Schema.Number,
+    min: Schema.Number,
+    step: Schema.Number,
+    url: Schema.String,
+    options: Schema.Array(Schema.String),
+    actor: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+  }),
+);
+export type ListParametersOutput = typeof ListParametersOutput.Type;
+
+// The operation
+/**
+ * List cluster parameters
+ *
+ * Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint.
+ *
+ * @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`.
+ */
+export const listParameters = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListParametersInput,
+  outputSchema: ListParametersOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/listPasswords.ts

@@ -0,0 +1,92 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListPasswordsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  organization: Schema.String.pipe(T.PathParam()),
+  database: Schema.String.pipe(T.PathParam()),
+  branch: Schema.String.pipe(T.PathParam()),
+  read_only_region_id: Schema.optional(Schema.String),
+  page: Schema.optional(Schema.Number),
+  per_page: Schema.optional(Schema.Number),
+}).pipe(
+  T.Http({
+    method: "GET",
+    path: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords",
+  }),
+);
+export type ListPasswordsInput = typeof ListPasswordsInput.Type;
+
+// Output Schema
+export const ListPasswordsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  current_page: Schema.Number,
+  next_page: Schema.NullOr(Schema.Number),
+  next_page_url: Schema.NullOr(Schema.String),
+  prev_page: Schema.NullOr(Schema.Number),
+  prev_page_url: Schema.NullOr(Schema.String),
+  data: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      name: Schema.String,
+      role: Schema.Literals(["reader", "writer", "admin", "readwriter"]),
+      cidrs: Schema.NullOr(Schema.Array(Schema.String)),
+      created_at: Schema.String,
+      deleted_at: Schema.NullOr(Schema.String),
+      expires_at: Schema.NullOr(Schema.String),
+      last_used_at: Schema.NullOr(Schema.String),
+      expired: Schema.Boolean,
+      direct_vtgate: Schema.Boolean,
+      direct_vtgate_addresses: Schema.Array(Schema.String),
+      ttl_seconds: Schema.NullOr(Schema.Number),
+      access_host_url: Schema.String,
+      access_host_regional_url: Schema.String,
+      access_host_regional_urls: Schema.Array(Schema.String),
+      actor: Schema.Struct({
+        id: Schema.String,
+        display_name: Schema.String,
+        avatar_url: Schema.String,
+      }),
+      region: Schema.Struct({
+        id: Schema.String,
+        provider: Schema.String,
+        enabled: Schema.Boolean,
+        public_ip_addresses: Schema.Array(Schema.String),
+        display_name: Schema.String,
+        location: Schema.String,
+        slug: Schema.String,
+        current_default: Schema.Boolean,
+      }),
+      username: Schema.String,
+      plain_text: Schema.NullOr(Schema.String),
+      replica: Schema.Boolean,
+      renewable: Schema.Boolean,
+      database_branch: Schema.Struct({
+        name: Schema.String,
+        id: Schema.String,
+        production: Schema.Boolean,
+        mysql_edge_address: Schema.String,
+        private_edge_connectivity: Schema.Boolean,
+      }),
+    }),
+  ),
+});
+export type ListPasswordsOutput = typeof ListPasswordsOutput.Type;
+
+// The operation
+/**
+ * List passwords
+ *
+ * @param organization - The name of the organization the password belongs to
+ * @param database - The name of the database the password belongs to
+ * @param branch - The name of the branch the password belongs to
+ * @param read_only_region_id - A read-only region of the database branch. If present, the password results will be filtered to only those in the region
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listPasswords = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListPasswordsInput,
+  outputSchema: ListPasswordsOutput,
+  errors: [Forbidden, NotFound] as const,
+}));