@scaleway/sdk 1.1.0 → 1.4.0

package/dist/api/account/v2/api.gen.js

@@ -11,7 +11,7 @@ const jsonContentHeaders = {
 /**
  * Account API.
  *
- * This API allows you to manage projects.
+ * User related data. This API allows you to manage projects.
  */
 class API extends API$1 {
   constructor() {
@@ -19,7 +19,8 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Create project
+     * Create a new Project for an Organization. Generate a new Project for an
+     * Organization, specifying its configuration including name and description.
      *
      * @param request - The request {@link CreateProjectRequest}
      * @returns A Promise of Project
@@ -41,7 +42,10 @@ class API extends API$1 {
       }, unmarshalListProjectsResponse);
     };
     /**
-     * List projects
+     * List all Projects of an Organization. List all Projects of an Organization.
+     * The response will include the total number of Projects as well as their
+     * associated Organizations, names and IDs. Other information include the
+     * creation and update date of the Project.
      *
      * @param request - The request {@link ListProjectsRequest}
      * @returns A Promise of ListProjectsResponse
@@ -53,7 +57,9 @@ class API extends API$1 {
       return enrichForPagination('projects', _this.pageOfListProjects, request);
     };
     /**
-     * Get project
+     * Get an existing Project. Retrieve information about an existing Project,
+     * specified by its Project ID. Its full details, including ID, name and
+     * description, are returned in the response object.
      *
      * @param request - The request {@link GetProjectRequest}
      * @returns A Promise of Project
@@ -68,7 +74,10 @@ class API extends API$1 {
       }, unmarshalProject);
     };
     /**
-     * Delete project
+     * Delete an existing Project. Delete an existing Project, specified by its
+     * Project ID. The Project needs to be empty (meaning there are no resources
+     * left in it) to be deleted effectively. Note that deleting a Project is
+     * permanent, and cannot be undone.
      *
      * @param request - The request {@link DeleteProjectRequest}
      */
@@ -82,7 +91,8 @@ class API extends API$1 {
       });
     };
     /**
-     * Update project
+     * Update Project. Update the parameters of an existing Project, specified by
+     * its Project ID. These parameters include the name and description.
      *
      * @param request - The request {@link UpdateProjectRequest}
      * @returns A Promise of Project

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

@@ -13,8 +13,8 @@ const jsonContentHeaders = {
 /**
  * Apple silicon.
  *
- * Scaleway Apple silicon M1 as-a-Service is built using the latest generation
- * of Apple Mac mini hardware (fifth generation).
+ * Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built
+ * using the latest generation of Apple Mac mini hardware (fifth generation).
  *
  * These dedicated Mac mini M1s are designed for developing, building, testing,
  * and signing applications for Apple devices, including iPhones, iPads, Mac
@@ -37,7 +37,9 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * List all server types technical details.
+     * List server types. List all technical details about Apple silicon server
+     * types available in the specified zone. Since there is only one Availability
+     * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
      *
      * @param request - The request {@link ListServerTypesRequest}
      * @returns A Promise of ListServerTypesResponse
@@ -52,7 +54,7 @@ class API extends API$1 {
       }, unmarshalListServerTypesResponse);
     };
     /**
-     * Get a server technical details.
+     * Get a server type. Get a server technical details.
      *
      * @param request - The request {@link GetServerTypeRequest}
      * @returns A Promise of ServerType
@@ -62,7 +64,8 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/server-type/${validatePathParam('serverType', request.serverType)}`
     }, unmarshalServerType);
     /**
-     * Create a server.
+     * Create a server. Create a new server in the targeted zone, specifying its
+     * configuration including name and type.
      *
      * @param request - The request {@link CreateServerRequest}
      * @returns A Promise of Server
@@ -84,7 +87,9 @@ class API extends API$1 {
       }, unmarshalListServersResponse);
     };
     /**
-     * List all servers.
+     * List all servers. List all servers in the specified zone. By default,
+     * returned servers in the list are ordered by creation date in ascending
+     * order, though this can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListServersRequest}
      * @returns A Promise of ListServersResponse
@@ -106,7 +111,9 @@ class API extends API$1 {
       }, unmarshalListOSResponse);
     };
     /**
-     * List all Operating System (OS).
+     * List all Operating System (OS). List all Operating System (OS). The
+     * response will include the total number of OS as well as their associated
+     * IDs, names and labels.
      *
      * @param request - The request {@link ListOSRequest}
      * @returns A Promise of ListOSResponse
@@ -118,7 +125,8 @@ class API extends API$1 {
       return enrichForPagination('os', _this.pageOfListOS, request);
     };
     /**
-     * Get an Operating System (OS).
+     * Get an Operating System (OS). Get an Operating System (OS). The response
+     * will include the OS's unique ID as well as its name and label.
      *
      * @param request - The request {@link GetOSRequest}
      * @returns A Promise of OS
@@ -128,7 +136,9 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/os/${validatePathParam('osId', request.osId)}`
     }, unmarshalOS);
     /**
-     * Get a server.
+     * Get a server. Retrieve information about an existing Apple silicon server,
+     * specified by its server ID. Its full details, including name, status and IP
+     * address, are returned in the response object.
      *
      * @param request - The request {@link GetServerRequest}
      * @returns A Promise of Server
@@ -146,7 +156,8 @@ class API extends API$1 {
      */
     this.waitForServer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
     /**
-     * Update a server.
+     * Update a server. Update the parameters of an existing Apple silicon server,
+     * specified by its server ID.
      *
      * @param request - The request {@link UpdateServerRequest}
      * @returns A Promise of Server
@@ -158,7 +169,10 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
     /**
-     * Delete a server.
+     * Delete a server. Delete an existing Apple silicon server, specified by its
+     * server ID. Deleting a server is permanent, and cannot be undone. Note that
+     * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
+     * meaning you cannot delete your server prior to that.
      *
      * @param request - The request {@link DeleteServerRequest}
      */
