@scaleway/sdk 1.0.0 → 1.2.0

package/dist/api/rdb/v1/marshalling.gen.js

@@ -282,6 +282,7 @@ const unmarshalNodeType = data => {
     beta: data.beta,
     description: data.description,
     disabled: data.disabled,
+    generation: data.generation,
     isBssdCompatible: data.is_bssd_compatible,
     isHaRequired: data.is_ha_required,
     memory: data.memory,
@@ -603,6 +604,9 @@ const marshalDeleteInstanceACLRulesRequest = (request, defaults) => ({
 const marshalDeleteInstanceSettingsRequest = (request, defaults) => ({
   setting_names: request.settingNames
 });
+const marshalMigrateEndpointRequest = (request, defaults) => ({
+  instance_id: request.instanceId
+});
 const marshalPrepareInstanceLogsRequest = (request, defaults) => ({
   end_date: request.endDate,
   start_date: request.startDate
@@ -665,4 +669,4 @@ const marshalUpgradeInstanceRequest = (request, defaults) => ({
   }])
 });
 
-export { marshalAddInstanceACLRulesRequest, marshalAddInstanceSettingsRequest, marshalCloneInstanceRequest, marshalCreateDatabaseBackupRequest, marshalCreateDatabaseRequest, marshalCreateEndpointRequest, marshalCreateInstanceFromSnapshotRequest, marshalCreateInstanceRequest, marshalCreateReadReplicaEndpointRequest, marshalCreateReadReplicaRequest, marshalCreateSnapshotRequest, marshalCreateUserRequest, marshalDeleteInstanceACLRulesRequest, marshalDeleteInstanceSettingsRequest, marshalPrepareInstanceLogsRequest, marshalPurgeInstanceLogsRequest, marshalRestoreDatabaseBackupRequest, marshalSetInstanceACLRulesRequest, marshalSetInstanceSettingsRequest, marshalSetPrivilegeRequest, marshalUpdateDatabaseBackupRequest, marshalUpdateInstanceRequest, marshalUpdateSnapshotRequest, marshalUpdateUserRequest, marshalUpgradeInstanceRequest, unmarshalAddInstanceACLRulesResponse, unmarshalAddInstanceSettingsResponse, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalDeleteInstanceACLRulesResponse, unmarshalDeleteInstanceSettingsResponse, unmarshalEndpoint, unmarshalInstance, unmarshalInstanceLog, unmarshalInstanceMetrics, unmarshalListDatabaseBackupsResponse, unmarshalListDatabaseEnginesResponse, unmarshalListDatabasesResponse, unmarshalListInstanceACLRulesResponse, unmarshalListInstanceLogsDetailsResponse, unmarshalListInstanceLogsResponse, unmarshalListInstancesResponse, unmarshalListNodeTypesResponse, unmarshalListPrivilegesResponse, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, unmarshalPrepareInstanceLogsResponse, unmarshalPrivilege, unmarshalReadReplica, unmarshalSetInstanceACLRulesResponse, unmarshalSetInstanceSettingsResponse, unmarshalSnapshot, unmarshalUser };
+export { marshalAddInstanceACLRulesRequest, marshalAddInstanceSettingsRequest, marshalCloneInstanceRequest, marshalCreateDatabaseBackupRequest, marshalCreateDatabaseRequest, marshalCreateEndpointRequest, marshalCreateInstanceFromSnapshotRequest, marshalCreateInstanceRequest, marshalCreateReadReplicaEndpointRequest, marshalCreateReadReplicaRequest, marshalCreateSnapshotRequest, marshalCreateUserRequest, marshalDeleteInstanceACLRulesRequest, marshalDeleteInstanceSettingsRequest, marshalMigrateEndpointRequest, marshalPrepareInstanceLogsRequest, marshalPurgeInstanceLogsRequest, marshalRestoreDatabaseBackupRequest, marshalSetInstanceACLRulesRequest, marshalSetInstanceSettingsRequest, marshalSetPrivilegeRequest, marshalUpdateDatabaseBackupRequest, marshalUpdateInstanceRequest, marshalUpdateSnapshotRequest, marshalUpdateUserRequest, marshalUpgradeInstanceRequest, unmarshalAddInstanceACLRulesResponse, unmarshalAddInstanceSettingsResponse, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalDeleteInstanceACLRulesResponse, unmarshalDeleteInstanceSettingsResponse, unmarshalEndpoint, unmarshalInstance, unmarshalInstanceLog, unmarshalInstanceMetrics, unmarshalListDatabaseBackupsResponse, unmarshalListDatabaseEnginesResponse, unmarshalListDatabasesResponse, unmarshalListInstanceACLRulesResponse, unmarshalListInstanceLogsDetailsResponse, unmarshalListInstanceLogsResponse, unmarshalListInstancesResponse, unmarshalListNodeTypesResponse, unmarshalListPrivilegesResponse, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, unmarshalPrepareInstanceLogsResponse, unmarshalPrivilege, unmarshalReadReplica, unmarshalSetInstanceACLRulesResponse, unmarshalSetInstanceSettingsResponse, unmarshalSnapshot, unmarshalUser };

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

@@ -16,22 +16,47 @@ class API extends API$1 {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Create a cluster
+     *
+     * @param request - The request {@link CreateClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.createCluster = request => this.client.fetch({
       body: JSON.stringify(marshalCreateClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters`
     }, unmarshalCluster);
+    /**
+     * Update a cluster
+     *
+     * @param request - The request {@link UpdateClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.updateCluster = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
+    /**
+     * Get a cluster
+     *
+     * @param request - The request {@link GetClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.getCluster = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
+    /**
+     * Waits for {@link Cluster} to be in a final state.
+     *
+     * @param request - The request {@link GetClusterRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Cluster
+     */
     this.waitForCluster = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CLUSTER_TRANSIENT_STATUSES.includes(res.status))), this.getCluster, request, options);
     this.pageOfListClusters = function (request) {
       if (request === void 0) {
@@ -40,25 +65,52 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/clusters`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['tags', request.tags], ['version', request.version])
+        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], ['project_id', request.projectId], ['tags', request.tags], ['version', request.version])
       }, unmarshalListClustersResponse);
     };
+    /**
+     * List clusters
+     *
+     * @param request - The request {@link ListClustersRequest}
+     * @returns A Promise of ListClustersResponse
+     */
     this.listClusters = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('clusters', _this.pageOfListClusters, request);
     };
