@scaleway/sdk 1.33.0 → 1.34.0

package/dist/api/billing/v2alpha1/api.gen.js

@@ -11,6 +11,14 @@ import { unmarshalGetConsumptionResponse, unmarshalListInvoicesResponse } from '
  * This API allows you to query your consumption. Billing API.
  */
 class API extends API$1 {
+  /**
+   * Get current month's consumption. The consumption reflects the amount of
+   * money you have spent for the products you have used. The consumption value
+   * is monetary and is not computed in real time.
+   *
+   * @param request - The request {@link GetConsumptionRequest}
+   * @returns A Promise of GetConsumptionResponse
+   */
   getConsumption = (() => {
     var _this = this;
     return function (request) {
@@ -37,6 +45,14 @@ class API extends API$1 {
       }, unmarshalListInvoicesResponse);
     };
   })();
+
+  /**
+   * List invoices. List all your invoices, filtering by `start_date` and
+   * `invoice_type`. Each invoice has its own ID.
+   *
+   * @param request - The request {@link ListInvoicesRequest}
+   * @returns A Promise of ListInvoicesResponse
+   */
   listInvoices = (() => {
     var _this3 = this;
     return function (request) {
@@ -46,6 +62,13 @@ class API extends API$1 {
       return enrichForPagination('invoices', _this3.pageOfListInvoices, request);
     };
   })();
+
+  /**
+   * Download an invoice. Download a specific invoice, specified by its ID.
+   *
+   * @param request - The request {@link DownloadInvoiceRequest}
+   * @returns A Promise of Blob
+   */
   downloadInvoice = request => this.client.fetch({
     method: 'GET',
     path: `/billing/v2alpha1/invoices/${validatePathParam('invoiceId', request.invoiceId)}/download`,

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

@@ -83,7 +83,7 @@ class API extends API$1 {
       return _this4.client.fetch({
         method: 'GET',
         path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? _this4.client.settings.defaultZone)}/servers`,
-        urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this4.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['private_nic_mac_address', request.privateNicMacAddress], ['project', request.project], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
+        urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? _this4.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['private_nic_mac_address', request.privateNicMacAddress], ['project', request.project], ['servers', request.servers && request.servers.length > 0 ? request.servers.join(',') : undefined], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
       }, unmarshalListServersResponse);
     };
   })();

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

@@ -767,7 +767,7 @@ class API extends API$1 {
  */
 class ZonedAPI extends API$1 {
   /** Lists the available zones of the API. */
-  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'nl-ams-3', 'pl-waw-1', 'pl-waw-2'];
+  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'nl-ams-3', 'pl-waw-1', 'pl-waw-2', 'pl-waw-3'];
   pageOfListLbs = (() => {
     var _this10 = this;
     return function (request) {

package/dist/index.cjs

@@ -497,7 +497,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.32.1';
+const version = 'v1.33.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () =>
@@ -3694,6 +3694,14 @@ const unmarshalListInvoicesResponse = data => {
  * This API allows you to query your consumption. Billing API.
  */
 let API$q = class API extends API$u {
+  /**
+   * Get current month's consumption. The consumption reflects the amount of
+   * money you have spent for the products you have used. The consumption value
+   * is monetary and is not computed in real time.
+   *
+   * @param request - The request {@link GetConsumptionRequest}
+   * @returns A Promise of GetConsumptionResponse
+   */
   getConsumption = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/billing/v2alpha1/consumption`,
@@ -3704,7 +3712,22 @@ let API$q = class API extends API$u {
     path: `/billing/v2alpha1/invoices`,
     urlParams: urlParams(['invoice_type', request.invoiceType ?? 'unknown_type'], ['order_by', request.orderBy ?? 'invoice_number_desc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['started_after', request.startedAfter], ['started_before', request.startedBefore])
   }, unmarshalListInvoicesResponse);
+
+  /**
+   * List invoices. List all your invoices, filtering by `start_date` and
+   * `invoice_type`. Each invoice has its own ID.
+   *
+   * @param request - The request {@link ListInvoicesRequest}
+   * @returns A Promise of ListInvoicesResponse
+   */
   listInvoices = (request = {}) => enrichForPagination('invoices', this.pageOfListInvoices, request);
+
+  /**
+   * Download an invoice. Download a specific invoice, specified by its ID.
+   *
+   * @param request - The request {@link DownloadInvoiceRequest}
+   * @returns A Promise of Blob
+   */
   downloadInvoice = request => this.client.fetch({
     method: 'GET',
     path: `/billing/v2alpha1/invoices/${validatePathParam('invoiceId', request.invoiceId)}/download`,
@@ -12923,7 +12946,7 @@ let API$h = class API extends API$u {
   pageOfListServers = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`,
-    urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['private_nic_mac_address', request.privateNicMacAddress], ['project', request.project], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
+    urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['private_nic_mac_address', request.privateNicMacAddress], ['project', request.project], ['servers', request.servers && request.servers.length > 0 ? request.servers.join(',') : undefined], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
   }, unmarshalListServersResponse);
 
   /**
@@ -18109,7 +18132,7 @@ let API$d = class API extends API$u {
  */
 class ZonedAPI extends API$u {
   /** Lists the available zones of the API. */
-  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'nl-ams-3', 'pl-waw-1', 'pl-waw-2'];
+  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'nl-ams-3', 'pl-waw-1', 'pl-waw-2', 'pl-waw-3'];
   pageOfListLbs = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs`,

package/dist/index.d.ts

@@ -2953,12 +2953,33 @@ type DownloadInvoiceRequest = {
  * This API allows you to query your consumption. Billing API.
  */
 declare class API$q extends API$u {
+    /**
+     * Get current month's consumption. The consumption reflects the amount of
+     * money you have spent for the products you have used. The consumption value
+     * is monetary and is not computed in real time.
+     *
+     * @param request - The request {@link GetConsumptionRequest}
+     * @returns A Promise of GetConsumptionResponse
+     */
     getConsumption: (request?: Readonly<GetConsumptionRequest>) => Promise<GetConsumptionResponse>;
     protected pageOfListInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse>;
+    /**
+     * List invoices. List all your invoices, filtering by `start_date` and
+     * `invoice_type`. Each invoice has its own ID.
+     *
+     * @param request - The request {@link ListInvoicesRequest}
+     * @returns A Promise of ListInvoicesResponse
+     */
     listInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse> & {
         all: () => Promise<Invoice[]>;
         [Symbol.asyncIterator]: () => AsyncGenerator<Invoice[], void, void>;
     };
+    /**
+     * Download an invoice. Download a specific invoice, specified by its ID.
+     *
+     * @param request - The request {@link DownloadInvoiceRequest}
+     * @returns A Promise of Blob
+     */
     downloadInvoice: (request: Readonly<DownloadInvoiceRequest>) => Promise<Blob>;
 }
 
@@ -12713,6 +12734,8 @@ type ListServersRequest = {
     privateNetworks?: string[];
     /** List Instances associated with the given private NIC MAC address. */
     privateNicMacAddress?: string;
+    /** List Instances from these server ids (use commas to separate them). */
+    servers?: string[];
 };
 type DeleteServerRequest = {
     /** Zone to target. If none is passed will use default zone from the config. */
@@ -16023,7 +16046,9 @@ type CreateVolumeRequest = {
      * config.
      */
     region?: Region;
+    /** Project ID. */
     projectId?: string;
+    /** Volume name. */
     name: string;
 };
 type GetVolumeRequest = {
@@ -16032,6 +16057,7 @@ type GetVolumeRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID. */
     volumeId: string;
 };
 type ListVolumesRequest = {
@@ -16040,10 +16066,14 @@ type ListVolumesRequest = {
      * config.
      */
     region?: Region;
+    /** Project ID, only volumes belonging to this project will be listed. */
     projectId?: string;
+    /** Sort the order of the returned volumes. */
+    orderBy?: ListVolumesRequestOrderBy;
+    /** Page number. */
     page?: number;
+    /** Maximum number of volumes to return per page. */
     pageSize?: number;
-    orderBy?: ListVolumesRequestOrderBy;
 };
 type UpdateVolumeRequest = {
     /**
@@ -16051,8 +16081,11 @@ type UpdateVolumeRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID. */
     volumeId: string;
+    /** Volume name. */
     name?: string;
+    /** Tags of the volume. */
     tags?: string[];
 };
 type DeleteVolumeRequest = {
@@ -16061,6 +16094,7 @@ type DeleteVolumeRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID. */
     volumeId: string;
 };
 type CreatePinByURLRequest = {
@@ -16069,9 +16103,13 @@ type CreatePinByURLRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID on which you want to pin your content. */
     volumeId: string;
+    /** URL containing the content you want to pin. */
     url: string;
+    /** Pin name. */
     name?: string;
+    /** Pin options. */
     pinOptions?: PinOptions;
 };
 type CreatePinByCIDRequest = {
@@ -16080,10 +16118,15 @@ type CreatePinByCIDRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID on which you want to pin your content. */
     volumeId: string;
+    /** CID containing the content you want to pin. */
     cid: string;
-    name?: string;
+    /** Node containing the content you want to pin. */
     origins?: string[];
+    /** Pin name. */
+    name?: string;
+    /** Pin options. */
     pinOptions?: PinOptions;
 };
 type ReplacePinRequest = {
@@ -16092,11 +16135,17 @@ type ReplacePinRequest = {
      * config.
      */
     region?: Region;
+    /** Pin ID whose information you wish to replace. */
     pinId: string;
+    /** Volume ID. */
     volumeId: string;
+    /** New CID you want to pin in place of the old one. */
     cid: string;
+    /** New name to replace. */
     name?: string;
+    /** Node containing the content you want to pin. */
     origins?: string[];
+    /** Pin options. */
     pinOptions?: PinOptions;
 };
 type GetPinRequest = {
@@ -16105,7 +16154,9 @@ type GetPinRequest = {
      * config.
      */
     region?: Region;
+    /** Pin ID of which you want to obtain information. */
     pinId: string;
+    /** Volume ID. */
     volumeId: string;
 };
 type ListPinsRequest = {
@@ -16114,12 +16165,19 @@ type ListPinsRequest = {
      * config.
      */
     region?: Region;
+    /** Volume ID of which you want to list the pins. */
     volumeId: string;
+    /** Project ID. */
     projectId?: string;
+    /** Organization ID. */
     organizationId?: string;
+    /** Sort order of the returned Volume. */
+    orderBy?: ListPinsRequestOrderBy;
+    /** Page number. */
     page?: number;
+    /** Maximum number of volumes to return per page. */
     pageSize?: number;
-    orderBy?: ListPinsRequestOrderBy;
+    /** List pins by status. */
     status?: PinStatus;
 };
 type DeletePinRequest = {
@@ -16128,7 +16186,9 @@ type DeletePinRequest = {
      * config.
      */
     region?: Region;
+    /** Pin ID you want to remove from the volume. */
     pinId: string;
+    /** Volume ID. */
     volumeId: string;
 };
 

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = 'v1.32.1';
+const version = 'v1.33.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 export { userAgent, version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "1.33.0",
+  "version": "1.34.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -35,5 +35,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "b0fca268066e3e1db0723b86450b2d3610c54178"
+  "gitHead": "7ef3bc7a9f525abd386d98da73c1a409ca968365"
 }