@@ -167,7 +181,8 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     });
     /**
-     * Reboot a server.
+     * Reboot a server. Reboot an existing Apple silicon server, specified by its
+     * server ID.
      *
      * @param request - The request {@link RebootServerRequest}
      * @returns A Promise of Server
@@ -179,7 +194,10 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reboot`
     }, unmarshalServer);
     /**
-     * Reinstall a server.
+     * Reinstall a server. Reinstall an existing Apple silicon server (specified
+     * by its server ID) from a new image (OS). All the data on the disk is
+     * deleted and all configuration is reset to the defailt configuration values
+     * of the image (OS).
      *
      * @param request - The request {@link ReinstallServerRequest}
      * @returns A Promise of Server

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

@@ -11,9 +11,9 @@ const jsonContentHeaders = {
 };
 
 /**
- * Elastic metal API.
+ * Elastic Metal API.
  *
- * This API allows to manage your Bare metal server.
+ * This API allows to manage your Elastic Metal server. Elastic Metal API.
  */
 class API extends API$1 {
   constructor() {
@@ -31,7 +31,8 @@ class API extends API$1 {
       }, unmarshalListServersResponse);
     };
     /**
-     * List elastic metal servers for organization.
+     * List Elastic Metal servers for an organization. List Elastic Metal servers
+     * for a specific organization.
      *
      * @param request - The request {@link ListServersRequest}
      * @returns A Promise of ListServersResponse
@@ -43,7 +44,8 @@ class API extends API$1 {
       return enrichForPagination('servers', _this.pageOfListServers, request);
     };
     /**
-     * Get the server associated with the given ID.
+     * Get a specific Elastic Metal server. Get full details of an existing
+     * Elastic Metal server associated with the ID.
      *
      * @param request - The request {@link GetServerRequest}
      * @returns A Promise of Server
@@ -61,8 +63,8 @@ class API extends API$1 {
      */
     this.waitForServer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
     /**
-     * Create a new elastic metal server. Once the server is created, you probably
-     * want to install an OS.
+     * Create an Elastic Metal server. Create a new Elastic Metal server. Once the
+     * server is created, proceed with the [installation of an OS](#post-3e949e).
      *
      * @param request - The request {@link CreateServerRequest}
      * @returns A Promise of Server
@@ -74,7 +76,9 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`
     }, unmarshalServer);
     /**
-     * Update the server associated with the given ID.
+     * Update an Elastic Metal server. Update the server associated with the ID.
+     * You can update parameters such as the server's name, tags and description.
+     * Any parameters left null in the request body are not updated.
      *
      * @param request - The request {@link UpdateServerRequest}
      * @returns A Promise of Server
@@ -86,7 +90,8 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
     /**
-     * Install an OS on the server associated with the given ID.
+     * Install an Elastic Metal server. Install an Operating System (OS) on the
+     * Elastic Metal server with a specific ID.
      *
      * @param request - The request {@link InstallServerRequest}
      * @returns A Promise of Server
@@ -98,7 +103,8 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/install`
     }, unmarshalServer);
     /**
-     * Give the ping status on the server associated with the given ID.
+     * Return server metrics. Get the ping status of the server associated with
+     * the ID.
      *
      * @param request - The request {@link GetServerMetricsRequest}
      * @returns A Promise of GetServerMetricsResponse
@@ -108,7 +114,7 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/metrics`
     }, unmarshalGetServerMetricsResponse);
     /**
-     * Delete the server associated with the given ID.
+     * Delete an Elastic Metal server. Delete the server associated with the ID.
      *
      * @param request - The request {@link DeleteServerRequest}
      * @returns A Promise of Server
@@ -118,8 +124,9 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}`
     }, unmarshalServer);
     /**
-     * Reboot the server associated with the given ID, use boot param to reboot in
-     * rescue.
+     * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated
+     * with the ID, use the `boot_type` `rescue` to reboot the server in rescue
+     * mode.
      *
      * @param request - The request {@link RebootServerRequest}
      * @returns A Promise of Server
@@ -131,7 +138,7 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reboot`
     }, unmarshalServer);
     /**
-     * Start the server associated with the given ID.
+     * Start an Elastic Metal server. Start the server associated with the ID.
      *
      * @param request - The request {@link StartServerRequest}
      * @returns A Promise of Server
@@ -143,7 +150,9 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/start`
     }, unmarshalServer);
     /**
-     * Stop the server associated with the given ID.
+     * Stop an Elastic Metal server. Stop the server associated with the ID. The
+     * server remains allocated to your account and all data remains on the local
+     * storage of the server.
      *
      * @param request - The request {@link StopServerRequest}
      * @returns A Promise of Server
@@ -160,24 +169,26 @@ class API extends API$1 {
       urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListServerEventsResponse);
     /**
-     * List events associated to the given server ID.
+     * List server events. List event (i.e. start/stop/reboot) associated to the
+     * server ID.
      *
      * @param request - The request {@link ListServerEventsRequest}
      * @returns A Promise of ListServerEventsResponse
      */
     this.listServerEvents = request => enrichForPagination('events', this.pageOfListServerEvents, request);
     /**
-     * Start BMC (Baseboard Management Controller) access associated with the
-     * given ID. The BMC (Baseboard Management Controller) access is available one
-     * hour after the installation of the server. You need first to create an
-     * option Remote Access. You will find the ID and the price with a call to
-     * listOffers
+     * Start BMC access. Start BMC (Baseboard Management Controller) access
+     * associated with the ID. The BMC (Baseboard Management Controller) access is
+     * available one hour after the installation of the server. You need first to
+     * create an option Remote Access. You will find the ID and the price with a
+     * call to listOffers
      * (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92).
-     * Then you can add the option
-     * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do
-     * not forget to delete the Option. After start BMC, you need to Get Remote
-     * Access to get the login/password
-     * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
+     * Then add the option
+     * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
+     * After adding the BMC option, you need to Get Remote Access to get the
+     * login/password
+     * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do
+     * not forget to delete the Option after use.
      *
      * @param request - The request {@link StartBMCAccessRequest}
      * @returns A Promise of BMCAccess
@@ -189,8 +200,9 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     }, unmarshalBMCAccess);
     /**
-     * Get the BMC (Baseboard Management Controller) access associated with the
-     * given ID.
+     * Get BMC access. Get the BMC (Baseboard Management Controller) access
+     * associated with the ID, including the URL and login information needed to
+     * connect.
      *
      * @param request - The request {@link GetBMCAccessRequest}
      * @returns A Promise of BMCAccess
@@ -200,8 +212,8 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     }, unmarshalBMCAccess);
     /**
-     * Stop BMC (Baseboard Management Controller) access associated with the given
-     * ID.
+     * Stop BMC access. Stop BMC (Baseboard Management Controller) access
+     * associated with the ID.
      *
      * @param request - The request {@link StopBMCAccessRequest}
      */
