@scaleway/sdk-datawarehouse 2.2.0 → 2.3.1

package/dist/v1beta1/api.gen.d.ts

@@ -1,6 +1,6 @@
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { CreateDatabaseRequest, CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, Database, DeleteDatabaseRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, Endpoint, GetDeploymentCertificateRequest, GetDeploymentRequest, ListDatabasesRequest, ListDatabasesResponse, ListDeploymentsRequest, ListDeploymentsResponse, ListPresetsRequest, ListPresetsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, UpdateDeploymentRequest, UpdateUserRequest, User } from './types.gen.js';
+import type { CreateDatabaseRequest, CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, Database, DeleteDatabaseRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, Endpoint, GetDeploymentCertificateRequest, GetDeploymentRequest, ListDatabasesRequest, ListDatabasesResponse, ListDeploymentsRequest, ListDeploymentsResponse, ListPresetsRequest, ListPresetsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, StartDeploymentRequest, StopDeploymentRequest, UpdateDeploymentRequest, UpdateUserRequest, User } from './types.gen.js';
 /**
  * Data Warehouse API.
 
@@ -81,7 +81,27 @@ export declare class API extends ParentAPI {
      * @returns A Promise of Deployment
      */
     deleteDeployment: (request: Readonly<DeleteDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * Get deployment TLS certificate. Retrieve the TLS certificate associated with a deployment.
+     *
+     * @param request - The request {@link GetDeploymentCertificateRequest}
+     * @returns A Promise of Blob
+     */
     getDeploymentCertificate: (request: Readonly<GetDeploymentCertificateRequest>) => Promise<Blob>;
+    /**
+     * Start a deployment. Start a stopped deployment.
+     *
+     * @param request - The request {@link StartDeploymentRequest}
+     * @returns A Promise of Deployment
+     */
+    startDeployment: (request: Readonly<StartDeploymentRequest>) => Promise<Deployment>;
+    /**
+     * Stop a deployment. Stop a running deployment.
+     *
+     * @param request - The request {@link StopDeploymentRequest}
+     * @returns A Promise of Deployment
+     */
+    stopDeployment: (request: Readonly<StopDeploymentRequest>) => Promise<Deployment>;
     protected pageOfListUsers: (request: Readonly<ListUsersRequest>) => Promise<ListUsersResponse>;
     /**
      * List users associated with a deployment.

package/dist/v1beta1/api.gen.js

@@ -10,7 +10,9 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par"]
+    regions: [
+      "fr-par"
+    ]
   });
   pageOfListPresets = (request = {}) => this.client.fetch(
     {
@@ -18,10 +20,7 @@ class API extends API$1 {
       path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/presets`,
       urlParams: urlParams(
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListPresetsResponse
@@ -39,10 +38,7 @@ class API extends API$1 {
       path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
       urlParams: urlParams(
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["version", request.version]
       )
     },
@@ -64,10 +60,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["tags", request.tags]
       )
@@ -102,9 +95,7 @@ class API extends API$1 {
    * @returns A Promise of Deployment
    */
   waitForDeployment = (request, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !DEPLOYMENT_TRANSIENT_STATUSES.includes(res.status)
-    )),
+    options?.stop ?? ((res) => Promise.resolve(!DEPLOYMENT_TRANSIENT_STATUSES.includes(res.status))),
     this.getDeployment,
     request,
     options
@@ -156,12 +147,52 @@ class API extends API$1 {
     },
     unmarshalDeployment
   );
-  getDeploymentCertificate = (request) => this.client.fetch({
-    method: "GET",
-    path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/certificate`,
-    urlParams: urlParams(["dl", 1]),
-    responseType: "blob"
-  });
+  /**
+   * Get deployment TLS certificate. Retrieve the TLS certificate associated with a deployment.
+   *
+   * @param request - The request {@link GetDeploymentCertificateRequest}
+   * @returns A Promise of Blob
+   */
+  getDeploymentCertificate = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/certificate`,
+      urlParams: urlParams(
+        ["dl", 1]
+      ),
+      responseType: "blob"
+    }
+  );
+  /**
+   * Start a deployment. Start a stopped deployment.
+   *
+   * @param request - The request {@link StartDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  startDeployment = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/start`
+    },
+    unmarshalDeployment
+  );
+  /**
+   * Stop a deployment. Stop a running deployment.
+   *
+   * @param request - The request {@link StopDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  stopDeployment = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/stop`
+    },
+    unmarshalDeployment
+  );
   pageOfListUsers = (request) => this.client.fetch(
     {
       method: "GET",
@@ -170,10 +201,7 @@ class API extends API$1 {
         ["name", request.name],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListUsersResponse
@@ -224,21 +252,25 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteUserRequest}
    */
