@scaleway/sdk 1.4.0 → 1.5.0

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

@@ -9,10 +9,10 @@ const jsonContentHeaders = {
 };
 
 /**
- * Secret API (beta).
+ * Secret Manager API documentation.
  *
  * This API allows you to conveniently store, access and share sensitive data.
- * Secret API (beta).
+ * Secret Manager API documentation.
  */
 class API extends API$1 {
   constructor() {
@@ -20,7 +20,7 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Create a Secret containing no versions.
+     * Create a secret. You must sepcify the `region` to create a secret.
      *
      * @param request - The request {@link CreateSecretRequest}
      * @returns A Promise of Secret
@@ -32,7 +32,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
     }, unmarshalSecret);
     /**
-     * Get metadata of a Secret.
+     * Get metadata using the secret's name. Retrieve the metadata of a secret
+     * specified by the `region` and the `secret_name` parameters.
      *
      * @param request - The request {@link GetSecretRequest}
      * @returns A Promise of Secret
@@ -42,7 +43,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
     }, unmarshalSecret);
     /**
-     * Get metadata of a Secret.
+     * Get metadata using the secret's ID. Retrieve the metadata of a secret
+     * specified by the `region` and the `secret_id` parameters.
      *
      * @param request - The request {@link GetSecretByNameRequest}
      * @returns A Promise of Secret
@@ -52,7 +54,9 @@ class API extends API$1 {
       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.
+     * Update metadata of a secret. Edit a secret's metadata such as name, tag(s)
+     * and description. The secret to update is specified by the `secret_id` and
+     * `region` parameters.
      *
      * @param request - The request {@link UpdateSecretRequest}
      * @returns A Promise of Secret
@@ -74,7 +78,9 @@ class API extends API$1 {
       }, unmarshalListSecretsResponse);
     };
     /**
-     * List Secrets.
+     * List secrets. Retrieve the list of secrets created within an Organization
+     * and/or Project. You must specify either the `organization_id` or the
+     * `project_id` and the `region`.
      *
      * @param request - The request {@link ListSecretsRequest}
      * @returns A Promise of ListSecretsResponse
@@ -86,7 +92,8 @@ class API extends API$1 {
       return enrichForPagination('secrets', _this.pageOfListSecrets, request);
     };
     /**
-     * Delete a secret.
+     * Delete a secret. Delete a given secret specified by the `region` and
+     * `secret_id` parameters.
      *
      * @param request - The request {@link DeleteSecretRequest}
      */
