@distilled.cloud/planetscale 0.19.1 → 0.20.0

package/lib/operations/getSchemaRecommendation.d.ts

@@ -40,32 +40,32 @@ export type GetSchemaRecommendationOutput = typeof GetSchemaRecommendationOutput
  * @param number - Schema recommendation sequence number. Example: `42`.
  */
 export declare const getSchemaRecommendation: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
     readonly number: number;
-    readonly organization: string;
 }, {
+    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=getSchemaRecommendation.d.ts.map

package/lib/operations/getServiceToken.d.ts

@@ -93,84 +93,84 @@ export type GetServiceTokenOutput = typeof GetServiceTokenOutput.Type;
  * @param id - The ID of the service token
  */
 export declare const getServiceToken: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly id: string;
     readonly organization: string;
+    readonly id: string;
 }, {
-    readonly actor_display_name: string;
-    readonly actor_id: string;
-    readonly actor_type: string;
+    readonly id: string;
+    readonly name?: string | null | undefined;
+    readonly display_name: string;
+    readonly token?: string | import("effect/Redacted").Redacted<string> | null | undefined;
+    readonly plain_text_refresh_token?: string | import("effect/Redacted").Redacted<string> | null | undefined;
     readonly avatar_url: string;
     readonly created_at: string;
-    readonly display_name: string;
+    readonly updated_at: string;
     readonly expires_at?: string | null | undefined;
-    readonly id: string;
     readonly last_used_at?: string | null | undefined;
-    readonly name?: string | null | undefined;
+    readonly actor_id: string;
+    readonly actor_display_name: string;
+    readonly actor_type: string;
+    readonly service_token_accesses?: readonly {
+        readonly id: string;
+        readonly access: string;
+        readonly description: string;
+        readonly resource_name: string;
+        readonly resource_id: string;
+        readonly resource_type: string;
+        readonly resource: {
+            readonly id: string;
+            readonly name: string;
+            readonly created_at: string;
+            readonly updated_at: string;
+            readonly deleted_at: string;
+        };
+    }[] | undefined;
     readonly oauth_accesses_by_resource?: {
-        readonly branch: {
-            readonly accesses: readonly {
-                readonly description: string;
+        readonly database: {
+            readonly databases: readonly {
                 readonly name: string;
-            }[];
-            readonly branches: readonly {
-                readonly database: string;
                 readonly id: string;
-                readonly name: string;
                 readonly organization: string;
                 readonly url: string;
             }[];
-        };
-        readonly database: {
             readonly accesses: readonly {
-                readonly description: string;
                 readonly name: string;
+                readonly description: string;
             }[];
-            readonly databases: readonly {
-                readonly id: string;
+        };
+        readonly organization: {
+            readonly organizations: readonly {
                 readonly name: string;
-                readonly organization: string;
+                readonly id: string;
                 readonly url: string;
             }[];
-        };
-        readonly organization: {
             readonly accesses: readonly {
-                readonly description: string;
                 readonly name: string;
+                readonly description: string;
             }[];
-            readonly organizations: readonly {
-                readonly id: string;
+        };
+        readonly branch: {
+            readonly branches: readonly {
                 readonly name: string;
+                readonly id: string;
+                readonly database: string;
+                readonly organization: string;
                 readonly url: string;
             }[];
-        };
-        readonly user: {
             readonly accesses: readonly {
-                readonly description: string;
                 readonly name: string;
+                readonly description: string;
             }[];
+        };
+        readonly user: {
             readonly users: readonly {
+                readonly name: string;
                 readonly id: string;
+            }[];
+            readonly accesses: readonly {
                 readonly name: string;
+                readonly description: string;
             }[];
         };
     } | undefined;
-    readonly plain_text_refresh_token?: string | import("effect/Redacted").Redacted<string> | null | undefined;
-    readonly service_token_accesses?: readonly {
-        readonly access: string;
-        readonly description: string;
-        readonly id: string;
-        readonly resource: {
-            readonly created_at: string;
-            readonly deleted_at: string;
-            readonly id: string;
-            readonly name: string;
-            readonly updated_at: string;
-        };
-        readonly resource_id: string;
-        readonly resource_name: string;
-        readonly resource_type: string;
-    }[] | undefined;
-    readonly token?: string | import("effect/Redacted").Redacted<string> | null | undefined;
-    readonly updated_at: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getServiceToken.d.ts.map

package/lib/operations/getTrafficBudget.d.ts

@@ -54,45 +54,45 @@ export type GetTrafficBudgetOutput = typeof GetTrafficBudgetOutput.Type;
  * @param id - The ID of the traffic budget
  */
 export declare const getTrafficBudget: 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 actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly burst?: number | undefined;
-    readonly capacity?: number | undefined;
-    readonly concurrency?: number | undefined;
-    readonly created_at: string;
     readonly id: string;
-    readonly mode: "enforce" | "off" | "warn";
     readonly name: string;
+    readonly mode: "enforce" | "off" | "warn";
+    readonly capacity?: number | undefined;
     readonly rate?: number | undefined;
+    readonly burst?: number | undefined;
+    readonly concurrency?: number | undefined;
+    readonly warning_threshold?: number | undefined;
+    readonly actor: {
+        readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
+    };
     readonly rules: readonly {
-        readonly actor: {
-            readonly avatar_url: string;
-            readonly display_name: string;
-            readonly id: string;
-        };
-        readonly created_at: string;
-        readonly fingerprint?: string | undefined;
         readonly id: string;
-        readonly keyspace?: string | undefined;
         readonly kind: "match";
-        readonly syntax_highlighted_sql: string;
         readonly tags: readonly {
-            readonly key: string;
             readonly key_id: string;
-            readonly source: "sql" | "system";
+            readonly key: string;
             readonly value: string;
+            readonly source: "sql" | "system";
         }[];
+        readonly fingerprint?: string | undefined;
+        readonly keyspace?: string | undefined;
+        readonly actor: {
+            readonly id: string;
+            readonly display_name: string;
+            readonly avatar_url: string;
+        };
+        readonly syntax_highlighted_sql: string;
+        readonly created_at: string;
         readonly updated_at: string;
     }[];
+    readonly created_at: string;
     readonly updated_at: string;
-    readonly warning_threshold?: number | undefined;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getTrafficBudget.d.ts.map

package/lib/operations/getWebhook.d.ts

@@ -27,19 +27,19 @@ export type GetWebhookOutput = typeof GetWebhookOutput.Type;
  * @param id - The ID of the webhook
  */
 export declare const getWebhook: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
     readonly id: string;
-    readonly organization: string;
 }, {
-    readonly created_at: string;
-    readonly enabled: boolean;
-    readonly events: readonly ("branch.anomaly" | "branch.out_of_memory" | "branch.primary_promoted" | "branch.ready" | "branch.schema_recommendation" | "branch.sleeping" | "branch.start_maintenance" | "cluster.storage" | "database.access_request" | "deploy_request.closed" | "deploy_request.errored" | "deploy_request.in_progress" | "deploy_request.opened" | "deploy_request.pending_cutover" | "deploy_request.queued" | "deploy_request.reverted" | "deploy_request.schema_applied" | "keyspace.storage" | "webhook.test")[];
     readonly id: string;
-    readonly last_sent_at: string | null;
+    readonly url: string;
+    readonly secret: string | import("effect/Redacted").Redacted<string>;
+    readonly enabled: boolean;
     readonly last_sent_result: string | null;
     readonly last_sent_success: boolean | null;
-    readonly secret: string | import("effect/Redacted").Redacted<string>;
+    readonly last_sent_at: string | null;
+    readonly created_at: string;
     readonly updated_at: string;
-    readonly url: string;
+    readonly events: readonly ("branch.anomaly" | "branch.out_of_memory" | "branch.primary_promoted" | "branch.ready" | "branch.schema_recommendation" | "branch.sleeping" | "branch.start_maintenance" | "cluster.storage" | "database.access_request" | "deploy_request.closed" | "deploy_request.errored" | "deploy_request.in_progress" | "deploy_request.opened" | "deploy_request.pending_cutover" | "deploy_request.queued" | "deploy_request.reverted" | "deploy_request.schema_applied" | "keyspace.storage" | "webhook.test")[];
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getWebhook.d.ts.map

package/lib/operations/getWorkflow.d.ts

@@ -122,114 +122,114 @@ export type GetWorkflowOutput = typeof GetWorkflowOutput.Type;
  * @param number - The sequence number of the workflow
  */
 export declare const getWorkflow: import("@distilled.cloud/core/client").OperationMethod<{
+    readonly organization: string;
     readonly database: string;
     readonly number: number;
-    readonly organization: string;
 }, {
+    readonly id: string;
+    readonly name: string;
+    readonly number: number;
+    readonly state: "cancelled" | "cancelling" | "completed" | "copying" | "cutover" | "cutting_over" | "error" | "pending" | "reversed_cutover" | "reversing_traffic" | "reversing_traffic_for_cancel" | "running" | "stopped" | "switched_primaries" | "switched_replicas" | "switching_primaries" | "switching_replicas" | "verified_data" | "verifying_data";
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly started_at: string;
+    readonly completed_at: string;
+    readonly cancelled_at: string;
+    readonly reversed_at: string;
+    readonly retried_at: string;
+    readonly data_copy_completed_at: string;
+    readonly cutover_at: string;
+    readonly replicas_switched: boolean;
+    readonly primaries_switched: boolean;
+    readonly switch_replicas_at: string;
+    readonly switch_primaries_at: string;
+    readonly verify_data_at: string;
+    readonly workflow_type: "move_tables";
+    readonly workflow_subtype: string;
+    readonly defer_secondary_keys: boolean;
+    readonly on_ddl: "EXEC" | "EXEC_IGNORE" | "IGNORE" | "STOP";
+    readonly workflow_errors: string;
+    readonly may_retry: boolean;
+    readonly may_restart: boolean;
+    readonly verified_data_stale: boolean;
+    readonly sequence_tables_applied: boolean;
     readonly actor: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly branch: {
-        readonly created_at: string;
-        readonly deleted_at: string;
+    readonly verify_data_by: {
         readonly id: string;
-        readonly name: string;
-        readonly updated_at: string;
-    };
-    readonly cancelled_at: string;
-    readonly cancelled_by: {
-        readonly avatar_url: string;
         readonly display_name: string;
-        readonly id: string;
-    };
-    readonly completed_at: string;
-    readonly completed_by: {
         readonly avatar_url: string;
-        readonly display_name: string;
+    };
+    readonly reversed_by: {
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly created_at: string;
-    readonly cutover_at: string;
-    readonly cutover_by: {
+    readonly switch_replicas_by: {
+        readonly id: string;
+        readonly display_name: string;
         readonly avatar_url: string;
+    };
+    readonly switch_primaries_by: {
+        readonly id: string;
         readonly display_name: string;
+        readonly avatar_url: string;
+    };
+    readonly cancelled_by: {
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly data_copy_completed_at: string;
-    readonly defer_secondary_keys: boolean;
-    readonly global_keyspace: {
-        readonly created_at: string;
-        readonly deleted_at: string;
+    readonly completed_by: {
         readonly id: string;
-        readonly name: string;
-        readonly updated_at: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly id: string;
-    readonly may_restart: boolean;
-    readonly may_retry: boolean;
-    readonly name: string;
-    readonly number: number;
-    readonly on_ddl: "EXEC" | "EXEC_IGNORE" | "IGNORE" | "STOP";
-    readonly primaries_switched: boolean;
-    readonly replicas_switched: boolean;
-    readonly retried_at: string;
     readonly retried_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
-    };
-    readonly reversed_at: string;
-    readonly reversed_by: {
-        readonly avatar_url: string;
         readonly display_name: string;
+        readonly avatar_url: string;
+    };
+    readonly cutover_by: {
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
     readonly reversed_cutover_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
         readonly id: string;
+        readonly display_name: string;
+        readonly avatar_url: string;
     };
-    readonly sequence_tables_applied: boolean;
-    readonly source_keyspace: {
-        readonly created_at: string;
-        readonly deleted_at: string;
+    readonly branch: {
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     };
-    readonly started_at: string;
-    readonly state: "cancelled" | "cancelling" | "completed" | "copying" | "cutover" | "cutting_over" | "error" | "pending" | "reversed_cutover" | "reversing_traffic" | "reversing_traffic_for_cancel" | "running" | "stopped" | "switched_primaries" | "switched_replicas" | "switching_primaries" | "switching_replicas" | "verified_data" | "verifying_data";
-    readonly switch_primaries_at: string;
-    readonly switch_primaries_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
-        readonly id: string;
-    };
-    readonly switch_replicas_at: string;
-    readonly switch_replicas_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
+    readonly source_keyspace: {
         readonly id: string;
-    };
-    readonly target_keyspace: {
+        readonly name: string;
         readonly created_at: string;
+        readonly updated_at: string;
         readonly deleted_at: string;
+    };
+    readonly target_keyspace: {
         readonly id: string;
         readonly name: string;
+        readonly created_at: string;
         readonly updated_at: string;
+        readonly deleted_at: string;
     };
-    readonly updated_at: string;
-    readonly verified_data_stale: boolean;
-    readonly verify_data_at: string;
-    readonly verify_data_by: {
-        readonly avatar_url: string;
-        readonly display_name: string;
+    readonly global_keyspace: {
         readonly id: string;
+        readonly name: string;
+        readonly created_at: string;
+        readonly updated_at: string;
+        readonly deleted_at: string;
     };
-    readonly workflow_errors: string;
-    readonly workflow_subtype: string;
-    readonly workflow_type: "move_tables";
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=getWorkflow.d.ts.map

package/lib/operations/lintBranchSchema.d.ts

@@ -45,35 +45,35 @@ export type LintBranchSchemaOutput = typeof LintBranchSchemaOutput.Type;
  * @param per_page - If provided, specifies the number of returned results
  */
 export declare const lintBranchSchema: import("@distilled.cloud/core/client").PaginatedOperationMethod<{
-    readonly branch: string;
-    readonly database: string;
     readonly organization: string;
+    readonly database: string;
+    readonly branch: 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 lint_error: string;
+        readonly subject_type: "routing_rules" | "table" | "vschema";
+        readonly keyspace_name: string;
+        readonly table_name: string;
+        readonly error_description: string;
+        readonly docs_url: string;
+        readonly column_name: string;
+        readonly foreign_key_column_names: readonly string[];
         readonly auto_increment_column_names: readonly string[];
         readonly charset_name: string;
-        readonly check_constraint_name: string;
-        readonly column_name: string;
-        readonly docs_url: string;
         readonly engine_name: string;
-        readonly enum_value: string;
-        readonly error_description: string;
-        readonly foreign_key_column_names: readonly string[];
+        readonly vindex_name: string;
         readonly json_path: string;
-        readonly keyspace_name: string;
-        readonly lint_error: string;
-        readonly partition_name: string;
+        readonly check_constraint_name: string;
+        readonly enum_value: string;
         readonly partitioning_type: string;
-        readonly subject_type: "routing_rules" | "table" | "vschema";
-        readonly table_name: string;
-        readonly vindex_name: string;
+        readonly partition_name: string;
     }[];
-    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=lintBranchSchema.d.ts.map

package/lib/operations/listAuditLogs.d.ts

@@ -42,35 +42,35 @@ export type ListAuditLogsOutput = typeof ListAuditLogsOutput.Type;
  * @param limit - If provided, specifies the number of returned results (max 100)
  */
 export declare const listAuditLogs: import("@distilled.cloud/core/client").OperationMethod<{
-    readonly ending_before?: string | undefined;
-    readonly limit?: number | undefined;
     readonly organization: string;
     readonly starting_after?: string | undefined;
+    readonly ending_before?: string | undefined;
+    readonly limit?: number | undefined;
 }, {
-    readonly cursor_end: string | null;
+    readonly has_next: boolean;
+    readonly has_prev: boolean;
     readonly cursor_start: string | null;
+    readonly cursor_end: string | null;
     readonly data: readonly {
-        readonly action: string;
-        readonly actor_display_name: string;
+        readonly id: string;
         readonly actor_id: string;
         readonly actor_type: string;
-        readonly audit_action: string;
-        readonly auditable_display_name: string;
         readonly auditable_id: string;
         readonly auditable_type: string;
-        readonly created_at: string;
-        readonly id: string;
+        readonly target_id: string;
+        readonly target_type: string;
         readonly location: string | null;
+        readonly target_display_name: string;
+        readonly audit_action: string;
+        readonly action: string;
+        readonly actor_display_name: string;
+        readonly auditable_display_name: string;
+        readonly remote_ip: string | null;
+        readonly created_at: string;
+        readonly updated_at: string;
         readonly metadata: {
             readonly [x: string]: unknown;
         };
-        readonly remote_ip: string | null;
-        readonly target_display_name: string;
-        readonly target_id: string;
-        readonly target_type: string;
-        readonly updated_at: string;
     }[];
-    readonly has_next: boolean;
-    readonly has_prev: boolean;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=listAuditLogs.d.ts.map

package/lib/operations/listBackupPolicies.d.ts

@@ -42,33 +42,33 @@ export type ListBackupPoliciesOutput = typeof ListBackupPoliciesOutput.Type;
  * @param per_page - If provided, specifies the number of returned results
  */
 export declare const listBackupPolicies: 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;
+    readonly next_page_url: string;
+    readonly prev_page: number;
+    readonly prev_page_url: string;
     readonly data: readonly {
-        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;
     }[];
-    readonly next_page: number;
-    readonly next_page_url: string;
-    readonly prev_page: number;
-    readonly prev_page_url: string;
 }, Forbidden | NotFound, import("../credentials.ts").Credentials>;
 //# sourceMappingURL=listBackupPolicies.d.ts.map