@scaleway/sdk 1.0.0 → 1.1.0

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

@@ -1,7 +1,7 @@
 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 { unmarshalGetServerTypesAvailabilityResponse, unmarshalListServersTypesResponse, unmarshalListVolumesTypesResponse, unmarshalListServersResponse, marshalCreateServerRequest, unmarshalCreateServerResponse, unmarshalGetServerResponse, marshalSetServerRequest, unmarshalSetServerResponse, marshalUpdateServerRequest, unmarshalUpdateServerResponse, unmarshalListServerActionsResponse, marshalServerActionRequest, unmarshalServerActionResponse, unmarshalListServerUserDataResponse, unmarshalListImagesResponse, unmarshalGetImageResponse, marshalCreateImageRequest, unmarshalCreateImageResponse, marshalSetImageRequest, unmarshalSetImageResponse, unmarshalListSnapshotsResponse, marshalCreateSnapshotRequest, unmarshalCreateSnapshotResponse, unmarshalGetSnapshotResponse, marshalSetSnapshotRequest, unmarshalSetSnapshotResponse, marshalExportSnapshotRequest, unmarshalExportSnapshotResponse, unmarshalListVolumesResponse, marshalCreateVolumeRequest, unmarshalCreateVolumeResponse, unmarshalGetVolumeResponse, marshalUpdateVolumeRequest, unmarshalUpdateVolumeResponse, unmarshalListSecurityGroupsResponse, marshalCreateSecurityGroupRequest, unmarshalCreateSecurityGroupResponse, unmarshalGetSecurityGroupResponse, marshalSetSecurityGroupRequest, unmarshalSetSecurityGroupResponse, unmarshalListSecurityGroupRulesResponse, marshalCreateSecurityGroupRuleRequest, unmarshalCreateSecurityGroupRuleResponse, marshalSetSecurityGroupRulesRequest, unmarshalSetSecurityGroupRulesResponse, unmarshalGetSecurityGroupRuleResponse, marshalSetSecurityGroupRuleRequest, unmarshalSetSecurityGroupRuleResponse, unmarshalListPlacementGroupsResponse, marshalCreatePlacementGroupRequest, unmarshalCreatePlacementGroupResponse, unmarshalGetPlacementGroupResponse, marshalSetPlacementGroupRequest, unmarshalSetPlacementGroupResponse, marshalUpdatePlacementGroupRequest, unmarshalUpdatePlacementGroupResponse, unmarshalGetPlacementGroupServersResponse, marshalSetPlacementGroupServersRequest, unmarshalSetPlacementGroupServersResponse, marshalUpdatePlacementGroupServersRequest, unmarshalUpdatePlacementGroupServersResponse, unmarshalListIpsResponse, marshalCreateIpRequest, unmarshalCreateIpResponse, unmarshalGetIpResponse, marshalUpdateIpRequest, unmarshalUpdateIpResponse, unmarshalListPrivateNICsResponse, marshalCreatePrivateNICRequest, unmarshalCreatePrivateNICResponse, unmarshalGetPrivateNICResponse, unmarshalListBootscriptsResponse, unmarshalGetBootscriptResponse, unmarshalGetDashboardResponse } from './marshalling.gen.js';