@@ -210,8 +222,8 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/bmc-access`
     });
     /**
-     * Configure ip associated with the given server ID and ipID. You can use this
-     * method to set a reverse dns for an IP.
+     * Update IP. Configure the IP address associated with the server ID and IP
+     * ID. You can use this method to set a reverse DNS for an IP address.
      *
      * @param request - The request {@link UpdateIPRequest}
      * @returns A Promise of IP
@@ -223,7 +235,8 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/ips/${validatePathParam('ipId', request.ipId)}`
     }, unmarshalIP);
     /**
-     * Add an option to a specific server.
+     * Add server option. Add an option, such as Private Networks, to a specific
+     * server.
      *
      * @param request - The request {@link AddOptionServerRequest}
      * @returns A Promise of Server
@@ -235,7 +248,7 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/options/${validatePathParam('optionId', request.optionId)}`
     }, unmarshalServer);
     /**
-     * Delete an option from a specific server.
+     * Delete server option. Delete an option from a specific server.
      *
      * @param request - The request {@link DeleteOptionServerRequest}
      * @returns A Promise of Server
@@ -255,7 +268,7 @@ class API extends API$1 {
       }, unmarshalListOffersResponse);
     };
     /**
-     * List all available server offers.
+     * List offers. List all available Elastic Metal server configurations.
      *
      * @param request - The request {@link ListOffersRequest}
      * @returns A Promise of ListOffersResponse
@@ -267,7 +280,7 @@ class API extends API$1 {
       return enrichForPagination('offers', _this.pageOfListOffers, request);
     };
     /**
-     * Return specific offer for the given ID.
+     * Get offer. Get details of an offer identified by its offer ID.
      *
      * @param request - The request {@link GetOfferRequest}
      * @returns A Promise of Offer
@@ -277,7 +290,7 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/offers/${validatePathParam('offerId', request.offerId)}`
     }, unmarshalOffer);
     /**
-     * Return specific option for the given ID.
+     * Get option. Return specific option for the ID.
      *
      * @param request - The request {@link GetOptionRequest}
      * @returns A Promise of Option
@@ -297,7 +310,7 @@ class API extends API$1 {
       }, unmarshalListOptionsResponse);
     };
     /**
-     * List all options matching with filters.
+     * List options. List all options matching with filters.
      *
      * @param request - The request {@link ListOptionsRequest}
      * @returns A Promise of ListOptionsResponse
@@ -319,7 +332,7 @@ class API extends API$1 {
       }, unmarshalListSettingsResponse);
     };
     /**
-     * Return all settings for a project ID.
+     * List all settings. Return all settings for a project ID.
      *
      * @param request - The request {@link ListSettingsRequest}
      * @returns A Promise of ListSettingsResponse
@@ -331,7 +344,7 @@ class API extends API$1 {
       return enrichForPagination('settings', _this.pageOfListSettings, request);
     };
     /**
-     * Update a setting for a project ID (enable or disable).
+     * Update setting. Update a setting for a project ID (enable or disable).
      *
      * @param request - The request {@link UpdateSettingRequest}
      * @returns A Promise of Setting
@@ -353,7 +366,8 @@ class API extends API$1 {
       }, unmarshalListOSResponse);
     };
     /**
-     * List all available OS that can be install on an elastic metal server.
+     * List available OSes. List all OSes that are available for installation on
+     * Elastic Metal servers.
      *
      * @param request - The request {@link ListOSRequest}
      * @returns A Promise of ListOSResponse
@@ -365,7 +379,7 @@ class API extends API$1 {
       return enrichForPagination('os', _this.pageOfListOS, request);
     };
     /**
-     * Return specific OS for the given ID.
+     * Get an OS with an ID. Return specific OS for the ID.
      *
      * @param request - The request {@link GetOSRequest}
      * @returns A Promise of OS
@@ -386,7 +400,7 @@ class PrivateNetworkAPI extends API$1 {
     super(...arguments);
     _this2 = this;
     /**
-     * Add a server to a private network
+     * Add a server to a Private Network.
      *
      * @param request - The request
      *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
@@ -399,7 +413,7 @@ class PrivateNetworkAPI extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private-networks`
     }, unmarshalServerPrivateNetwork);
     /**
-     * Set multiple private networks on a server
+     * Set multiple Private Networks on a server.
      *
      * @param request - The request
      *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
@@ -422,7 +436,7 @@ class PrivateNetworkAPI extends API$1 {
       }, unmarshalListServerPrivateNetworksResponse);
     };
     /**
-     * List the private networks of a server
+     * List the Private Networks of a server.
      *
      * @param request - The request
      *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
@@ -435,7 +449,7 @@ class PrivateNetworkAPI extends API$1 {
       return enrichForPagination('serverPrivateNetworks', _this2.pageOfListServerPrivateNetworks, request);
     };
     /**
-     * Delete a private network
+     * Delete a Private Network.
      *
      * @param request - The request
      *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}

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

@@ -13,13 +13,20 @@ const jsonContentHeaders = {
 /**
  * Cockpit API.
  *
- * This API allows to manage Cockpits.
+ * This API allows to manage Cockpits. Cockpit API.
  */
 class API extends API$1 {
   constructor() {
     var _this;
     super(...arguments);
     _this = this;
+    /**
+     * Activate a cockpit. Activate a cockpit associated with the given project
+     * ID.
+     *
+     * @param request - The request {@link ActivateCockpitRequest}
+     * @returns A Promise of Cockpit
+     */
     this.activateCockpit = function (request) {
       if (request === void 0) {
         request = {};
@@ -32,7 +39,7 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Get the cockpit associated with the given project ID.
+     * Get cockpit. Get the cockpit associated with the given project ID.
      *
      * @param request - The request {@link GetCockpitRequest}
      * @returns A Promise of Cockpit
@@ -60,6 +67,13 @@ class API extends API$1 {
       }
       return waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), _this.getCockpit, request, options);
     };
+    /**
+     * Deactivate a cockpit. Deactivate a cockpit associated with the given
+     * project ID.
+     *
+     * @param request - The request {@link DeactivateCockpitRequest}
+     * @returns A Promise of Cockpit
+     */
     this.deactivateCockpit = function (request) {
       if (request === void 0) {
         request = {};
@@ -72,7 +86,8 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Reset the Grafana your cockpit associated with the given project ID.
+     * Reset Grafana. Reset the Grafana of your cockpit associated with the given
+     * project ID.
      *
      * @param request - The request {@link ResetCockpitGrafanaRequest}
      * @returns A Promise of Cockpit
@@ -89,7 +104,7 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Create token associated with the given project ID.
+     * Create a token. Create a token associated with the given project ID.
      *
      * @param request - The request {@link CreateTokenRequest}
      * @returns A Promise of Token
@@ -111,7 +126,7 @@ class API extends API$1 {
       }, unmarshalListTokensResponse);
     };
     /**
-     * List tokens associated with the given project ID.
+     * List tokens. List tokens associated with the given project ID.
      *
      * @param request - The request {@link ListTokensRequest}
      * @returns A Promise of ListTokensResponse
@@ -123,7 +138,7 @@ class API extends API$1 {
       return enrichForPagination('tokens', _this.pageOfListTokens, request);
     };
     /**
-     * Get the token associated with the given ID.
+     * Get token. Get the token associated with the given ID.
      *
      * @param request - The request {@link GetTokenRequest}
      * @returns A Promise of Token
@@ -133,7 +148,7 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
     }, unmarshalToken);
     /**
-     * Delete the token associated with the given ID.
+     * Delete token. Delete the token associated with the given ID.
      *
      * @param request - The request {@link DeleteTokenRequest}
      */
@@ -142,7 +157,8 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
     });
     /**
-     * Create an alert contact point for the default receiver.
+     * Create an alert contact point. Create an alert contact point for the
+     * default receiver.
      *
      * @param request - The request {@link CreateContactPointRequest}
      * @returns A Promise of ContactPoint
@@ -169,7 +185,8 @@ class API extends API$1 {
       }, unmarshalListContactPointsResponse);
     };
     /**
-     * List alert contact points associated with the given cockpit ID.
+     * List alert contact points. List alert contact points associated with the
+     * given cockpit ID.
      *
      * @param request - The request {@link ListContactPointsRequest}
      * @returns A Promise of ListContactPointsResponse
@@ -181,7 +198,8 @@ class API extends API$1 {
       return enrichForPagination('contactPoints', _this.pageOfListContactPoints, request);
     };
     /**
-     * Delete an alert contact point for the default receiver.
+     * Delete an alert contact point. Delete an alert contact point for the
+     * default receiver.
      *
      * @param request - The request {@link DeleteContactPointRequest}
      */
