@distilled.cloud/planetscale 0.8.0 → 0.10.0

package/src/operations/listGeneratedQueryPatternsReports.ts

@@ -9,6 +9,9 @@ export const ListGeneratedQueryPatternsReportsInput =
     organization: Schema.String.pipe(T.PathParam()),
     database: Schema.String.pipe(T.PathParam()),
     branch: Schema.String.pipe(T.PathParam()),
+    starting_after: Schema.optional(Schema.String),
+    ending_before: Schema.optional(Schema.String),
+    limit: Schema.optional(Schema.Number),
   }).pipe(
     T.Http({
       method: "GET",
@@ -51,6 +54,9 @@ export type ListGeneratedQueryPatternsReportsOutput =
  * @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 starting_after - If provided, returns results after the specified cursor
+ * @param ending_before - If provided, returns results before the specified cursor
+ * @param limit - If provided, specifies the number of returned results (max 100)
  */
 export const listGeneratedQueryPatternsReports =
   /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({

package/src/operations/listMaintenanceSchedules.ts

@@ -0,0 +1,71 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListMaintenanceSchedulesInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/maintenance-schedules",
+    }),
+  );
+export type ListMaintenanceSchedulesInput =
+  typeof ListMaintenanceSchedulesInput.Type;
+
+// Output Schema
+export const ListMaintenanceSchedulesOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.Number,
+    next_page_url: Schema.String,
+    prev_page: Schema.Number,
+    prev_page_url: Schema.String,
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        last_window_datetime: Schema.String,
+        next_window_datetime: Schema.String,
+        duration: Schema.Number,
+        day: Schema.Number,
+        hour: Schema.Number,
+        week: Schema.Number,
+        frequency_value: Schema.Number,
+        frequency_unit: Schema.Literals(["day", "week", "month", "once"]),
+        enabled: Schema.Boolean,
+        expires_at: Schema.String,
+        deadline_at: Schema.String,
+        required: Schema.Boolean,
+        pending_vitess_version_update: Schema.Boolean,
+        pending_vitess_version: Schema.String,
+      }),
+    ),
+  });
+export type ListMaintenanceSchedulesOutput =
+  typeof ListMaintenanceSchedulesOutput.Type;
+
+// The operation
+/**
+ * List maintenance schedules
+ *
+ * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
+ * @param database - Database name slug from `list_databases`. Example: `app-db`.
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listMaintenanceSchedules = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListMaintenanceSchedulesInput,
+    outputSchema: ListMaintenanceSchedulesOutput,
+    errors: [Forbidden, NotFound] as const,
+  }),
+);

package/src/operations/listMaintenanceWindows.ts

@@ -0,0 +1,60 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListMaintenanceWindowsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String.pipe(T.PathParam()),
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/maintenance-schedules/{id}/windows",
+    }),
+  );
+export type ListMaintenanceWindowsInput =
+  typeof ListMaintenanceWindowsInput.Type;
+
+// Output Schema
+export const ListMaintenanceWindowsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.Number,
+    next_page_url: Schema.String,
+    prev_page: Schema.Number,
+    prev_page_url: Schema.String,
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+        started_at: Schema.String,
+        finished_at: Schema.String,
+      }),
+    ),
+  });
+export type ListMaintenanceWindowsOutput =
+  typeof ListMaintenanceWindowsOutput.Type;
+
+// The operation
+/**
+ * List maintenance windows
+ *
+ * @param id - The ID of the maintenance schedule
+ * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
+ * @param database - Database name slug from `list_databases`. Example: `app-db`.
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ */
+export const listMaintenanceWindows = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: ListMaintenanceWindowsInput,
+    outputSchema: ListMaintenanceWindowsOutput,
+    errors: [Forbidden, NotFound] as const,
+  }),
+);

package/src/operations/listOrganizationTeamMembers.ts

