@scaleway/sdk 2.47.0 → 2.49.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.
Files changed (44) hide show
  1. package/dist/api/baremetal/v1/api.gen.cjs +33 -0
  2. package/dist/api/baremetal/v1/api.gen.d.ts +17 -1
  3. package/dist/api/baremetal/v1/api.gen.js +34 -1
  4. package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
  5. package/dist/api/baremetal/v1/marshalling.gen.cjs +140 -0
  6. package/dist/api/baremetal/v1/marshalling.gen.d.ts +4 -1
  7. package/dist/api/baremetal/v1/marshalling.gen.js +140 -0
  8. package/dist/api/baremetal/v1/types.gen.d.ts +63 -0
  9. package/dist/api/billing/v2alpha1/marshalling.gen.cjs +1 -0
  10. package/dist/api/billing/v2alpha1/marshalling.gen.js +1 -0
  11. package/dist/api/billing/v2alpha1/types.gen.d.ts +2 -0
  12. package/dist/api/billing/v2beta1/marshalling.gen.cjs +1 -0
  13. package/dist/api/billing/v2beta1/marshalling.gen.js +1 -0
  14. package/dist/api/billing/v2beta1/types.gen.d.ts +2 -0
  15. package/dist/api/edge_services/v1alpha1/api.gen.cjs +29 -0
  16. package/dist/api/edge_services/v1alpha1/api.gen.d.ts +5 -1
  17. package/dist/api/edge_services/v1alpha1/api.gen.js +30 -1
  18. package/dist/api/edge_services/v1alpha1/index.gen.d.ts +1 -1
  19. package/dist/api/edge_services/v1alpha1/marshalling.gen.cjs +56 -16
  20. package/dist/api/edge_services/v1alpha1/marshalling.gen.d.ts +5 -2
  21. package/dist/api/edge_services/v1alpha1/marshalling.gen.js +56 -16
  22. package/dist/api/edge_services/v1alpha1/types.gen.d.ts +51 -28
  23. package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +3 -0
  24. package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +3 -0
  25. package/dist/api/iam/v1alpha1/validation-rules.gen.js +3 -0
  26. package/dist/api/instance/v1/api.gen.cjs +7 -8
  27. package/dist/api/instance/v1/api.gen.d.ts +8 -9
  28. package/dist/api/instance/v1/api.gen.js +7 -8
  29. package/dist/api/k8s/v1/marshalling.gen.cjs +1 -0
  30. package/dist/api/k8s/v1/marshalling.gen.js +1 -0
  31. package/dist/api/k8s/v1/types.gen.d.ts +2 -0
  32. package/dist/api/k8s/v1/validation-rules.gen.cjs +2 -4
  33. package/dist/api/k8s/v1/validation-rules.gen.d.ts +0 -2
  34. package/dist/api/k8s/v1/validation-rules.gen.js +2 -4
  35. package/dist/scw/constants.cjs +1 -1
  36. package/dist/scw/constants.d.ts +2 -2
  37. package/dist/scw/constants.js +1 -1
  38. package/dist/scw/custom-marshalling.cjs +19 -4
  39. package/dist/scw/custom-marshalling.d.ts +4 -2
  40. package/dist/scw/custom-marshalling.js +19 -4
  41. package/dist/scw/custom-types.cjs +1 -0
  42. package/dist/scw/custom-types.d.ts +1 -0
  43. package/dist/scw/custom-types.js +1 -0
  44. package/package.json +2 -2
@@ -46,6 +46,7 @@ const unmarshalDiscountFilter = (data) => {
46
46
  );
47
47
  }
48
48
  return {
49
+ exclude: data.exclude,
49
50
  type: data.type,
50
51
  value: data.value
51
52
  };
@@ -14,6 +14,8 @@ export interface DiscountFilter {
14
14
  type: DiscountFilterType;
15
15
  /** Value of filter, it can be a product/range/region/zone value. */
16
16
  value: string;
17
+ /** Boolean to describe if filter is an excluding filter. */
18
+ exclude: boolean;
17
19
  }
18
20
  export interface GetConsumptionResponseConsumption {
19
21
  /** Monetary value of the consumption. */
@@ -79,6 +79,7 @@ const unmarshalDiscountFilter = (data) => {
79
79
  );
80
80
  }
81
81
  return {
82
+ exclude: data.exclude,
82
83
  type: data.type,
83
84
  value: data.value
84
85
  };
@@ -77,6 +77,7 @@ const unmarshalDiscountFilter = (data) => {
77
77
  );
78
78
  }
79
79
  return {
80
+ exclude: data.exclude,
80
81
  type: data.type,
81
82
  value: data.value
82
83
  };