+    /**
+     * Upgrade your Database for Redis® cluster to a new version or scale it
+     * vertically / horizontally. Please note: scaling horizontally your Database
+     * for Redis® cluster won't renew its TLS certificate. In order to refresh the
+     * SSL certificate, you have to use the dedicated api route.
+     *
+     * @param request - The request {@link MigrateClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.migrateCluster = request => this.client.fetch({
       body: JSON.stringify(marshalMigrateClusterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/migrate`
     }, unmarshalCluster);
+    /**
+     * Delete a cluster
+     *
+     * @param request - The request {@link DeleteClusterRequest}
+     * @returns A Promise of Cluster
+     */
     this.deleteCluster = request => this.client.fetch({
       method: 'DELETE',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
+    /**
+     * Get metrics of a cluster
+     *
+     * @param request - The request {@link GetClusterMetricsRequest}
+     * @returns A Promise of ClusterMetricsResponse
+     */
     this.getClusterMetrics = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/metrics`,
@@ -69,77 +121,167 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/node-types`,
       urlParams: urlParams(['include_disabled_types', request.includeDisabledTypes], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListNodeTypesResponse);
+    /**
+     * List available node types
+     *
+     * @param request - The request {@link ListNodeTypesRequest}
+     * @returns A Promise of ListNodeTypesResponse
+     */
     this.listNodeTypes = request => enrichForPagination('nodeTypes', this.pageOfListNodeTypes, request);
     this.pageOfListClusterVersions = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/cluster-versions`,
       urlParams: urlParams(['include_beta', request.includeBeta], ['include_deprecated', request.includeDeprecated], ['include_disabled', request.includeDisabled], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['version', request.version])
     }, unmarshalListClusterVersionsResponse);
+    /**
+     * List available Redis™ versions
+     *
+     * @param request - The request {@link ListClusterVersionsRequest}
+     * @returns A Promise of ListClusterVersionsResponse
+     */
     this.listClusterVersions = request => enrichForPagination('versions', this.pageOfListClusterVersions, request);
+    /**
+     * Get the TLS certificate of a cluster
+     *
+     * @param request - The request {@link GetClusterCertificateRequest}
+     * @returns A Promise of Blob
+     */
     this.getClusterCertificate = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/certificate`,
       urlParams: urlParams(['dl', 1]),
       responseType: 'blob'
     });