@@ -14,6 +14,8 @@ export const ListOrganizationTeamMembersInput =
   /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
     organization: Schema.String.pipe(T.PathParam()),
     team: Schema.String.pipe(T.PathParam()),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
   }).pipe(
     T.Http({
       method: "GET",
@@ -119,6 +121,8 @@ export type ListOrganizationTeamMembersOutput =
  *
  * @param organization - The name of the organization
  * @param team - The slug of the team
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
  */
 export const listOrganizationTeamMembers = /*@__PURE__*/ /*#__PURE__*/ API.make(
   () => ({

package/src/operations/listOrganizationTeams.ts

@@ -13,6 +13,8 @@ export const ListOrganizationTeamsInput =
   /*@__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}/teams" }),
   );
@@ -84,6 +86,8 @@ export type ListOrganizationTeamsOutput =
  *
  * @param organization - The name of the organization
  * @param q - Search term to filter teams by name
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
  */
 export const listOrganizationTeams = /*@__PURE__*/ /*#__PURE__*/ API.make(
   () => ({

package/src/operations/listSchemaRecommendations.ts

@@ -9,6 +9,8 @@ export const ListSchemaRecommendationsInput =
     organization: Schema.String.pipe(T.PathParam()),
     database: Schema.String.pipe(T.PathParam()),
     state: Schema.optional(Schema.Literals(["open", "closed"])),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
   }).pipe(
     T.Http({
       method: "GET",
@@ -74,6 +76,8 @@ export type ListSchemaRecommendationsOutput =
  * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
  * @param database - Database name slug from `list_databases`. Example: `app-db`.
  * @param state - Filter by recommendation state
+ * @param page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
  */
 export const listSchemaRecommendations = /*@__PURE__*/ /*#__PURE__*/ API.make(
   () => ({

package/src/operations/listTrafficBudgets.ts

@@ -0,0 +1,96 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const ListTrafficBudgetsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    branch: Schema.String.pipe(T.PathParam()),
+    page: Schema.optional(Schema.Number),
+    per_page: Schema.optional(Schema.Number),
+    period: Schema.optional(Schema.String),
+    created_at: Schema.optional(Schema.String),
+    fingerprint: Schema.optional(Schema.String),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets",
+    }),
+  );
+export type ListTrafficBudgetsInput = typeof ListTrafficBudgetsInput.Type;
+
+// Output Schema
+export const ListTrafficBudgetsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    current_page: Schema.Number,
+    next_page: Schema.Number,
+    next_page_url: Schema.String,
+    prev_page: Schema.Number,
+    prev_page_url: Schema.String,
+    data: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+        mode: Schema.Literals(["enforce", "warn", "off"]),
+        capacity: Schema.optional(Schema.Number),
+        rate: Schema.optional(Schema.Number),
+        burst: Schema.optional(Schema.Number),
+        concurrency: Schema.optional(Schema.Number),
+        warning_threshold: Schema.optional(Schema.Number),
+        actor: Schema.Struct({
+          id: Schema.String,
+          display_name: Schema.String,
+          avatar_url: Schema.String,
+        }),
+        rules: Schema.Array(
+          Schema.Struct({
+            id: Schema.String,
+            kind: Schema.Literals(["match"]),
+            tags: Schema.Array(
+              Schema.Struct({
+                key_id: Schema.String,
+                key: Schema.String,
+                value: Schema.String,
+                source: Schema.Literals(["sql", "system"]),
+              }),
+            ),
+            fingerprint: Schema.optional(Schema.String),
+            keyspace: Schema.optional(Schema.String),
+            actor: Schema.Struct({
+              id: Schema.String,
+              display_name: Schema.String,
+              avatar_url: Schema.String,
+            }),
+            syntax_highlighted_sql: Schema.String,
+            created_at: Schema.String,
+            updated_at: Schema.String,
+          }),
+        ),
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+  });
+export type ListTrafficBudgetsOutput = typeof ListTrafficBudgetsOutput.Type;
+
+// The operation
+/**
+ * List traffic budgets
+ *
+ * @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 page - If provided, specifies the page offset of returned results
+ * @param per_page - If provided, specifies the number of returned results
+ * @param period - Time period filter (e.g., '1h', '24h', '7d')
+ * @param created_at - Filter by creation date range (format: 'start..end')
+ * @param fingerprint - Filter budgets by query fingerprint
+ */
+export const listTrafficBudgets = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListTrafficBudgetsInput,
+  outputSchema: ListTrafficBudgetsOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/updateBackup.ts

@@ -58,6 +58,7 @@ export const UpdateBackupOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
   backup_policy: Schema.NullOr(
     Schema.Struct({
       id: Schema.String,
+      display_name: Schema.String,
       name: Schema.String,
       target: Schema.Literals(["production", "development"]),
       retention_value: Schema.Number,

package/src/operations/updateBackupPolicy.ts

@@ -0,0 +1,76 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const UpdateBackupPolicyInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String.pipe(T.PathParam()),
+    organization: Schema.String.pipe(T.PathParam()),
+    database: Schema.String.pipe(T.PathParam()),
+    name: Schema.optional(Schema.String),
+    target: Schema.optional(Schema.Literals(["production", "development"])),
+    retention_value: Schema.optional(Schema.Number),
+    retention_unit: Schema.optional(
+      Schema.Literals(["hour", "day", "week", "month", "year"]),
+    ),
+    frequency_value: Schema.optional(Schema.Number),
+    frequency_unit: Schema.optional(
+      Schema.Literals(["hour", "day", "week", "month"]),
+    ),
+    schedule_time: Schema.optional(Schema.String),
+    schedule_day: Schema.optional(Schema.Number),
+    schedule_week: Schema.optional(Schema.Number),
+  }).pipe(
+    T.Http({
+      method: "PATCH",
+      path: "/organizations/{organization}/databases/{database}/backup-policies/{id}",
+    }),
+  );
+export type UpdateBackupPolicyInput = typeof UpdateBackupPolicyInput.Type;
+
+// Output Schema
+export const UpdateBackupPolicyOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    display_name: Schema.String,
+    name: Schema.String,
+    target: Schema.Literals(["production", "development"]),
+    retention_value: Schema.Number,
+    retention_unit: Schema.String,
+    frequency_value: Schema.Number,
+    frequency_unit: Schema.String,
+    schedule_time: Schema.String,
+    schedule_day: Schema.Number,
+    schedule_week: Schema.Number,
+    created_at: Schema.String,
+    updated_at: Schema.String,
+    last_ran_at: Schema.String,
+    next_run_at: Schema.String,
+    required: Schema.Boolean,
+  });
+export type UpdateBackupPolicyOutput = typeof UpdateBackupPolicyOutput.Type;
+
+// The operation
+/**
+ * Update a backup policy
+ *
+ * @param id - The ID of the backup policy
+ * @param organization - Organization name slug from `list_organizations`. Example: `acme`.
+ * @param database - Database name slug from `list_databases`. Example: `app-db`.
+ * @param name - The name of the backup policy
+ * @param target - Whether the policy is for production or development branches
+ * @param retention_value - A number value for the retention period of the backup policy
+ * @param retention_unit - The unit for the retention period of the backup policy
+ * @param frequency_value - A number value for the frequency of the backup policy
+ * @param frequency_unit - The unit for the frequency of the backup policy
+ * @param schedule_time - The time of day that the backup is scheduled, in HH:MM format
+ * @param schedule_day - Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
+ * @param schedule_week - Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
+ */
+export const updateBackupPolicy = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateBackupPolicyInput,
+  outputSchema: UpdateBackupPolicyOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/operations/updateTrafficBudget.ts

@@ -0,0 +1,95 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client";
+import * as T from "../traits";
+import { Forbidden, NotFound } from "../errors";
+
+// Input Schema
+export const UpdateTrafficBudgetInput =
+  /*@__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()),
+    name: Schema.optional(Schema.String),
+    mode: Schema.optional(Schema.Literals(["enforce", "warn", "off"])),
+    capacity: Schema.optional(Schema.Number),
+    rate: Schema.optional(Schema.Number),
+    burst: Schema.optional(Schema.Number),
+    concurrency: Schema.optional(Schema.Number),
+    warning_threshold: Schema.optional(Schema.Number),
+    rules: Schema.optional(Schema.Array(Schema.String)),
+  }).pipe(
+    T.Http({
+      method: "PATCH",
+      path: "/organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}",
+    }),
+  );
+export type UpdateTrafficBudgetInput = typeof UpdateTrafficBudgetInput.Type;
+
+// Output Schema
+export const UpdateTrafficBudgetOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    mode: Schema.Literals(["enforce", "warn", "off"]),
+    capacity: Schema.optional(Schema.Number),
+    rate: Schema.optional(Schema.Number),
+    burst: Schema.optional(Schema.Number),
+    concurrency: Schema.optional(Schema.Number),
+    warning_threshold: Schema.optional(Schema.Number),
+    actor: Schema.Struct({
+      id: Schema.String,
+      display_name: Schema.String,
+      avatar_url: Schema.String,
+    }),
+    rules: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        kind: Schema.Literals(["match"]),
+        tags: Schema.Array(
+          Schema.Struct({
+            key_id: Schema.String,
+            key: Schema.String,
+            value: Schema.String,
+            source: Schema.Literals(["sql", "system"]),
+          }),
+        ),
+        fingerprint: Schema.optional(Schema.String),
+        keyspace: Schema.optional(Schema.String),
+        actor: Schema.Struct({
+          id: Schema.String,
+          display_name: Schema.String,
+          avatar_url: Schema.String,
+        }),
+        syntax_highlighted_sql: Schema.String,
+        created_at: Schema.String,
+        updated_at: Schema.String,
+      }),
+    ),
+    created_at: Schema.String,
+    updated_at: Schema.String,
+  });
+export type UpdateTrafficBudgetOutput = typeof UpdateTrafficBudgetOutput.Type;
+
+// The operation
+/**
+ * Update a traffic budget
+ *
+ * @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 traffic budget
+ * @param name - Name of the traffic budget
+ * @param mode - The mode of the traffic budget
+ * @param capacity - The maximum capacity that can be banked, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
+ * @param rate - The rate at which capacity refills, as a percentage of server resources (0-100). Unlimited when not set.
+ * @param burst - The maximum capacity a single query can consume, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
+ * @param concurrency - The percentage of available worker processes this policy can use (0-100). Unlimited when not set.
+ * @param warning_threshold - A percentage of capacity, burst, or concurrency thresholds to emit warnings for enforced budgets (0-100).
+ * @param rules - Array of traffic rules to apply to the budget
+ */
+export const updateTrafficBudget = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: UpdateTrafficBudgetInput,
+  outputSchema: UpdateTrafficBudgetOutput,
+  errors: [Forbidden, NotFound] as const,
+}));

package/src/retry.ts

@@ -5,7 +5,7 @@
  */
 import * as Effect from "effect/Effect";
 import * as Layer from "effect/Layer";
-import * as ServiceMap from "effect/ServiceMap";
+import * as Context from "effect/Context";
 export {
   type Options,
   type Factory,
@@ -21,7 +21,7 @@ import type { Policy } from "@distilled.cloud/core/retry";
 /**
  * Context tag for configuring retry behavior of PlanetScale API calls.
  */
-export class Retry extends ServiceMap.Service<Retry, Policy>()(
+export class Retry extends Context.Service<Retry, Policy>()(
   "PlanetScaleRetry",
 ) {}