@@ -95,7 +102,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
     });
     /**
-     * Create a SecretVersion.
+     * Create a version. Create a version of a given secret specified by the
+     * `region` and `secret_id` parameters.
      *
      * @param request - The request {@link CreateSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -107,7 +115,9 @@ class API extends API$1 {
       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.
+     * Get metadata of a secret's version using the secret's ID. Retrieve the
+     * metadata of a secret's given version specified by the `region`, `secret_id`
+     * and `revision` parameters.
      *
      * @param request - The request {@link GetSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -117,7 +127,9 @@ class API extends API$1 {
       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.
+     * Get metadata of a secret's version using the secret's name. Retrieve the
+     * metadata of a secret's given version specified by the `region`,
+     * `secret_name` and `revision` parameters.
      *
      * @param request - The request {@link GetSecretVersionByNameRequest}
      * @returns A Promise of SecretVersion
@@ -127,7 +139,8 @@ class API extends API$1 {
       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.
+     * Update metadata of a version. Edit the metadata of a secret's given
+     * version, specified by the `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link UpdateSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -144,7 +157,9 @@ class API extends API$1 {
       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.
+     * List versions of a secret using the secret's ID. Retrieve the list of a
+     * given secret's versions specified by the `secret_id` and `region`
+     * parameters.
      *
      * @param request - The request {@link ListSecretVersionsRequest}
      * @returns A Promise of ListSecretVersionsResponse
@@ -156,14 +171,17 @@ class API extends API$1 {
       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.
+     * List versions of a secret using the secret's name. Retrieve the list of a
+     * given secret's versions specified by the `secret_name` and `region`
+     * parameters.
      *
      * @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.
+     * Delete a version. Delete a secret's version and the sensitive data
+     * contained in it. Deleting a version is permanent and cannot be undone.
      *
      * @param request - The request {@link DestroySecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -175,7 +193,8 @@ class API extends API$1 {
       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.
+     * Enable a version. Make a specific version accessible. You must specify the
+     * `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link EnableSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -187,7 +206,8 @@ class API extends API$1 {
       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.
+     * Disable a version. Make a specific version inaccessible. You must specify
+     * the `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link DisableSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -199,7 +219,9 @@ class API extends API$1 {
       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.
+     * Access a secret's version using the secret's ID. Access sensitive data in a
+     * secret's version specified by the `region`, `secret_id` and `revision`
+     * parameters.
      *
      * @param request - The request {@link AccessSecretVersionRequest}
      * @returns A Promise of AccessSecretVersionResponse
@@ -209,7 +231,9 @@ class API extends API$1 {
       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.
+     * Access a secret's version using the secret's name. Access sensitive data in
+     * a secret's version specified by the `region`, `secret_name` and `revision`
+     * parameters.
      *
      * @param request - The request {@link AccessSecretVersionByNameRequest}
      * @returns A Promise of AccessSecretVersionResponse

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

@@ -11,9 +11,9 @@ const jsonContentHeaders = {
 };
 
 /**
- * Transactional Email API.
+ * Transactional Email API documentation.
  *
- * Tem. Transactional Email API.
+ * Tem. Transactional Email API documentation.
  */
 class API extends API$1 {
   constructor() {
@@ -21,7 +21,10 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Send an email.
+     * Send an email. You must specify the `region`, the sender and the
+     * recipient's information and the `project_id` to send an email from a
+     * checked domain. The subject of the email must contain at least 6
+     * characters.
      *
      * @param request - The request {@link CreateEmailRequest}
      * @returns A Promise of CreateEmailResponse
@@ -33,7 +36,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails`
     }, unmarshalCreateEmailResponse);
     /**
-     * Get information about an email.
+     * Get an email. Retrieve information about a specific email using the
+     * `email_id` and `region` parameters.
      *
      * @param request - The request {@link GetEmailRequest}
      * @returns A Promise of Email
@@ -61,8 +65,8 @@ class API extends API$1 {
       }, unmarshalListEmailsResponse);
     };
     /**
-     * List emails sent from a domain and/or for a project and/or for an
-     * organization.
+     * List emails. Retrieve the list of emails sent from a specific domain or for
+     * a specific Project or Organization. You must specify the `region`.
      *
      * @param request - The request {@link ListEmailsRequest}
      * @returns A Promise of ListEmailsResponse
@@ -74,7 +78,7 @@ class API extends API$1 {
       return enrichForPagination('emails', _this.pageOfListEmails, request);
     };
     /**
-     * Get statistics on the email statuses.
+     * Email statuses. Get information on your emails' statuses.
      *
      * @param request - The request {@link GetStatisticsRequest}
      * @returns A Promise of Statistics
@@ -90,7 +94,9 @@ class API extends API$1 {
       }, unmarshalStatistics);
     };
     /**
-     * Try to cancel an email if it has not yet been sent.
+     * Cancel an email. You can cancel the sending of an email if it has not been
+     * sent yet. You must specify the `region` and the `email_id` of the email you
+     * want to cancel.
      *
      * @param request - The request {@link CancelEmailRequest}
      * @returns A Promise of Email
@@ -102,7 +108,8 @@ class API extends API$1 {
       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.
+     * Register a domain in a project. You must specify the `region`, `project_id`
+     * and `domain_name` to register a domain in a specific Project.
      *
      * @param request - The request {@link CreateDomainRequest}
      * @returns A Promise of Domain
@@ -114,7 +121,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
     }, unmarshalDomain);
     /**
-     * Get information about a domain.
+     * Get information about a domain. Retrieve information about a specific
+     * domain using the `region` and `domain_id` parameters.
      *
      * @param request - The request {@link GetDomainRequest}
      * @returns A Promise of Domain
@@ -142,7 +150,8 @@ class API extends API$1 {
       }, unmarshalListDomainsResponse);
     };
     /**
-     * List domains in a project and/or in an organization.
+     * List domains. Retrieve domains in a specific project or in a specific
+     * Organization using the `region` parameter.
      *
      * @param request - The request {@link ListDomainsRequest}
      * @returns A Promise of ListDomainsResponse
@@ -154,7 +163,9 @@ class API extends API$1 {
       return enrichForPagination('domains', _this.pageOfListDomains, request);
     };
     /**
-     * Revoke a domain.
+     * Delete a domain. You must specify the domain you want to delete by the
+     * `region` and `domain_id`. Deleting a domain is permanent and cannot be
+     * undone.
      *
      * @param request - The request {@link RevokeDomainRequest}
      * @returns A Promise of Domain
@@ -166,7 +177,8 @@ class API extends API$1 {
       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).
+     * Domain DNS check. Perform an immediate DNS check of a domain using the
+     * `region` and `domain_id` parameters.
      *
      * @param request - The request {@link CheckDomainRequest}
      * @returns A Promise of Domain

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

@@ -91,7 +91,7 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hostings/${validatePathParam('hostingId', request.hostingId)}`
     }, unmarshalHosting);
     /**
-     * Retore a hosting. Restore a hosting with the given ID.
+     * Restore a hosting. Restore a hosting with the given ID.
      *
      * @param request - The request {@link RestoreHostingRequest}
      * @returns A Promise of Hosting
@@ -103,7 +103,8 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hostings/${validatePathParam('hostingId', request.hostingId)}/restore`
     }, unmarshalHosting);
     /**
-     * Get the DNS records. Get the DNS records of a specified domain.
+     * Get the DNS records. The set of DNS record of a specific domain associated
+     * to a hosting.
      *
      * @param request - The request {@link GetDomainDnsRecordsRequest}
      * @returns A Promise of DnsRecords

package/dist/helpers/is-response.js

@@ -0,0 +1,10 @@
+/**
+ * Validates an object is of type Response without using `instanceof`.
+ *
+ * @remarks Check issue #509 for more context.
+ *
+ * @internal
+ */
+const isResponse = obj => obj !== null && obj !== undefined && typeof obj === 'object' && 'status' in obj && typeof obj.status === 'number' && 'statusText' in obj && typeof obj.statusText === 'string' && 'headers' in obj && typeof obj.headers === 'object' && 'body' in obj && typeof obj.body !== 'undefined';
+
+export { isResponse };