-  deleteUser = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "DELETE",
-    path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/users/${validatePathParam("name", request.name)}`
-  });
+  deleteUser = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "DELETE",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/users/${validatePathParam("name", request.name)}`
+    }
+  );
   /**
    * Delete an endpoint from a deployment.
    *
    * @param request - The request {@link DeleteEndpointRequest}
    */
-  deleteEndpoint = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
-  });
+  deleteEndpoint = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
+    }
+  );
   /**
    * Create a new endpoint for a deployment.
    *
@@ -264,10 +296,7 @@ class API extends API$1 {
         ["name", request.name],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListDatabasesResponse
@@ -301,10 +330,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteDatabaseRequest}
    */
-  deleteDatabase = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/databases/${validatePathParam("name", request.name)}`
-  });
+  deleteDatabase = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/datawarehouse/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/databases/${validatePathParam("name", request.name)}`
+    }
+  );
 }
 export {
   API

package/dist/v1beta1/content.gen.js

@@ -4,7 +4,9 @@ const DEPLOYMENT_TRANSIENT_STATUSES = [
   "deleting",
   "locking",
   "unlocking",
-  "deploying"
+  "deploying",
+  "stopping",
+  "starting"
 ];
 export {
   DEPLOYMENT_TRANSIENT_STATUSES

package/dist/v1beta1/index.gen.d.ts

@@ -1,5 +1,5 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
-export type { CreateDatabaseRequest, CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, Database, DeleteDatabaseRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, DeploymentStatus, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointService, EndpointServiceProtocol, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetDeploymentCertificateRequest, GetDeploymentRequest, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListPresetsRequest, ListPresetsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, Preset, UpdateDeploymentRequest, UpdateUserRequest, User, Version, } from './types.gen.js';
+export type { CreateDatabaseRequest, CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, Database, DeleteDatabaseRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, DeploymentStatus, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointService, EndpointServiceProtocol, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetDeploymentCertificateRequest, GetDeploymentRequest, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListPresetsRequest, ListPresetsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, Preset, StartDeploymentRequest, StopDeploymentRequest, UpdateDeploymentRequest, UpdateUserRequest, User, Version, } from './types.gen.js';
 export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1beta1/marshalling.gen.js

@@ -184,9 +184,7 @@ const marshalEndpointSpec = (request, defaults) => ({
     },
     {
       param: "private_network",
-      value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(
-        request.privateNetwork
-      ) : void 0
+      value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(request.privateNetwork) : void 0
     }
   ])
 });

package/dist/v1beta1/types.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Region as ScwRegion } from '@scaleway/sdk-client';
-export type DeploymentStatus = 'unknown_status' | 'ready' | 'creating' | 'configuring' | 'deleting' | 'error' | 'locked' | 'locking' | 'unlocking' | 'deploying';
+export type DeploymentStatus = 'unknown_status' | 'ready' | 'creating' | 'configuring' | 'deleting' | 'error' | 'locked' | 'locking' | 'unlocking' | 'deploying' | 'stopping' | 'starting' | 'stopped';
 export type EndpointServiceProtocol = 'unknown_protocol' | 'tcp' | 'https' | 'mysql';
 export type ListDatabasesRequestOrderBy = 'name_asc' | 'name_desc' | 'size_asc' | 'size_desc';
 export type ListDeploymentsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'name_asc' | 'name_desc';
@@ -326,6 +326,9 @@ export type GetDeploymentCertificateRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * UUID of the deployment.
+     */
     deploymentId: string;
 };
 export type GetDeploymentRequest = {
@@ -473,6 +476,26 @@ export interface ListVersionsResponse {
      */
     totalCount: number;
 }
+export type StartDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the deployment.
+     */
+    deploymentId: string;
+};
+export type StopDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the deployment.
+     */
+    deploymentId: string;
+};
 export type UpdateDeploymentRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-datawarehouse",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Scaleway SDK datawarehouse",
   "license": "Apache-2.0",
   "files": [
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "2.1.0"
+    "@scaleway/sdk-std": "2.1.1"
   },
   "peerDependencies": {
     "@scaleway/sdk-client": "^2.1.0"