@distilled.cloud/planetscale 0.19.1 → 0.20.0

package/lib/operations/updateAutoDeleteBranch.d.ts

@@ -150,151 +150,151 @@ export type UpdateAutoDeleteBranchOutput = typeof UpdateAutoDeleteBranchOutput.T
  * @param enable - Whether or not to enable auto-delete branch for the deploy request
  */
 export declare const updateAutoDeleteBranch: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
-    readonly enable?: boolean | undefined;
     readonly number: number;
-    readonly organization: string;
+    readonly enable?: boolean | undefined;
 }, {
+    readonly id: string;
+    readonly number: number;
     readonly actor: {
-        readonly avatar_url: string;
+        readonly id: string;
         readonly display_name: string;
+        readonly avatar_url: string;
+    };
+    readonly closed_by: {
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly approved: boolean;
     readonly branch: string;
+    readonly branch_id: string;
     readonly branch_deleted: boolean;
-    readonly branch_deleted_at: string;
     readonly branch_deleted_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
-    };
-    readonly branch_id: string;
-    readonly closed_at: string;
-    readonly closed_by: {
-        readonly avatar_url: string;
         readonly display_name: string;
-        readonly id: string;
+        readonly avatar_url: string;
     };
-    readonly created_at: string;
-    readonly deployed_at: string;
+    readonly branch_deleted_at: string;
+    readonly into_branch: string;
+    readonly into_branch_sharded: boolean;
+    readonly into_branch_shard_count: number;
+    readonly approved: boolean;
+    readonly state: "closed" | "open";
+    readonly deployment_state: "cancelled" | "complete" | "complete_cancel" | "complete_error" | "complete_pending_revert" | "complete_revert" | "complete_revert_error" | "error" | "in_progress" | "in_progress_cancel" | "in_progress_cutover" | "in_progress_revert" | "in_progress_revert_vschema" | "in_progress_vschema" | "no_changes" | "pending" | "pending_cutover" | "queued" | "ready" | "submitting";
     readonly deployment: {
-        readonly actor: {
-            readonly avatar_url: string;
-            readonly display_name: string;
-            readonly id: string;
-        };
+        readonly id: string;
         readonly auto_cutover: boolean;
         readonly auto_delete_branch: boolean;
-        readonly cancelled_actor: {
-            readonly avatar_url: string;
-            readonly display_name: string;
-            readonly id: string;
-        };
         readonly created_at: string;
-        readonly cutover_actor: {
-            readonly avatar_url: string;
-            readonly display_name: string;
-            readonly id: string;
-        };
         readonly cutover_at: string;
         readonly cutover_expiring: boolean;
         readonly deploy_check_errors: string;
-        readonly deploy_operation_summaries: readonly {
-            readonly can_drop_data: boolean;
-            readonly created_at: string;
-            readonly ddl_statement: string;
-            readonly deploy_errors: string;
-            readonly eta_seconds: number;
+        readonly finished_at: string;
+        readonly queued_at: string;
+        readonly ready_to_cutover_at: string;
+        readonly started_at: string;
+        readonly state: "cancelled" | "complete" | "complete_cancel" | "complete_error" | "complete_pending_revert" | "complete_revert" | "complete_revert_error" | "error" | "in_progress" | "in_progress_cancel" | "in_progress_cutover" | "in_progress_revert" | "in_progress_revert_vschema" | "in_progress_vschema" | "no_changes" | "pending" | "pending_cutover" | "queued" | "ready" | "submitting";
+        readonly submitted_at: string;
+        readonly updated_at: string;
+        readonly into_branch: string;
+        readonly deploy_request_number: number;
+        readonly deployable: boolean;
+        readonly preceding_deployments: readonly {
+            readonly [x: string]: unknown;
+        }[];
+        readonly deploy_operations: readonly {
             readonly id: string;
+            readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending" | "queued";
             readonly keyspace_name: string;
+            readonly table_name: string;
             readonly operation_name: string;
-            readonly operations: readonly {
-                readonly eta_seconds: number;
-                readonly id: string;
-                readonly progress_percentage: number;
-                readonly shard: string;
-                readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending" | "queued";
-            }[];
+            readonly eta_seconds: number;
             readonly progress_percentage: number;
-            readonly removed_foreign_key_names: readonly string[];
-            readonly shard_count: number;
-            readonly shard_names: readonly string[];
-            readonly sharded: boolean;
-            readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending";
+            readonly deploy_error_docs_url: string;
+            readonly ddl_statement: string;
             readonly syntax_highlighted_ddl: string;
-            readonly table_name: string;
+            readonly created_at: string;
+            readonly updated_at: string;
+            readonly throttled_at: string;
+            readonly can_drop_data: boolean;
+            readonly table_locked: boolean;
             readonly table_recently_used: boolean;
             readonly table_recently_used_at: string;
-            readonly throttled_at: string;
+            readonly removed_foreign_key_names: readonly string[];
+            readonly deploy_errors: string;
         }[];
-        readonly deploy_operations: readonly {
-            readonly can_drop_data: boolean;
+        readonly deploy_operation_summaries: readonly {
+            readonly id: string;
             readonly created_at: string;
-            readonly ddl_statement: string;
-            readonly deploy_error_docs_url: string;
             readonly deploy_errors: string;
+            readonly ddl_statement: string;
             readonly eta_seconds: number;
-            readonly id: string;
             readonly keyspace_name: string;
             readonly operation_name: string;
             readonly progress_percentage: number;
-            readonly removed_foreign_key_names: readonly string[];
-            readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending" | "queued";
+            readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending";
             readonly syntax_highlighted_ddl: string;
-            readonly table_locked: boolean;
             readonly table_name: string;
-            readonly table_recently_used: boolean;
             readonly table_recently_used_at: string;
             readonly throttled_at: string;
-            readonly updated_at: string;
+            readonly removed_foreign_key_names: readonly string[];
+            readonly shard_count: number;
+            readonly shard_names: readonly string[];
+            readonly can_drop_data: boolean;
+            readonly table_recently_used: boolean;
+            readonly sharded: boolean;
+            readonly operations: readonly {
+                readonly id: string;
+                readonly shard: string;
+                readonly state: "cancelled" | "complete" | "error" | "in_progress" | "pending" | "queued";
+                readonly progress_percentage: number;
+                readonly eta_seconds: number;
+            }[];
         }[];
-        readonly deploy_request_number: number;
-        readonly deployable: boolean;
-        readonly deployment_revert_request: {
-            readonly [x: string]: unknown;
-        };
-        readonly finished_at: string;
-        readonly id: string;
-        readonly instant_ddl: boolean;
-        readonly instant_ddl_eligible: boolean;
-        readonly into_branch: string;
         readonly lint_errors: readonly {
             readonly [x: string]: unknown;
         }[];
-        readonly locked_table_name: string;
-        readonly lookup_vindex_operations: readonly {
-            readonly [x: string]: unknown;
-        }[];
-        readonly preceding_deployments: readonly {
+        readonly sequential_diff_dependencies: readonly {
             readonly [x: string]: unknown;
         }[];
-        readonly queued_at: string;
-        readonly ready_to_cutover_at: string;
-        readonly schema_last_updated_at: string;
-        readonly sequential_diff_dependencies: readonly {
+        readonly lookup_vindex_operations: readonly {
             readonly [x: string]: unknown;
         }[];
-        readonly started_at: string;
-        readonly state: "cancelled" | "complete" | "complete_cancel" | "complete_error" | "complete_pending_revert" | "complete_revert" | "complete_revert_error" | "error" | "in_progress" | "in_progress_cancel" | "in_progress_cutover" | "in_progress_revert" | "in_progress_revert_vschema" | "in_progress_vschema" | "no_changes" | "pending" | "pending_cutover" | "queued" | "ready" | "submitting";
-        readonly submitted_at: string;
-        readonly table_locked: boolean;
         readonly throttler_configurations: readonly {
             readonly [x: string]: unknown;
         }[];
-        readonly updated_at: string;
+        readonly deployment_revert_request: {
+            readonly [x: string]: unknown;
+        };
+        readonly actor: {
+            readonly id: string;
+            readonly display_name: string;
+            readonly avatar_url: string;
+        };
+        readonly cutover_actor: {
+            readonly id: string;
+            readonly display_name: string;
+            readonly avatar_url: string;
+        };
+        readonly cancelled_actor: {
+            readonly id: string;
+            readonly display_name: string;
+            readonly avatar_url: string;
+        };
+        readonly schema_last_updated_at: string;
+        readonly table_locked: boolean;
+        readonly locked_table_name: string;
+        readonly instant_ddl: boolean;
+        readonly instant_ddl_eligible: boolean;
     };
-    readonly deployment_state: "cancelled" | "complete" | "complete_cancel" | "complete_error" | "complete_pending_revert" | "complete_revert" | "complete_revert_error" | "error" | "in_progress" | "in_progress_cancel" | "in_progress_cutover" | "in_progress_revert" | "in_progress_revert_vschema" | "in_progress_vschema" | "no_changes" | "pending" | "pending_cutover" | "queued" | "ready" | "submitting";
-    readonly html_body: string;
+    readonly num_comments: number;
     readonly html_url: string;
-    readonly id: string;
-    readonly into_branch: string;
-    readonly into_branch_shard_count: number;
-    readonly into_branch_sharded: boolean;
     readonly notes: string;
-    readonly num_comments: number;
-    readonly number: number;
-    readonly state: "closed" | "open";
+    readonly html_body: string;
+    readonly created_at: string;
     readonly updated_at: string;
+    readonly closed_at: string;
+    readonly deployed_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=updateAutoDeleteBranch.d.ts.map

package/lib/operations/updateBackup.d.ts

@@ -80,70 +80,70 @@ export type UpdateBackupOutput = typeof UpdateBackupOutput.Type;
  * @param protected - Whether the backup is protected from deletion or not
  */
 export declare const updateBackup: 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 protected?: boolean | undefined;
 }, {
+    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=updateBackup.d.ts.map

package/lib/operations/updateBackupPolicy.d.ts

@@ -51,34 +51,34 @@ export type UpdateBackupPolicyOutput = typeof UpdateBackupPolicyOutput.Type;
  * @param schedule_week - Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
  */
 export declare const updateBackupPolicy: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly database: string;
-    readonly frequency_unit?: "day" | "hour" | "month" | "week" | undefined;
-    readonly frequency_value?: number | undefined;
     readonly id: string;
-    readonly name?: string | undefined;
     readonly organization: string;
-    readonly retention_unit?: "day" | "hour" | "month" | "week" | "year" | undefined;
+    readonly database: string;
+    readonly name?: string | undefined;
+    readonly target?: "development" | "production" | undefined;
     readonly retention_value?: number | undefined;
-    readonly schedule_day?: number | undefined;
+    readonly retention_unit?: "day" | "hour" | "month" | "week" | "year" | undefined;
+    readonly frequency_value?: number | undefined;
+    readonly frequency_unit?: "day" | "hour" | "month" | "week" | undefined;
     readonly schedule_time?: string | undefined;
+    readonly schedule_day?: number | undefined;
     readonly schedule_week?: number | undefined;
-    readonly target?: "development" | "production" | undefined;
 }, {
-    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=updateBackupPolicy.d.ts.map

package/lib/operations/updateBouncerResizeRequest.d.ts

@@ -61,55 +61,55 @@ export type UpdateBouncerResizeRequestOutput = typeof UpdateBouncerResizeRequest
  * @param parameters - Bouncer configuration parameters nested by namespace (e.g., {"pgbouncer": {"default_pool_size": "100"}}). Use the 'List cluster parameters' endpoint to retrieve available parameters. Only parameters with namespace 'pgbouncer' can be updated.
  */
 export declare const updateBouncerResizeRequest: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
     readonly bouncer: string;
     readonly bouncer_size?: string | undefined;
-    readonly branch: string;
-    readonly database: string;
-    readonly organization: string;
+    readonly replicas_per_cell?: number | undefined;
     readonly parameters?: {
         readonly [x: string]: unknown;
     } | undefined;
-    readonly replicas_per_cell?: number | undefined;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly bouncer: {
-        readonly created_at: string;
-        readonly deleted_at: string;
-        readonly id: string;
-        readonly name: string;
-        readonly updated_at: string;
-    };
-    readonly completed_at: string;
-    readonly created_at: string;
     readonly id: string;
+    readonly state: "canceled" | "completed" | "pending" | "resizing";
+    readonly replicas_per_cell: number;
     readonly parameters: {
         readonly [x: string]: unknown;
     };
+    readonly previous_replicas_per_cell: number;
     readonly previous_parameters: {
         readonly [x: string]: unknown;
     };
-    readonly previous_replicas_per_cell: number;
-    readonly previous_sku: {
-        readonly cpu: string;
+    readonly started_at: string;
+    readonly completed_at: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly actor: {
+        readonly id: string;
         readonly display_name: string;
+        readonly avatar_url: string;
+    };
+    readonly bouncer: {
+        readonly id: string;
         readonly name: string;
-        readonly ram: number;
-        readonly sort_order: number;
+        readonly created_at: string;
+        readonly updated_at: string;
+        readonly deleted_at: string;
     };
-    readonly replicas_per_cell: number;
     readonly sku: {
-        readonly cpu: string;
+        readonly name: string;
         readonly display_name: string;
+        readonly cpu: string;
+        readonly ram: number;
+        readonly sort_order: number;
+    };
+    readonly previous_sku: {
         readonly name: string;
+        readonly display_name: string;
+        readonly cpu: string;
         readonly ram: number;
         readonly sort_order: number;
     };
-    readonly started_at: string;
-    readonly state: "canceled" | "completed" | "pending" | "resizing";
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=updateBouncerResizeRequest.d.ts.map

package/lib/operations/updateBranch.d.ts

@@ -72,65 +72,65 @@ export type UpdateBranchOutput = typeof UpdateBranchOutput.Type;
  * @param new_name - The name to update the branch
  */
 export declare const updateBranch: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
+    readonly organization: string;
     readonly database: string;
+    readonly branch: string;
     readonly new_name: string;
-    readonly organization: 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=updateBranch.d.ts.map