@scaleway/sdk 1.2.0 → 1.4.0

package/dist/api/function/v1beta1/api.gen.js

@@ -13,7 +13,7 @@ const jsonContentHeaders = {
 /**
  * Functions API.
  *
- * Serverless functions API.
+ * Serverless functions API. Functions API.
  */
 class API extends API$1 {
   constructor() {
@@ -31,7 +31,7 @@ class API extends API$1 {
       }, unmarshalListNamespacesResponse);
     };
     /**
-     * List all your namespaces
+     * List all your namespaces.
      *
      * @param request - The request {@link ListNamespacesRequest}
      * @returns A Promise of ListNamespacesResponse
@@ -43,7 +43,7 @@ class API extends API$1 {
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
     /**
-     * Get the namespace associated with the given id.
+     * Get a namespace. Get the namespace associated with the given id.
      *
      * @param request - The request {@link GetNamespaceRequest}
      * @returns A Promise of Namespace
@@ -61,7 +61,7 @@ class API extends API$1 {
      */
     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
+     * Create a new namespace.
      *
      * @param request - The request {@link CreateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -78,7 +78,8 @@ class API extends API$1 {
       }, unmarshalNamespace);
     };
     /**
-     * Update the space associated with the given id.
+     * Update an existing namespace. Update the space associated with the given
+     * id.
      *
      * @param request - The request {@link UpdateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -90,7 +91,8 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
     /**
-     * Delete the namespace associated with the given id.
+     * Delete an existing namespace. Delete the namespace associated with the
+     * given id.
      *
      * @param request - The request {@link DeleteNamespaceRequest}
      * @returns A Promise of Namespace
@@ -105,14 +107,14 @@ class API extends API$1 {
       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])
     }, unmarshalListFunctionsResponse);
     /**
-     * List all your functions
+     * List all your functions.
      *
      * @param request - The request {@link ListFunctionsRequest}
      * @returns A Promise of ListFunctionsResponse
      */
     this.listFunctions = request => enrichForPagination('functions', this.pageOfListFunctions, request);
     /**
-     * Get the function associated with the given id.
+     * Get a function. Get the function associated with the given id.
      *
      * @param request - The request {@link GetFunctionRequest}
      * @returns A Promise of Function
@@ -130,7 +132,7 @@ class API extends API$1 {
      */
     this.waitForFunction = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!FUNCTION_TRANSIENT_STATUSES.includes(res.status))), this.getFunction, request, options);
     /**
-     * Create a new function
+     * Create a new function.
      *
      * @param request - The request {@link CreateFunctionRequest}
      * @returns A Promise of Function
@@ -142,7 +144,8 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/functions`
     }, unmarshalFunction);
     /**
-     * Update the function associated with the given id.
+     * Update an existing function. Update the function associated with the given
+     * id.
      *
      * @param request - The request {@link UpdateFunctionRequest}
      * @returns A Promise of Function
@@ -154,7 +157,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/functions/${validatePathParam('functionId', request.functionId)}`
     }, unmarshalFunction);
     /**
-     * Delete the function associated with the given id.
+     * Delete a function. Delete the function associated with the given id.
      *
      * @param request - The request {@link DeleteFunctionRequest}
      * @returns A Promise of Function
@@ -164,7 +167,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/functions/${validatePathParam('functionId', request.functionId)}`
     }, unmarshalFunction);
     /**
-     * Deploy a function associated with the given id.
+     * Deploy a function. Deploy a function associated with the given id.
      *
      * @param request - The request {@link DeployFunctionRequest}
      * @returns A Promise of Function
@@ -176,7 +179,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/functions/${validatePathParam('functionId', request.functionId)}/deploy`
     }, unmarshalFunction);
     /**
-     * List available function runtimes.
+     * List function runtimes. List available function runtimes.
      *
      * @param request - The request {@link ListFunctionRuntimesRequest}
      * @returns A Promise of ListFunctionRuntimesResponse
@@ -191,7 +194,8 @@ class API extends API$1 {
       }, unmarshalListFunctionRuntimesResponse);
     };
     /**
-     * Get an upload URL of a function associated with the given id.
+     * Get an upload URL of a function. Get an upload URL of a function associated
+     * with the given id.
      *
      * @param request - The request {@link GetFunctionUploadURLRequest}
      * @returns A Promise of UploadURL
@@ -202,7 +206,8 @@ class API extends API$1 {
       urlParams: urlParams(['content_length', request.contentLength])
     }, unmarshalUploadURL);
     /**
-     * Get a download URL for a function associated with the given id.
+     * Get a download URL of a function. Get a download URL for a function
+     * associated with the given id.
      *
      * @param request - The request {@link GetFunctionDownloadURLRequest}
      * @returns A Promise of DownloadURL
@@ -217,14 +222,14 @@ class API extends API$1 {
       urlParams: urlParams(['function_id', request.functionId], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListCronsResponse);
     /**
-     * List all your crons
+     * List all your crons.
      *
      * @param request - The request {@link ListCronsRequest}
      * @returns A Promise of ListCronsResponse
      */
     this.listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
     /**
-     * Get the cron associated with the given id.
+     * Get a cron. Get the cron associated with the given id.
      *
      * @param request - The request {@link GetCronRequest}
      * @returns A Promise of Cron
@@ -242,7 +247,7 @@ class API extends API$1 {
      */
     this.waitForCron = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
     /**
-     * Create a new cron
+     * Create a new cron.
      *
      * @param request - The request {@link CreateCronRequest}
      * @returns A Promise of Cron
@@ -254,7 +259,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/crons`
     }, unmarshalCron);
     /**
-     * Update the cron associated with the given id.
+     * Update an existing cron. Update the cron associated with the given id.
      *
      * @param request - The request {@link UpdateCronRequest}
      * @returns A Promise of Cron
@@ -266,7 +271,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/crons/${validatePathParam('cronId', request.cronId)}`
     }, unmarshalCron);
     /**
-     * Delete the cron associated with the given id.
+     * Delete an existing cron. Delete the cron associated with the given id.
      *
      * @param request - The request {@link DeleteCronRequest}
      * @returns A Promise of Cron
@@ -281,7 +286,7 @@ class API extends API$1 {
       urlParams: urlParams(['order_by', request.orderBy ?? 'timestamp_desc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListLogsResponse);
     /**
-     * List your application logs
+     * List your application logs.
      *
      * @param request - The request {@link ListLogsRequest}
      * @returns A Promise of ListLogsResponse
@@ -293,14 +298,14 @@ class API extends API$1 {
       urlParams: urlParams(['function_id', request.functionId], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDomainsResponse);
     /**
-     * List all domain name bindings
+     * List all domain name bindings.
      *
      * @param request - The request {@link ListDomainsRequest}
      * @returns A Promise of ListDomainsResponse
      */
     this.listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
     /**
-     * Get a domain name binding
+     * Get a domain name binding.
      *
      * @param request - The request {@link GetDomainRequest}
      * @returns A Promise of Domain
@@ -318,7 +323,7 @@ class API extends API$1 {
      */
     this.waitForDomain = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
     /**
-     * Create a domain name binding
+     * Create a domain name binding.
      *
      * @param request - The request {@link CreateDomainRequest}
      * @returns A Promise of Domain
@@ -330,7 +335,7 @@ class API extends API$1 {
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
     }, unmarshalDomain);
     /**
-     * Delete a domain name binding
+     * Delete a domain name binding.
      *
      * @param request - The request {@link DeleteDomainRequest}
      * @returns A Promise of Domain
@@ -339,7 +344,11 @@ class API extends API$1 {
       method: 'DELETE',
       path: `/functions/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}`
     }, unmarshalDomain);
-    /** @deprecated */
+    /**
+     * @deprecated
+     * @param request - The request {@link IssueJWTRequest}
+     * @returns A Promise of Token
+     */
     this.issueJWT = function (request) {
       if (request === void 0) {
         request = {};
@@ -357,7 +366,7 @@ class API extends API$1 {
       }, unmarshalToken);
     };
     /**
-     * Create a new revocable token
+     * Create a new revocable token.
      *
      * @param request - The request {@link CreateTokenRequest}
      * @returns A Promise of Token
@@ -374,7 +383,7 @@ class API extends API$1 {
       }, unmarshalToken);
     };
     /**
-     * Get a token
+     * Get a token.
      *
      * @param request - The request {@link GetTokenRequest}
      * @returns A Promise of Token
@@ -402,7 +411,7 @@ class API extends API$1 {
       }, unmarshalListTokensResponse);
     };
     /**
-     * List all tokens
+     * List all tokens.
      *
      * @param request - The request {@link ListTokensRequest}
      * @returns A Promise of ListTokensResponse
@@ -414,7 +423,7 @@ class API extends API$1 {
       return enrichForPagination('tokens', _this.pageOfListTokens, request);
     };
     /**
-     * Delete a token
+     * Delete a token.
      *
      * @param request - The request {@link DeleteTokenRequest}
      * @returns A Promise of Token