@scaleway/sdk 1.0.0 → 1.2.0

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

@@ -5,6 +5,13 @@ import { PRIVATE_NETWORK_TRANSIENT_STATUSES, LB_TRANSIENT_STATUSES, INSTANCE_TRA
 class LbV1UtilsAPI extends API {
   constructor() {
     super(...arguments);
+    /**
+     * Waits for all private networks of a load balancer to be in a final state.
+     *
+     * @param request - The request {@link WaitForLbPrivateNetworksRequest}
+     * @param options - The waiting options
+     * @returns A Promise of ListLbPrivateNetworksResponse
+     */
     this.waitForLbPrivateNetworks = (request, options) => tryAtIntervals(async () => {
       const value = await this.listLbPrivateNetworks({
         lbId: request.lbId,
@@ -18,6 +25,13 @@ class LbV1UtilsAPI extends API {
         value
       };
     }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    /**
+     * Waits for all instances of a load balancer to be in a final state.
+     *
+     * @param request - The request {@link GetLbRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Lb
+     */
     this.waitForLbInstances = (request, options) => tryAtIntervals(async () => {
       const value = await this.getLb(request);
       return {
@@ -30,6 +44,14 @@ class LbV1UtilsAPI extends API {
 class LbZonedV1UtilsAPI extends ZonedAPI {
   constructor() {
     super(...arguments);
+    /**
+     * Waits for all private networks of a (zoned) load balancer to be in a final
+     * state.
+     *
+     * @param request - The request {@link ZonedWaitForLbPrivateNetworksRequest}
+     * @param options - The waiting options
+     * @returns A Promise of ListLbPrivateNetworksResponse
+     */
     this.waitForLbPrivateNetworks = (request, options) => tryAtIntervals(async () => {
       const value = await this.listLbPrivateNetworks({
         lbId: request.lbId,
@@ -43,6 +65,13 @@ class LbZonedV1UtilsAPI extends ZonedAPI {
         value
       };
     }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    /**
+     * Waits for all instances of a (zoned) load balancer to be in a final state.
+     *
+     * @param request - The request {@link GetLbRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Lb
+     */
     this.waitForLbInstances = (request, options) => tryAtIntervals(async () => {
       const value = await this.getLb(request);
       return {

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

@@ -265,6 +265,12 @@ const unmarshalPrivateNetworkDHCPConfig = data => {
   }
   return {};
 };
+const unmarshalPrivateNetworkIpamConfig = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'PrivateNetworkIpamConfig' failed as data isn't a dictionary.`);
+  }
+  return {};
+};
 const unmarshalPrivateNetworkStaticConfig = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'PrivateNetworkStaticConfig' failed as data isn't a dictionary.`);
@@ -330,6 +336,7 @@ const unmarshalPrivateNetwork = data => {
   return {
     createdAt: unmarshalDate(data.created_at),
     dhcpConfig: data.dhcp_config ? unmarshalPrivateNetworkDHCPConfig(data.dhcp_config) : undefined,
+    ipamConfig: data.ipam_config ? unmarshalPrivateNetworkIpamConfig(data.ipam_config) : undefined,
     lb: data.lb ? unmarshalLb(data.lb) : undefined,
     privateNetworkId: data.private_network_id,
     staticConfig: data.static_config ? unmarshalPrivateNetworkStaticConfig(data.static_config) : undefined,
@@ -548,6 +555,7 @@ const marshalHealthCheck = (request, defaults) => ({
   }])
 });
 const marshalPrivateNetworkDHCPConfig = (request, defaults) => ({});
+const marshalPrivateNetworkIpamConfig = (request, defaults) => ({});
 const marshalPrivateNetworkStaticConfig = (request, defaults) => ({
   ip_address: request.ipAddress
 });
@@ -576,6 +584,9 @@ const marshalAttachPrivateNetworkRequest = (request, defaults) => ({
   }, {
     param: 'dhcp_config',
     value: request.dhcpConfig ? marshalPrivateNetworkDHCPConfig(request.dhcpConfig) : undefined
+  }, {
+    param: 'ipam_config',
+    value: request.ipamConfig ? marshalPrivateNetworkIpamConfig(request.ipamConfig) : undefined
   }])
 });
 const marshalCreateAclRequest = (request, defaults) => ({
@@ -786,6 +797,9 @@ const marshalZonedApiAttachPrivateNetworkRequest = (request, defaults) => ({
   }, {
     param: 'dhcp_config',
     value: request.dhcpConfig ? marshalPrivateNetworkDHCPConfig(request.dhcpConfig) : undefined
+  }, {
+    param: 'ipam_config',
+    value: request.ipamConfig ? marshalPrivateNetworkIpamConfig(request.ipamConfig) : undefined
   }])
 });
 const marshalZonedApiCreateAclRequest = (request, defaults) => ({

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

@@ -20,12 +20,24 @@ class API extends API$1 {
         urlParams: urlParams(['page', request.page], ['per_page', request.perPage ?? _this.client.settings.defaultPageSize])
       }, unmarshalListImagesResponse);
     };
+    /**
+     * List marketplace images
+     *
+     * @param request - The request {@link ListImagesRequest}
+     * @returns A Promise of ListImagesResponse
+     */
     this.listImages = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('images', _this.pageOfListImages, request);
     };
+    /**
+     * Get a specific marketplace image
+     *
+     * @param request - The request {@link GetImageRequest}
+     * @returns A Promise of GetImageResponse
+     */
     this.getImage = request => this.client.fetch({
       method: 'GET',
       path: `/marketplace/v1/images/${validatePathParam('imageId', request.imageId)}`

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

@@ -15,7 +15,19 @@ class API extends API$1 {
       path: `/marketplace/v2/images`,
       urlParams: urlParams(['arch', request.arch], ['category', request.category], ['include_eol', request.includeEol], ['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListImagesResponse);
+    /**
+     * List marketplace images
+     *
+     * @param request - The request {@link ListImagesRequest}
+     * @returns A Promise of ListImagesResponse
+     */
     this.listImages = request => enrichForPagination('images', this.pageOfListImages, request);
+    /**
+     * Get a specific marketplace image
+     *
+     * @param request - The request {@link GetImageRequest}
+     * @returns A Promise of Image
+     */
     this.getImage = request => this.client.fetch({
       method: 'GET',
       path: `/marketplace/v2/images/${validatePathParam('imageId', request.imageId)}`
@@ -49,6 +61,12 @@ class API extends API$1 {
         }])))
       }, unmarshalListLocalImagesResponse);
     };
+    /**
+     * List local images from a specific image or version
+     *
+     * @param request - The request {@link ListLocalImagesRequest}
+     * @returns A Promise of ListLocalImagesResponse
+     */
     this.listLocalImages = function (request) {
       if (request === void 0) {
         request = {};

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

@@ -25,41 +25,81 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/namespaces`,
-        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])
       }, unmarshalListNamespacesResponse);
     };
+    /**
+     * List namespaces
+     *
+     * @param request - The request {@link ListNamespacesRequest}
+     * @returns A Promise of ListNamespacesResponse
+     */
     this.listNamespaces = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
+    /**
+     * Create a namespace
+     *
+     * @param request - The request {@link CreateNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.createNamespace = request => this.client.fetch({
       body: JSON.stringify(marshalCreateNamespaceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
+    /**
+     * Update the name of a namespace
+     *
+     * @param request - The request {@link UpdateNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.updateNamespace = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateNamespaceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
+    /**
+     * Get a namespace
+     *
+     * @param request - The request {@link GetNamespaceRequest}
+     * @returns A Promise of Namespace
+     */
     this.getNamespace = request => this.client.fetch({
       method: 'GET',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
+    /**
+     * Delete a namespace
+     *
+     * @param request - The request {@link DeleteNamespaceRequest}
+     */
     this.deleteNamespace = request => this.client.fetch({
       method: 'DELETE',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     });
+    /**
+     * Create a set of credentials for a specific namespace.
+     *
+     * @param request - The request {@link CreateCredentialRequest}
+     * @returns A Promise of Credential
+     */
     this.createCredential = request => this.client.fetch({
       body: JSON.stringify(marshalCreateCredentialRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials`
     }, unmarshalCredential);
+    /**
+     * Delete credentials
+     *
+     * @param request - The request {@link DeleteCredentialRequest}
+     */
     this.deleteCredential = request => this.client.fetch({
       method: 'DELETE',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials/${validatePathParam('credentialId', request.credentialId)}`
@@ -74,24 +114,43 @@ class API extends API$1 {
         urlParams: urlParams(['namespace_id', request.namespaceId], ['order_by', request.orderBy ?? 'id_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
       }, unmarshalListCredentialsResponse);
     };
+    /**
+     * List credentials
+     *
+     * @param request - The request {@link ListCredentialsRequest}
+     * @returns A Promise of ListCredentialsResponse
+     */
     this.listCredentials = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('credentials', _this.pageOfListCredentials, request);
     };
+    /**
+     * Update a set of credentials.
+     *
+     * @param request - The request {@link UpdateCredentialRequest}
+     * @returns A Promise of Credential
+     */
     this.updateCredential = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateCredentialRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials/${validatePathParam('credentialId', request.credentialId)}`
     }, unmarshalCredential);
+    /**
+     * Get a set of credentials
+     *
+     * @param request - The request {@link GetCredentialRequest}
+     * @returns A Promise of Credential
+     */
     this.getCredential = request => this.client.fetch({
       method: 'GET',
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials/${validatePathParam('credentialId', request.credentialId)}`
     }, unmarshalCredential);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par'];
 
 export { API };