@@ -229,7 +247,7 @@ class API extends API$1 {
       });
     };
     /**
-     * Trigger a test alert to all receivers.
+     * Trigger a test alert. Trigger a test alert to all receivers.
      *
      * @param request - The request {@link TriggerTestAlertRequest}
      */
@@ -245,7 +263,7 @@ class API extends API$1 {
       });
     };
     /**
-     * Create a grafana user for your grafana instance.
+     * Create a grafana user. Create a grafana user for your grafana instance.
      *
      * @param request - The request {@link CreateGrafanaUserRequest}
      * @returns A Promise of GrafanaUser
@@ -267,7 +285,8 @@ class API extends API$1 {
       }, unmarshalListGrafanaUsersResponse);
     };
     /**
-     * List grafana users who are able to connect to your grafana instance.
+     * List grafana users. List grafana users who are able to connect to your
+     * grafana instance.
      *
      * @param request - The request {@link ListGrafanaUsersRequest}
      * @returns A Promise of ListGrafanaUsersResponse
@@ -279,7 +298,7 @@ class API extends API$1 {
       return enrichForPagination('grafanaUsers', _this.pageOfListGrafanaUsers, request);
     };
     /**
-     * Delete a grafana user from your grafana instance.
+     * Delete a grafana user. Delete a grafana user from your grafana instance.
      *
      * @param request - The request {@link DeleteGrafanaUserRequest}
      */
@@ -290,7 +309,8 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/delete`
     });
     /**
-     * Reset the Grafana user password from your grafana instance.
+     * Reset Grafana user password. Reset the Grafana user password from your
+     * grafana instance.
      *
      * @param request - The request {@link ResetGrafanaUserPasswordRequest}
      * @returns A Promise of GrafanaUser