@scaleway/sdk 1.0.0 → 1.2.0

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

@@ -1,5 +1,5 @@
 import { API as API$1 } from '../../../scw/api.js';
-import { validatePathParam, urlParams, resolveOneOf } from '../../../helpers/marshalling.js';
+import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { marshalCreateSecretRequest, unmarshalSecret, marshalUpdateSecretRequest, unmarshalListSecretsResponse, marshalCreateSecretVersionRequest, unmarshalSecretVersion, marshalUpdateSecretVersionRequest, unmarshalListSecretVersionsResponse, unmarshalAccessSecretVersionResponse } from './marshalling.gen.js';
 
@@ -18,25 +18,44 @@ class API extends API$1 {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Create a Secret containing no versions
+     *
+     * @param request - The request {@link CreateSecretRequest}
+     * @returns A Promise of Secret
+     */
     this.createSecret = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSecretRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
     }, unmarshalSecret);
-    this.getSecret = function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this.client.fetch({
-        method: 'GET',
-        path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`,
-        urlParams: urlParams(...Object.entries(resolveOneOf([{
-          param: 'secret_name',
-          value: request.secretName
-        }])))
-      }, unmarshalSecret);
-    };
+    /**
+     * Get metadata of a Secret
+     *
+     * @param request - The request {@link GetSecretRequest}
+     * @returns A Promise of Secret
+     */
+    this.getSecret = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
+    }, unmarshalSecret);
+    /**
+     * Get metadata of a Secret
+     *
+     * @param request - The request {@link GetSecretByNameRequest}
+     * @returns A Promise of Secret
+     */
+    this.getSecretByName = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}`
+    }, unmarshalSecret);
+    /**
+     * Update metadata of a Secret
+     *
+     * @param request - The request {@link UpdateSecretRequest}
+     * @returns A Promise of Secret
+     */
     this.updateSecret = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateSecretRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -50,86 +69,157 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/secrets`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'name_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])
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
       }, unmarshalListSecretsResponse);
     };
+    /**
+     * List Secrets
+     *
+     * @param request - The request {@link ListSecretsRequest}
+     * @returns A Promise of ListSecretsResponse
+     */
     this.listSecrets = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('secrets', _this.pageOfListSecrets, request);
     };
+    /**
+     * Delete a secret
+     *
+     * @param request - The request {@link DeleteSecretRequest}
+     */
     this.deleteSecret = request => this.client.fetch({
       method: 'DELETE',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
     });
+    /**
+     * Create a SecretVersion
+     *
+     * @param request - The request {@link CreateSecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.createSecretVersion = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSecretVersionRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`
     }, unmarshalSecretVersion);
+    /**
+     * Get metadata of a SecretVersion
+     *
+     * @param request - The request {@link GetSecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.getSecretVersion = request => this.client.fetch({
       method: 'GET',
-      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`,
-      urlParams: urlParams(...Object.entries(resolveOneOf([{
-        param: 'secret_name',
-        value: request.secretName
-      }])))
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
+    }, unmarshalSecretVersion);
+    /**
+     * Get metadata of a SecretVersion
+     *
+     * @param request - The request {@link GetSecretVersionByNameRequest}
+     * @returns A Promise of SecretVersion
+     */
+    this.getSecretVersionByName = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}/versions/${validatePathParam('revision', request.revision)}`
     }, unmarshalSecretVersion);
+    /**
+     * Update metadata of a SecretVersion
+     *
+     * @param request - The request {@link UpdateSecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.updateSecretVersion = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateSecretVersionRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
     }, unmarshalSecretVersion);
-    this.pageOfListSecretVersions = function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this.client.fetch({
-        method: 'GET',
-        path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`,
-        urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['status', request.status], ...Object.entries(resolveOneOf([{
-          param: 'secret_name',
-          value: request.secretName
-        }])))
-      }, unmarshalListSecretVersionsResponse);
-    };
-    this.listSecretVersions = function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return enrichForPagination('versions', _this.pageOfListSecretVersions, request);
-    };
+    this.pageOfListSecretVersions = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`,
+      urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status])
+    }, unmarshalListSecretVersionsResponse);
+    /**
+     * List versions of a secret, not returning any sensitive data
+     *
+     * @param request - The request {@link ListSecretVersionsRequest}
+     * @returns A Promise of ListSecretVersionsResponse
+     */
+    this.listSecretVersions = request => enrichForPagination('versions', this.pageOfListSecretVersions, request);
+    this.pageOfListSecretVersionsByName = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}/versions`,
+      urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status])
+    }, unmarshalListSecretVersionsResponse);
+    /**
+     * List versions of a secret, not returning any sensitive data
+     *
+     * @param request - The request {@link ListSecretVersionsByNameRequest}
+     * @returns A Promise of ListSecretVersionsResponse
+     */
+    this.listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
+    /**
+     * Destroy a SecretVersion, permanently destroying the sensitive data
+     *
+     * @param request - The request {@link DestroySecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.destroySecretVersion = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
     }, unmarshalSecretVersion);
+    /**
+     * Enable a SecretVersion
+     *
+     * @param request - The request {@link EnableSecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.enableSecretVersion = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/enable`
     }, unmarshalSecretVersion);
+    /**
+     * Disable a SecretVersion
+     *
+     * @param request - The request {@link DisableSecretVersionRequest}
+     * @returns A Promise of SecretVersion
+     */
     this.disableSecretVersion = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/disable`
     }, unmarshalSecretVersion);
+    /**
+     * Access a SecretVersion, returning the sensitive data
+     *
+     * @param request - The request {@link AccessSecretVersionRequest}
+     * @returns A Promise of AccessSecretVersionResponse
+     */
     this.accessSecretVersion = request => this.client.fetch({
       method: 'GET',
-      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/access`,
-      urlParams: urlParams(...Object.entries(resolveOneOf([{
-        param: 'secret_name',
-        value: request.secretName
-      }])))
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/access`
+    }, unmarshalAccessSecretVersionResponse);
+    /**
+     * Access a SecretVersion, returning the sensitive data
+     *
+     * @param request - The request {@link AccessSecretVersionByNameRequest}
+     * @returns A Promise of AccessSecretVersionResponse
+     */
+    this.accessSecretVersionByName = request => this.client.fetch({
+      method: 'GET',
+      path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}/versions/${validatePathParam('revision', request.revision)}/access`
     }, unmarshalAccessSecretVersionResponse);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par'];
 
 export { API };

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