@@ -21,6 +21,8 @@ export interface DiscountFilter {
21
21
  type: DiscountFilterType;
22
22
  /** Value of filter. */
23
23
  value: string;
24
+ /** Boolean to describe if filter is an excluding filter. */
25
+ exclude: boolean;
24
26
  }
25
27
  export interface ListConsumptionsResponseConsumption {
26
28
  /** Monetary value of the consumption. */
@@ -595,5 +595,34 @@ class API extends api.API {
595
595
  },
596
596
  marshalling_gen.unmarshalCheckLbOriginResponse
597
597
  );
598
+ listPlans = () => this.client.fetch(
599
+ {
600
+ method: "GET",
601
+ path: `/edge-services/v1alpha1/plans`
602
+ },
603
+ marshalling_gen.unmarshalListPlansResponse
604
+ );
605
+ selectPlan = (request = {}) => this.client.fetch(
606
+ {
607
+ body: JSON.stringify(
608
+ marshalling_gen.marshalSelectPlanRequest(request, this.client.settings)
609
+ ),
610
+ headers: jsonContentHeaders,
611
+ method: "PATCH",
612
+ path: `/edge-services/v1alpha1/current-plan`
613
+ },
614
+ marshalling_gen.unmarshalPlan
615
+ );
616
+ getCurrentPlan = (request = {}) => this.client.fetch(
617
+ {
618
+ method: "GET",
619
+ path: `/edge-services/v1alpha1/current-plan/${marshalling.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
620
+ },
621
+ marshalling_gen.unmarshalPlan
622
+ );
623
+ deleteCurrentPlan = (request = {}) => this.client.fetch({
624
+ method: "DELETE",
625
+ path: `/edge-services/v1alpha1/current-plan/${marshalling.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
626
+ });
598
627
  }
599
628
  exports.API = API;
@@ -1,6 +1,6 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
2
  import type { WaitForOptions } from '../../../bridge';
3
- import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesResponse, Pipeline, PurgeRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
3
+ import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesResponse, Pipeline, Plan, PurgeRequest, SelectPlanRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
4
4
  /** Edge Services API. */
5
5
  export declare class API extends ParentAPI {
6
6
  protected pageOfListPipelines: (request?: Readonly<ListPipelinesRequest>) => Promise<ListPipelinesResponse>;
@@ -297,4 +297,8 @@ export declare class API extends ParentAPI {
297
297
  */
298
298
  waitForPurgeRequest: (request: Readonly<GetPurgeRequestRequest>, options?: Readonly<WaitForOptions<PurgeRequest>>) => Promise<PurgeRequest>;
299
299
  checkLbOrigin: (request?: Readonly<CheckLbOriginRequest>) => Promise<CheckLbOriginResponse>;
300
+ listPlans: () => Promise<ListPlansResponse>;
301
+ selectPlan: (request?: Readonly<SelectPlanRequest>) => Promise<Plan>;
302
+ getCurrentPlan: (request?: Readonly<GetCurrentPlanRequest>) => Promise<Plan>;
303
+ deleteCurrentPlan: (request?: Readonly<DeleteCurrentPlanRequest>) => Promise<void>;
300
304
  }
@@ -4,7 +4,7 @@ import { urlParams, validatePathParam } from "../../../helpers/marshalling.js";
4
4
  import "../../../vendor/base64/index.js";
5
5
  import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
6
6
  import { PIPELINE_TRANSIENT_STATUSES, PURGE_REQUEST_TRANSIENT_STATUSES } from "./content.gen.js";
7
- import { unmarshalListPipelinesResponse, marshalCreatePipelineRequest, unmarshalPipeline, marshalUpdatePipelineRequest, unmarshalListDNSStagesResponse, marshalCreateDNSStageRequest, unmarshalDNSStage, marshalUpdateDNSStageRequest, unmarshalListTLSStagesResponse, marshalCreateTLSStageRequest, unmarshalTLSStage, marshalUpdateTLSStageRequest, unmarshalListCacheStagesResponse, marshalCreateCacheStageRequest, unmarshalCacheStage, marshalUpdateCacheStageRequest, unmarshalListBackendStagesResponse, marshalCreateBackendStageRequest, unmarshalBackendStage, marshalUpdateBackendStageRequest, marshalCheckDomainRequest, unmarshalCheckDomainResponse, marshalCheckPEMChainRequest, unmarshalCheckPEMChainResponse, unmarshalListPurgeRequestsResponse, marshalCreatePurgeRequestRequest, unmarshalPurgeRequest, marshalCheckLbOriginRequest, unmarshalCheckLbOriginResponse } from "./marshalling.gen.js";
7
+ import { unmarshalListPipelinesResponse, marshalCreatePipelineRequest, unmarshalPipeline, marshalUpdatePipelineRequest, unmarshalListDNSStagesResponse, marshalCreateDNSStageRequest, unmarshalDNSStage, marshalUpdateDNSStageRequest, unmarshalListTLSStagesResponse, marshalCreateTLSStageRequest, unmarshalTLSStage, marshalUpdateTLSStageRequest, unmarshalListCacheStagesResponse, marshalCreateCacheStageRequest, unmarshalCacheStage, marshalUpdateCacheStageRequest, unmarshalListBackendStagesResponse, marshalCreateBackendStageRequest, unmarshalBackendStage, marshalUpdateBackendStageRequest, marshalCheckDomainRequest, unmarshalCheckDomainResponse, marshalCheckPEMChainRequest, unmarshalCheckPEMChainResponse, unmarshalListPurgeRequestsResponse, marshalCreatePurgeRequestRequest, unmarshalPurgeRequest, marshalCheckLbOriginRequest, unmarshalCheckLbOriginResponse, unmarshalListPlansResponse, marshalSelectPlanRequest, unmarshalPlan } from "./marshalling.gen.js";
8
8
  const jsonContentHeaders = {
9
9
  "Content-Type": "application/json; charset=utf-8"
10
10
  };
@@ -593,6 +593,35 @@ class API extends API$1 {
593
593
  },
594
594
  unmarshalCheckLbOriginResponse
595
595
  );
