@serve.zone/interfaces 5.4.6 → 5.8.0

package/ts/requests/backup.ts

@@ -0,0 +1,198 @@
+import * as plugins from '../plugins.js';
+import type {
+  IBackupArchiveManifest,
+  IBackupArchiveObject,
+  IBackupRecord,
+  IBackupReplicationResult,
+  TBackupSnapshot,
+} from '../data/backup.js';
+import type { IService } from '../data/service.js';
+import type { IIdentity } from '../data/user.js';
+
+export interface IReq_Any_Cloudly_CreateServiceBackup
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_CreateServiceBackup
+> {
+  method: 'createServiceBackup';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    clusterId?: string;
+    tags?: Record<string, string>;
+    replicate?: boolean;
+  };
+  response: {
+    backup: IBackupRecord;
+  };
+}
+
+export interface IReq_Any_Cloudly_GetServiceBackups
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetServiceBackups
+> {
+  method: 'getServiceBackups';
+  request: {
+    identity: IIdentity;
+    serviceId?: string;
+    status?: IBackupRecord['status'];
+  };
+  response: {
+    backups: IBackupRecord[];
+  };
+}
+
+export interface IReq_Any_Cloudly_GetBackupById
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetBackupById
+> {
+  method: 'getBackupById';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+  };
+  response: {
+    backup: IBackupRecord;
+  };
+}
+
+export interface IReq_Any_Cloudly_RestoreServiceBackup
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_RestoreServiceBackup
+> {
+  method: 'restoreServiceBackup';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+    clear?: boolean;
+    resourceTypes?: Array<TBackupSnapshot['type']>;
+  };
+  response: {
+    backup: IBackupRecord;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_ExecuteServiceBackup
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_ExecuteServiceBackup
+> {
+  method: 'executeServiceBackup';
+  request: {
+    backupId: string;
+    service: IService;
+    tags?: Record<string, string>;
+    replication?: {
+      enabled: boolean;
+    };
+  };
+  response: {
+    snapshots: TBackupSnapshot[];
+    replication?: IBackupReplicationResult;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_ExecuteServiceRestore
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_ExecuteServiceRestore
+> {
+  method: 'executeServiceRestore';
+  request: {
+    backupId: string;
+    service: IService;
+    snapshots: TBackupSnapshot[];
+    clear?: boolean;
+    resourceTypes?: Array<TBackupSnapshot['type']>;
+    replication?: {
+      enabled: boolean;
+    };
+  };
+  response: {
+    restored: TBackupSnapshot[];
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_PrepareBackupReplication
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_PrepareBackupReplication
+> {
+  method: 'prepareBackupReplication';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+    manifest: IBackupArchiveManifest;
+  };
+  response: {
+    missingObjects: IBackupArchiveObject[];
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_UploadBackupArchiveObject
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_UploadBackupArchiveObject
+> {
+  method: 'uploadBackupArchiveObject';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+    object: IBackupArchiveObject;
+    contentsBase64: string;
+  };
+  response: {
+    accepted: boolean;
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_CompleteBackupReplication
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_CompleteBackupReplication
+> {
+  method: 'completeBackupReplication';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+    manifest: IBackupArchiveManifest;
+  };
+  response: {
+    replication: IBackupReplicationResult;
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_GetBackupArchiveManifest
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_GetBackupArchiveManifest
+> {
+  method: 'getBackupArchiveManifest';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+  };
+  response: {
+    manifest: IBackupArchiveManifest;
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_DownloadBackupArchiveObject
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_DownloadBackupArchiveObject
+> {
+  method: 'downloadBackupArchiveObject';
+  request: {
+    identity: IIdentity;
+    backupId: string;
+    object: IBackupArchiveObject;
+  };
+  response: {
+    object: IBackupArchiveObject;
+    contentsBase64: string;
+  };
+}

package/ts/requests/baseos.ts

@@ -0,0 +1,93 @@
+import type {
+  IBaseOsHeartbeatResult,
+  IBaseOsDesiredState,
+  IBaseOsImageBuild,
+  IBaseOsImageBuildRequest,
+  IBaseOsImageDownloadUrl,
+  IBaseOsNode,
+  IBaseOsRegisterResult,
+  IBaseOsRuntimeInfo,
+} from '../data/baseos.js';
+import type { IIdentity } from '../data/user.js';
+
+export interface IRequest_BaseOs_Cloudly_RegisterNode {
+  method: 'baseOsRegisterNode';
+  request: {
+    joinToken?: string;
+    nodeToken?: string;
+    status: IBaseOsRuntimeInfo;
+  };
+  response: IBaseOsRegisterResult;
+}
+
+export interface IRequest_BaseOs_Cloudly_SendHeartbeat {
+  method: 'baseOsSendHeartbeat';
+  request: {
+    nodeToken: string;
+    status: IBaseOsRuntimeInfo;
+  };
+  response: IBaseOsHeartbeatResult;
+}
+
+export interface IRequest_Any_Cloudly_GetBaseOsNodes {
+  method: 'getBaseOsNodes';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    nodes: IBaseOsNode[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_SetBaseOsNodeDesiredState {
+  method: 'setBaseOsNodeDesiredState';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+    desiredState: IBaseOsDesiredState;
+  };
+  response: {
+    node: IBaseOsNode;
+  };
+}
+
+export interface IRequest_Any_Cloudly_CreateBaseOsImageBuild {
+  method: 'createBaseOsImageBuild';
+  request: {
+    identity: IIdentity;
+    build: IBaseOsImageBuildRequest;
+  };
+  response: {
+    build: IBaseOsImageBuild;
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetBaseOsImageBuilds {
+  method: 'getBaseOsImageBuilds';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    builds: IBaseOsImageBuild[];
+  };
+}
+
+export interface IRequest_Any_Cloudly_GetBaseOsImageBuildById {
+  method: 'getBaseOsImageBuildById';
+  request: {
+    identity: IIdentity;
+    buildId: string;
+  };
+  response: {
+    build: IBaseOsImageBuild;
+  };
+}
+
+export interface IRequest_Any_Cloudly_CreateBaseOsImageDownloadUrl {
+  method: 'createBaseOsImageDownloadUrl';
+  request: {
+    identity: IIdentity;
+    buildId: string;
+  };
+  response: IBaseOsImageDownloadUrl;
+}

package/ts/requests/cluster.ts

@@ -58,6 +58,7 @@ export interface IReq_Any_Cloudly_UpdateCluster extends plugins.typedrequestInte
   method: 'updateCluster';
   request: {
     identity: userInterfaces.IIdentity;
+    clusterId: string;
     clusterData: clusterInterfaces.ICluster['data'];
   };
   response: {

package/ts/requests/index.ts

@@ -2,6 +2,8 @@ import * as plugins from '../plugins.js';
 
 import * as adminRequests from './admin.js';
 import * as baremetalRequests from './baremetal.js';
+import * as baseOsRequests from './baseos.js';
+import * as backupRequests from './backup.js';
 import * as certificateRequests from './certificate.js';
 import * as clusterRequests from './cluster.js';
 import * as configRequests from './config.js';
@@ -29,6 +31,8 @@ import * as versionRequests from './version.js';
 export {
   adminRequests as admin,
   baremetalRequests as baremetal,
+  baseOsRequests as baseos,
+  backupRequests as backup,
   certificateRequests as certificate,
   clusterRequests as cluster,
   configRequests as config,