@@ -20,16 +20,35 @@ class API extends API$1 {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Send an email
+     *
+     * @param request - The request {@link CreateEmailRequest}
+     * @returns A Promise of CreateEmailResponse
+     */
     this.createEmail = request => this.client.fetch({
       body: JSON.stringify(marshalCreateEmailRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails`
     }, unmarshalCreateEmailResponse);
+    /**
+     * Get information about an email
+     *
+     * @param request - The request {@link GetEmailRequest}
+     * @returns A Promise of Email
+     */
     this.getEmail = request => this.client.fetch({
       method: 'GET',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}`
     }, unmarshalEmail);
+    /**
+     * Waits for {@link Email} to be in a final state.
+     *
+     * @param request - The request {@link GetEmailRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Email
+     */
     this.waitForEmail = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!EMAIL_TRANSIENT_STATUSES.includes(res.status))), this.getEmail, request, options);
     this.pageOfListEmails = function (request) {
       if (request === void 0) {
@@ -38,15 +57,28 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/emails`,
-        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_to', request.mailTo], ['message_id', request.messageId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['since', request.since], ['statuses', request.statuses], ['until', request.until])
+        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_to', request.mailTo], ['message_id', request.messageId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['since', request.since], ['statuses', request.statuses], ['until', request.until])
       }, unmarshalListEmailsResponse);
     };
+    /**
+     * List emails sent from a domain and/or for a project and/or for an
+     * organization
+     *
+     * @param request - The request {@link ListEmailsRequest}
+     * @returns A Promise of ListEmailsResponse
+     */
     this.listEmails = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('emails', _this.pageOfListEmails, request);
     };
+    /**
+     * Get statistics on the email statuses
+     *
+     * @param request - The request {@link GetStatisticsRequest}
+     * @returns A Promise of Statistics
+     */
     this.getStatistics = function (request) {
       if (request === void 0) {
         request = {};
@@ -54,25 +86,50 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/statistics`,
-        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['since', request.since], ['until', request.until])
+        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['project_id', request.projectId], ['since', request.since], ['until', request.until])
       }, unmarshalStatistics);
     };
+    /**
+     * Try to cancel an email if it has not yet been sent
+     *
+     * @param request - The request {@link CancelEmailRequest}
+     * @returns A Promise of Email
+     */
     this.cancelEmail = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}/cancel`
     }, unmarshalEmail);
+    /**
+     * Register a domain in a project
+     *
+     * @param request - The request {@link CreateDomainRequest}
+     * @returns A Promise of Domain
+     */
     this.createDomain = request => this.client.fetch({
       body: JSON.stringify(marshalCreateDomainRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
     }, unmarshalDomain);
+    /**
+     * Get information about a domain
+     *
+     * @param request - The request {@link GetDomainRequest}
+     * @returns A Promise of Domain
+     */
     this.getDomain = request => this.client.fetch({
       method: 'GET',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}`
     }, unmarshalDomain);
+    /**
+     * Waits for {@link Domain} to be in a final state.
+     *
+     * @param request - The request {@link GetDomainRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Domain
+     */
     this.waitForDomain = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
     this.pageOfListDomains = function (request) {
       if (request === void 0) {
@@ -81,21 +138,39 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/domains`,
-        urlParams: urlParams(['name', request.name], ['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], ['status', request.status])
+        urlParams: urlParams(['name', request.name], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['status', request.status])
       }, unmarshalListDomainsResponse);
     };
+    /**
+     * List domains in a project and/or in an organization
+     *
+     * @param request - The request {@link ListDomainsRequest}
+     * @returns A Promise of ListDomainsResponse
+     */
     this.listDomains = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('domains', _this.pageOfListDomains, request);
     };
+    /**
+     * Revoke a domain
+     *
+     * @param request - The request {@link RevokeDomainRequest}
+     * @returns A Promise of Domain
+     */
     this.revokeDomain = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/revoke`
     }, unmarshalDomain);