596
+ listPlans = () => this.client.fetch(
597
+ {
598
+ method: "GET",
599
+ path: `/edge-services/v1alpha1/plans`
600
+ },
601
+ unmarshalListPlansResponse
602
+ );
603
+ selectPlan = (request = {}) => this.client.fetch(
604
+ {
605
+ body: JSON.stringify(
606
+ marshalSelectPlanRequest(request, this.client.settings)
607
+ ),
608
+ headers: jsonContentHeaders,
609
+ method: "PATCH",
610
+ path: `/edge-services/v1alpha1/current-plan`
611
+ },
612
+ unmarshalPlan
613
+ );
614
+ getCurrentPlan = (request = {}) => this.client.fetch(
615
+ {
616
+ method: "GET",
617
+ path: `/edge-services/v1alpha1/current-plan/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
618
+ },
619
+ unmarshalPlan
620
+ );
621
+ deleteCurrentPlan = (request = {}) => this.client.fetch({
622
+ method: "DELETE",
623
+ path: `/edge-services/v1alpha1/current-plan/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
624
+ });
596
625
  }
597
626
  export {
598
627
  API
@@ -1,3 +1,3 @@
1
1
  export { API } from './api.gen';
2
2
  export * from './content.gen';
3
- export type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DNSStageType, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, LbOriginError, ListBackendStagesRequest, ListBackendStagesRequestOrderBy, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesRequestOrderBy, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesRequestOrderBy, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesRequestOrderBy, ListPipelinesResponse, ListPurgeRequestsRequest, ListPurgeRequestsRequestOrderBy, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesRequestOrderBy, ListTLSStagesResponse, Pipeline, PipelineError, PipelineErrorCode, PipelineErrorSeverity, PipelineErrorStage, PipelineErrorType, PipelineStatus, PurgeRequest, PurgeRequestStatus, ScalewayLb, ScalewayLbBackendConfig, ScalewayS3BackendConfig, TLSSecret, TLSSecretsConfig, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest, } from './types.gen';
3
+ export type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainRequestSecretChain, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, DNSStageType, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteTLSStageRequest, GetBackendStageRequest, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetTLSStageRequest, LbOriginError, ListBackendStagesRequest, ListBackendStagesRequestOrderBy, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesRequestOrderBy, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesRequestOrderBy, ListDNSStagesResponse, ListPipelinesRequest, ListPipelinesRequestOrderBy, ListPipelinesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsRequestOrderBy, ListPurgeRequestsResponse, ListTLSStagesRequest, ListTLSStagesRequestOrderBy, ListTLSStagesResponse, Pipeline, PipelineError, PipelineErrorCode, PipelineErrorSeverity, PipelineErrorStage, PipelineErrorType, PipelineStatus, Plan, PlanDetails, PlanName, PurgeRequest, PurgeRequestStatus, ScalewayLb, ScalewayLbBackendConfig, ScalewayS3BackendConfig, SelectPlanRequest, TLSSecret, TLSSecretsConfig, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest, } from './types.gen';
@@ -122,22 +122,6 @@ const unmarshalPipeline = (data) => {
122
122
  updatedAt: marshalling.unmarshalDate(data.updated_at)
123
123
  };
124
124
  };
