@distilled.cloud/planetscale 0.19.1 → 0.20.0

package/lib/operations/getBranchChangeRequest.d.ts

@@ -55,50 +55,50 @@ export type GetBranchChangeRequestOutput = typeof GetBranchChangeRequestOutput.T
  * @param id - The ID of the change request
  */
 export declare const getBranchChangeRequest: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
+    readonly organization: string;
     readonly database: string;
+    readonly branch: string;
     readonly id: string;
-    readonly organization: string;
 }, {
+    readonly id: string;
+    readonly restart: readonly number[];
+    readonly state: "canceled" | "completed" | "pending" | "queued" | "resizing";
+    readonly started_at: string;
+    readonly completed_at: string;
+    readonly created_at: string;
+    readonly updated_at: string;
     readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
+    readonly cluster_name: string;
     readonly cluster_display_name: string;
     readonly cluster_metal: boolean;
-    readonly cluster_name: string;
-    readonly completed_at: string;
-    readonly created_at: string;
-    readonly id: string;
-    readonly maximum_storage_bytes: number;
-    readonly minimum_storage_bytes: number;
+    readonly replicas: number;
     readonly parameters: {
         readonly [x: string]: unknown;
     };
+    readonly previous_cluster_name: string;
     readonly previous_cluster_display_name: string;
     readonly previous_cluster_metal: boolean;
-    readonly previous_cluster_name: string;
-    readonly previous_maximum_storage_bytes: number;
-    readonly previous_minimum_storage_bytes: number;
+    readonly previous_replicas: number;
     readonly previous_parameters: {
         readonly [x: string]: unknown;
     };
-    readonly previous_replicas: number;
-    readonly previous_storage_autoscaling: boolean;
-    readonly previous_storage_iops: number;
-    readonly previous_storage_shrinking: boolean;
-    readonly previous_storage_throughput_mibs: number;
-    readonly previous_storage_type: string;
-    readonly replicas: number;
-    readonly restart: readonly number[];
-    readonly started_at: string;
-    readonly state: "canceled" | "completed" | "pending" | "queued" | "resizing";
+    readonly minimum_storage_bytes: number;
+    readonly maximum_storage_bytes: number;
     readonly storage_autoscaling: boolean;
-    readonly storage_iops: number;
     readonly storage_shrinking: boolean;
-    readonly storage_throughput_mibs: number;
     readonly storage_type: "gp3" | "io2" | "pd_ssd";
-    readonly updated_at: string;
+    readonly storage_iops: number;
+    readonly storage_throughput_mibs: number;
+    readonly previous_minimum_storage_bytes: number;
+    readonly previous_maximum_storage_bytes: number;
+    readonly previous_storage_autoscaling: boolean;
+    readonly previous_storage_shrinking: boolean;
+    readonly previous_storage_type: string;
+    readonly previous_storage_iops: number;
+    readonly previous_storage_throughput_mibs: number;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getBranchChangeRequest.d.ts.map

package/lib/operations/getBranchSchema.d.ts

@@ -26,15 +26,15 @@ export type GetBranchSchemaOutput = typeof GetBranchSchemaOutput.Type;
  * @param namespace - Return the schema for a PostgreSQL catalog namespace in `<database>.<schema>` format (e.g. public.schema1)
  */
 export declare const getBranchSchema: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
+    readonly organization: string;
     readonly database: string;
+    readonly branch: string;
     readonly keyspace?: string | undefined;
     readonly namespace?: string | undefined;
-    readonly organization: string;
 }, {
     readonly data: readonly {
-        readonly html: string;
         readonly name: string;
+        readonly html: string;
         readonly raw: string;
     }[];
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;

package/lib/operations/getCurrentUser.d.ts

@@ -30,24 +30,24 @@ export type GetCurrentUserOutput = typeof GetCurrentUserOutput.Type;
  * Get the user associated with this service token
  */
 export declare const getCurrentUser: import("@distilled.cloud/core/client").OperationMethod<{}, {
+    readonly id: string;
+    readonly display_name: string;
+    readonly name?: string | null | undefined;
+    readonly email: string;
     readonly avatar_url: string;
     readonly created_at: string;
+    readonly updated_at: string;
+    readonly two_factor_auth_configured: boolean;
     readonly default_organization?: {
-        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;
     } | undefined;
+    readonly sso?: boolean | undefined;
+    readonly managed?: boolean | undefined;
     readonly directory_managed?: boolean | undefined;
-    readonly display_name: string;
-    readonly email: string;
     readonly email_verified?: boolean | undefined;
-    readonly id: string;
-    readonly managed?: boolean | undefined;
-    readonly name?: string | null | undefined;
-    readonly sso?: boolean | undefined;
-    readonly two_factor_auth_configured: boolean;
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getCurrentUser.d.ts.map

package/lib/operations/getDatabase.d.ts

@@ -75,68 +75,68 @@ export type GetDatabaseOutput = typeof GetDatabaseOutput.Type;
  * @param database - Database name slug from `list_databases`. Example: `app-db`.
  */
 export declare const getDatabase: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
 }, {
-    readonly allow_data_branching?: boolean | undefined;
+    readonly id: string;
+    readonly url: string;
+    readonly branches_url: string;
+    readonly branches_count?: number | undefined;
+    readonly open_schema_recommendations_count?: number | undefined;
+    readonly development_branches_count?: number | undefined;
+    readonly production_branches_count?: number | undefined;
+    readonly issues_count?: number | undefined;
+    readonly multiple_admins_required_for_deletion?: boolean | undefined;
+    readonly ready: boolean;
     readonly at_backup_restore_branches_limit?: boolean | undefined;
     readonly at_development_branch_usage_limit?: boolean | undefined;
-    readonly automatic_migrations?: boolean | null | undefined;
-    readonly branches_count?: number | undefined;
-    readonly branches_url: string;
-    readonly config_change_queued?: boolean | undefined;
-    readonly config_changing?: boolean | undefined;
-    readonly created_at: string;
     readonly data_import?: {
+        readonly state: string;
+        readonly import_check_errors: string;
+        readonly started_at: string;
+        readonly finished_at: string;
         readonly data_source: {
-            readonly database: string;
             readonly hostname: string;
             readonly port: number;
+            readonly database: string;
         };
-        readonly finished_at: string;
-        readonly import_check_errors: string;
-        readonly started_at: string;
-        readonly state: string;
     } | null | undefined;
-    readonly default_branch?: string | undefined;
-    readonly default_branch_read_only_regions_count?: number | undefined;
-    readonly default_branch_shard_count?: number | undefined;
-    readonly default_branch_table_count?: number | undefined;
-    readonly development_branches_count?: number | undefined;
-    readonly foreign_keys_enabled?: boolean | undefined;
-    readonly html_url: string;
-    readonly id: string;
-    readonly insights_enabled?: boolean | undefined;
-    readonly insights_raw_queries?: boolean | undefined;
-    readonly issues_count?: number | undefined;
-    readonly kind: "mysql" | "postgresql";
-    readonly migration_framework?: string | null | undefined;
-    readonly migration_table_name?: string | null | undefined;
-    readonly multiple_admins_required_for_deletion?: boolean | undefined;
-    readonly name: string;
-    readonly open_schema_recommendations_count?: number | undefined;
-    readonly plan?: string | undefined;
-    readonly production_branch_web_console?: boolean | undefined;
-    readonly production_branches_count?: number | undefined;
-    readonly ready: boolean;
     readonly region: {
-        readonly current_default: boolean;
-        readonly display_name: string;
-        readonly enabled: boolean;
         readonly id: string;
-        readonly location: 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 html_url: string;
+    readonly name: string;
+    readonly state: "awakening" | "import_ready" | "importing" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
+    readonly sharded?: boolean | undefined;
+    readonly default_branch_shard_count?: number | undefined;
+    readonly default_branch_read_only_regions_count?: number | undefined;
+    readonly default_branch_table_count?: number | undefined;
+    readonly default_branch?: string | undefined;
     readonly require_approval_for_deploy?: boolean | undefined;
-    readonly resize_queued?: boolean | undefined;
     readonly resizing?: boolean | undefined;
+    readonly resize_queued?: boolean | undefined;
+    readonly config_changing?: boolean | undefined;
+    readonly config_change_queued?: boolean | undefined;
+    readonly allow_data_branching?: boolean | undefined;
+    readonly foreign_keys_enabled?: boolean | undefined;
+    readonly automatic_migrations?: boolean | null | undefined;
     readonly restrict_branch_region?: boolean | undefined;
-    readonly schema_last_updated_at?: string | undefined;
-    readonly sharded?: boolean | undefined;
-    readonly state: "awakening" | "import_ready" | "importing" | "pending" | "ready" | "sleep_in_progress" | "sleeping";
+    readonly insights_raw_queries?: boolean | undefined;
+    readonly plan?: string | undefined;
+    readonly insights_enabled?: boolean | undefined;
+    readonly production_branch_web_console?: boolean | undefined;
+    readonly migration_table_name?: string | null | undefined;
+    readonly migration_framework?: string | null | undefined;
+    readonly created_at: string;
     readonly updated_at: string;
-    readonly url: string;
+    readonly schema_last_updated_at?: string | undefined;
+    readonly kind: "mysql" | "postgresql";
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getDatabase.d.ts.map

package/lib/operations/getDatabasePostgresCidr.d.ts

@@ -29,21 +29,21 @@ export type GetDatabasePostgresCidrOutput = typeof GetDatabasePostgresCidrOutput
  * @param id - The ID of the IP restriction entry
  */
 export declare const getDatabasePostgresCidr: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
     readonly id: string;
-    readonly organization: string;
 }, {
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly cidrs: readonly string[];
-    readonly created_at: string;
-    readonly deleted_at: string;
     readonly id: string;
-    readonly role: string;
     readonly schema: string;
+    readonly role: string;
+    readonly cidrs: readonly string[];
+    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;
+    };
 }, Forbidden | NotFound | UnprocessableEntity, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getDatabasePostgresCidr.d.ts.map

package/lib/operations/getDatabaseThrottler.d.ts

@@ -27,20 +27,20 @@ export type GetDatabaseThrottlerOutput = typeof GetDatabaseThrottlerOutput.Type;
  * @param database - The name of the database that the throttled deploy requests belong to
  */
 export declare const getDatabaseThrottler: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
 }, {
+    readonly keyspaces: readonly string[];
     readonly configurable: {
-        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 configurations: readonly {
         readonly keyspace_name: string;
         readonly ratio: number;
     }[];
-    readonly keyspaces: readonly string[];
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getDatabaseThrottler.d.ts.map

package/lib/operations/getDefaultRole.d.ts

@@ -52,44 +52,44 @@ export type GetDefaultRoleOutput = typeof GetDefaultRoleOutput.Type;
  * @param branch - Branch name from `list_branches`. Example: `main`.
  */
 export declare const getDefaultRole: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: string;
 }, {
+    readonly id: string;
+    readonly name: string;
     readonly access_host_url: string;
-    readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly branch: {
-        readonly created_at: string;
-        readonly deleted_at: string | null;
-        readonly id: string;
-        readonly name: string;
-        readonly updated_at: string;
-    };
-    readonly created_at: string;
+    readonly private_access_host_url: string;
+    readonly private_connection_service_name: string;
+    readonly username: string;
+    readonly password: string | import("effect/Redacted").Redacted<string> | null;
     readonly database_name: string;
-    readonly default: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
     readonly deleted_at: string | null;
+    readonly expires_at: string | null;
+    readonly dropped_at: string | null;
     readonly disabled_at: string | null;
     readonly drop_failed: string | null;
-    readonly dropped_at: string | null;
     readonly expired: boolean;
-    readonly expires_at: string | null;
-    readonly id: string;
+    readonly default: boolean;
+    readonly ttl: number | null;
     readonly inherited_roles: readonly ("pg_checkpoint" | "pg_create_subscription" | "pg_maintain" | "pg_monitor" | "pg_read_all_data" | "pg_read_all_settings" | "pg_read_all_stats" | "pg_signal_backend" | "pg_stat_scan_tables" | "pg_use_reserved_connections" | "pg_write_all_data" | "postgres" | "pscale_managed")[];
-    readonly name: string;
-    readonly password: string | import("effect/Redacted").Redacted<string> | null;
-    readonly private_access_host_url: string;
-    readonly private_connection_service_name: string;
+    readonly branch: {
+        readonly id: string;
+        readonly name: string;
+        readonly created_at: string;
+        readonly updated_at: string;
+        readonly deleted_at: string | null;
+    };
+    readonly actor: {
+        readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
+    };
     readonly query_safety_settings: {
         readonly require_where_on_delete: "off" | "on" | "warn";
         readonly require_where_on_update: "off" | "on" | "warn";
     };
-    readonly ttl: number | null;
-    readonly updated_at: string;
-    readonly username: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getDefaultRole.d.ts.map

package/lib/operations/getDeployQueue.d.ts

@@ -120,121 +120,121 @@ export type GetDeployQueueOutput = typeof GetDeployQueueOutput.Type;
  * @param per_page - If provided, specifies the number of returned results
  */
 export declare const getDeployQueue: import("@distilled.cloud/core/client").PaginatedOperationMethod<{
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
     readonly page?: number | undefined;
     readonly per_page?: number | undefined;
 }, {
     readonly current_page: number;
+    readonly next_page: number | null;
+    readonly next_page_url: string | null;
+    readonly prev_page: number | null;
+    readonly prev_page_url: string | null;
     readonly data: readonly {
-        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 next_page: number | null;
-    readonly next_page_url: string | null;
-    readonly prev_page: number | null;
-    readonly prev_page_url: string | null;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getDeployQueue.d.ts.map