@scaleway/sdk 1.2.0 → 1.4.0

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

@@ -15,7 +15,7 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Get availability for all server types.
+     * Get availability. Get availability for all server types.
      *
      * @param request - The request {@link GetServerTypesAvailabilityRequest}
      * @returns A Promise of GetServerTypesAvailabilityResponse
@@ -31,7 +31,7 @@ class API extends API$1 {
       }, unmarshalGetServerTypesAvailabilityResponse);
     };
     /**
-     * Get server types technical details.
+     * List server types. Get server types technical details.
      *
      * @param request - The request {@link ListServersTypesRequest}
      * @returns A Promise of ListServersTypesResponse
@@ -47,7 +47,7 @@ class API extends API$1 {
       }, unmarshalListServersTypesResponse);
     };
     /**
-     * Get volumes technical details.
+     * List volumes types. Get volumes technical details.
      *
      * @param request - The request {@link ListVolumesTypesRequest}
      * @returns A Promise of ListVolumesTypesResponse
@@ -73,7 +73,7 @@ class API extends API$1 {
       }, unmarshalListServersResponse);
     };
     /**
-     * List all servers
+     * List all servers.
      *
      * @param request - The request {@link ListServersRequest}
      * @returns A Promise of ListServersResponse
@@ -91,7 +91,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
     }, unmarshalCreateServerResponse);
     /**
-     * Delete a server with the given ID.
+     * Delete a server. Delete a server with the given ID.
      *
      * @param request - The request {@link DeleteServerRequest}
      */
@@ -100,7 +100,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     });
     /**
-     * Get the details of a specified Server.
+     * Get a server. Get the details of a specified Server.
      *
      * @param request - The request {@link GetServerRequest}
      * @returns A Promise of GetServerResponse
@@ -122,7 +122,8 @@ class API extends API$1 {
       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.
+     * List server actions. List all actions that can currently be performed on a
+     * server.
      *
      * @param request - The request {@link ListServerActionsRequest}
      * @returns A Promise of ListServerActionsResponse
@@ -132,12 +133,13 @@ class API extends API$1 {
       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.
+     * Perform action. 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
@@ -149,7 +151,7 @@ class API extends API$1 {
       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.
+     * List user data. List all user data keys registered on a given server.
      *
      * @param request - The request {@link ListServerUserDataRequest}
      * @returns A Promise of ListServerUserDataResponse
@@ -159,7 +161,7 @@ class API extends API$1 {
       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.
+     * Delete user data. Delete the given key from a server user data.
      *
      * @param request - The request {@link DeleteServerUserDataRequest}
      */
@@ -178,7 +180,7 @@ class API extends API$1 {
       }, unmarshalListImagesResponse);
     };
     /**
-     * List all images available in an account.
+     * List instance images. List all images available in an account.
      *
      * @param request - The request {@link ListImagesRequest}
      * @returns A Promise of ListImagesResponse
@@ -190,7 +192,7 @@ class API extends API$1 {
       return enrichForPagination('images', _this.pageOfListImages, request);
     };
     /**
-     * Get details of an image with the given ID.
+     * Get an instance image. Get details of an image with the given ID.
      *
      * @param request - The request {@link GetImageRequest}
      * @returns A Promise of GetImageResponse
@@ -200,7 +202,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/images/${validatePathParam('imageId', request.imageId)}`
     }, unmarshalGetImageResponse);
     /**
-     * Create an instance image
+     * Create an instance image.
      *
      * @param request - The request {@link CreateImageRequest}
      * @returns A Promise of CreateImageResponse
@@ -218,7 +220,7 @@ class API extends API$1 {
       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.
+     * Delete an instance image. Delete the image with the given ID.
      *
      * @param request - The request {@link DeleteImageRequest}
      */
@@ -237,7 +239,7 @@ class API extends API$1 {
       }, unmarshalListSnapshotsResponse);
     };
     /**
-     * List snapshots
+     * List snapshots.
      *
      * @param request - The request {@link ListSnapshotsRequest}
      * @returns A Promise of ListSnapshotsResponse
@@ -249,7 +251,7 @@ class API extends API$1 {
       return enrichForPagination('snapshots', _this.pageOfListSnapshots, request);
     };
     /**
-     * Create a snapshot from a given volume or from a QCOW2 file
+     * Create a snapshot from a given volume or from a QCOW2 file.
      *
      * @param request - The request {@link CreateSnapshotRequest}
      * @returns A Promise of CreateSnapshotResponse
@@ -266,7 +268,7 @@ class API extends API$1 {
       }, unmarshalCreateSnapshotResponse);
     };
     /**
-     * Get details of a snapshot with the given ID.
+     * Get a snapshot. Get details of a snapshot with the given ID.
      *
      * @param request - The request {@link GetSnapshotRequest}
      * @returns A Promise of GetSnapshotResponse
@@ -282,7 +284,7 @@ class API extends API$1 {
       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.
+     * Delete a snapshot. Delete the snapshot with the given ID.
      *
      * @param request - The request {@link DeleteSnapshotRequest}
      */
