@scaleway/sdk-searchdb 1.5.1 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
- import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
2
1
  import { API as ParentAPI } from '@scaleway/sdk-client';
3
- import type { CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, Endpoint, GetDeploymentCertificateAuthorityRequest, GetDeploymentRequest, ListDeploymentsRequest, ListDeploymentsResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, User } from './types.gen.js';
2
+ import type { WaitForOptions, ApiLocality } from '@scaleway/sdk-client';
3
+ import type { CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, DownloadDeploymentCertificateAuthorityRequest, Endpoint, GetDeploymentRequest, ListDeploymentsRequest, ListDeploymentsResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, User } from './types.gen.js';
4
4
  /**
5
5
  * Cloud Essentials for Opensearch API.
6
6
 
@@ -47,7 +47,7 @@ export declare class API extends ParentAPI {
47
47
  * @param options - The waiting options
48
48
  * @returns A Promise of Deployment
49
49
  */
50
- waitForDeployment: (request: Readonly<GetDeploymentRequest>, options?: Readonly<WaitForOptions<Deployment>> | undefined) => Promise<Deployment>;
50
+ waitForDeployment: (request: Readonly<GetDeploymentRequest>, options?: Readonly<WaitForOptions<Deployment>>) => Promise<Deployment>;
51
51
  /**
52
52
  * Delete a Cloud Essentials for OpenSearch deployment.
53
53
  *
@@ -132,5 +132,5 @@ export declare class API extends ParentAPI {
132
132
  * @param request - The request {@link DeleteUserRequest}
133
133
  */
134
134
  deleteUser: (request: Readonly<DeleteUserRequest>) => Promise<void>;
135
- getDeploymentCertificateAuthority: (request: Readonly<GetDeploymentCertificateAuthorityRequest>) => Promise<Blob>;
135
+ downloadDeploymentCertificateAuthority: (request: Readonly<DownloadDeploymentCertificateAuthorityRequest>) => Promise<Blob>;
136
136
  }