+    /**
+     * Ask for an immediate check of a domain (DNS check)
+     *
+     * @param request - The request {@link CheckDomainRequest}
+     * @returns A Promise of Domain
+     */
     this.checkDomain = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
@@ -104,6 +179,7 @@ class API extends API$1 {
     }, unmarshalDomain);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par'];
 
 export { API };

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

@@ -29,6 +29,16 @@ class API extends API$1 {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Register a human and return a access-key and a secret-key that must be used
+     * in all other commands.
+     *
+     * Hint: you can use other test commands by setting the SCW_SECRET_KEY env
+     * variable.
+     *
+     * @param request - The request {@link RegisterRequest}
+     * @returns A Promise of RegisterResponse
+     */
     this.register = request => this.client.fetch({
       body: JSON.stringify(marshalRegisterRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -42,42 +52,92 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/test/v1/humans`,
-        urlParams: urlParams(['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(['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])
       }, unmarshalListHumansResponse);
     };
+    /**
+     * List all your humans
+     *
+     * @param request - The request {@link ListHumansRequest}
+     * @returns A Promise of ListHumansResponse
+     */
     this.listHumans = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('humans', _this.pageOfListHumans, request);
     };
+    /**
+     * Get the human details associated with the given id.
+     *
+     * @param request - The request {@link GetHumanRequest}
+     * @returns A Promise of Human
+     */
     this.getHuman = request => this.client.fetch({
       method: 'GET',
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
     }, unmarshalHuman);
+    /**
+     * Waits for {@link Human} to be in a final state.
+     *
+     * @param request - The request {@link GetHumanRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Human
+     */
     this.waitForHuman = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!HUMAN_TRANSIENT_STATUSES.includes(res.status))), this.getHuman, request, options);
+    /**
+     * Create a new human
+     *
+     * @param request - The request {@link CreateHumanRequest}
+     * @returns A Promise of Human
+     */
     this.createHuman = request => this.client.fetch({
       body: JSON.stringify(marshalCreateHumanRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/test/v1/humans`
     }, unmarshalHuman);
+    /**
+     * Update the human associated with the given id.
+     *
+     * @param request - The request {@link UpdateHumanRequest}
+     * @returns A Promise of Human
+     */
     this.updateHuman = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateHumanRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
     }, unmarshalHuman);
+    /**
+     * Delete the human associated with the given id.
+     *
+     * @param request - The request {@link DeleteHumanRequest}
+     * @returns A Promise of Human
+     */
     this.deleteHuman = request => this.client.fetch({
       method: 'DELETE',
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
     }, unmarshalHuman);
+    /**
+     * Start a one hour running for the given human.
+     *
+     * @param request - The request {@link RunHumanRequest}
+     * @returns A Promise of Human
+     */
     this.runHuman = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}/run`
     }, unmarshalHuman);
+    /**
+     * Make a human smoke.
+     *
+     * @deprecated
+     * @param request - The request {@link SmokeHumanRequest}
+     * @returns A Promise of Human
+     */
     this.smokeHuman = function (request) {
       if (request === void 0) {
         request = {};

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

@@ -21,15 +21,27 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/private-networks`,
-        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], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['tags', request.tags])
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags])
       }, unmarshalListPrivateNetworksResponse);
     };
+    /**
+     * List private networks
+     *
+     * @param request - The request {@link ListPrivateNetworksRequest}
+     * @returns A Promise of ListPrivateNetworksResponse
+     */
     this.listPrivateNetworks = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('privateNetworks', _this.pageOfListPrivateNetworks, request);
     };
+    /**
+     * Create a private network
+     *
+     * @param request - The request {@link CreatePrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
     this.createPrivateNetwork = function (request) {
       if (request === void 0) {
         request = {};
@@ -41,22 +53,40 @@ class API extends API$1 {
         path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/private-networks`
       }, unmarshalPrivateNetwork);
     };
+    /**
+     * Get a private network
+     *
+     * @param request - The request {@link GetPrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
     this.getPrivateNetwork = request => this.client.fetch({
       method: 'GET',
       path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     }, unmarshalPrivateNetwork);
+    /**
+     * Update private network
+     *
+     * @param request - The request {@link UpdatePrivateNetworkRequest}
+     * @returns A Promise of PrivateNetwork
+     */
     this.updatePrivateNetwork = request => this.client.fetch({
       body: JSON.stringify(marshalUpdatePrivateNetworkRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     }, unmarshalPrivateNetwork);
+    /**
+     * Delete a private network
+     *
+     * @param request - The request {@link DeletePrivateNetworkRequest}
+     */
     this.deletePrivateNetwork = request => this.client.fetch({
       method: 'DELETE',
       path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     });
   }
 }
+/** 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 };