@@ -291,7 +293,8 @@ class API extends API$1 {
       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.
+     * Export a snapshot. Export a snapshot to a given S3 bucket in the same
+     * region.
      *
      * @param request - The request {@link ExportSnapshotRequest}
      * @returns A Promise of ExportSnapshotResponse
@@ -313,7 +316,7 @@ class API extends API$1 {
       }, unmarshalListVolumesResponse);
     };
     /**
-     * List volumes
+     * List volumes.
      *
      * @param request - The request {@link ListVolumesRequest}
      * @returns A Promise of ListVolumesResponse
@@ -325,7 +328,7 @@ class API extends API$1 {
       return enrichForPagination('volumes', _this.pageOfListVolumes, request);
     };
     /**
-     * Create a volume
+     * Create a volume.
      *
      * @param request - The request {@link CreateVolumeRequest}
      * @returns A Promise of CreateVolumeResponse
@@ -342,7 +345,7 @@ class API extends API$1 {
       }, unmarshalCreateVolumeResponse);
     };
     /**
-     * Get details of a volume with the given ID.
+     * Get a volume. Get details of a volume with the given ID.
      *
      * @param request - The request {@link GetVolumeRequest}
      * @returns A Promise of GetVolumeResponse
@@ -352,9 +355,9 @@ class API extends API$1 {
       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.
+     * Update a volume. 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
@@ -366,7 +369,7 @@ class API extends API$1 {
       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.
+     * Delete a volume. Delete the volume with the given ID.
      *
      * @param request - The request {@link DeleteVolumeRequest}
      */
@@ -385,7 +388,7 @@ class API extends API$1 {
       }, unmarshalListSecurityGroupsResponse);
     };
     /**
-     * List all security groups available in an account.
+     * List security groups. List all security groups available in an account.
      *
      * @param request - The request {@link ListSecurityGroupsRequest}
      * @returns A Promise of ListSecurityGroupsResponse
@@ -397,7 +400,7 @@ class API extends API$1 {
       return enrichForPagination('securityGroups', _this.pageOfListSecurityGroups, request);
     };
     /**
-     * Create a security group
+     * Create a security group.
      *
      * @param request - The request {@link CreateSecurityGroupRequest}
      * @returns A Promise of CreateSecurityGroupResponse
@@ -409,7 +412,8 @@ class API extends API$1 {
       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.
+     * Get a security group. Get the details of a Security Group with the given
+     * ID.
      *
      * @param request - The request {@link GetSecurityGroupRequest}
      * @returns A Promise of GetSecurityGroupResponse
@@ -419,7 +423,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/security_groups/${validatePathParam('securityGroupId', request.securityGroupId)}`
     }, unmarshalGetSecurityGroupResponse);
     /**
-     * Delete a security group
+     * Delete a security group.
      *
      * @param request - The request {@link DeleteSecurityGroupRequest}
      */
@@ -434,7 +438,8 @@ class API extends API$1 {
       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.
+     * Get default rules. Lists the default rules applied to all the security
+     * groups.
      *
      * @param request - The request {@link ListDefaultSecurityGroupRulesRequest}
      * @returns A Promise of ListSecurityGroupRulesResponse
@@ -454,14 +459,14 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize])
     }, unmarshalListSecurityGroupRulesResponse);
     /**
-     * List rules
+     * List rules.
      *
      * @param request - The request {@link ListSecurityGroupRulesRequest}
      * @returns A Promise of ListSecurityGroupRulesResponse
      */
     this.listSecurityGroupRules = request => enrichForPagination('rules', this.pageOfListSecurityGroupRules, request);
     /**
-     * Create rule
+     * Create rule.
      *
      * @param request - The request {@link CreateSecurityGroupRuleRequest}
      * @returns A Promise of CreateSecurityGroupRuleResponse
@@ -473,9 +478,10 @@ class API extends API$1 {
       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.
+     * Update all the rules of a security group. 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
@@ -487,7 +493,7 @@ class API extends API$1 {
       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.
+     * Delete rule. Delete a security group rule with the given ID.
      *
      * @param request - The request {@link DeleteSecurityGroupRuleRequest}
      */
