@distilled.cloud/planetscale 0.19.1 → 0.20.0

package/lib/operations/disableSafeMigrations.d.ts

@@ -70,64 +70,64 @@ export type DisableSafeMigrationsOutput = typeof DisableSafeMigrationsOutput.Typ
  * @param branch - The name of the branch
  */
 export declare const disableSafeMigrations: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly cluster_iops: number | null;
-    readonly cluster_name: string;
+    readonly id: string;
+    readonly name: string;
     readonly created_at: string;
+    readonly updated_at: string;
     readonly deleted_at: string | null;
-    readonly direct_vtgate?: boolean | undefined;
-    readonly has_read_only_replicas: boolean;
-    readonly has_replicas: boolean;
-    readonly html_url: string;
-    readonly id: string;
+    readonly restore_checklist_completed_at: string | null;
+    readonly schema_last_updated_at: string;
     readonly kind: "mysql" | "postgresql";
-    readonly metal: boolean;
     readonly mysql_address?: string | undefined;
     readonly mysql_edge_address?: string | undefined;
-    readonly name: string;
-    readonly parent_branch: string | null;
-    readonly private_edge_connectivity: boolean;
-    readonly production: boolean;
+    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
+    readonly direct_vtgate?: boolean | undefined;
+    readonly vtgate_size?: string | undefined;
+    readonly vtgate_count?: number | undefined;
+    readonly cluster_name: string;
+    readonly cluster_iops: number | null;
     readonly ready: boolean;