125
- const unmarshalPurgeRequest = (data) => {
126
- if (!json.isJSONObject(data)) {
127
- throw new TypeError(
128
- `Unmarshalling the type 'PurgeRequest' failed as data isn't a dictionary.`
129
- );
130
- }
131
- return {
132
- all: data.all,
133
- assets: data.assets,
134
- createdAt: marshalling.unmarshalDate(data.created_at),
135
- id: data.id,
136
- pipelineId: data.pipeline_id,
137
- status: data.status,
138
- updatedAt: marshalling.unmarshalDate(data.updated_at)
139
- };
140
- };
141
125
  const unmarshalTLSSecret = (data) => {
142
126
  if (!json.isJSONObject(data)) {
143
127
  throw new TypeError(
@@ -168,6 +152,22 @@ const unmarshalTLSStage = (data) => {
168
152
  updatedAt: marshalling.unmarshalDate(data.updated_at)
169
153
  };
170
154
  };
155
+ const unmarshalPurgeRequest = (data) => {
156
+ if (!json.isJSONObject(data)) {
157
+ throw new TypeError(
158
+ `Unmarshalling the type 'PurgeRequest' failed as data isn't a dictionary.`
159
+ );
160
+ }
161
+ return {
162
+ all: data.all,
163
+ assets: data.assets,
164
+ createdAt: marshalling.unmarshalDate(data.created_at),
165
+ id: data.id,
166
+ pipelineId: data.pipeline_id,
167
+ status: data.status,
168
+ updatedAt: marshalling.unmarshalDate(data.updated_at)
169
+ };
170
+ };
171
171
  const unmarshalCheckDomainResponse = (data) => {
172
172
  if (!json.isJSONObject(data)) {
173
173
  throw new TypeError(
@@ -243,6 +243,29 @@ const unmarshalListPipelinesResponse = (data) => {
243
243
  totalCount: data.total_count
244
244
  };
245
245
  };
246
+ const unmarshalPlanDetails = (data) => {
247
+ if (!json.isJSONObject(data)) {
248
+ throw new TypeError(
249
+ `Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary.`
250
+ );
251
+ }
252
+ return {
253
+ packageGb: data.package_gb,
254
+ pipelineLimit: data.pipeline_limit,
255
+ planName: data.plan_name
256
+ };
257
+ };
258
+ const unmarshalListPlansResponse = (data) => {
259
+ if (!json.isJSONObject(data)) {
260
+ throw new TypeError(
261
+ `Unmarshalling the type 'ListPlansResponse' failed as data isn't a dictionary.`
262
+ );
263
+ }
264
+ return {
265
+ plans: marshalling.unmarshalArrayOfObject(data.plans, unmarshalPlanDetails),
266
+ totalCount: data.total_count
267
+ };
268
+ };
246
269
  const unmarshalListPurgeRequestsResponse = (data) => {
247
270
  if (!json.isJSONObject(data)) {
248
271
  throw new TypeError(
@@ -268,6 +291,16 @@ const unmarshalListTLSStagesResponse = (data) => {
268
291
  totalCount: data.total_count
269
292
  };
270
293
  };
294
+ const unmarshalPlan = (data) => {
295
+ if (!json.isJSONObject(data)) {
296
+ throw new TypeError(
297
+ `Unmarshalling the type 'Plan' failed as data isn't a dictionary.`
298
+ );
299
+ }
300
+ return {
301
+ planName: data.plan_name
302
+ };
303
+ };
271
304
  const marshalCheckDomainRequest = (request, defaults) => ({
272
305
  cname: request.cname,
273
306
  fqdn: request.fqdn,
@@ -361,6 +394,10 @@ const marshalCreateTLSStageRequest = (request, defaults) => ({
361
394
  { param: "backend_stage_id", value: request.backendStageId }
362
395
  ])
363
396
  });
397
+ const marshalSelectPlanRequest = (request, defaults) => ({
398
+ plan_name: request.planName,
399
+ project_id: request.projectId ?? defaults.defaultProjectId
400
+ });
364
401
  const marshalUpdateBackendStageRequest = (request, defaults) => ({
365
402
  ...marshalling.resolveOneOf([
366
403
  {
@@ -412,6 +449,7 @@ exports.marshalCreateDNSStageRequest = marshalCreateDNSStageRequest;
412
449
  exports.marshalCreatePipelineRequest = marshalCreatePipelineRequest;
413
450
  exports.marshalCreatePurgeRequestRequest = marshalCreatePurgeRequestRequest;
414
451
  exports.marshalCreateTLSStageRequest = marshalCreateTLSStageRequest;
452
+ exports.marshalSelectPlanRequest = marshalSelectPlanRequest;
415
453
  exports.marshalUpdateBackendStageRequest = marshalUpdateBackendStageRequest;
416
454
  exports.marshalUpdateCacheStageRequest = marshalUpdateCacheStageRequest;
417
455
  exports.marshalUpdateDNSStageRequest = marshalUpdateDNSStageRequest;
@@ -427,8 +465,10 @@ exports.unmarshalListBackendStagesResponse = unmarshalListBackendStagesResponse;
427
465
  exports.unmarshalListCacheStagesResponse = unmarshalListCacheStagesResponse;
428
466
  exports.unmarshalListDNSStagesResponse = unmarshalListDNSStagesResponse;
429
467
  exports.unmarshalListPipelinesResponse = unmarshalListPipelinesResponse;
468
+ exports.unmarshalListPlansResponse = unmarshalListPlansResponse;
430
469
  exports.unmarshalListPurgeRequestsResponse = unmarshalListPurgeRequestsResponse;
431
470
  exports.unmarshalListTLSStagesResponse = unmarshalListTLSStagesResponse;
432
471
  exports.unmarshalPipeline = unmarshalPipeline;
472
+ exports.unmarshalPlan = unmarshalPlan;
433
473
  exports.unmarshalPurgeRequest = unmarshalPurgeRequest;
434
474
  exports.unmarshalTLSStage = unmarshalTLSStage;
@@ -1,11 +1,11 @@
1
1
  import type { DefaultValues } from '../../../bridge';
2
- import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, ListBackendStagesResponse, ListCacheStagesResponse, ListDNSStagesResponse, ListPipelinesResponse, ListPurgeRequestsResponse, ListTLSStagesResponse, Pipeline, PurgeRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
2
+ import type { BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateTLSStageRequest, DNSStage, ListBackendStagesResponse, ListCacheStagesResponse, ListDNSStagesResponse, ListPipelinesResponse, ListPlansResponse, ListPurgeRequestsResponse, ListTLSStagesResponse, Pipeline, Plan, PurgeRequest, SelectPlanRequest, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateTLSStageRequest } from './types.gen';
3
3
  export declare const unmarshalBackendStage: (data: unknown) => BackendStage;
4
4
  export declare const unmarshalCacheStage: (data: unknown) => CacheStage;
5
5
  export declare const unmarshalDNSStage: (data: unknown) => DNSStage;
6
6
  export declare const unmarshalPipeline: (data: unknown) => Pipeline;
7
- export declare const unmarshalPurgeRequest: (data: unknown) => PurgeRequest;
8
7
  export declare const unmarshalTLSStage: (data: unknown) => TLSStage;
8
+ export declare const unmarshalPurgeRequest: (data: unknown) => PurgeRequest;
9
9
  export declare const unmarshalCheckDomainResponse: (data: unknown) => CheckDomainResponse;
10
10
  export declare const unmarshalCheckLbOriginResponse: (data: unknown) => CheckLbOriginResponse;
11
11
  export declare const unmarshalCheckPEMChainResponse: (data: unknown) => CheckPEMChainResponse;
@@ -13,8 +13,10 @@ export declare const unmarshalListBackendStagesResponse: (data: unknown) => List
13
13
  export declare const unmarshalListCacheStagesResponse: (data: unknown) => ListCacheStagesResponse;
14
14
  export declare const unmarshalListDNSStagesResponse: (data: unknown) => ListDNSStagesResponse;
15
15
  export declare const unmarshalListPipelinesResponse: (data: unknown) => ListPipelinesResponse;
16
+ export declare const unmarshalListPlansResponse: (data: unknown) => ListPlansResponse;
16
17
  export declare const unmarshalListPurgeRequestsResponse: (data: unknown) => ListPurgeRequestsResponse;
17
18
  export declare const unmarshalListTLSStagesResponse: (data: unknown) => ListTLSStagesResponse;
19
+ export declare const unmarshalPlan: (data: unknown) => Plan;
18
20
  export declare const marshalCheckDomainRequest: (request: CheckDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
19
21
  export declare const marshalCheckLbOriginRequest: (request: CheckLbOriginRequest, defaults: DefaultValues) => Record<string, unknown>;
20
22
  export declare const marshalCheckPEMChainRequest: (request: CheckPEMChainRequest, defaults: DefaultValues) => Record<string, unknown>;
@@ -24,6 +26,7 @@ export declare const marshalCreateDNSStageRequest: (request: CreateDNSStageReque
24
26
  export declare const marshalCreatePipelineRequest: (request: CreatePipelineRequest, defaults: DefaultValues) => Record<string, unknown>;
25
27
  export declare const marshalCreatePurgeRequestRequest: (request: CreatePurgeRequestRequest, defaults: DefaultValues) => Record<string, unknown>;
26
28
  export declare const marshalCreateTLSStageRequest: (request: CreateTLSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
29
+ export declare const marshalSelectPlanRequest: (request: SelectPlanRequest, defaults: DefaultValues) => Record<string, unknown>;
27
30
  export declare const marshalUpdateBackendStageRequest: (request: UpdateBackendStageRequest, defaults: DefaultValues) => Record<string, unknown>;
28
31
  export declare const marshalUpdateCacheStageRequest: (request: UpdateCacheStageRequest, defaults: DefaultValues) => Record<string, unknown>;
29
32
  export declare const marshalUpdateDNSStageRequest: (request: UpdateDNSStageRequest, defaults: DefaultValues) => Record<string, unknown>;
@@ -120,22 +120,6 @@ const unmarshalPipeline = (data) => {
120
120
  updatedAt: unmarshalDate(data.updated_at)
121
121
  };
122
122
  };
123
- const unmarshalPurgeRequest = (data) => {
124
- if (!isJSONObject(data)) {
125
- throw new TypeError(
126
- `Unmarshalling the type 'PurgeRequest' failed as data isn't a dictionary.`
127
- );
128
- }
129
- return {
130
- all: data.all,
131
- assets: data.assets,
132
- createdAt: unmarshalDate(data.created_at),
133
- id: data.id,
134
- pipelineId: data.pipeline_id,
135
- status: data.status,
136
- updatedAt: unmarshalDate(data.updated_at)
137
- };
138
- };
139
123
  const unmarshalTLSSecret = (data) => {
140
124
  if (!isJSONObject(data)) {
141
125
  throw new TypeError(
@@ -166,6 +150,22 @@ const unmarshalTLSStage = (data) => {
166
150
  updatedAt: unmarshalDate(data.updated_at)
167
151
  };
168
152
  };
153
+ const unmarshalPurgeRequest = (data) => {
154
+ if (!isJSONObject(data)) {
155
+ throw new TypeError(
156
+ `Unmarshalling the type 'PurgeRequest' failed as data isn't a dictionary.`
157
+ );
158
+ }
159
+ return {
160
+ all: data.all,
161
+ assets: data.assets,
162
+ createdAt: unmarshalDate(data.created_at),
163
+ id: data.id,
164
+ pipelineId: data.pipeline_id,
165
+ status: data.status,
166
+ updatedAt: unmarshalDate(data.updated_at)
167
+ };
168
+ };
169
169
  const unmarshalCheckDomainResponse = (data) => {
170
170
  if (!isJSONObject(data)) {
171
171
  throw new TypeError(
@@ -241,6 +241,29 @@ const unmarshalListPipelinesResponse = (data) => {
241
241
  totalCount: data.total_count
242
242
  };
243
243
  };
244
+ const unmarshalPlanDetails = (data) => {
245
+ if (!isJSONObject(data)) {
246
+ throw new TypeError(
247
+ `Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary.`
248
+ );
249
+ }
250
+ return {
251
+ packageGb: data.package_gb,
252
+ pipelineLimit: data.pipeline_limit,
253
+ planName: data.plan_name
254
+ };
255
+ };
256
+ const unmarshalListPlansResponse = (data) => {
257
+ if (!isJSONObject(data)) {
258
+ throw new TypeError(
259
+ `Unmarshalling the type 'ListPlansResponse' failed as data isn't a dictionary.`
260
+ );
261
+ }
262
+ return {
263
+ plans: unmarshalArrayOfObject(data.plans, unmarshalPlanDetails),
264
+ totalCount: data.total_count
265
+ };
266
+ };
244
267
  const unmarshalListPurgeRequestsResponse = (data) => {
245
268
  if (!isJSONObject(data)) {
246
269
  throw new TypeError(
@@ -266,6 +289,16 @@ const unmarshalListTLSStagesResponse = (data) => {
266
289
  totalCount: data.total_count
267
290
  };
268
291
  };
292
+ const unmarshalPlan = (data) => {
293
+ if (!isJSONObject(data)) {
294
+ throw new TypeError(
295
+ `Unmarshalling the type 'Plan' failed as data isn't a dictionary.`
296
+ );
297
+ }
298
+ return {
299
+ planName: data.plan_name
300
+ };
301
+ };
269
302
  const marshalCheckDomainRequest = (request, defaults) => ({
270
303
  cname: request.cname,
271
304
  fqdn: request.fqdn,
@@ -359,6 +392,10 @@ const marshalCreateTLSStageRequest = (request, defaults) => ({
359
392
  { param: "backend_stage_id", value: request.backendStageId }
360
393
  ])
361
394
  });
395
+ const marshalSelectPlanRequest = (request, defaults) => ({
396
+ plan_name: request.planName,
397
+ project_id: request.projectId ?? defaults.defaultProjectId
398
+ });
362
399
  const marshalUpdateBackendStageRequest = (request, defaults) => ({
363
400
  ...resolveOneOf([
364
401
  {
@@ -411,6 +448,7 @@ export {
411
448
  marshalCreatePipelineRequest,
412
449
  marshalCreatePurgeRequestRequest,
413
450
  marshalCreateTLSStageRequest,
451
+ marshalSelectPlanRequest,
414
452
  marshalUpdateBackendStageRequest,
415
453
  marshalUpdateCacheStageRequest,
416
454
  marshalUpdateDNSStageRequest,
@@ -426,9 +464,11 @@ export {
426
464
  unmarshalListCacheStagesResponse,
427
465
  unmarshalListDNSStagesResponse,
428
466
  unmarshalListPipelinesResponse,
467
+ unmarshalListPlansResponse,
429
468
  unmarshalListPurgeRequestsResponse,
430
469
  unmarshalListTLSStagesResponse,
431
470
  unmarshalPipeline,
471
+ unmarshalPlan,
432
472
  unmarshalPurgeRequest,
433
473
  unmarshalTLSStage
434
474
  };
@@ -12,6 +12,7 @@ export type PipelineErrorSeverity = 'unknown_severity' | 'warning' | 'critical';
12
12
  export type PipelineErrorStage = 'unknown_stage' | 'dns' | 'tls' | 'cache' | 'backend';
13
13
  export type PipelineErrorType = 'unknown_type' | 'runtime' | 'config';
14
14
  export type PipelineStatus = 'unknown_status' | 'ready' | 'error' | 'pending' | 'warning';
15
+ export type PlanName = 'unknown_name' | 'starter' | 'professional' | 'advanced';
15
16
  export type PurgeRequestStatus = 'unknown_status' | 'done' | 'error' | 'pending';
16
17
  export interface ScalewayLb {
17
18
  /** ID of the Load Balancer. */
@@ -53,10 +54,6 @@ export interface TLSSecret {
53
54
  /** Region of the Secret. */
54
55
  region: Region;
55
56
  }
56
- export interface CheckPEMChainRequestSecretChain {
57
- secretId: string;
58
- secretRegion: string;
59
- }
60
57
  export interface BackendStage {
61
58
  /** ID of the backend stage. */
62
59
  id: string;
@@ -164,30 +161,6 @@ export interface Pipeline {
164
161
  */
165
162
  dnsStageId?: string;
166
163
  }
167
- export interface PurgeRequest {
168
- /** ID of the purge request. */
169
- id: string;
170
- /** Pipeline ID the purge request belongs to. */
171
- pipelineId: string;
172
- /** Status of the purge request. */
173
- status: PurgeRequestStatus;
174
- /**
175
- * List of asserts to purge.
176
- *
177
- * One-of ('target'): at most one of 'assets', 'all' could be set.
178
- */
179
- assets?: string[];
180
- /**
181
- * Defines whether to purge all content.
182
- *
183
- * One-of ('target'): at most one of 'assets', 'all' could be set.
184
- */
185
- all?: boolean;
186
- /** Date the purge request was created. */
187
- createdAt?: Date;
188
- /** Date the purge request was last updated. */
189
- updatedAt?: Date;
190
- }
191
164
  export interface TLSStage {
192
165
  /** ID of the TLS stage. */
193
166
  id: string;
@@ -223,6 +196,39 @@ export interface TLSStage {
223
196
  */
224
197
  backendStageId?: string;
225
198
  }
199
+ export interface CheckPEMChainRequestSecretChain {
200
+ secretId: string;
201
+ secretRegion: string;
202
+ }
203
+ export interface PlanDetails {
204
+ planName: PlanName;
205
+ packageGb: number;
206
+ pipelineLimit: number;
207
+ }
208
+ export interface PurgeRequest {
209
+ /** ID of the purge request. */
210
+ id: string;
211
+ /** Pipeline ID the purge request belongs to. */
212
+ pipelineId: string;
213
+ /** Status of the purge request. */
214
+ status: PurgeRequestStatus;
215
+ /**
216
+ * List of asserts to purge.
217
+ *
218
+ * One-of ('target'): at most one of 'assets', 'all' could be set.
219
+ */
220
+ assets?: string[];
221
+ /**
222
+ * Defines whether to purge all content.
223
+ *
224
+ * One-of ('target'): at most one of 'assets', 'all' could be set.
225
+ */
226
+ all?: boolean;
227
+ /** Date the purge request was created. */
228
+ createdAt?: Date;
229
+ /** Date the purge request was last updated. */
230
+ updatedAt?: Date;
231
+ }
226
232
  export interface TLSSecretsConfig {
227
233
  /** Secret information (from Secret Manager). */
228
234
  tlsSecrets: TLSSecret[];
@@ -376,6 +382,9 @@ export type DeleteCacheStageRequest = {
376
382
  /** ID of the cache stage to delete. */
377
383
  cacheStageId: string;
378
384
  };
385
+ export type DeleteCurrentPlanRequest = {
386
+ projectId?: string;
387
+ };
379
388
  export type DeleteDNSStageRequest = {
380
389
  /** ID of the DNS stage to delete. */
381
390
  dnsStageId: string;
@@ -396,6 +405,9 @@ export type GetCacheStageRequest = {
396
405
  /** ID of the requested cache stage. */
397
406
  cacheStageId: string;
398
407
  };
408
+ export type GetCurrentPlanRequest = {
409
+ projectId?: string;
410
+ };
399
411
  export type GetDNSStageRequest = {
400
412
  /** ID of the requested DNS stage. */
401
413
  dnsStageId: string;
@@ -538,6 +550,10 @@ export interface ListPipelinesResponse {
538
550
  /** Count of all pipelines matching the requested criteria. */
539
551
  totalCount: number;
540
552
  }
553
+ export interface ListPlansResponse {
554
+ totalCount: number;
555
+ plans: PlanDetails[];
556
+ }
541
557
  export type ListPurgeRequestsRequest = {
542
558
  /** Sort order of purge requests in the response. */
543
559
  orderBy?: ListPurgeRequestsRequestOrderBy;
@@ -601,6 +617,13 @@ export interface ListTLSStagesResponse {
601
617
  /** Count of all TLS stages matching the requested criteria. */
602
618
  totalCount: number;
603
619
  }
620
+ export interface Plan {
621
+ planName: PlanName;
622
+ }
623
+ export type SelectPlanRequest = {
624
+ projectId?: string;
625
+ planName?: PlanName;
626
+ };
604
627
  export type UpdateBackendStageRequest = {
605
628
  /** ID of the backend stage to update. */
606
629
  backendStageId: string;
@@ -50,6 +50,9 @@ const CreateSSHKeyRequest = {
50
50
  }
51
51
  };
52
52
  const CreateUserRequestMember = {
53
+ email: {
54
+ ignoreEmpty: true
55
+ },
53
56
  password: {
54
57
  ignoreEmpty: true,
55
58
  maxLength: 72
@@ -48,6 +48,9 @@ export declare const CreateSSHKeyRequest: {
48
48
  };
49
49
  };
50
50
  export declare const CreateUserRequestMember: {
51
+ email: {
52
+ ignoreEmpty: boolean;
53
+ };
51
54
  password: {
52
55
  ignoreEmpty: boolean;
53
56
  maxLength: number;
@@ -48,6 +48,9 @@ const CreateSSHKeyRequest = {
48
48
  }
49
49
  };
50
50
  const CreateUserRequestMember = {
51
+ email: {
52
+ ignoreEmpty: true
53
+ },
51
54
  password: {
52
55
  ignoreEmpty: true,
53
56
  maxLength: 72
@@ -190,15 +190,14 @@ class API extends api.API {
190
190
  * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
191
191
  * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
192
192
  * it. `backup`: Create an image with all the volumes of an Instance.
193
- * `terminate`: Delete the Instance along with all attached volumes.
194
- * `enable_routed_ip`: Migrate the Instance to the new network stack.
193
+ * `terminate`: Delete the Instance along with its attached volumes, except
194
+ * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
195
+ * network stack.
195
196
  *
196
- * Keep in mind that terminating an Instance will result in the deletion of
197
- * all attached volumes, including local and block storage. If you want to
198
- * preserve your local volumes, you should use the `archive` action instead of
199
- * `terminate`. Similarly, if you want to keep your block storage volumes, you
200
- * must first detach them before issuing the `terminate` command. For more
201
- * information, read the [Volumes](#path-volumes-list-volumes) documentation.
197
+ * Keep in mind that `terminate` an Instance will result in the deletion of
198
+ * `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type
199
+ * will only be detached. If you want to preserve your volumes, you should
200
+ * detach them before the Instance deletion or `terminate` action.
202
201
  *
203
202
  * @param request - The request {@link ServerActionRequest}
204
203
  * @returns A Promise of ServerActionResponse
@@ -74,15 +74,14 @@ export declare class API extends ParentAPI {
74
74
  * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
75
75
  * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
76
76
  * it. `backup`: Create an image with all the volumes of an Instance.
77
- * `terminate`: Delete the Instance along with all attached volumes.
78
- * `enable_routed_ip`: Migrate the Instance to the new network stack.
79
- *
80
- * Keep in mind that terminating an Instance will result in the deletion of
81
- * all attached volumes, including local and block storage. If you want to
82
- * preserve your local volumes, you should use the `archive` action instead of
83
- * `terminate`. Similarly, if you want to keep your block storage volumes, you
84
- * must first detach them before issuing the `terminate` command. For more
85
- * information, read the [Volumes](#path-volumes-list-volumes) documentation.
77
+ * `terminate`: Delete the Instance along with its attached volumes, except
78
+ * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
79
+ * network stack.
80
+ *
81
+ * Keep in mind that `terminate` an Instance will result in the deletion of
82
+ * `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type
83
+ * will only be detached. If you want to preserve your volumes, you should
84
+ * detach them before the Instance deletion or `terminate` action.
86
85
  *
87
86
  * @param request - The request {@link ServerActionRequest}
88
87
  * @returns A Promise of ServerActionResponse