@scaleway/sdk 2.58.0 → 2.60.0

package/dist/api/vpcgw/v2/api.gen.cjs

@@ -0,0 +1,518 @@
+"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");
+require("../../../vendor/base64/index.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 zones of the API. */
+  static LOCALITIES = [
+    "fr-par-1",
+    "fr-par-2",
+    "nl-ams-1",
+    "nl-ams-2",
+    "nl-ams-3",
+    "pl-waw-1",
+    "pl-waw-2",
+    "pl-waw-3"
+  ];
+  pageOfListGateways = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways`,
+      urlParams: marshalling.urlParams(
+        ["include_legacy", request.includeLegacy],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["private_network_ids", request.privateNetworkIds],
+        ["project_id", request.projectId],
+        ["status", request.status],
+        ["tags", request.tags],
+        ["types", request.types]
+      )
+    },
+    marshalling_gen.unmarshalListGatewaysResponse
+  );
+  /**
+   * List Public Gateways. List Public Gateways in a given Scaleway Organization
+   * or Project. By default, results are displayed in ascending order of
+   * creation date.
+   *
+   * @param request - The request {@link ListGatewaysRequest}
+   * @returns A Promise of ListGatewaysResponse
+   */
+  listGateways = (request = {}) => resourcePaginator.enrichForPagination("gateways", this.pageOfListGateways, request);
+  /**
+   * Get a Public Gateway. Get details of a Public Gateway, specified by its
+   * gateway ID. The response object contains full details of the gateway,
+   * including its **name**, **type**, **status** and more.
+   *
+   * @param request - The request {@link GetGatewayRequest}
+   * @returns A Promise of Gateway
+   */
+  getGateway = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}`
+    },
+    marshalling_gen.unmarshalGateway
+  );
+  /**
+   * Waits for {@link Gateway} to be in a final state.
+   *
+   * @param request - The request {@link GetGatewayRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Gateway
+   */
+  waitForGateway = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.GATEWAY_TRANSIENT_STATUSES.includes(res.status))),
+    this.getGateway,
+    request,
+    options
+  );
+  /**
+   * Create a Public Gateway. Create a new Public Gateway in the specified
+   * Scaleway Project, defining its **name**, **type** and other configuration
+   * details such as whether to enable SSH bastion.
+   *
+   * @param request - The request {@link CreateGatewayRequest}
+   * @returns A Promise of Gateway
+   */
+  createGateway = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateGatewayRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways`
+    },
+    marshalling_gen.unmarshalGateway
+  );
+  /**
+   * Update a Public Gateway. Update the parameters of an existing Public
+   * Gateway, for example, its **name**, **tags**, **SSH bastion
+   * configuration**, and **DNS servers**.
+   *
+   * @param request - The request {@link UpdateGatewayRequest}
+   * @returns A Promise of Gateway
+   */
+  updateGateway = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateGatewayRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}`
+    },
+    marshalling_gen.unmarshalGateway
+  );
+  /**
+   * Delete a Public Gateway. Delete an existing Public Gateway, specified by
+   * its gateway ID. This action is irreversible.
+   *
+   * @param request - The request {@link DeleteGatewayRequest}
+   * @returns A Promise of Gateway
+   */
+  deleteGateway = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}`,
+      urlParams: marshalling.urlParams(["delete_ip", request.deleteIp])
+    },
+    marshalling_gen.unmarshalGateway
+  );
+  /**
+   * Upgrade a Public Gateway to the latest version and/or to a different
+   * commercial offer type. Upgrade a given Public Gateway to the newest
+   * software version or to a different commercial offer type. This applies the
+   * latest bugfixes and features to your Public Gateway. Note that gateway
+   * service will be interrupted during the update.
+   *
+   * @param request - The request {@link UpgradeGatewayRequest}
+   * @returns A Promise of Gateway
+   */
+  upgradeGateway = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpgradeGatewayRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/upgrade`
+    },
+    marshalling_gen.unmarshalGateway
+  );
+  pageOfListGatewayNetworks = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks`,
+      urlParams: marshalling.urlParams(
+        ["gateway_ids", request.gatewayIds],
+        ["masquerade_enabled", request.masqueradeEnabled],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["private_network_ids", request.privateNetworkIds],
+        ["status", request.status]
+      )
+    },
+    marshalling_gen.unmarshalListGatewayNetworksResponse
+  );
+  /**
+   * List Public Gateway connections to Private Networks. List the connections
+   * between Public Gateways and Private Networks (a connection = a
+   * GatewayNetwork). You can choose to filter by `gateway-id` to list all
+   * Private Networks attached to the specified Public Gateway, or by
+   * `private_network_id` to list all Public Gateways attached to the specified
+   * Private Network. Other query parameters are also available. The result is
+   * an array of GatewayNetwork objects, each giving details of the connection
+   * between a given Public Gateway and a given Private Network.
+   *
+   * @param request - The request {@link ListGatewayNetworksRequest}
+   * @returns A Promise of ListGatewayNetworksResponse
+   */
+  listGatewayNetworks = (request = {}) => resourcePaginator.enrichForPagination(
+    "gatewayNetworks",
+    this.pageOfListGatewayNetworks,
+    request
+  );
+  /**
+   * Get a Public Gateway connection to a Private Network. Get details of a
+   * given connection between a Public Gateway and a Private Network (this
+   * connection = a GatewayNetwork), specified by its `gateway_network_id`. The
+   * response object contains details of the connection including the IDs of the
+   * Public Gateway and Private Network, the dates the connection was
+   * created/updated and its configuration settings.
+   *
+   * @param request - The request {@link GetGatewayNetworkRequest}
+   * @returns A Promise of GatewayNetwork
+   */
+  getGatewayNetwork = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${marshalling.validatePathParam("gatewayNetworkId", request.gatewayNetworkId)}`
+    },
+    marshalling_gen.unmarshalGatewayNetwork
+  );
+  /**
+   * Waits for {@link GatewayNetwork} to be in a final state.
+   *
+   * @param request - The request {@link GetGatewayNetworkRequest}
+   * @param options - The waiting options
+   * @returns A Promise of GatewayNetwork
+   */
+  waitForGatewayNetwork = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(
+      !content_gen.GATEWAY_NETWORK_TRANSIENT_STATUSES.includes(res.status)
+    )),
+    this.getGatewayNetwork,
+    request,
+    options
+  );
+  /**
+   * Attach a Public Gateway to a Private Network. Attach a specific Public
+   * Gateway to a specific Private Network (create a GatewayNetwork). You can
+   * configure parameters for the connection including whether to enable
+   * masquerade (dynamic NAT), and more.
+   *
+   * @param request - The request {@link CreateGatewayNetworkRequest}
+   * @returns A Promise of GatewayNetwork
+   */
+  createGatewayNetwork = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateGatewayNetworkRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks`
+    },
+    marshalling_gen.unmarshalGatewayNetwork
+  );
+  /**
+   * Update a Public Gateway's connection to a Private Network. Update the
+   * configuration parameters of a connection between a given Public Gateway and
+   * Private Network (the connection = a GatewayNetwork). Updatable parameters
+   * include whether to enable traffic masquerade (dynamic NAT).
+   *
+   * @param request - The request {@link UpdateGatewayNetworkRequest}
+   * @returns A Promise of GatewayNetwork
+   */
+  updateGatewayNetwork = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateGatewayNetworkRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${marshalling.validatePathParam("gatewayNetworkId", request.gatewayNetworkId)}`
+    },
+    marshalling_gen.unmarshalGatewayNetwork
+  );
+  /**
+   * Detach a Public Gateway from a Private Network. Detach a given Public
+   * Gateway from a given Private Network, i.e. delete a GatewayNetwork
+   * specified by a gateway_network_id.
+   *
+   * @param request - The request {@link DeleteGatewayNetworkRequest}
+   * @returns A Promise of GatewayNetwork
+   */
+  deleteGatewayNetwork = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-networks/${marshalling.validatePathParam("gatewayNetworkId", request.gatewayNetworkId)}`
+    },
+    marshalling_gen.unmarshalGatewayNetwork
+  );
+  pageOfListPatRules = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules`,
+      urlParams: marshalling.urlParams(
+        ["gateway_ids", request.gatewayIds],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["private_ips", request.privateIps],
+        ["protocol", request.protocol]
+      )
+    },
+    marshalling_gen.unmarshalListPatRulesResponse
+  );
+  /**
+   * List PAT rules. List PAT rules. You can filter by gateway ID to list all
+   * PAT rules for a particular gateway, or filter for PAT rules targeting a
+   * specific IP address or using a specific protocol.
+   *
+   * @param request - The request {@link ListPatRulesRequest}
+   * @returns A Promise of ListPatRulesResponse
+   */
+  listPatRules = (request = {}) => resourcePaginator.enrichForPagination("patRules", this.pageOfListPatRules, request);
+  /**
+   * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response
+   * object gives full details of the PAT rule, including the Public Gateway it
+   * belongs to and the configuration settings in terms of public / private
+   * ports, private IP and protocol.
+   *
+   * @param request - The request {@link GetPatRuleRequest}
+   * @returns A Promise of PatRule
+   */
+  getPatRule = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${marshalling.validatePathParam("patRuleId", request.patRuleId)}`
+    },
+    marshalling_gen.unmarshalPatRule
+  );
+  /**
+   * Create a PAT rule. Create a new PAT rule on a specified Public Gateway,
+   * defining the protocol to use, public port to listen on, and private port /
+   * IP address to map to.
+   *
+   * @param request - The request {@link CreatePatRuleRequest}
+   * @returns A Promise of PatRule
+   */
+  createPatRule = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreatePatRuleRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules`
+    },
+    marshalling_gen.unmarshalPatRule
+  );
+  /**
+   * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID.
+   * Configuration settings including private/public port, private IP address
+   * and protocol can all be updated.
+   *
+   * @param request - The request {@link UpdatePatRuleRequest}
+   * @returns A Promise of PatRule
+   */
+  updatePatRule = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdatePatRuleRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${marshalling.validatePathParam("patRuleId", request.patRuleId)}`
+    },
+    marshalling_gen.unmarshalPatRule
+  );
+  /**
+   * Set all PAT rules. Set a definitive list of PAT rules attached to a Public
+   * Gateway. Each rule is identified by its public port and protocol. This will
+   * sync the current PAT rule list on the gateway with the new list, creating,
+   * updating or deleting PAT rules accordingly.
+   *
+   * @param request - The request {@link SetPatRulesRequest}
+   * @returns A Promise of SetPatRulesResponse
+   */
+  setPatRules = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalSetPatRulesRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules`
+    },
+    marshalling_gen.unmarshalSetPatRulesResponse
+  );
+  /**
+   * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This
+   * action is irreversible.
+   *
+   * @param request - The request {@link DeletePatRuleRequest}
+   */
+  deletePatRule = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/pat-rules/${marshalling.validatePathParam("patRuleId", request.patRuleId)}`
+  });
+  /**
+   * List Public Gateway types. List the different Public Gateway commercial
+   * offer types available at Scaleway. The response is an array of objects
+   * describing the name and technical details of each available gateway type.
+   *
+   * @param request - The request {@link ListGatewayTypesRequest}
+   * @returns A Promise of ListGatewayTypesResponse
+   */
+  listGatewayTypes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateway-types`
+    },
+    marshalling_gen.unmarshalListGatewayTypesResponse
+  );
+  pageOfListIPs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips`,
+      urlParams: marshalling.urlParams(
+        ["is_free", request.isFree],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["reverse", request.reverse],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListIPsResponse
+  );
+  /**
+   * List IPs. List Public Gateway flexible IP addresses. A number of filter
+   * options are available for limiting results in the response.
+   *
+   * @param request - The request {@link ListIPsRequest}
+   * @returns A Promise of ListIPsResponse
+   */
+  listIPs = (request = {}) => resourcePaginator.enrichForPagination("ips", this.pageOfListIPs, request);
+  /**
+   * Get an IP. Get details of a Public Gateway flexible IP address, identified
+   * by its IP ID. The response object contains information including which (if
+   * any) Public Gateway using this IP address, the reverse and various other
+   * metadata.
+   *
+   * @param request - The request {@link GetIPRequest}
+   * @returns A Promise of IP
+   */
+  getIP = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${marshalling.validatePathParam("ipId", request.ipId)}`
+    },
+    marshalling_gen.unmarshalIP
+  );
+  /**
+   * Reserve an IP. Create (reserve) a new flexible IP address that can be used
+   * for a Public Gateway in a specified Scaleway Project.
+   *
+   * @param request - The request {@link CreateIPRequest}
+   * @returns A Promise of IP
+   */
+  createIP = (request = {}) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips`
+    },
+    marshalling_gen.unmarshalIP
+  );
+  /**
+   * Update an IP. Update details of an existing flexible IP address, including
+   * its tags, reverse and the Public Gateway it is assigned to.
+   *
+   * @param request - The request {@link UpdateIPRequest}
+   * @returns A Promise of IP
+   */
+  updateIP = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${marshalling.validatePathParam("ipId", request.ipId)}`
+    },
+    marshalling_gen.unmarshalIP
+  );
+  /**
+   * Delete an IP. Delete a flexible IP address from your account. This action
+   * is irreversible.
+   *
+   * @param request - The request {@link DeleteIPRequest}
+   */
+  deleteIP = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/ips/${marshalling.validatePathParam("ipId", request.ipId)}`
+  });
+  /**
+   * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public
+   * Gateway, specified by its gateway ID. This adds any new SSH keys in the
+   * gateway's Scaleway Project to the gateway itself.
+   *
+   * @param request - The request {@link RefreshSSHKeysRequest}
+   * @returns A Promise of Gateway
+   */
+  refreshSSHKeys = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/refresh-ssh-keys`
+    },
+    marshalling_gen.unmarshalGateway
+  );
+}
+exports.API = API;