@scaleway/sdk 2.26.0 → 2.27.0

package/dist/api/k8s/v1/api.gen.cjs

@@ -0,0 +1,550 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  pageOfListClusters = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["private_network_id", request.privateNetworkId],
+        ["project_id", request.projectId],
+        ["status", request.status],
+        ["type", request.type]
+      )
+    },
+    marshalling_gen.unmarshalListClustersResponse
+  );
+  /**
+   * List Clusters. List all existing Kubernetes clusters in a specific region.
+   *
+   * @param request - The request {@link ListClustersRequest}
+   * @returns A Promise of ListClustersResponse
+   */
+  listClusters = (request = {}) => resourcePaginator.enrichForPagination("clusters", this.pageOfListClusters, request);
+  /**
+   * Create a new Cluster. Create a new Kubernetes cluster in a Scaleway region.
+   *
+   * @param request - The request {@link CreateClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  createCluster = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateClusterRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Get a Cluster. Retrieve information about a specific Kubernetes cluster.
+   *
+   * @param request - The request {@link GetClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  getCluster = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Waits for {@link Cluster} to be in a final state.
+   *
+   * @param request - The request {@link GetClusterRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Cluster
+   */
+  waitForCluster = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.CLUSTER_TRANSIENT_STATUSES.includes(res.status))),
+    this.getCluster,
+    request,
+    options
+  );
+  /**
+   * Update a Cluster. Update information on a specific Kubernetes cluster. You
+   * can update details such as its name, description, tags and configuration.
+   * To upgrade a cluster, you will need to use the dedicated endpoint.
+   *
+   * @param request - The request {@link UpdateClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  updateCluster = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateClusterRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Delete a Cluster. Delete a specific Kubernetes cluster and all its
+   * associated pools and nodes. Note that this method will not delete any Load
+   * Balancer or Block Volume that are associated with the cluster.
+   *
+   * @param request - The request {@link DeleteClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  deleteCluster = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}`,
+      urlParams: marshalling.urlParams([
+        "with_additional_resources",
+        request.withAdditionalResources
+      ])
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its
+   * associated pools to a specific and supported Kubernetes version.
+   *
+   * @param request - The request {@link UpgradeClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  upgradeCluster = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpgradeClusterRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/upgrade`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Change the Cluster type. Change the type of a specific Kubernetes cluster.
+   * To see the possible values you can enter for the `type` field, [list
+   * available cluster
+   * types](#path-clusters-list-available-cluster-types-for-a-cluster).
+   *
+   * @param request - The request {@link SetClusterTypeRequest}
+   * @returns A Promise of Cluster
+   */
+  setClusterType = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalSetClusterTypeRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/set-type`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * List available versions for a Cluster. List the versions that a specific
+   * Kubernetes cluster is allowed to upgrade to. Results will include every
+   * patch version greater than the current patch, as well as one minor version
+   * ahead of the current version. Any upgrade skipping a minor version will not
+   * work.
+   *
+   * @param request - The request {@link ListClusterAvailableVersionsRequest}
+   * @returns A Promise of ListClusterAvailableVersionsResponse
+   */
+  listClusterAvailableVersions = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/available-versions`
+    },
+    marshalling_gen.unmarshalListClusterAvailableVersionsResponse
+  );
+  /**
+   * List available cluster types for a cluster. List the cluster types that a
+   * specific Kubernetes cluster is allowed to switch to.
+   *
+   * @param request - The request {@link ListClusterAvailableTypesRequest}
+   * @returns A Promise of ListClusterAvailableTypesResponse
+   */
+  listClusterAvailableTypes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/available-types`
+    },
+    marshalling_gen.unmarshalListClusterAvailableTypesResponse
+  );
+  _getClusterKubeConfig = (request) => this.client.fetch({
+    method: "GET",
+    path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/kubeconfig`,
+    urlParams: marshalling.urlParams(["dl", 1], ["redacted", request.redacted]),
+    responseType: "blob"
+  });
+  /**
+   * Reset the admin token of a Cluster. Reset the admin token for a specific
+   * Kubernetes cluster. This will revoke the old admin token (which will not be
+   * usable afterwards) and create a new one. Note that you will need to
+   * download kubeconfig again to keep interacting with the cluster.
+   *
+   * @param request - The request {@link ResetClusterAdminTokenRequest}
+   */
+  resetClusterAdminToken = (request) => this.client.fetch({
+    body: "{}",
+    headers: jsonContentHeaders,
+    method: "POST",
+    path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/reset-admin-token`
+  });
+  /**
+   * Migrate an existing cluster to a Private Network cluster. Migrate a cluster
+   * that was created before the release of Private Network clusters to a new
+   * one with a Private Network.
+   *
+   * @param request - The request {@link MigrateToPrivateNetworkClusterRequest}
+   * @returns A Promise of Cluster
+   */
+  migrateToPrivateNetworkCluster = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalMigrateToPrivateNetworkClusterRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/migrate-to-private-network`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  /**
+   * Migrate a cluster to Routed IPs. Migrate the nodes of an existing cluster
+   * to Routed IPs and enable Routed IPs for all future nodes.
+   *
+   * @param request - The request {@link MigrateClusterToRoutedIPsRequest}
+   * @returns A Promise of Cluster
+   */
+  migrateClusterToRoutedIPs = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/migrate-to-routed-ips`
+    },
+    marshalling_gen.unmarshalCluster
+  );
+  pageOfListPools = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/pools`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["status", request.status]
+      )
+    },
+    marshalling_gen.unmarshalListPoolsResponse
+  );
+  /**
+   * List Pools in a Cluster. List all the existing pools for a specific
+   * Kubernetes cluster.
+   *
+   * @param request - The request {@link ListPoolsRequest}
+   * @returns A Promise of ListPoolsResponse
+   */
+  listPools = (request) => resourcePaginator.enrichForPagination("pools", this.pageOfListPools, request);
+  /**
+   * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes
+   * cluster.
+   *
+   * @param request - The request {@link CreatePoolRequest}
+   * @returns A Promise of Pool
+   */
+  createPool = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreatePoolRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/pools`
+    },
+    marshalling_gen.unmarshalPool
+  );
+  /**
+   * Get a Pool in a Cluster. Retrieve details about a specific pool in a
+   * Kubernetes cluster.
+   *
+   * @param request - The request {@link GetPoolRequest}
+   * @returns A Promise of Pool
+   */
+  getPool = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools/${marshalling.validatePathParam("poolId", request.poolId)}`
+    },
+    marshalling_gen.unmarshalPool
+  );
+  /**
+   * Waits for {@link Pool} to be in a final state.
+   *
+   * @param request - The request {@link GetPoolRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Pool
+   */
+  waitForPool = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.POOL_TRANSIENT_STATUSES.includes(res.status))),
+    this.getPool,
+    request,
+    options
+  );
+  /**
+   * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific
+   * pool. Note that it only works if the targeted version matches the cluster's
+   * version.
+   *
+   * @param request - The request {@link UpgradePoolRequest}
+   * @returns A Promise of Pool
+   */
+  upgradePool = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpgradePoolRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools/${marshalling.validatePathParam("poolId", request.poolId)}/upgrade`
+    },
+    marshalling_gen.unmarshalPool
+  );
+  /**
+   * Update a Pool in a Cluster. Update the attributes of a specific pool, such
+   * as its desired size, autoscaling settings, and tags.
+   *
+   * @param request - The request {@link UpdatePoolRequest}
+   * @returns A Promise of Pool
+   */
+  updatePool = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdatePoolRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools/${marshalling.validatePathParam("poolId", request.poolId)}`
+    },
+    marshalling_gen.unmarshalPool
+  );
+  /**
+   * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note
+   * that all the pool's nodes will also be deleted.
+   *
+   * @param request - The request {@link DeletePoolRequest}
+   * @returns A Promise of Pool
+   */
+  deletePool = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools/${marshalling.validatePathParam("poolId", request.poolId)}`
+    },
+    marshalling_gen.unmarshalPool
+  );
+  /**
+   * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is
+   * not intended to be called by end users but rather programmatically by the
+   * kapsule-node-agent.
+   *
+   * @param request - The request {@link CreateExternalNodeRequest}
+   * @returns A Promise of ExternalNode
+   */
+  createExternalNode = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools/${marshalling.validatePathParam("poolId", request.poolId)}/external-nodes`
+    },
+    marshalling_gen.unmarshalExternalNode
+  );
+  pageOfListNodes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/nodes`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["pool_id", request.poolId],
+        ["status", request.status]
+      )
+    },
+    marshalling_gen.unmarshalListNodesResponse
+  );
+  /**
+   * List Nodes in a Cluster. List all the existing nodes for a specific
+   * Kubernetes cluster.
+   *
+   * @param request - The request {@link ListNodesRequest}
+   * @returns A Promise of ListNodesResponse
+   */
+  listNodes = (request) => resourcePaginator.enrichForPagination("nodes", this.pageOfListNodes, request);
+  /**
+   * Get a Node in a Cluster. Retrieve details about a specific Kubernetes Node.
+   *
+   * @param request - The request {@link GetNodeRequest}
+   * @returns A Promise of Node
+   */
+  getNode = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/${marshalling.validatePathParam("nodeId", request.nodeId)}`
+    },
+    marshalling_gen.unmarshalNode
+  );
+  /**
+   * Waits for {@link Node} to be in a final state.
+   *
+   * @param request - The request {@link GetNodeRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Node
+   */
+  waitForNode = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.NODE_TRANSIENT_STATUSES.includes(res.status))),
+    this.getNode,
+    request,
+    options
+  );
+  /**
+   * Replace a Node in a Cluster. Replace a specific Node. The node will first
+   * be cordoned (scheduling will be disabled on it). The existing pods on the
+   * node will then be drained and rescheduled onto another schedulable node.
+   * Note that when there is not enough space to reschedule all the pods (such
+   * as in a one-node cluster), disruption of your applications can be
+   * expected.
+   *
+   * @deprecated
+   * @param request - The request {@link ReplaceNodeRequest}
+   * @returns A Promise of Node
+   */
+  replaceNode = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/${marshalling.validatePathParam("nodeId", request.nodeId)}/replace`
+    },
+    marshalling_gen.unmarshalNode
+  );
+  /**
+   * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be
+   * cordoned (scheduling will be disabled on it). The existing pods on the node
+   * will then be drained and rescheduled onto another schedulable node. Note
+   * that when there is not enough space to reschedule all the pods (such as in
+   * a one-node cluster), disruption of your applications can be expected.
+   *
+   * @param request - The request {@link RebootNodeRequest}
+   * @returns A Promise of Node
+   */
+  rebootNode = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/${marshalling.validatePathParam("nodeId", request.nodeId)}/reboot`
+    },
+    marshalling_gen.unmarshalNode
+  );
+  /**
+   * Delete a Node in a Cluster. Delete a specific Node. Note that when there is
+   * not enough space to reschedule all the pods (such as in a one-node
+   * cluster), disruption of your applications can be expected.
+   *
+   * @param request - The request {@link DeleteNodeRequest}
+   * @returns A Promise of Node
+   */
+  deleteNode = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/${marshalling.validatePathParam("nodeId", request.nodeId)}`,
+      urlParams: marshalling.urlParams(
+        ["replace", request.replace],
+        ["skip_drain", request.skipDrain]
+      )
+    },
+    marshalling_gen.unmarshalNode
+  );
+  /**
+   * List all available Versions. List all available versions for the creation
+   * of a new Kubernetes cluster.
+   *
+   * @param request - The request {@link ListVersionsRequest}
+   * @returns A Promise of ListVersionsResponse
+   */
+  listVersions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`
+    },
+    marshalling_gen.unmarshalListVersionsResponse
+  );
+  /**
+   * Get a Version. Retrieve a specific Kubernetes version and its details.
+   *
+   * @param request - The request {@link GetVersionRequest}
+   * @returns A Promise of Version
+   */
+  getVersion = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions/${marshalling.validatePathParam("versionName", request.versionName)}`
+    },
+    marshalling_gen.unmarshalVersion
+  );
+  pageOfListClusterTypes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/cluster-types`,
+      urlParams: marshalling.urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListClusterTypesResponse
+  );
+  /**
+   * List cluster types. List available cluster types and their technical
+   * details.
+   *
+   * @param request - The request {@link ListClusterTypesRequest}
+   * @returns A Promise of ListClusterTypesResponse
+   */
+  listClusterTypes = (request = {}) => resourcePaginator.enrichForPagination("clusterTypes", this.pageOfListClusterTypes, request);
+}
+exports.API = API;