+    /**
+     * Renew the TLS certificate of a cluster
+     *
+     * @param request - The request {@link RenewClusterCertificateRequest}
+     * @returns A Promise of Cluster
+     */
     this.renewClusterCertificate = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/renew-certificate`
     }, unmarshalCluster);
+    /**
+     * Add cluster settings
+     *
+     * @param request - The request {@link AddClusterSettingsRequest}
+     * @returns A Promise of ClusterSettingsResponse
+     */
     this.addClusterSettings = request => this.client.fetch({
       body: JSON.stringify(marshalAddClusterSettingsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings`
     }, unmarshalClusterSettingsResponse);
+    /**
+     * Delete a cluster setting
+     *
+     * @param request - The request {@link DeleteClusterSettingRequest}
+     * @returns A Promise of Cluster
+     */
     this.deleteClusterSetting = request => this.client.fetch({
       method: 'DELETE',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings/${validatePathParam('settingName', request.settingName)}`
     }, unmarshalCluster);
+    /**
+     * Set cluster settings
+     *
+     * @param request - The request {@link SetClusterSettingsRequest}
+     * @returns A Promise of ClusterSettingsResponse
+     */
     this.setClusterSettings = request => this.client.fetch({
       body: JSON.stringify(marshalSetClusterSettingsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings`
     }, unmarshalClusterSettingsResponse);