+import { unmarshalGetServerTypesAvailabilityResponse, unmarshalListServersTypesResponse, unmarshalListVolumesTypesResponse, unmarshalListServersResponse, marshalCreateServerRequest, unmarshalCreateServerResponse, unmarshalGetServerResponse, marshalSetServerRequest, unmarshalSetServerResponse, marshalUpdateServerRequest, unmarshalUpdateServerResponse, unmarshalListServerActionsResponse, marshalServerActionRequest, unmarshalServerActionResponse, unmarshalListServerUserDataResponse, unmarshalListImagesResponse, unmarshalGetImageResponse, marshalCreateImageRequest, unmarshalCreateImageResponse, marshalSetImageRequest, unmarshalSetImageResponse, unmarshalListSnapshotsResponse, marshalCreateSnapshotRequest, unmarshalCreateSnapshotResponse, unmarshalGetSnapshotResponse, marshalSetSnapshotRequest, unmarshalSetSnapshotResponse, marshalExportSnapshotRequest, unmarshalExportSnapshotResponse, unmarshalListVolumesResponse, marshalCreateVolumeRequest, unmarshalCreateVolumeResponse, unmarshalGetVolumeResponse, marshalUpdateVolumeRequest, unmarshalUpdateVolumeResponse, unmarshalListSecurityGroupsResponse, marshalCreateSecurityGroupRequest, unmarshalCreateSecurityGroupResponse, unmarshalGetSecurityGroupResponse, marshalSetSecurityGroupRequest, unmarshalSetSecurityGroupResponse, unmarshalListSecurityGroupRulesResponse, marshalCreateSecurityGroupRuleRequest, unmarshalCreateSecurityGroupRuleResponse, marshalSetSecurityGroupRulesRequest, unmarshalSetSecurityGroupRulesResponse, unmarshalGetSecurityGroupRuleResponse, marshalSetSecurityGroupRuleRequest, unmarshalSetSecurityGroupRuleResponse, unmarshalListPlacementGroupsResponse, marshalCreatePlacementGroupRequest, unmarshalCreatePlacementGroupResponse, unmarshalGetPlacementGroupResponse, marshalSetPlacementGroupRequest, unmarshalSetPlacementGroupResponse, marshalUpdatePlacementGroupRequest, unmarshalUpdatePlacementGroupResponse, unmarshalGetPlacementGroupServersResponse, marshalSetPlacementGroupServersRequest, unmarshalSetPlacementGroupServersResponse, marshalUpdatePlacementGroupServersRequest, unmarshalUpdatePlacementGroupServersResponse, unmarshalListIpsResponse, marshalCreateIpRequest, unmarshalCreateIpResponse, unmarshalGetIpResponse, marshalUpdateIpRequest, unmarshalUpdateIpResponse, unmarshalListPrivateNICsResponse, marshalCreatePrivateNICRequest, unmarshalCreatePrivateNICResponse, unmarshalGetPrivateNICResponse, marshalUpdatePrivateNICRequest, unmarshalPrivateNIC, unmarshalListBootscriptsResponse, unmarshalGetBootscriptResponse, unmarshalGetDashboardResponse } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 const jsonContentHeaders = {
@@ -14,6 +14,12 @@ class API extends API$1 {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Get availability for all server types.
+     *
+     * @param request - The request {@link GetServerTypesAvailabilityRequest}
+     * @returns A Promise of GetServerTypesAvailabilityResponse
+     */
     this.getServerTypesAvailability = function (request) {
       if (request === void 0) {
         request = {};
@@ -24,6 +30,12 @@ class API extends API$1 {
         urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize])
       }, unmarshalGetServerTypesAvailabilityResponse);
     };
+    /**
+     * Get server types technical details.
+     *
+     * @param request - The request {@link ListServersTypesRequest}
+     * @returns A Promise of ListServersTypesResponse
+     */
     this.listServersTypes = function (request) {
       if (request === void 0) {
         request = {};
@@ -34,6 +46,12 @@ class API extends API$1 {
         urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize])
       }, unmarshalListServersTypesResponse);
     };
+    /**
+     * Get volumes technical details.
+     *
+     * @param request - The request {@link ListVolumesTypesRequest}
+     * @returns A Promise of ListVolumesTypesResponse
+     */
     this.listVolumesTypes = function (request) {
       if (request === void 0) {
         request = {};
@@ -51,9 +69,15 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/servers`,
-        urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['project', request.project ?? _this.client.settings.defaultProjectId], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
+        urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['project', request.project], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
       }, unmarshalListServersResponse);
     };
+    /**
+     * List all servers
+     *
+     * @param request - The request {@link ListServersRequest}
+     * @returns A Promise of ListServersResponse
+     */
     this.listServers = function (request) {
       if (request === void 0) {
         request = {};
@@ -66,10 +90,21 @@ class API extends API$1 {
       method: 'POST',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
     }, unmarshalCreateServerResponse);
+    /**
+     * Delete a server with the given ID.
+     *
+     * @param request - The request {@link DeleteServerRequest}
+     */
     this.deleteServer = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     });
+    /**
+     * Get the details of a specified Server.
+     *
+     * @param request - The request {@link GetServerRequest}
+     * @returns A Promise of GetServerResponse
+     */
     this.getServer = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
@@ -86,20 +121,48 @@ class API extends API$1 {
       method: 'PATCH',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalUpdateServerResponse);
+    /**
+     * List all actions that can currently be performed on a server.
+     *
+     * @param request - The request {@link ListServerActionsRequest}
+     * @returns A Promise of ListServerActionsResponse
+     */
     this.listServerActions = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/action`
     }, unmarshalListServerActionsResponse);