@@ -41,7 +41,7 @@ var API = class extends API$1 {
41
41
  this.pageOfListDeployments = (request = {}) => this.client.fetch({
42
42
  method: "GET",
43
43
  path: `/searchdb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`,
44
- urlParams: urlParams(["name", request.name], ["order_by", request.orderBy], ["organization_id", request.organizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["project_id", request.projectId], ["tags", request.tags], ["version", request.version])
44
+ urlParams: urlParams(["name", request.name], ["order_by", request.orderBy], ["organization_id", request.organizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["project_id", request.projectId], ["tags", request.tags])
45
45
  }, unmarshalListDeploymentsResponse);
46
46
  this.listDeployments = (request = {}) => enrichForPagination("deployments", this.pageOfListDeployments, request);
47
47
  this.pageOfListVersions = (request = {}) => this.client.fetch({
@@ -88,7 +88,7 @@ var API = class extends API$1 {
88
88
  method: "DELETE",
89
89
  path: `/searchdb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/users/${validatePathParam("username", request.username)}`
90
90
  });
91
- this.getDeploymentCertificateAuthority = (request) => this.client.fetch({
91
+ this.downloadDeploymentCertificateAuthority = (request) => this.client.fetch({
92
92
  method: "GET",
93
93
  path: `/searchdb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/certificate-authority`,
94
94
  urlParams: urlParams(["dl", 1]),
@@ -1,5 +1,5 @@
1
1
  export { API, } from './api.gen.js';
2
2
  export * from './content.gen.js';
3
3
  export * from './marshalling.gen.js';
4
- export type { CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, DeploymentStatus, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointService, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetDeploymentCertificateAuthorityRequest, GetDeploymentRequest, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListNodeTypesRequest, ListNodeTypesRequestOrderBy, ListNodeTypesResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsRequestOrderBy, ListVersionsResponse, NodeType, NodeTypeStockStatus, NodeTypeVolumeType, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, User, Version, Volume, VolumeType, } from './types.gen.js';
4
+ export type { CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteUserRequest, Deployment, DeploymentStatus, DownloadDeploymentCertificateAuthorityRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointService, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetDeploymentRequest, ListDeploymentsRequest, ListDeploymentsRequestOrderBy, ListDeploymentsResponse, ListNodeTypesRequest, ListNodeTypesRequestOrderBy, ListNodeTypesResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsRequestOrderBy, ListVersionsResponse, NodeType, NodeTypeStockStatus, NodeTypeVolumeType, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, User, Version, Volume, VolumeType, } from './types.gen.js';
5
5
  export * as ValidationRules from './validation-rules.gen.js';
@@ -1,5 +1,5 @@
1
1
  import type { DefaultValues } from '@scaleway/sdk-client';
2
- import type { CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, Deployment, Endpoint, ListDeploymentsResponse, ListNodeTypesResponse, ListUsersResponse, ListVersionsResponse, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, User } from './types.gen.js';
2
+ import type { Endpoint, Deployment, User, ListDeploymentsResponse, ListNodeTypesResponse, ListUsersResponse, ListVersionsResponse, CreateDeploymentRequest, CreateEndpointRequest, CreateUserRequest, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest } from './types.gen.js';
3
3
  export declare const unmarshalEndpoint: (data: unknown) => Endpoint;
4
4
  export declare const unmarshalDeployment: (data: unknown) => Deployment;
5
5
  export declare const unmarshalUser: (data: unknown) => User;
@@ -1,72 +1,63 @@
1
1
  export declare const queriesMetadata: {
2
- readonly namespace: "searchdb";
3
- readonly version: "v1alpha1";
4
- readonly folderName: "searchdbv1alpha1";
2
+ readonly namespace: 'searchdb';
3
+ readonly version: 'v1alpha1';
4
+ readonly folderName: 'searchdbv1alpha1';
5
5
  readonly services: readonly [{
6
- readonly apiClass: "API";
6
+ readonly apiClass: 'API';
7
7
  readonly methods: readonly [{
8
- readonly methodName: "getDeployment";
9
- readonly protoName: "GetDeployment";
10
- readonly paramsType: "GetDeploymentRequest";
11
- readonly returnType: "Deployment";
8
+ readonly methodName: 'getDeployment';
9
+ readonly protoName: 'GetDeployment';
10
+ readonly paramsType: 'GetDeploymentRequest';
11
+ readonly returnType: 'Deployment';
12
12
  readonly isList: false;
13
- readonly paginationType: "none";
13
+ readonly paginationType: 'none';
14
14
  readonly isPrivate: false;
15
- readonly description: "\"";
15
+ readonly description: '"';
16
16
  readonly hasWaiter: true;
17
17
  }, {
18
- readonly methodName: "listDeployments";
19
- readonly protoName: "ListDeployments";
20
- readonly paramsType: "ListDeploymentsRequest";
21
- readonly returnType: "ListDeploymentsResponse";
18
+ readonly methodName: 'listDeployments';
19
+ readonly protoName: 'ListDeployments';
20
+ readonly paramsType: 'ListDeploymentsRequest';
21
+ readonly returnType: 'ListDeploymentsResponse';
22
22
  readonly isList: true;
23
- readonly paginationType: "offset";
24
- readonly pageParamKey: "page";
25
- readonly listItemType: "Deployment";
23
+ readonly paginationType: 'offset';
24
+ readonly pageParamKey: 'page';
25
+ readonly listItemType: 'Deployment';
26
26
  readonly isPrivate: false;
27
- readonly description: "\"";
27
+ readonly description: '"';
28
28
  }, {
29
- readonly methodName: "listVersions";
30
- readonly protoName: "ListVersions";
31
- readonly paramsType: "ListVersionsRequest";
32
- readonly returnType: "ListVersionsResponse";
29
+ readonly methodName: 'listVersions';
30
+ readonly protoName: 'ListVersions';
31
+ readonly paramsType: 'ListVersionsRequest';
32
+ readonly returnType: 'ListVersionsResponse';
33
33
  readonly isList: true;
34
- readonly paginationType: "offset";
35
- readonly pageParamKey: "page";
36
- readonly listItemType: "Version";
34
+ readonly paginationType: 'offset';
35
+ readonly pageParamKey: 'page';
36
+ readonly listItemType: 'Version';
37
37
  readonly isPrivate: false;
38
- readonly description: "\"";
38
+ readonly description: '"';
39
39
  }, {
40
- readonly methodName: "listNodeTypes";
41
- readonly protoName: "ListNodeTypes";
42
- readonly paramsType: "ListNodeTypesRequest";
43
- readonly returnType: "ListNodeTypesResponse";
40
+ readonly methodName: 'listNodeTypes';
41
+ readonly protoName: 'ListNodeTypes';
42
+ readonly paramsType: 'ListNodeTypesRequest';
43
+ readonly returnType: 'ListNodeTypesResponse';
44
44
  readonly isList: true;
45
- readonly paginationType: "offset";
46
- readonly pageParamKey: "page";
47
- readonly listItemType: "NodeType";
45
+ readonly paginationType: 'offset';
46
+ readonly pageParamKey: 'page';
47
+ readonly listItemType: 'NodeType';
48
48
  readonly isPrivate: false;
49
- readonly description: "\"";
49
+ readonly description: '"';
50
50
  }, {
51
- readonly methodName: "listUsers";
52
- readonly protoName: "ListUsers";
53
- readonly paramsType: "ListUsersRequest";
54
- readonly returnType: "ListUsersResponse";
51
+ readonly methodName: 'listUsers';
52
+ readonly protoName: 'ListUsers';
53
+ readonly paramsType: 'ListUsersRequest';
54
+ readonly returnType: 'ListUsersResponse';
55
55
  readonly isList: true;
56
- readonly paginationType: "offset";
57
- readonly pageParamKey: "page";
58
- readonly listItemType: "User";
56
+ readonly paginationType: 'offset';
57
+ readonly pageParamKey: 'page';
58
+ readonly listItemType: 'User';
59
59
  readonly isPrivate: false;
60
- readonly description: "\"";
61
- }, {
62
- readonly methodName: "getDeploymentCertificateAuthority";
63
- readonly protoName: "GetDeploymentCertificateAuthority";
64
- readonly paramsType: "GetDeploymentCertificateAuthorityRequest";
65
- readonly returnType: "Blob";
66
- readonly isList: false;
67
- readonly paginationType: "none";
68
- readonly isPrivate: false;
69
- readonly description: "\"";
60
+ readonly description: '"';
70
61
  }];
71
62
  }];
72
63
  };
@@ -64,16 +64,6 @@ const queriesMetadata = {
64
64
  listItemType: "User",
65
65
  isPrivate: false,
66
66
  description: "\""
67
- },
68
- {
69
- methodName: "getDeploymentCertificateAuthority",
70
- protoName: "GetDeploymentCertificateAuthority",
71
- paramsType: "GetDeploymentCertificateAuthorityRequest",
72
- returnType: "Blob",
73
- isList: false,
74
- paginationType: "none",
75
- isPrivate: false,
76
- description: "\""
77
67
  }
78
68
  ]
79
69
  }]
@@ -336,7 +336,7 @@ export type DeleteUserRequest = {
336
336
  */
337
337
  username: string;
338
338
  };
339
- export type GetDeploymentCertificateAuthorityRequest = {
339
+ export type DownloadDeploymentCertificateAuthorityRequest = {
340
340
  /**
341
341
  * Region to target. If none is passed will use default region from the config.
342
342
  */
@@ -392,10 +392,6 @@ export type ListDeploymentsRequest = {
392
392
  * Deployment name to filter for.
393
393
  */
394
394
  name?: string;
395
- /**
396
- * Engine version to filter for.
397
- */
398
- version?: string;
399
395
  };
400
396
  /**
401
397
  * Retrieve a list of deployments.
@@ -4,6 +4,10 @@ export declare const CreateDeploymentRequest: {
4
4
  minLength: number;
5
5
  pattern: RegExp;
6
6
  };
7
+ nodeAmount: {
8
+ greaterThanOrEqual: number;
9
+ lessThanOrEqual: number;
10
+ };
7
11
  nodeType: {
8
12
  maxLength: number;
9
13
  minLength: number;
@@ -55,11 +59,6 @@ export declare const ListDeploymentsRequest: {
55
59
  greaterThanOrEqual: number;
56
60
  lessThanOrEqual: number;
57
61
  };
58
- version: {
59
- maxLength: number;
60
- minLength: number;
61
- pattern: RegExp;
62
- };
63
62
  };
64
63
  export declare const ListNodeTypesRequest: {
65
64
  page: {
@@ -110,6 +109,7 @@ export declare const UpdateUserRequest: {
110
109
  pattern: RegExp;
111
110
  };
112
111
  };
112
+ export declare const UpgradeDeploymentRequest: {};
113
113
  export declare const Volume: {
114
114
  sizeBytes: {
115
115
  greaterThanOrEqual: number;
@@ -10,6 +10,7 @@ var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
10
10
  ListVersionsRequest: () => ListVersionsRequest,
11
11
  UpdateDeploymentRequest: () => UpdateDeploymentRequest,
12
12
  UpdateUserRequest: () => UpdateUserRequest,
13
+ UpgradeDeploymentRequest: () => UpgradeDeploymentRequest,
13
14
  Volume: () => Volume
14
15
  });
15
16
  const CreateDeploymentRequest = {
@@ -18,19 +19,23 @@ const CreateDeploymentRequest = {
18
19
  minLength: 1,
19
20
  pattern: /^[A-Za-z0-9\-_]+$/
20
21
  },
22
+ nodeAmount: {
23
+ greaterThanOrEqual: 1,
24
+ lessThanOrEqual: 99
25
+ },
21
26
  nodeType: {
22
27
  maxLength: 128,
23
28
  minLength: 1,
24
29
  pattern: /^[A-Za-z0-9\-_]+$/
25
30
  },
26
31
  password: {
27
- maxLength: 128,
32
+ maxLength: 50,
28
33
  minLength: 12
29
34
  },
30
35
  userName: {
31
36
  maxLength: 63,
32
37
  minLength: 1,
33
- pattern: /^[a-zA-Z0-9_\-]*$/
38
+ pattern: /^[a-zA-Z0-9_$-]*$/
34
39
  },
35
40
  version: {
36
41
  maxLength: 128,
@@ -40,13 +45,13 @@ const CreateDeploymentRequest = {
40
45
  };
41
46
  const CreateUserRequest = {
42
47
  password: {
43
- maxLength: 128,
44
- minLength: 8
48
+ maxLength: 50,
49
+ minLength: 12
45
50
  },
46
51
  username: {
47
52
  maxLength: 63,
48
53
  minLength: 1,
49
- pattern: /^[a-zA-Z0-9_\-]*$/
54
+ pattern: /^[a-zA-Z0-9_$-]*$/
50
55
  }
51
56
  };
52
57
  const DeleteUserRequest = { username: {
@@ -64,11 +69,6 @@ const ListDeploymentsRequest = {
64
69
  pageSize: {
65
70
  greaterThanOrEqual: 1,
66
71
  lessThanOrEqual: 100
67
- },
68
- version: {
69
- maxLength: 128,
70
- minLength: 1,
71
- pattern: /^[A-Za-z0-9\-_]+$/
72
72
  }
73
73
  };
74
74
  const ListNodeTypesRequest = {
@@ -103,15 +103,16 @@ const UpdateDeploymentRequest = { name: {
103
103
  } };
104
104
  const UpdateUserRequest = {
105
105
  password: {
106
- maxLength: 128,
107
- minLength: 8
106
+ maxLength: 50,
107
+ minLength: 12
108
108
  },
109
109
  username: {
110
110
  maxLength: 63,
111
111
  minLength: 1,
112
- pattern: /^[a-zA-Z0-9_\-]*$/
112
+ pattern: /^[a-zA-Z0-9_$-]*$/
113
113
  }
114
114
  };
115
+ const UpgradeDeploymentRequest = {};
115
116
  const Volume = { sizeBytes: { greaterThanOrEqual: 1e9 } };
116
117
  //#endregion
117
- export { CreateDeploymentRequest, CreateUserRequest, DeleteUserRequest, ListDeploymentsRequest, ListNodeTypesRequest, ListUsersRequest, ListVersionsRequest, UpdateDeploymentRequest, UpdateUserRequest, Volume, validation_rules_gen_exports };
118
+ export { CreateDeploymentRequest, CreateUserRequest, DeleteUserRequest, ListDeploymentsRequest, ListNodeTypesRequest, ListUsersRequest, ListVersionsRequest, UpdateDeploymentRequest, UpdateUserRequest, UpgradeDeploymentRequest, Volume, validation_rules_gen_exports };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-searchdb",
3
- "version": "1.5.1",
3
+ "version": "1.6.0",
4
4
  "description": "Scaleway SDK searchdb",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -32,17 +32,17 @@
32
32
  },
33
33
  "dependencies": {
34
34
  "@scaleway/random-name": "5.1.4",
35
- "@scaleway/sdk-std": "2.4.1"
35
+ "@scaleway/sdk-std": "2.4.2"
36
36
  },
37
37
  "devDependencies": {
38
- "@repo/configs": "^0.1.1",
39
- "@scaleway/sdk-client": "^2.3.1"
38
+ "@scaleway/sdk-client": "^2.4.0",
39
+ "@repo/configs": "^0.1.1"
40
40
  },
41
41
  "peerDependencies": {
42
- "@scaleway/sdk-client": "^2.3.1"
42
+ "@scaleway/sdk-client": "^2.4.0"
43
43
  },
44
44
  "engines": {
45
- "node": ">=20.18.3"
45
+ "node": ">=20.20.2"
46
46
  },
47
47
  "scripts": {
48
48
  "package:check": "pnpm publint",