@@ -496,7 +502,7 @@ class API extends API$1 {
       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.
+     * Get rule. Get details of a security group rule with the given ID.
      *
      * @param request - The request {@link GetSecurityGroupRuleRequest}
      * @returns A Promise of GetSecurityGroupRuleResponse
@@ -522,7 +528,7 @@ class API extends API$1 {
       }, unmarshalListPlacementGroupsResponse);
     };
     /**
-     * List all placement groups.
+     * List placement groups. List all placement groups.
      *
      * @param request - The request {@link ListPlacementGroupsRequest}
      * @returns A Promise of ListPlacementGroupsResponse
@@ -534,7 +540,7 @@ class API extends API$1 {
       return enrichForPagination('placementGroups', _this.pageOfListPlacementGroups, request);
     };
     /**
-     * Create a new placement group.
+     * Create a placement group. Create a new placement group.
      *
      * @param request - The request {@link CreatePlacementGroupRequest}
      * @returns A Promise of CreatePlacementGroupResponse
@@ -551,7 +557,7 @@ class API extends API$1 {
       }, unmarshalCreatePlacementGroupResponse);
     };
     /**
-     * Get the given placement group.
+     * Get a placement group. Get the given placement group.
      *
      * @param request - The request {@link GetPlacementGroupRequest}
      * @returns A Promise of GetPlacementGroupResponse
@@ -561,7 +567,7 @@ class API extends API$1 {
       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.
+     * Set placement group. Set all parameters of the given placement group.
      *
      * @param request - The request {@link SetPlacementGroupRequest}
      * @returns A Promise of SetPlacementGroupResponse
@@ -573,7 +579,8 @@ class API extends API$1 {
       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.
+     * Update a placement group. Update one or more parameter of the given
+     * placement group.
      *
      * @param request - The request {@link UpdatePlacementGroupRequest}
      * @returns A Promise of UpdatePlacementGroupResponse
@@ -594,7 +601,8 @@ class API extends API$1 {
       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.
+     * Get placement group servers. Get all servers belonging to the given
+     * placement group.
      *
      * @param request - The request {@link GetPlacementGroupServersRequest}
      * @returns A Promise of GetPlacementGroupServersResponse
@@ -604,7 +612,8 @@ class API extends API$1 {
       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.
+     * Set placement group servers. Set all servers belonging to the given
+     * placement group.
      *
      * @param request - The request {@link SetPlacementGroupServersRequest}
      * @returns A Promise of SetPlacementGroupServersResponse
@@ -616,7 +625,8 @@ class API extends API$1 {
       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.
+     * Update placement group servers. Update all servers belonging to the given
+     * placement group.
      *
      * @param request - The request {@link UpdatePlacementGroupServersRequest}
      * @returns A Promise of UpdatePlacementGroupServersResponse
@@ -638,7 +648,7 @@ class API extends API$1 {
       }, unmarshalListIpsResponse);
     };
     /**
-     * List all flexible IPs
+     * List all flexible IPs.
      *
      * @param request - The request {@link ListIpsRequest}
      * @returns A Promise of ListIpsResponse
@@ -650,7 +660,7 @@ class API extends API$1 {
       return enrichForPagination('ips', _this.pageOfListIps, request);
     };
     /**
-     * Reserve a flexible IP
+     * Reserve a flexible IP.
      *
      * @param request - The request {@link CreateIpRequest}
      * @returns A Promise of CreateIpResponse
@@ -667,7 +677,7 @@ class API extends API$1 {
       }, unmarshalCreateIpResponse);
     };
     /**
-     * Get details of an IP with the given ID or address.
+     * Get a flexible IP. Get details of an IP with the given ID or address.
      *
      * @param request - The request {@link GetIpRequest}
      * @returns A Promise of GetIpResponse
@@ -677,7 +687,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips/${validatePathParam('ip', request.ip)}`
     }, unmarshalGetIpResponse);
     /**
-     * Update a flexible IP
+     * Update a flexible IP.
      *
      * @param request - The request {@link UpdateIpRequest}
      * @returns A Promise of UpdateIpResponse
@@ -689,7 +699,7 @@ class API extends API$1 {
       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.
+     * Delete a flexible IP. Delete the IP with the given ID.
      *
      * @param request - The request {@link DeleteIpRequest}
      */
@@ -703,7 +713,7 @@ class API extends API$1 {
       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.
+     * List all private NICs. List all private NICs of a given server.
      *
      * @param request - The request {@link ListPrivateNICsRequest}
      * @returns A Promise of ListPrivateNICsResponse
@@ -722,7 +732,7 @@ class API extends API$1 {
       path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private_nics`
     }, unmarshalCreatePrivateNICResponse);
     /**
-     * Get private NIC properties.
+     * Get a private NIC. Get private NIC properties.
      *
      * @param request - The request {@link GetPrivateNICRequest}
      * @returns A Promise of GetPrivateNICResponse
@@ -732,7 +742,8 @@ class API extends API$1 {
       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.
+     * Update a private NIC. Update one or more parameter/s to a given private
+     * NIC.
      *
      * @param request - The request {@link UpdatePrivateNICRequest}
      * @returns A Promise of PrivateNIC
@@ -763,7 +774,7 @@ class API extends API$1 {
       }, unmarshalListBootscriptsResponse);
     };
     /**
-     * List bootscripts
+     * List bootscripts.
      *
      * @deprecated
      * @param request - The request {@link ListBootscriptsRequest}
@@ -776,7 +787,7 @@ class API extends API$1 {
       return enrichForPagination('bootscripts', _this.pageOfListBootscripts, request);
     };
     /**
-     * Get details of a bootscript with the given ID.
+     * Get bootscripts. Get details of a bootscript with the given ID.
      *
      * @deprecated
      * @param request - The request {@link GetBootscriptRequest}