+    /**
+     * Perform power related actions on a server. Be wary that when terminating a
+     * server, all the attached volumes (local _and_ block storage) are deleted.
+     * So, if you want to keep your local volumes, you must use the `archive`
+     * action instead of `terminate`. And if you want to keep block-storage
+     * volumes, **you must** detach it beforehand you issue the `terminate` call.
+     * For more information, read the [Volumes](#volumes-7e8a39) documentation.
+     *
+     * @param request - The request {@link ServerActionRequest}
+     * @returns A Promise of ServerActionResponse
+     */
     this.serverAction = request => this.client.fetch({
       body: JSON.stringify(marshalServerActionRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/action`
     }, unmarshalServerActionResponse);
+    /**
+     * List all user data keys registered on a given server.
+     *
+     * @param request - The request {@link ListServerUserDataRequest}
+     * @returns A Promise of ListServerUserDataResponse
+     */
     this.listServerUserData = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/user_data`
     }, unmarshalListServerUserDataResponse);
+    /**
+     * Delete the given key from a server user data.
+     *
+     * @param request - The request {@link DeleteServerUserDataRequest}
+     */
     this.deleteServerUserData = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/user_data/${validatePathParam('key', request.key)}`
@@ -111,19 +174,37 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/images`,
-        urlParams: urlParams(['arch', request.arch], ['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['public', request.public], ['tags', request.tags])
+        urlParams: urlParams(['arch', request.arch], ['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['public', request.public], ['tags', request.tags])
       }, unmarshalListImagesResponse);
     };
+    /**
+     * List all images available in an account.
+     *
+     * @param request - The request {@link ListImagesRequest}
+     * @returns A Promise of ListImagesResponse
+     */
     this.listImages = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('images', _this.pageOfListImages, request);
     };
+    /**
+     * Get details of an image with the given ID.
+     *
+     * @param request - The request {@link GetImageRequest}
+     * @returns A Promise of GetImageResponse
+     */
     this.getImage = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('imageId', request.imageId)}`
     }, unmarshalGetImageResponse);
+    /**
+     * Create an instance image
+     *
+     * @param request - The request {@link CreateImageRequest}
+     * @returns A Promise of CreateImageResponse
+     */
     this.createImage = request => this.client.fetch({
       body: JSON.stringify(marshalCreateImageRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -136,6 +217,11 @@ class API extends API$1 {
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('id', request.id)}`
     }, unmarshalSetImageResponse);
+    /**
+     * Delete the image with the given ID.
+     *
+     * @param request - The request {@link DeleteImageRequest}
+     */
     this.deleteImage = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('imageId', request.imageId)}`
@@ -147,15 +233,27 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/snapshots`,
-        urlParams: urlParams(['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['tags', request.tags])
+        urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags])
       }, unmarshalListSnapshotsResponse);
     };
+    /**
+     * List snapshots
+     *
+     * @param request - The request {@link ListSnapshotsRequest}
+     * @returns A Promise of ListSnapshotsResponse
+     */
     this.listSnapshots = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('snapshots', _this.pageOfListSnapshots, request);
     };
+    /**
+     * Create a snapshot from a given volume or from a QCOW2 file
+     *
+     * @param request - The request {@link CreateSnapshotRequest}
+     * @returns A Promise of CreateSnapshotResponse
+     */
     this.createSnapshot = function (request) {
       if (request === void 0) {
         request = {};
@@ -167,6 +265,12 @@ class API extends API$1 {
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/snapshots`
       }, unmarshalCreateSnapshotResponse);
     };
+    /**
+     * Get details of a snapshot with the given ID.
+     *
+     * @param request - The request {@link GetSnapshotRequest}
+     * @returns A Promise of GetSnapshotResponse
+     */
     this.getSnapshot = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
@@ -177,10 +281,21 @@ class API extends API$1 {
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     }, unmarshalSetSnapshotResponse);
+    /**
+     * Delete the snapshot with the given ID.
+     *
+     * @param request - The request {@link DeleteSnapshotRequest}
+     */
     this.deleteSnapshot = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     });
+    /**
+     * Export a snapshot to a given S3 bucket in the same region.
+     *
+     * @param request - The request {@link ExportSnapshotRequest}
+     * @returns A Promise of ExportSnapshotResponse
+     */
     this.exportSnapshot = request => this.client.fetch({
       body: JSON.stringify(marshalExportSnapshotRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -194,15 +309,27 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/volumes`,
-        urlParams: urlParams(['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['volume_type', request.volumeType])
+        urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['volume_type', request.volumeType])
       }, unmarshalListVolumesResponse);
     };
+    /**
+     * List volumes
+     *
+     * @param request - The request {@link ListVolumesRequest}
+     * @returns A Promise of ListVolumesResponse
+     */
     this.listVolumes = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('volumes', _this.pageOfListVolumes, request);
     };
