feat: rename application backups to snapshots

Author: joaotonaco

.changeset/bumpy-walls-drum.md

@@ -0,0 +1,5 @@
+---
+"@squarecloud/api-types": minor
+---
+
+Rename application backups to snapshots

payloads/v2/backups.ts

@@ -1,13 +1,9 @@
-import type { APIPayload, ISODateString } from "../../common/v2";
-
 /**
- * @see https://docs.squarecloud.app/api-reference/endpoint/apps/backup
+ * @deprecated Use APIApplicationSnapshot instead
  */
-export interface APIApplicationBackup {
-	name: string;
-	size: number;
-	modified: ISODateString;
-	key: string;
-}
+export type APIApplicationBackup = never;
 
-export type APIApplicationBackupsPayload = APIPayload<APIApplicationBackup[]>;
+/**
+ * @deprecated Use APIApplicationSnapshotsPayload instead
+ */
+export type APIApplicationBackupsPayload = never;

payloads/v2/index.ts

@@ -5,5 +5,6 @@ export * from "./files";
 export * from "./logs";
 export * from "./network";
 export * from "./service";
+export * from "./snapshots";
 export * from "./status";
 export * from "./user";

payloads/v2/snapshots.ts

@@ -0,0 +1,15 @@
+import type { APIPayload, ISODateString } from "../../common/v2";
+
+/**
+ * @see https://docs.squarecloud.app/api-reference/endpoint/apps/snapshots
+ */
+export interface APIApplicationSnapshot {
+	name: string;
+	size: number;
+	modified: ISODateString;
+	key: string;
+}
+
+export type APIApplicationSnapshotsPayload = APIPayload<
+	APIApplicationSnapshot[]
+>;

rest/v2/backups.ts

@@ -1,12 +1,9 @@
-import type { APIPayload } from "../../common/v2";
-
 /**
- * @see https://docs.squarecloud.app/api-reference/endpoint/apps/backup
+ * @deprecated Use RESTPostAPIApplicationSnapshotResult instead
  */
-export interface RESTPostAPIApplicationBackupResult {
-	url: string;
-	key: string;
-}
+export type RESTPostAPIApplicationBackupResult = never;
 
-export type RESTPostAPIApplicationBackupResultPayload =
-	APIPayload<RESTPostAPIApplicationBackupResult>;
+/**
+ * @deprecated Use RESTPostAPIApplicationSnapshotResultPayload instead
+ */
+export type RESTPostAPIApplicationBackupResultPayload = never;

rest/v2/index.ts

@@ -3,3 +3,4 @@ export * from "./backups";
 export * from "./deploy";
 export * from "./files";
 export * from "./network";
+export * from "./snapshots";

rest/v2/snapshots.ts

@@ -0,0 +1,12 @@
+import type { APIPayload } from "../../common/v2";
+
+/**
+ * @see https://docs.squarecloud.app/api-reference/endpoint/apps/snapshots
+ */
+export interface RESTPostAPIApplicationSnapshotResult {
+	url: string;
+	key: string;
+}
+
+export type RESTPostAPIApplicationSnapshotResultPayload =
+	APIPayload<RESTPostAPIApplicationSnapshotResult>;