+    /**
+     * Set ACL rules for a given cluster
+     *
+     * @param request - The request {@link SetAclRulesRequest}
+     * @returns A Promise of SetAclRulesResponse
+     */
     this.setAclRules = request => this.client.fetch({
       body: JSON.stringify(marshalSetAclRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/acls`
     }, unmarshalSetAclRulesResponse);
+    /**
+     * Add ACL rules for a given cluster
+     *
+     * @param request - The request {@link AddAclRulesRequest}
+     * @returns A Promise of AddAclRulesResponse
+     */
     this.addAclRules = request => this.client.fetch({
       body: JSON.stringify(marshalAddAclRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/acls`
     }, unmarshalAddAclRulesResponse);
+    /**
+     * Delete an ACL rule for a given cluster
+     *
+     * @param request - The request {@link DeleteAclRuleRequest}
+     * @returns A Promise of Cluster
+     */
     this.deleteAclRule = request => this.client.fetch({
       method: 'DELETE',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/acls/${validatePathParam('aclId', request.aclId)}`
     }, unmarshalCluster);
+    /**
+     * Get an ACL rule
+     *
+     * @param request - The request {@link GetAclRuleRequest}
+     * @returns A Promise of ACLRule
+     */
     this.getAclRule = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/acls/${validatePathParam('aclId', request.aclId)}`
     }, unmarshalACLRule);
+    /**
+     * Set endpoints for a given cluster
+     *
+     * @param request - The request {@link SetEndpointsRequest}
+     * @returns A Promise of SetEndpointsResponse
+     */
     this.setEndpoints = request => this.client.fetch({
       body: JSON.stringify(marshalSetEndpointsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/endpoints`
     }, unmarshalSetEndpointsResponse);
+    /**
+     * Add endpoints for a given cluster
+     *
+     * @param request - The request {@link AddEndpointsRequest}
+     * @returns A Promise of AddEndpointsResponse
+     */
     this.addEndpoints = request => this.client.fetch({
       body: JSON.stringify(marshalAddEndpointsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/endpoints`
     }, unmarshalAddEndpointsResponse);
+    /**
+     * Delete an endpoint for a given cluster
+     *
+     * @param request - The request {@link DeleteEndpointRequest}
+     * @returns A Promise of Cluster
+     */
     this.deleteEndpoint = request => this.client.fetch({
       method: 'DELETE',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     }, unmarshalCluster);
+    /**
+     * Get an endpoint
+     *
+     * @param request - The request {@link GetEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
     this.getEndpoint = request => this.client.fetch({
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
@@ -152,6 +294,7 @@ class API extends API$1 {
     }, unmarshalEndpoint);
   }
 }
+/** 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/registry/v1/api.gen.js

@@ -27,32 +27,69 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/registry/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/namespaces`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        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], ['project_id', request.projectId])
       }, unmarshalListNamespacesResponse);
     };
+    /**
+     * List all your namespaces
+     *
+     * @param request - The request {@link ListNamespacesRequest}
+     * @returns A Promise of ListNamespacesResponse
+     */
     this.listNamespaces = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
+    /**
+     * Get the namespace associated with the given id.
+     *
+     * @param request - The request {@link GetNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.getNamespace = request => this.client.fetch({
       method: 'GET',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
+    /**
+     * Waits for {@link Namespace} to be in a final state.
+     *
+     * @param request - The request {@link GetNamespaceRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Namespace
+     */
     this.waitForNamespace = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
+    /**
+     * Create a new namespace
+     *
+     * @param request - The request {@link CreateNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.createNamespace = request => this.client.fetch({
       body: JSON.stringify(marshalCreateNamespaceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
+    /**
+     * Update the namespace associated with the given id.
+     *
+     * @param request - The request {@link UpdateNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.updateNamespace = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateNamespaceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
+    /**
+     * Delete the namespace associated with the given id.
+     *
+     * @param request - The request {@link DeleteNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.deleteNamespace = request => this.client.fetch({
       method: 'DELETE',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
@@ -64,26 +101,57 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/registry/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/images`,
-        urlParams: urlParams(['name', request.name], ['namespace_id', request.namespaceId], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['name', request.name], ['namespace_id', request.namespaceId], ['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])
       }, unmarshalListImagesResponse);
     };
+    /**
+     * List all your images
+     *
+     * @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 the image associated with the given id.
+     *
+     * @param request - The request {@link GetImageRequest}
+     * @returns A Promise of Image
+     */
     this.getImage = request => this.client.fetch({
       method: 'GET',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}`
     }, unmarshalImage);
+    /**
+     * Waits for {@link Image} to be in a final state.
+     *
+     * @param request - The request {@link GetImageRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Image
+     */
     this.waitForImage = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
+    /**
+     * Update the image associated with the given id.
+     *
+     * @param request - The request {@link UpdateImageRequest}
+     * @returns A Promise of Image
+     */
     this.updateImage = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateImageRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}`
     }, unmarshalImage);
+    /**
+     * Delete the image associated with the given id.
+     *
+     * @param request - The request {@link DeleteImageRequest}
+     * @returns A Promise of Image
+     */
     this.deleteImage = request => this.client.fetch({
       method: 'DELETE',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}`
@@ -93,12 +161,37 @@ class API extends API$1 {
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}/tags`,
       urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListTagsResponse);
+    /**
+     * List all your tags
+     *
+     * @param request - The request {@link ListTagsRequest}
+     * @returns A Promise of ListTagsResponse
+     */
     this.listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
+    /**
+     * Get the tag associated with the given id.
+     *
+     * @param request - The request {@link GetTagRequest}
+     * @returns A Promise of Tag
+     */
     this.getTag = request => this.client.fetch({
       method: 'GET',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/tags/${validatePathParam('tagId', request.tagId)}`
     }, unmarshalTag);
+    /**
+     * Waits for {@link Tag} to be in a final state.
+     *
+     * @param request - The request {@link GetTagRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Tag
+     */
     this.waitForTag = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
+    /**
+     * Delete the tag associated with the given id.
+     *
+     * @param request - The request {@link DeleteTagRequest}
+     * @returns A Promise of Tag
+     */
     this.deleteTag = request => this.client.fetch({
       method: 'DELETE',
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/tags/${validatePathParam('tagId', request.tagId)}`,
@@ -106,6 +199,7 @@ class API extends API$1 {
     }, unmarshalTag);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
 
 export { API };