-    readonly region: {
-        readonly current_default: boolean;
-        readonly display_name: string;
-        readonly enabled: boolean;
+    readonly schema_ready?: boolean | undefined;
+    readonly metal: boolean;
+    readonly production: boolean;
+    readonly safe_migrations: boolean;
+    readonly sharded?: boolean | undefined;
+    readonly shard_count?: number | undefined;
+    readonly stale_schema: boolean;
+    readonly actor: {
         readonly id: string;
-        readonly location: string;
-        readonly provider: string;
-        readonly public_ip_addresses: readonly string[];
-        readonly slug: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly restore_checklist_completed_at: string | null;
     readonly restored_from_branch: {
-        readonly created_at: string;
-        readonly deleted_at: string;
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     } | null;
-    readonly safe_migrations: boolean;
-    readonly schema_last_updated_at: string;
-    readonly schema_ready?: boolean | undefined;
-    readonly shard_count?: number | undefined;
-    readonly sharded?: boolean | undefined;
-    readonly stale_schema: boolean;
-    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
-    readonly updated_at: string;
+    readonly private_edge_connectivity: boolean;
+    readonly has_replicas: boolean;
+    readonly has_read_only_replicas: boolean;
+    readonly html_url: string;
     readonly url: string;
-    readonly vtgate_count?: number | undefined;
+    readonly region: {
+        readonly id: string;
+        readonly provider: string;
+        readonly enabled: boolean;
+        readonly public_ip_addresses: readonly string[];
+        readonly display_name: string;
+        readonly location: string;
+        readonly slug: string;
+        readonly current_default: boolean;
+    };
+    readonly parent_branch: string | null;
     readonly vtgate_options?: {
         readonly [x: string]: unknown;
     } | undefined;
-    readonly vtgate_size?: string | undefined;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=disableSafeMigrations.d.ts.map

package/lib/operations/dismissSchemaRecommendation.d.ts

@@ -42,33 +42,33 @@ export type DismissSchemaRecommendationOutput = typeof DismissSchemaRecommendati
  * @param reason - The reason for dismissing the recommendation (max 500 characters)
  */
 export declare const dismissSchemaRecommendation: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
     readonly number: number;
-    readonly organization: string;
     readonly reason?: string | undefined;
 }, {
+    readonly id: string;
+    readonly html_url: string;
+    readonly title: string;
+    readonly table_name: string;
+    readonly keyspace: string;
+    readonly ddl_statement: string;
+    readonly number: number;
+    readonly state: "applied" | "dismissed" | "open" | "stale";
+    readonly recommendation_type: "bloated_index" | "bloated_table" | "duplicate_index" | "encoding_upgrade" | "new_index" | "sequence_overflow" | "sequence_overflow_foreign_key" | "unused_index" | "unused_table";
+    readonly created_at: string;
+    readonly updated_at: string;
     readonly applied_at: string;
+    readonly dismissed_at: string;
     readonly closed_by_deploy_request: {
-        readonly branch_id: string;
         readonly id: string;
+        readonly branch_id: string;
         readonly number: number;
     };
-    readonly created_at: string;
-    readonly ddl_statement: string;
-    readonly dismissed_at: string;
     readonly dismissed_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly html_url: string;
-    readonly id: string;
-    readonly keyspace: string;
-    readonly number: number;
-    readonly recommendation_type: "bloated_index" | "bloated_table" | "duplicate_index" | "encoding_upgrade" | "new_index" | "sequence_overflow" | "sequence_overflow_foreign_key" | "unused_index" | "unused_table";
-    readonly state: "applied" | "dismissed" | "open" | "stale";
-    readonly table_name: string;
-    readonly title: string;
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=dismissSchemaRecommendation.d.ts.map

package/lib/operations/enableSafeMigrations.d.ts

@@ -70,64 +70,64 @@ export type EnableSafeMigrationsOutput = typeof EnableSafeMigrationsOutput.Type;
  * @param branch - The name of the branch
  */
 export declare const enableSafeMigrations: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly cluster_iops: number | null;
-    readonly cluster_name: string;
+    readonly id: string;
+    readonly name: string;
     readonly created_at: string;
+    readonly updated_at: string;
     readonly deleted_at: string | null;
-    readonly direct_vtgate?: boolean | undefined;
-    readonly has_read_only_replicas: boolean;
-    readonly has_replicas: boolean;
-    readonly html_url: string;
-    readonly id: string;
+    readonly restore_checklist_completed_at: string | null;
+    readonly schema_last_updated_at: string;
     readonly kind: "mysql" | "postgresql";
-    readonly metal: boolean;
     readonly mysql_address?: string | undefined;
     readonly mysql_edge_address?: string | undefined;
-    readonly name: string;
-    readonly parent_branch: string | null;
-    readonly private_edge_connectivity: boolean;
-    readonly production: boolean;
+    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
+    readonly direct_vtgate?: boolean | undefined;
+    readonly vtgate_size?: string | undefined;
+    readonly vtgate_count?: number | undefined;
+    readonly cluster_name: string;
+    readonly cluster_iops: number | null;
     readonly ready: boolean;
-    readonly region: {
-        readonly current_default: boolean;
-        readonly display_name: string;
-        readonly enabled: boolean;
+    readonly schema_ready?: boolean | undefined;
+    readonly metal: boolean;
+    readonly production: boolean;
+    readonly safe_migrations: boolean;
+    readonly sharded?: boolean | undefined;
+    readonly shard_count?: number | undefined;
+    readonly stale_schema: boolean;
+    readonly actor: {
         readonly id: string;
-        readonly location: string;
-        readonly provider: string;
-        readonly public_ip_addresses: readonly string[];
-        readonly slug: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly restore_checklist_completed_at: string | null;
     readonly restored_from_branch: {
-        readonly created_at: string;
-        readonly deleted_at: string;
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     } | null;
-    readonly safe_migrations: boolean;
-    readonly schema_last_updated_at: string;
-    readonly schema_ready?: boolean | undefined;
-    readonly shard_count?: number | undefined;
-    readonly sharded?: boolean | undefined;
-    readonly stale_schema: boolean;
-    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
-    readonly updated_at: string;
+    readonly private_edge_connectivity: boolean;
+    readonly has_replicas: boolean;
+    readonly has_read_only_replicas: boolean;
+    readonly html_url: string;
     readonly url: string;
-    readonly vtgate_count?: number | undefined;
+    readonly region: {
+        readonly id: string;
+        readonly provider: string;
+        readonly enabled: boolean;
+        readonly public_ip_addresses: readonly string[];
+        readonly display_name: string;
+        readonly location: string;
+        readonly slug: string;
+        readonly current_default: boolean;
+    };
+    readonly parent_branch: string | null;
     readonly vtgate_options?: {
         readonly [x: string]: unknown;
     } | undefined;
-    readonly vtgate_size?: string | undefined;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=enableSafeMigrations.d.ts.map

package/lib/operations/getBackup.d.ts

@@ -78,69 +78,69 @@ export type GetBackupOutput = typeof GetBackupOutput.Type;
  * @param branch - The name of the branch
  */
 export declare const getBackup: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly id: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
 }, {
+    readonly id: string;
+    readonly name: string;
+    readonly state: "canceled" | "failed" | "ignored" | "pending" | "running" | "success";
+    readonly size: number;
+    readonly estimated_storage_cost: number;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly started_at: string | null;
+    readonly expires_at: string | null;
+    readonly completed_at: string | null;
+    readonly deleted_at: string | null;
+    readonly pvc_size: number;
+    readonly protected: boolean;
+    readonly required: boolean;
+    readonly restored_branches: readonly {
+        readonly id: string;
+        readonly name: string;
+        readonly created_at: string;
+        readonly updated_at: string;
+        readonly deleted_at: string | null;
+    }[];
     readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
     readonly backup_policy: {
-        readonly created_at: string;
-        readonly display_name: string;
-        readonly frequency_unit: string;
-        readonly frequency_value: number;
         readonly id: string;
-        readonly last_ran_at: string | null;
+        readonly display_name: string;
         readonly name: string;
-        readonly next_run_at: string | null;
-        readonly required: boolean;
-        readonly retention_unit: string;
+        readonly target: "development" | "production";
         readonly retention_value: number;
-        readonly schedule_day: number;
+        readonly retention_unit: string;
+        readonly frequency_value: number;
+        readonly frequency_unit: string;
         readonly schedule_time: string | null;
+        readonly schedule_day: number;
         readonly schedule_week: number;
-        readonly target: "development" | "production";
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly last_ran_at: string | null;
+        readonly next_run_at: string | null;
+        readonly required: boolean;
     } | null;
-    readonly completed_at: string | null;
-    readonly created_at: string;
-    readonly database_branch: {
-        readonly created_at: string;
-        readonly deleted_at: string | null;
+    readonly schema_snapshot: {
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly linted_at: string | null;
+        readonly url: string;
     };
-    readonly deleted_at: string | null;
-    readonly estimated_storage_cost: number;
-    readonly expires_at: string | null;
-    readonly id: string;
-    readonly name: string;
-    readonly protected: boolean;
-    readonly pvc_size: number;
-    readonly required: boolean;
-    readonly restored_branches: readonly {
-        readonly created_at: string;
-        readonly deleted_at: string | null;
+    readonly database_branch: {
         readonly id: string;
         readonly name: string;
-        readonly updated_at: string;
-    }[];
-    readonly schema_snapshot: {
         readonly created_at: string;
-        readonly id: string;
-        readonly linted_at: string | null;
-        readonly name: string;
         readonly updated_at: string;
-        readonly url: string;
+        readonly deleted_at: string | null;
     };
-    readonly size: number;
-    readonly started_at: string | null;
-    readonly state: "canceled" | "failed" | "ignored" | "pending" | "running" | "success";
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getBackup.d.ts.map

package/lib/operations/getBackupPolicy.d.ts

@@ -33,25 +33,25 @@ export type GetBackupPolicyOutput = typeof GetBackupPolicyOutput.Type;
  * @param database - Database name slug from `list_databases`. Example: `app-db`.
  */
 export declare const getBackupPolicy: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly database: string;
     readonly id: string;
     readonly organization: string;
+    readonly database: string;
 }, {
-    readonly created_at: string;
-    readonly display_name: string;
-    readonly frequency_unit: string;
-    readonly frequency_value: number;
     readonly id: string;
-    readonly last_ran_at: string;
+    readonly display_name: string;
     readonly name: string;
-    readonly next_run_at: string;
-    readonly required: boolean;
-    readonly retention_unit: string;
+    readonly target: "development" | "production";
     readonly retention_value: number;
-    readonly schedule_day: number;
+    readonly retention_unit: string;
+    readonly frequency_value: number;
+    readonly frequency_unit: string;
     readonly schedule_time: string;
+    readonly schedule_day: number;
     readonly schedule_week: number;
-    readonly target: "development" | "production";
+    readonly created_at: string;
     readonly updated_at: string;
+    readonly last_ran_at: string;
+    readonly next_run_at: string;
+    readonly required: boolean;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getBackupPolicy.d.ts.map

package/lib/operations/getBouncer.d.ts

@@ -71,62 +71,62 @@ export type GetBouncerOutput = typeof GetBouncerOutput.Type;
  * @param bouncer - The name of the bouncer
  */
 export declare const getBouncer: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly bouncer: string;
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
+    readonly bouncer: string;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
+    readonly id: string;
+    readonly name: string;
+    readonly sku: {
+        readonly name: string;
         readonly display_name: string;
+        readonly cpu: string;
+        readonly ram: number;
+        readonly sort_order: number;
+    };
+    readonly target: "primary" | "replica" | "replica_az_affinity";
+    readonly replicas_per_cell: number;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly deleted_at: string;
+    readonly actor: {
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
     readonly branch: {
-        readonly created_at: string;
-        readonly deleted_at: string;
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     };
-    readonly created_at: string;
-    readonly deleted_at: string;
-    readonly id: string;
-    readonly name: string;
     readonly parameters: readonly {
-        readonly actor: {
-            readonly avatar_url: string;
-            readonly display_name: string;
-            readonly id: string;
-        };
+        readonly id: string;
+        readonly namespace: "pgbouncer";
+        readonly name: string;
+        readonly display_name: string;
         readonly category: string;
-        readonly created_at: string;
-        readonly default_value: string;
         readonly description: string;
-        readonly display_name: string;
-        readonly id: string;
         readonly immutable: boolean;
-        readonly max: number;
-        readonly min: number;
-        readonly name: string;
-        readonly namespace: "pgbouncer";
-        readonly options: readonly string[];
         readonly parameter_type: "array" | "integer" | "seconds" | "select" | "string";
+        readonly default_value: string;
+        readonly value: string;
         readonly required: boolean;
+        readonly created_at: string;
+        readonly updated_at: string;
         readonly restart: boolean;
+        readonly max: number;
+        readonly min: number;
         readonly step: number;
-        readonly updated_at: string;
         readonly url: string;
-        readonly value: string;
+        readonly options: readonly string[];
+        readonly actor: {
+            readonly id: string;
+            readonly display_name: string;
+            readonly avatar_url: string;
+        };
     }[];
-    readonly replicas_per_cell: number;
-    readonly sku: {
-        readonly cpu: string;
-        readonly display_name: string;
-        readonly name: string;
-        readonly ram: number;
-        readonly sort_order: number;
-    };
-    readonly target: "primary" | "replica" | "replica_az_affinity";
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getBouncer.d.ts.map

package/lib/operations/getBranch.d.ts

@@ -70,64 +70,64 @@ export type GetBranchOutput = typeof GetBranchOutput.Type;
  * @param branch - Branch name from `list_branches`. Example: `main`.
  */
 export declare const getBranch: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly cluster_iops: number | null;
-    readonly cluster_name: string;
+    readonly id: string;
+    readonly name: string;
     readonly created_at: string;
+    readonly updated_at: string;
     readonly deleted_at: string | null;
-    readonly direct_vtgate?: boolean | undefined;
-    readonly has_read_only_replicas: boolean;
-    readonly has_replicas: boolean;
-    readonly html_url: string;
-    readonly id: string;
+    readonly restore_checklist_completed_at: string | null;
+    readonly schema_last_updated_at: string;
     readonly kind: "mysql" | "postgresql";
-    readonly metal: boolean;
     readonly mysql_address?: string | undefined;
     readonly mysql_edge_address?: string | undefined;
-    readonly name: string;
-    readonly parent_branch: string | null;
-    readonly private_edge_connectivity: boolean;
-    readonly production: boolean;
+    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
+    readonly direct_vtgate?: boolean | undefined;
+    readonly vtgate_size?: string | undefined;
+    readonly vtgate_count?: number | undefined;
+    readonly cluster_name: string;
+    readonly cluster_iops: number | null;
     readonly ready: boolean;
-    readonly region: {
-        readonly current_default: boolean;
-        readonly display_name: string;
-        readonly enabled: boolean;
+    readonly schema_ready?: boolean | undefined;
+    readonly metal: boolean;
+    readonly production: boolean;
+    readonly safe_migrations: boolean;
+    readonly sharded?: boolean | undefined;
+    readonly shard_count?: number | undefined;
+    readonly stale_schema: boolean;
+    readonly actor: {
         readonly id: string;
-        readonly location: string;
-        readonly provider: string;
-        readonly public_ip_addresses: readonly string[];
-        readonly slug: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly restore_checklist_completed_at: string | null;
     readonly restored_from_branch: {
-        readonly created_at: string;
-        readonly deleted_at: string;
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     } | null;
-    readonly safe_migrations: boolean;
-    readonly schema_last_updated_at: string;
-    readonly schema_ready?: boolean | undefined;
-    readonly shard_count?: number | undefined;
-    readonly sharded?: boolean | undefined;
-    readonly stale_schema: boolean;
-    readonly state: "awakening" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
-    readonly updated_at: string;
+    readonly private_edge_connectivity: boolean;
+    readonly has_replicas: boolean;
+    readonly has_read_only_replicas: boolean;
+    readonly html_url: string;
     readonly url: string;
-    readonly vtgate_count?: number | undefined;
+    readonly region: {
+        readonly id: string;
+        readonly provider: string;
+        readonly enabled: boolean;
+        readonly public_ip_addresses: readonly string[];
+        readonly display_name: string;
+        readonly location: string;
+        readonly slug: string;
+        readonly current_default: boolean;
+    };
+    readonly parent_branch: string | null;
     readonly vtgate_options?: {
         readonly [x: string]: unknown;
     } | undefined;
-    readonly vtgate_size?: string | undefined;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getBranch.d.ts.map