fixed all the list

Author: code-gio

.changeset/four-pears-wonder.md

@@ -0,0 +1,5 @@
+---
+"cloudways-js-client": patch
+---
+
+fixed all the list functions

src/services/Lists/index.ts

@@ -5,46 +5,39 @@ import type {
   App,
   Provider,
   Region,
-  PackageType,
+  PackageList,
+  ServerSize,
+  Setting,
 } from "./types";
 
 /**
- * Gets a list of available cloud providers.
- * @returns {Promise<Provider[]>} A promise resolving with an array of cloud providers.
+ * Gets a list of available apps and their versions.
+ * @returns {Promise<App[]>} A promise resolving with an array of apps and their versions.
  * @example
  * ```
  * [
- *   { "id": "do", "name": "DigitalOcean" },
- *   { "id": "vultr", "name": "Vultr" },
+ *   {
+ *     label: "WordPress",
+ *     versions: [
+ *       { app_version: "4.7", application: "wordpress" },
+ *       ...
+ *     ]
+ *   },
+ *   {
+ *     label: "PHP Stack",
+ *     versions: [
+ *       { app_version: "5.4", application: "phpstack" },
+ *       ...
+ *     ]
+ *   },
  *   ...
  * ]
  * ```
  */
-export function getProviderList(): Promise<Provider[]> {
-  return apiCall("/providers").then((response) => response.providers);
+export function getAppList(): Promise<App[]> {
+  return apiCall("/apps");
 }
 
-/**
- * Gets a list of regions.
- * @returns {Promise<Region[]>} A promise resolving with an array of regions.
- * @example
- * ```
- * [
- *   { "id": "us-east-1", "name": "US N.Virginia" },
- *   { "id": "us-west-1", "name": "California" },
- *   ...
- * ]
- * ```
- */
-export function getRegionList(): Promise<Region[]> {
-  return apiCall("/regions").then((response) => {
-    const regionsArray = Object.values(response.regions).flat();
-    return regionsArray as Region[]; // Type assertion to Region[]
-  });
-}
-
-// Similar updates for getServerSizesList, getAppList, getPackageList, getSettingsList
-
 /**
  * Gets possible backup frequencies.
  * @returns {Promise<BackupFrequency[]>} A promise resolving with an array of backup frequencies.
@@ -58,7 +51,9 @@ export function getRegionList(): Promise<Region[]> {
  * ```
  */
 export function getBackupFrequencies(): Promise<BackupFrequency[]> {
-  return apiCall("/backup-frequencies");
+  return apiCall("/backup-frequencies").then(
+    (response) => response.frequencies
+  );
 }
 
 /**
@@ -83,7 +78,7 @@ export function getCountriesList(): Promise<Country[]> {
  * ```
  */
 export function getMonitorDurations(): Promise<string[]> {
-  return apiCall("/monitor-durations");
+  return apiCall("/monitor_durations");
 }
 
 /**
@@ -99,7 +94,135 @@ export function getMonitorDurations(): Promise<string[]> {
  * ```
  */
 export function getMonitorTargets(): Promise<{ [provider: string]: string[] }> {
-  return apiCall("/monitor-targets");
+  return apiCall("/monitor_targets");
+}
+
+/**
+ * Gets a list of available packages and their versions.
+ * @returns {Promise<PackageList>} A promise resolving with a list of packages and their versions.
+ * @example
+ * ```
+ * {
+ *   "php": {
+ *     "debian10": {
+ *       "7.0": "PHP 7.0",
+ *       "7.1": "PHP 7.1",
+ *       ...
+ *     },
+ *     ...
+ *   },
+ *   "phpConfig": {
+ *     "debian10": {
+ *       "7.4": ["7.4", "8.0", ...],
+ *       ...
+ *     },
+ *     ...
+ *   },
+ *   "mysql": {
+ *     "debian10": {
+ *       "mysql,5.7": "MySQL 5.7",
+ *       ...
+ *     },
+ *     ...
+ *   },
+ *   "redis": {
+ *     "0": "Uninstall",
+ *     "latest": "Install"
+ *   },
+ *   ...
+ * }
+ * ```
+ */
+export function getPackageList(): Promise<PackageList> {
+  return apiCall("/packages");
+}
+
+/**
+ * Gets a list of available cloud providers.
+ * @returns {Promise<Provider[]>} A promise resolving with an array of cloud providers.
+ * @example
+ * ```
+ * [
+ *   { "id": "do", "name": "DigitalOcean" },
+ *   { "id": "vultr", "name": "Vultr" },
+ *   ...
+ * ]
+ * ```
+ */
+export function getProviderList(): Promise<Provider[]> {
+  return apiCall("/providers").then((response) => response.providers);
 }
 
-// ... and similarly for other functions
+/**
+ * Gets a list of regions.
+ * @returns {Promise<Region[]>} A promise resolving with an array of regions.
+ * @example
+ * ```
+ * [
+ *   { "id": "us-east-1", "name": "US N.Virginia" },
+ *   { "id": "us-west-1", "name": "California" },
+ *   ...
+ * ]
+ * ```
+ */
+export function getRegionList(): Promise<Region[]> {
+  return apiCall("/regions").then((response) => {
+    const regionsArray = Object.values(response.regions).flat();
+    return regionsArray as Region[]; // Type assertion to Region[]
+  });
+}
+
+/**
+ * Gets a list of server sizes available.
+ * @returns {Promise<ServerSize[]>} A promise resolving with an array of server sizes available for each provider.
+ * @example
+ * ```
+ * [
+ *   { provider: "Amazon", sizes: ["Small", "Medium", ...] },
+ *   { provider: "DO", sizes: ["512MB", "1GB", ...] },
+ *   { provider: "GCE", sizes: ["small", "n1-std-1", ...] },
+ *   { provider: "Vultr", sizes: ["768MB", "1GB", ...] },
+ *   { provider: "Kyup", sizes: ["1 Core", "2 Cores", ...] },
+ *   { provider: "Linode", sizes: ["1GB", "2GB", ...] }
+ * ]
+ * ```
+ */
+export function getServerSizesList(): Promise<ServerSize[]> {
+  return apiCall("/server_sizes").then((response) => {
+    const serverSizesList: ServerSize[] = [];
+    for (const provider in response.sizes) {
+      serverSizesList.push({
+        provider: provider,
+        sizes: response.sizes[provider],
+      });
+    }
+    return serverSizesList;
+  });
+}
+
+/**
+ * Gets a list of available settings and corresponding values.
+ * @returns {Promise<Setting[]>} A promise resolving with an array of settings and their possible values.
+ * @example
+ * ```
+ * [
+ *   { setting: "timezone", values: ["Pacific/Midway", "Pacific/Samoa", ...] },
+ *   { setting: "character_set", values: ["ascii", "greek", ...] },
+ *   { setting: "status", values: [" ----", "Off", "On"] },
+ *   { setting: "error_reporting", values: [" ----", "E_ALL & ~E_DEPRECATED & ~E_STRICT", ...] },
+ *   { setting: "statuses", values: ["disabled", "enabled"] }
+ * ]
+ * ```
+ */
+export function getSettingsList(): Promise<Setting[]> {
+  return apiCall("/settings").then((response) => {
+    const settingsList: Setting[] = [];
+    for (const setting in response.settings) {
+      settingsList.push({
+        setting: setting,
+        values: Object.keys(response.settings[setting]),
+      });
+    }
+    return settingsList;
+  });
+}

src/services/Lists/types.ts

@@ -63,25 +63,18 @@ export interface GetAppListResponse {
 }
 
 /**
- * Represents the versions of a specific package.
+ * Represents a package with its versions.
  */
-export interface PackageVersions {
+interface Package {
   [version: string]: string;
 }
 
 /**
- * Represents a package type with its versions.
+ * Represents a list of available packages and versions.
  */
-export interface PackageType {
-  [osVersion: string]: PackageVersions;
-}
-
-/**
- * Represents the response for getting a list of packages.
- */
-export interface GetPackageListResponse {
-  packages: {
-    [packageName: string]: PackageType;
+export interface PackageList {
+  [packageName: string]: {
+    [os: string]: Package;
   };
 }
 
@@ -132,3 +125,19 @@ export interface GetMonitorTargetsResponse {
     [provider: string]: string[];
   };
 }
+
+/**
+ * Represents a server size entry for a provider.
+ */
+export interface ServerSize {
+  provider: string;
+  sizes: string[];
+}
+
+/**
+ * Represents a setting entry and its possible values.
+ */
+export interface Setting {
+  setting: string;
+  values: string[];
+}