+    /**
+     * Create a volume
+     *
+     * @param request - The request {@link CreateVolumeRequest}
+     * @returns A Promise of CreateVolumeResponse
+     */
     this.createVolume = function (request) {
       if (request === void 0) {
         request = {};
@@ -214,16 +341,35 @@ class API extends API$1 {
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/volumes`
       }, unmarshalCreateVolumeResponse);
     };
+    /**
+     * Get details of a volume with the given ID.
+     *
+     * @param request - The request {@link GetVolumeRequest}
+     * @returns A Promise of GetVolumeResponse
+     */
     this.getVolume = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
     }, unmarshalGetVolumeResponse);
+    /**
+     * Replace name and/or size properties of given ID volume with the given
+     * value(s). Any volume name can be changed while, for now, only `b_ssd`
+     * volume growing is supported.
+     *
+     * @param request - The request {@link UpdateVolumeRequest}
+     * @returns A Promise of UpdateVolumeResponse
+     */
     this.updateVolume = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateVolumeRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
     }, unmarshalUpdateVolumeResponse);
+    /**
+     * Delete the volume with the given ID.
+     *
+     * @param request - The request {@link DeleteVolumeRequest}
+     */
     this.deleteVolume = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam('volumeId', request.volumeId)}`
@@ -235,25 +381,48 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/security_groups`,
-        urlParams: urlParams(['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['project_default', request.projectDefault], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
+        urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['project_default', request.projectDefault], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
       }, unmarshalListSecurityGroupsResponse);
     };
+    /**
+     * List all security groups available in an account.
+     *
+     * @param request - The request {@link ListSecurityGroupsRequest}
+     * @returns A Promise of ListSecurityGroupsResponse
+     */
     this.listSecurityGroups = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('securityGroups', _this.pageOfListSecurityGroups, request);
     };
+    /**
+     * Create a security group
+     *
+     * @param request - The request {@link CreateSecurityGroupRequest}
+     * @returns A Promise of CreateSecurityGroupResponse
+     */
     this.createSecurityGroup = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSecurityGroupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups`
     }, unmarshalCreateSecurityGroupResponse);
+    /**
+     * Get the details of a Security Group with the given ID.
+     *
+     * @param request - The request {@link GetSecurityGroupRequest}
+     * @returns A Promise of GetSecurityGroupResponse
+     */
     this.getSecurityGroup = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}`
     }, unmarshalGetSecurityGroupResponse);
+    /**
+     * Delete a security group
+     *
+     * @param request - The request {@link DeleteSecurityGroupRequest}
+     */
     this.deleteSecurityGroup = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}`
@@ -264,6 +433,12 @@ class API extends API$1 {
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('id', request.id)}`
     }, unmarshalSetSecurityGroupResponse);
+    /**
+     * Lists the default rules applied to all the security groups.
+     *
+     * @param request - The request {@link ListDefaultSecurityGroupRulesRequest}
+     * @returns A Promise of ListSecurityGroupRulesResponse
+     */
     this.listDefaultSecurityGroupRules = function (request) {
       if (request === void 0) {
         request = {};
@@ -278,23 +453,54 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules`,
       urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize])
     }, unmarshalListSecurityGroupRulesResponse);
+    /**
+     * List rules
+     *
+     * @param request - The request {@link ListSecurityGroupRulesRequest}
+     * @returns A Promise of ListSecurityGroupRulesResponse
+     */
     this.listSecurityGroupRules = request => enrichForPagination('rules', this.pageOfListSecurityGroupRules, request);
+    /**
+     * Create rule
+     *
+     * @param request - The request {@link CreateSecurityGroupRuleRequest}
+     * @returns A Promise of CreateSecurityGroupRuleResponse
+     */
     this.createSecurityGroupRule = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSecurityGroupRuleRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules`
     }, unmarshalCreateSecurityGroupRuleResponse);
+    /**
+     * Replaces the rules of the security group with the rules provided. This
+     * endpoint supports the update of existing rules, creation of new rules and
+     * deletion of existing rules when they are not passed in the request.
+     *
+     * @param request - The request {@link SetSecurityGroupRulesRequest}
+     * @returns A Promise of SetSecurityGroupRulesResponse
+     */
     this.setSecurityGroupRules = request => this.client.fetch({
       body: JSON.stringify(marshalSetSecurityGroupRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules`
     }, unmarshalSetSecurityGroupRulesResponse);
