added operation api service

Author: code-gio

.changeset/giant-plums-guess.md

@@ -0,0 +1,5 @@
+---
+"cloudways-js-client": patch
+---
+
+added operation api service

src/index.ts

@@ -1,7 +1,10 @@
+// export all the services
 export * from "./services/Lists";
 export * from "./services/core";
 export * from "./services/projects";
+export * from "./services/operation";
 
+// export all the types
 export * from "./services/Lists/types";
 export * from "./services/core/types";
 export * from "./services/projects/types";

src/services/core/index.ts

@@ -17,10 +17,15 @@ let authToken: AuthToken | null = null;
  * sets up the necessary credentials for subsequent API calls. It accepts the user's
  * email address and an API key generated from the Cloudways platform.
  *
+ * This function should be called once to configure the library. After initial setup,
+ * the library will automatically handle token renewal, ensuring continued access
+ * to the Cloudways API without needing to reinitialize or manually refresh tokens.
+ *
  * @param {string} email - The email address used to access the Cloudways Platform.
  * @param {string} apiKey - The API key generated on the Cloudways Platform API Section.
  * @returns {void}
  */
+
 export function initializeCloudwaysApi(email: string, apiKey: string): void {
   config = { email, api_key: apiKey };
 }

src/services/operation/index.ts

@@ -0,0 +1,47 @@
+import { apiCall } from "../core";
+import { HttpMethod } from "../core/types";
+
+// Define an interface for the operation status response
+interface OperationStatus {
+  id: string;
+  type: string;
+  server_id: string;
+  estimated_time_remaining: string;
+  frontend_step_number: string;
+  status: string;
+  is_completed: string;
+  message: string;
+  app_id: string;
+}
+
+interface GetOperationStatusResponse {
+  operation: OperationStatus;
+}
+
+/**
+ * Gets the status of an operation that is running in the background.
+ *
+ * @param id - The numeric ID of the operation.
+ * @returns {Promise<OperationStatus>} A promise resolving to the operation status details.
+ * @example
+ * ```
+ * {
+ *   "operation": {
+ *     "id": "596283",
+ *     "type": "restarting_server",
+ *     "server_id": "50482",
+ *     "estimated_time_remaining": "2",
+ *     "frontend_step_number": "1",
+ *     "status": "Process is initiated",
+ *     "is_completed": "0",
+ *     "message": "Process is initiated",
+ *     "app_id": "0"
+ *   }
+ * }
+ * ```
+ */
+export function getOperationStatus(id: number): Promise<OperationStatus> {
+  return apiCall(`/operation/${id}`, HttpMethod.GET).then(
+    (response: GetOperationStatusResponse) => response.operation
+  );
+}