@scaleway/sdk 1.12.0 → 1.14.0

package/dist/api/vpc/v2/api.gen.js

@@ -0,0 +1,231 @@
+import { API as API$1 } from '../../../scw/api.js';
+import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
+import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
+import { unmarshalListVPCsResponse, marshalCreateVPCRequest, unmarshalVPC, marshalUpdateVPCRequest, unmarshalListPrivateNetworksResponse, marshalCreatePrivateNetworkRequest, unmarshalPrivateNetwork, marshalUpdatePrivateNetworkRequest, marshalMigrateZonalPrivateNetworksRequest, marshalSetSubnetsRequest, unmarshalSetSubnetsResponse, marshalAddSubnetsRequest, unmarshalAddSubnetsResponse, marshalDeleteSubnetsRequest, unmarshalDeleteSubnetsResponse } from './marshalling.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8'
+};
+
+/** VPC API. */
+class API extends API$1 {
+  constructor() {
+    var _this;
+    super(...arguments);
+    _this = this;
+    this.pageOfListVPCs = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/vpcs`,
+        urlParams: urlParams(['is_default', request.isDefault], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
+      }, unmarshalListVPCsResponse);
+    };
+    /**
+     * List VPCs. List existing VPCs in the specified region.
+     *
+     * @param request - The request {@link ListVPCsRequest}
+     * @returns A Promise of ListVPCsResponse
+     */
+    this.listVPCs = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('vpcs', _this.pageOfListVPCs, request);
+    };
+    /**
+     * Create a VPC. Create a new VPC in the specified region.
+     *
+     * @param request - The request {@link CreateVPCRequest}
+     * @returns A Promise of VPC
+     */
+    this.createVPC = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalCreateVPCRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/vpcs`
+      }, unmarshalVPC);
+    };
+    /**
+     * Get a VPC. Retrieve details of an existing VPC, specified by its VPC ID.
+     *
+     * @param request - The request {@link GetVPCRequest}
+     * @returns A Promise of VPC
+     */
+    this.getVPC = request => this.client.fetch({
+      method: 'GET',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/vpcs/${validatePathParam('vpcId', request.vpcId)}`
+    }, unmarshalVPC);
+    /**
+     * Update VPC. Update parameters including name and tags of the specified VPC.
+     *
+     * @param request - The request {@link UpdateVPCRequest}
+     * @returns A Promise of VPC
+     */
+    this.updateVPC = request => this.client.fetch({
+      body: JSON.stringify(marshalUpdateVPCRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'PATCH',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/vpcs/${validatePathParam('vpcId', request.vpcId)}`
+    }, unmarshalVPC);
+    /**
+     * Delete a VPC. Delete a VPC specified by its VPC ID.
+     *
+     * @param request - The request {@link DeleteVPCRequest}
+     */
+    this.deleteVPC = request => this.client.fetch({
+      method: 'DELETE',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/vpcs/${validatePathParam('vpcId', request.vpcId)}`
+    });
+    this.pageOfListPrivateNetworks = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/private-networks`,
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags], ['vpc_id', request.vpcId])
+      }, unmarshalListPrivateNetworksResponse);
+    };
+    /**
+     * List Private Networks. List existing Private Networks in the specified
+     * region. By default, the Private Networks returned in the list are ordered
+     * by creation date in ascending order, though this can be modified via the
+     * order_by field.
+     *
+     * @param request - The request {@link ListPrivateNetworksRequest}
+     * @returns A Promise of ListPrivateNetworksResponse
+     */
+    this.listPrivateNetworks = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('privateNetworks', _this.pageOfListPrivateNetworks, request);
+    };
+    /**
+     * Create a Private Network. Create a new Private Network. Once created, you
+     * can attach Scaleway resources which are in the same region.
+     *
+     * @param request - The request {@link CreatePrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
+    this.createPrivateNetwork = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalCreatePrivateNetworkRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/private-networks`
+      }, unmarshalPrivateNetwork);
+    };
+    /**
+     * Get a Private Network. Retrieve information about an existing Private
+     * Network, specified by its Private Network ID. Its full details are returned
+     * in the response object.
+     *
+     * @param request - The request {@link GetPrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
+    this.getPrivateNetwork = request => this.client.fetch({
+      method: 'GET',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
+    }, unmarshalPrivateNetwork);
+    /**
+     * Update Private Network. Update parameters (such as name or tags) of an
+     * existing Private Network, specified by its Private Network ID.
+     *
+     * @param request - The request {@link UpdatePrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
+    this.updatePrivateNetwork = request => this.client.fetch({
+      body: JSON.stringify(marshalUpdatePrivateNetworkRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'PATCH',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
+    }, unmarshalPrivateNetwork);
+    /**
+     * Delete a Private Network. Delete an existing Private Network. Note that you
+     * must first detach all resources from the network, in order to delete it.
+     *
+     * @param request - The request {@link DeletePrivateNetworkRequest}
+     */
+    this.deletePrivateNetwork = request => this.client.fetch({
+      method: 'DELETE',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
+    });
+    /**
+     * Migrate Private Networks from zoned to regional. Transform multiple
+     * existing zoned Private Networks (scoped to a single Availability Zone) into
+     * regional Private Networks, scoped to an entire region. You can transform
+     * one or many Private Networks (specified by their Private Network IDs)
+     * within a single Scaleway Organization or Project, with the same call.
+     *
+     * @param request - The request {@link MigrateZonalPrivateNetworksRequest}
+     */
+    this.migrateZonalPrivateNetworks = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalMigrateZonalPrivateNetworksRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/private-networks/migrate-zonal`
+      });
+    };
+    /**
+     * Set the subnets of a Private Network. Set subnets for an existing Private
+     * Network. Note that the method is PUT and not PATCH. Any existing subnets
+     * will be removed in favor of the new specified set of subnets.
+     *
+     * @param request - The request {@link SetSubnetsRequest}
+     * @returns A Promise of SetSubnetsResponse
+     */
+    this.setSubnets = request => this.client.fetch({
+      body: JSON.stringify(marshalSetSubnetsRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'PUT',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/subnets`
+    }, unmarshalSetSubnetsResponse);
+    /**
+     * Add subnets to a Private Network. Add new subnets to an existing Private
+     * Network.
+     *
+     * @param request - The request {@link AddSubnetsRequest}
+     * @returns A Promise of AddSubnetsResponse
+     */
+    this.addSubnets = request => this.client.fetch({
+      body: JSON.stringify(marshalAddSubnetsRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/subnets`
+    }, unmarshalAddSubnetsResponse);
+    /**
+     * Delete subnets from a Private Network. Delete the specified subnets from a
+     * Private Network.
+     *
+     * @param request - The request {@link DeleteSubnetsRequest}
+     * @returns A Promise of DeleteSubnetsResponse
+     */
+    this.deleteSubnets = request => this.client.fetch({
+      body: JSON.stringify(marshalDeleteSubnetsRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'DELETE',
+      path: `/vpc/v2/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/subnets`
+    }, unmarshalDeleteSubnetsResponse);
+  }
+}
+/** Lists the available regions of the API. */
+API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
+
+export { API };

package/dist/api/vpc/v2/index.gen.js

@@ -0,0 +1,4 @@
+export { API } from './api.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/vpc/v2/marshalling.gen.js

@@ -0,0 +1,136 @@
+import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.1/node_modules/@scaleway/random-name/dist/index.js';
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalSubnet = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Subnet' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    subnet: data.subnet,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalPrivateNetwork = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'PrivateNetwork' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    region: data.region,
+    subnets: unmarshalArrayOfObject(data.subnets, unmarshalSubnet),
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at),
+    vpcId: data.vpc_id
+  };
+};
+const unmarshalVPC = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'VPC' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    isDefault: data.is_default,
+    name: data.name,
+    organizationId: data.organization_id,
+    privateNetworkCount: data.private_network_count,
+    projectId: data.project_id,
+    region: data.region,
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalAddSubnetsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'AddSubnetsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    subnets: data.subnets
+  };
+};
+const unmarshalDeleteSubnetsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DeleteSubnetsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    subnets: data.subnets
+  };
+};
+const unmarshalListPrivateNetworksResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListPrivateNetworksResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    privateNetworks: unmarshalArrayOfObject(data.private_networks, unmarshalPrivateNetwork),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListVPCsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListVPCsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    totalCount: data.total_count,
+    vpcs: unmarshalArrayOfObject(data.vpcs, unmarshalVPC)
+  };
+};
+const unmarshalSetSubnetsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'SetSubnetsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    subnets: data.subnets
+  };
+};
+const marshalAddSubnetsRequest = (request, defaults) => ({
+  subnets: request.subnets
+});
+const marshalCreatePrivateNetworkRequest = (request, defaults) => ({
+  name: request.name || randomName('pn'),
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  subnets: request.subnets,
+  tags: request.tags,
+  vpc_id: request.vpcId
+});
+const marshalCreateVPCRequest = (request, defaults) => ({
+  name: request.name || randomName('vpc'),
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  tags: request.tags
+});
+const marshalDeleteSubnetsRequest = (request, defaults) => ({
+  subnets: request.subnets
+});
+const marshalMigrateZonalPrivateNetworksRequest = (request, defaults) => ({
+  private_network_ids: request.privateNetworkIds,
+  ...resolveOneOf([{
+    default: defaults.defaultProjectId,
+    param: 'project_id',
+    value: request.projectId
+  }, {
+    default: defaults.defaultOrganizationId,
+    param: 'organization_id',
+    value: request.organizationId
+  }])
+});
+const marshalSetSubnetsRequest = (request, defaults) => ({
+  subnets: request.subnets
+});
+const marshalUpdatePrivateNetworkRequest = (request, defaults) => ({
+  name: request.name,
+  tags: request.tags
+});
+const marshalUpdateVPCRequest = (request, defaults) => ({
+  name: request.name,
+  tags: request.tags
+});
+
+export { marshalAddSubnetsRequest, marshalCreatePrivateNetworkRequest, marshalCreateVPCRequest, marshalDeleteSubnetsRequest, marshalMigrateZonalPrivateNetworksRequest, marshalSetSubnetsRequest, marshalUpdatePrivateNetworkRequest, marshalUpdateVPCRequest, unmarshalAddSubnetsResponse, unmarshalDeleteSubnetsResponse, unmarshalListPrivateNetworksResponse, unmarshalListVPCsResponse, unmarshalPrivateNetwork, unmarshalSetSubnetsResponse, unmarshalVPC };

package/dist/api/vpcgw/v1/api.gen.js

@@ -588,8 +588,8 @@ class API extends API$1 {
       path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam('gatewayId', request.gatewayId)}/refresh-ssh-keys`
     }, unmarshalGateway);
   }
-  /** Lists the available zones of the API. */
 }
+/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
 
 export { API };

package/dist/api/webhosting/v1alpha1/api.gen.js

@@ -141,8 +141,8 @@ class API extends API$1 {
       urlParams: urlParams(['hosting_id', request.hostingId], ['only_options', request.onlyOptions], ['order_by', request.orderBy ?? 'price_asc'], ['without_options', request.withoutOptions])
     }, unmarshalListOffersResponse);
   }
-  /** Lists the available regions of the API. */
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par'];
 
 export { API };