+    /**
+     * Delete a security group rule with the given ID.
+     *
+     * @param request - The request {@link DeleteSecurityGroupRuleRequest}
+     */
     this.deleteSecurityGroupRule = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules/${validatePathParam('securityGroupRuleId', request.securityGroupRuleId)}`
     });
+    /**
+     * Get details of a security group rule with the given ID.
+     *
+     * @param request - The request {@link GetSecurityGroupRuleRequest}
+     * @returns A Promise of GetSecurityGroupRuleResponse
+     */
     this.getSecurityGroupRule = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}/rules/${validatePathParam('securityGroupRuleId', request.securityGroupRuleId)}`
@@ -312,15 +518,27 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/placement_groups`,
-        urlParams: urlParams(['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
+        urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
       }, unmarshalListPlacementGroupsResponse);
     };
+    /**
+     * List all placement groups.
+     *
+     * @param request - The request {@link ListPlacementGroupsRequest}
+     * @returns A Promise of ListPlacementGroupsResponse
+     */
     this.listPlacementGroups = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('placementGroups', _this.pageOfListPlacementGroups, request);
     };
+    /**
+     * Create a new placement group.
+     *
+     * @param request - The request {@link CreatePlacementGroupRequest}
+     * @returns A Promise of CreatePlacementGroupResponse
+     */
     this.createPlacementGroup = function (request) {
       if (request === void 0) {
         request = {};
@@ -332,36 +550,77 @@ class API extends API$1 {
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/placement_groups`
       }, unmarshalCreatePlacementGroupResponse);
     };
+    /**
+     * Get the given placement group.
+     *
+     * @param request - The request {@link GetPlacementGroupRequest}
+     * @returns A Promise of GetPlacementGroupResponse
+     */
     this.getPlacementGroup = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
     }, unmarshalGetPlacementGroupResponse);
+    /**
+     * Set all parameters of the given placement group.
+     *
+     * @param request - The request {@link SetPlacementGroupRequest}
+     * @returns A Promise of SetPlacementGroupResponse
+     */
     this.setPlacementGroup = request => this.client.fetch({
       body: JSON.stringify(marshalSetPlacementGroupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
     }, unmarshalSetPlacementGroupResponse);
+    /**
+     * Update one or more parameter of the given placement group.
+     *
+     * @param request - The request {@link UpdatePlacementGroupRequest}
+     * @returns A Promise of UpdatePlacementGroupResponse
+     */
     this.updatePlacementGroup = request => this.client.fetch({
       body: JSON.stringify(marshalUpdatePlacementGroupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
     }, unmarshalUpdatePlacementGroupResponse);
+    /**
+     * Delete the given placement group.
+     *
+     * @param request - The request {@link DeletePlacementGroupRequest}
+     */
     this.deletePlacementGroup = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}`
     });
+    /**
+     * Get all servers belonging to the given placement group.
+     *
+     * @param request - The request {@link GetPlacementGroupServersRequest}
+     * @returns A Promise of GetPlacementGroupServersResponse
+     */
     this.getPlacementGroupServers = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}/servers`
     }, unmarshalGetPlacementGroupServersResponse);
+    /**
+     * Set all servers belonging to the given placement group.
+     *
+     * @param request - The request {@link SetPlacementGroupServersRequest}
+     * @returns A Promise of SetPlacementGroupServersResponse
+     */
     this.setPlacementGroupServers = request => this.client.fetch({
       body: JSON.stringify(marshalSetPlacementGroupServersRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/placement_groups/${validatePathParam('placementGroupId', request.placementGroupId)}/servers`
     }, unmarshalSetPlacementGroupServersResponse);
+    /**
+     * Update all servers belonging to the given placement group.
+     *
+     * @param request - The request {@link UpdatePlacementGroupServersRequest}
+     * @returns A Promise of UpdatePlacementGroupServersResponse
+     */
     this.updatePlacementGroupServers = request => this.client.fetch({
       body: JSON.stringify(marshalUpdatePlacementGroupServersRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -375,15 +634,27 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/ips`,
-        urlParams: urlParams(['name', request.name], ['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project ?? _this.client.settings.defaultProjectId], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
+        urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
       }, unmarshalListIpsResponse);
     };
+    /**
+     * List all flexible IPs
+     *
+     * @param request - The request {@link ListIpsRequest}
+     * @returns A Promise of ListIpsResponse
+     */
     this.listIps = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('ips', _this.pageOfListIps, request);
     };
+    /**
+     * Reserve a flexible IP
+     *
+     * @param request - The request {@link CreateIpRequest}
+     * @returns A Promise of CreateIpResponse
+     */
     this.createIp = function (request) {
       if (request === void 0) {
         request = {};
@@ -395,34 +666,88 @@ class API extends API$1 {
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/ips`
       }, unmarshalCreateIpResponse);
     };
+    /**
+     * Get details of an IP with the given ID or address.
+     *
+     * @param request - The request {@link GetIpRequest}
+     * @returns A Promise of GetIpResponse
+     */
     this.getIp = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
     }, unmarshalGetIpResponse);
+    /**
+     * Update a flexible IP
+     *
+     * @param request - The request {@link UpdateIpRequest}
+     * @returns A Promise of UpdateIpResponse
+     */
     this.updateIp = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateIpRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
     }, unmarshalUpdateIpResponse);
+    /**
+     * Delete the IP with the given ID.
+     *
+     * @param request - The request {@link DeleteIpRequest}
+     */
     this.deleteIp = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
     });
-    this.listPrivateNICs = request => this.client.fetch({
+    this.pageOfListPrivateNICs = request => this.client.fetch({
       method: 'GET',
-      path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics`
+      path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics`,
+      urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined])
     }, unmarshalListPrivateNICsResponse);
+    /**
+     * List all private NICs of a given server.
+     *
+     * @param request - The request {@link ListPrivateNICsRequest}
+     * @returns A Promise of ListPrivateNICsResponse
+     */
+    this.listPrivateNICs = request => enrichForPagination('privateNics', this.pageOfListPrivateNICs, request);
+    /**
+     * Create a private NIC connecting a server to a private network.
+     *
+     * @param request - The request {@link CreatePrivateNICRequest}
+     * @returns A Promise of CreatePrivateNICResponse
+     */
     this.createPrivateNIC = request => this.client.fetch({
       body: JSON.stringify(marshalCreatePrivateNICRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics`
     }, unmarshalCreatePrivateNICResponse);
+    /**
+     * Get private NIC properties.
+     *
+     * @param request - The request {@link GetPrivateNICRequest}
+     * @returns A Promise of GetPrivateNICResponse
+     */
     this.getPrivateNIC = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics/${validatePathParam('privateNicId', request.privateNicId)}`
     }, unmarshalGetPrivateNICResponse);
+    /**
+     * Update one or more parameter/s to a given private NIC.
+     *
+     * @param request - The request {@link UpdatePrivateNICRequest}
+     * @returns A Promise of PrivateNIC
+     */
+    this.updatePrivateNIC = request => this.client.fetch({
+      body: JSON.stringify(marshalUpdatePrivateNICRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'PATCH',
+      path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics/${validatePathParam('privateNicId', request.privateNicId)}`
+    }, unmarshalPrivateNIC);
+    /**
+     * Delete a private NIC.
+     *
+     * @param request - The request {@link DeletePrivateNICRequest}
+     */
     this.deletePrivateNIC = request => this.client.fetch({
       method: 'DELETE',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics/${validatePathParam('privateNicId', request.privateNicId)}`
@@ -437,12 +762,26 @@ class API extends API$1 {
         urlParams: urlParams(['arch', request.arch], ['default', request.default], ['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize], ['public', request.public], ['title', request.title])
       }, unmarshalListBootscriptsResponse);
     };
+    /**
+     * List bootscripts
+     *
+     * @deprecated
+     * @param request - The request {@link ListBootscriptsRequest}
+     * @returns A Promise of ListBootscriptsResponse
+     */
     this.listBootscripts = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('bootscripts', _this.pageOfListBootscripts, request);
     };
+    /**
+     * Get details of a bootscript with the given ID.
+     *
+     * @deprecated
+     * @param request - The request {@link GetBootscriptRequest}
+     * @returns A Promise of GetBootscriptResponse
+     */
     this.getBootscript = request => this.client.fetch({
       method: 'GET',
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/bootscripts/${validatePathParam('bootscriptId', request.bootscriptId)}`
@@ -454,11 +793,12 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/dashboard`,
-        urlParams: urlParams(['organization', request.organization ?? _this.client.settings.defaultOrganizationId], ['project', request.project ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['organization', request.organization], ['project', request.project])
       }, unmarshalGetDashboardResponse);
     };
   }
 }
+/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-1', 'fr-par-2', 'fr-par-3', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
 
 export { API };