@scaleway/sdk 1.5.0 → 1.7.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 (46) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.js +2 -2
  2. package/dist/api/baremetal/v1/api.gen.js +3 -3
  3. package/dist/api/baremetal/v1/api.utils.js +1 -1
  4. package/dist/api/cockpit/v1beta1/api.gen.js +89 -29
  5. package/dist/api/cockpit/v1beta1/marshalling.gen.js +44 -1
  6. package/dist/api/container/v1beta1/api.gen.js +35 -29
  7. package/dist/api/container/v1beta1/marshalling.gen.js +1 -1
  8. package/dist/api/domain/v2beta1/api.gen.js +2 -2
  9. package/dist/api/flexibleip/v1alpha1/api.gen.js +2 -2
  10. package/dist/api/function/v1beta1/api.gen.js +40 -31
  11. package/dist/api/function/v1beta1/marshalling.gen.js +1 -20
  12. package/dist/api/iam/v1alpha1/api.gen.js +2 -3
  13. package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
  14. package/dist/api/iam/v1alpha1/validation-rules.gen.js +10 -10
  15. package/dist/api/instance/v1/api.gen.js +86 -67
  16. package/dist/api/instance/v1/api.utils.js +7 -13
  17. package/dist/api/iot/v1/api.gen.js +2 -2
  18. package/dist/api/k8s/v1/api.gen.js +4 -4
  19. package/dist/api/lb/v1/api.gen.js +6 -6
  20. package/dist/api/lb/v1/api.utils.js +4 -4
  21. package/dist/api/lb/v1/marshalling.gen.js +33 -19
  22. package/dist/api/marketplace/v2/api.gen.js +46 -3
  23. package/dist/api/mnq/v1alpha1/api.gen.js +36 -13
  24. package/dist/api/rdb/v1/api.gen.js +6 -6
  25. package/dist/api/redis/v1/api.gen.js +2 -2
  26. package/dist/api/redis/v1/marshalling.gen.js +2 -0
  27. package/dist/api/registry/v1/api.gen.js +4 -4
  28. package/dist/api/secret/v1alpha1/api.gen.js +27 -16
  29. package/dist/api/secret/v1alpha1/marshalling.gen.js +22 -3
  30. package/dist/api/tem/v1alpha1/api.gen.js +3 -3
  31. package/dist/api/test/v1/api.gen.js +1 -1
  32. package/dist/api/vpc/v1/api.gen.js +15 -7
  33. package/dist/api/vpcgw/v1/api.gen.js +3 -3
  34. package/dist/api/webhosting/v1alpha1/api.gen.js +2 -2
  35. package/dist/helpers/marshalling.js +1 -1
  36. package/dist/index.cjs +513 -234
  37. package/dist/index.d.ts +1469 -736
  38. package/dist/internal/async/interval-retrier.js +8 -2
  39. package/dist/internal/logger/level-resolver.js +3 -3
  40. package/dist/scw/client-ini-factory.js +6 -0
  41. package/dist/scw/client-ini-profile.js +18 -0
  42. package/dist/scw/client-settings.js +12 -0
  43. package/dist/scw/constants.js +1 -1
  44. package/dist/scw/custom-marshalling.js +4 -7
  45. package/dist/scw/errors/standard/quotas-exceeded-error.js +6 -0
  46. package/package.json +2 -2
package/dist/index.cjs CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  // eslint-disable-next-line eslint-comments/disable-enable-pair
4
4
  /* eslint-disable @typescript-eslint/naming-convention */
5
- let LevelResolver;
6
- (function (LevelResolver) {
5
+ let LevelResolver = /*#__PURE__*/function (LevelResolver) {
7
6
  LevelResolver[LevelResolver["silent"] = 0] = "silent";
8
7
  LevelResolver[LevelResolver["error"] = 1] = "error";
9
8
  LevelResolver[LevelResolver["warn"] = 2] = "warn";
10
9
  LevelResolver[LevelResolver["info"] = 3] = "info";
11
10
  LevelResolver[LevelResolver["debug"] = 4] = "debug";
12
- })(LevelResolver || (LevelResolver = {}));
11
+ return LevelResolver;
12
+ }({});
13
13
  const shouldLog = (currentLevel, level) => LevelResolver[level] <= currentLevel;
14
14
 
15
15
  /**
@@ -138,6 +138,24 @@ const isURL = str => {
138
138
  return url.protocol === 'http:' || url.protocol === 'https:';
139
139
  };
140
140
 
141
+ /**
142
+ * Holds access key and secret key.
143
+ *
144
+ * @public
145
+ */
146
+
147
+ /**
148
+ * Holds default values of a Scaleway profile.
149
+ *
150
+ * @public
151
+ */
152
+
153
+ /**
154
+ * Holds values of a Scaleway profile.
155
+ *
156
+ * @public
157
+ */
158
+
141
159
  /**
142
160
  * Verifies that the payload contains both the accessKey and the secretKey.
143
161
  *
@@ -232,6 +250,12 @@ const obfuscateAuthHeadersEntry = ([name, value]) => {
232
250
  return [name, value];
233
251
  };
234
252
 
253
+ /**
254
+ * A factory to build {@link Settings}.
255
+ *
256
+ * @public
257
+ */
258
+
235
259
  /**
236
260
  * Instantiates the SDK from a configuration {@link Profile}.
237
261
  *
@@ -327,6 +351,18 @@ const withUserAgentSuffix = userAgent => settings => ({
327
351
  userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
328
352
  });
329
353
 
354
+ /**
355
+ * Holds default values of settings.
356
+ *
357
+ * @public
358
+ */
359
+
360
+ /**
361
+ * Settings hold the values of all client options.
362
+ *
363
+ * @public
364
+ */
365
+
330
366
  /**
331
367
  * Validates the content of a {@link Settings} object.
332
368
  *
@@ -390,7 +426,7 @@ const assertValidSettings = obj => {
390
426
  }
391
427
  };
392
428
 
393
- const version = 'v1.4.0';
429
+ const version = 'v1.6.0';
394
430
  const userAgent = `scaleway-sdk-js/${version}`;
395
431
 
396
432
  const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -692,6 +728,12 @@ class InvalidArgumentsError extends ScalewayError {
692
728
  * @public
693
729
  */
694
730
 
731
+ /**
732
+ * Details of an {@link QuotasExceededError} error.
733
+ *
734
+ * @public
735
+ */
736
+
695
737
  /**
696
738
  * Build the default message for {@link QuotasExceededError}.
697
739
  *
@@ -1504,6 +1546,12 @@ const tryAtIntervals = async (retry, strategy, timeout = DEFAULT_TIMEOUT_SECONDS
1504
1546
  * @public
1505
1547
  */
1506
1548
 
1549
+ /**
1550
+ * The options to wait until a resource is ready.
1551
+ *
1552
+ * @public
1553
+ */
1554
+
1507
1555
  /**
1508
1556
  * Fetches resource several times until an expected condition is reached, timeouts, or throws an exception.
1509
1557
  *
@@ -3425,6 +3473,20 @@ const unmarshalGrafanaUser = data => {
3425
3473
  role: data.role
3426
3474
  };
3427
3475
  };
3476
+ const unmarshalPlan = data => {
3477
+ if (!isJSONObject(data)) {
3478
+ throw new TypeError(`Unmarshalling the type 'Plan' failed as data isn't a dictionary.`);
3479
+ }
3480
+ return {
3481
+ id: data.id,
3482
+ logsIngestionPrice: data.logs_ingestion_price,
3483
+ name: data.name,
3484
+ retentionLogsInterval: data.retention_logs_interval,
3485
+ retentionMetricsInterval: data.retention_metrics_interval,
3486
+ retentionPrice: data.retention_price,
3487
+ sampleIngestionPrice: data.sample_ingestion_price
3488
+ };
3489
+ };
3428
3490
  const unmarshalToken$2 = data => {
3429
3491
  if (!isJSONObject(data)) {
3430
3492
  throw new TypeError(`Unmarshalling the type 'Token' failed as data isn't a dictionary.`);
@@ -3447,11 +3509,20 @@ const unmarshalCockpit = data => {
3447
3509
  createdAt: unmarshalDate(data.created_at),
3448
3510
  endpoints: data.endpoints ? unmarshalCockpitEndpoints(data.endpoints) : undefined,
3449
3511
  managedAlertsEnabled: data.managed_alerts_enabled,
3512
+ plan: data.plan ? unmarshalPlan(data.plan) : undefined,
3450
3513
  projectId: data.project_id,
3451
3514
  status: data.status,
3452
3515
  updatedAt: unmarshalDate(data.updated_at)
3453
3516
  };
3454
3517
  };
3518
+ const unmarshalCockpitMetrics = data => {
3519
+ if (!isJSONObject(data)) {
3520
+ throw new TypeError(`Unmarshalling the type 'CockpitMetrics' failed as data isn't a dictionary.`);
3521
+ }
3522
+ return {
3523
+ timeseries: unmarshalArrayOfObject(data.timeseries, unmarshalTimeSeries)
3524
+ };
3525
+ };
3455
3526
  const unmarshalListContactPointsResponse = data => {
3456
3527
  if (!isJSONObject(data)) {
3457
3528
  throw new TypeError(`Unmarshalling the type 'ListContactPointsResponse' failed as data isn't a dictionary.`);
@@ -3472,6 +3543,15 @@ const unmarshalListGrafanaUsersResponse = data => {
3472
3543
  totalCount: data.total_count
3473
3544
  };
3474
3545
  };
3546
+ const unmarshalListPlansResponse = data => {
3547
+ if (!isJSONObject(data)) {
3548
+ throw new TypeError(`Unmarshalling the type 'ListPlansResponse' failed as data isn't a dictionary.`);
3549
+ }
3550
+ return {
3551
+ plans: unmarshalArrayOfObject(data.plans, unmarshalPlan),
3552
+ totalCount: data.total_count
3553
+ };
3554
+ };
3475
3555
  const unmarshalListTokensResponse$2 = data => {
3476
3556
  if (!isJSONObject(data)) {
3477
3557
  throw new TypeError(`Unmarshalling the type 'ListTokensResponse' failed as data isn't a dictionary.`);
@@ -3481,6 +3561,12 @@ const unmarshalListTokensResponse$2 = data => {
3481
3561
  totalCount: data.total_count
3482
3562
  };
3483
3563
  };
3564
+ const unmarshalSelectPlanResponse = data => {
3565
+ if (!isJSONObject(data)) {
3566
+ throw new TypeError(`Unmarshalling the type 'SelectPlanResponse' failed as data isn't a dictionary.`);
3567
+ }
3568
+ return {};
3569
+ };
3484
3570
  const marshalContactPointEmail = (request, defaults) => ({
3485
3571
  to: request.to
3486
3572
  });
@@ -3538,6 +3624,10 @@ const marshalResetCockpitGrafanaRequest = (request, defaults) => ({
3538
3624
  const marshalResetGrafanaUserPasswordRequest = (request, defaults) => ({
3539
3625
  project_id: request.projectId ?? defaults.defaultProjectId
3540
3626
  });
3627
+ const marshalSelectPlanRequest = (request, defaults) => ({
3628
+ plan_id: request.planId,
3629
+ project_id: request.projectId ?? defaults.defaultProjectId
3630
+ });
3541
3631
  const marshalTriggerTestAlertRequest = (request, defaults) => ({
3542
3632
  project_id: request.projectId ?? defaults.defaultProjectId
3543
3633
  });
@@ -3548,14 +3638,16 @@ const jsonContentHeaders$j = {
3548
3638
  };
3549
3639
 
3550
3640
  /**
3551
- * Cockpit API.
3641
+ * Cockpit API documentation.
3552
3642
  *
3553
- * This API allows to manage Cockpits. Cockpit API.
3643
+ * Cockpit's API allows you to monitor your applications and their
3644
+ * infrastructure. Cockpit's API allows you to activate your Cockpit on your
3645
+ * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
3646
+ * Grafana for dashboarding to visualize them.
3554
3647
  */
3555
3648
  let API$l = class API extends API$q {
3556
3649
  /**
3557
- * Activate a cockpit. Activate a cockpit associated with the given project
3558
- * ID.
3650
+ * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
3559
3651
  *
3560
3652
  * @param request - The request {@link ActivateCockpitRequest}
3561
3653
  * @returns A Promise of Cockpit
@@ -3568,7 +3660,7 @@ let API$l = class API extends API$q {
3568
3660
  }, unmarshalCockpit);
3569
3661
 
3570
3662
  /**
3571
- * Get cockpit. Get the cockpit associated with the given project ID.
3663
+ * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
3572
3664
  *
3573
3665
  * @param request - The request {@link GetCockpitRequest}
3574
3666
  * @returns A Promise of Cockpit
@@ -3589,8 +3681,20 @@ let API$l = class API extends API$q {
3589
3681
  waitForCockpit = (request = {}, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), this.getCockpit, request, options);
3590
3682
 
3591
3683
  /**
3592
- * Deactivate a cockpit. Deactivate a cockpit associated with the given
3593
- * project ID.
3684
+ * Get Cockpit metrics. Get metrics from your Cockpit with the specified
3685
+ * Project ID.
3686
+ *
3687
+ * @param request - The request {@link GetCockpitMetricsRequest}
3688
+ * @returns A Promise of CockpitMetrics
3689
+ */
3690
+ getCockpitMetrics = (request = {}) => this.client.fetch({
3691
+ method: 'GET',
3692
+ path: `/cockpit/v1beta1/cockpit/metrics`,
3693
+ urlParams: urlParams(['end_date', request.endDate], ['metric_name', request.metricName], ['project_id', request.projectId ?? this.client.settings.defaultProjectId], ['start_date', request.startDate])
3694
+ }, unmarshalCockpitMetrics);
3695
+
3696
+ /**
3697
+ * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
3594
3698
  *
3595
3699
  * @param request - The request {@link DeactivateCockpitRequest}
3596
3700
  * @returns A Promise of Cockpit
@@ -3603,8 +3707,8 @@ let API$l = class API extends API$q {
3603
3707
  }, unmarshalCockpit);
3604
3708
 
3605
3709
  /**
3606
- * Reset Grafana. Reset the Grafana of your cockpit associated with the given
3607
- * project ID.
3710
+ * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
3711
+ * Project ID.
3608
3712
  *
3609
3713
  * @param request - The request {@link ResetCockpitGrafanaRequest}
3610
3714
  * @returns A Promise of Cockpit
@@ -3617,7 +3721,7 @@ let API$l = class API extends API$q {
3617
3721
  }, unmarshalCockpit);
3618
3722
 
3619
3723
  /**
3620
- * Create a token. Create a token associated with the given project ID.
3724
+ * Create a token. Create a token associated with the specified Project ID.
3621
3725
  *
3622
3726
  * @param request - The request {@link CreateTokenRequest}
3623
3727
  * @returns A Promise of Token
@@ -3635,7 +3739,7 @@ let API$l = class API extends API$q {
3635
3739
  }, unmarshalListTokensResponse$2);
3636
3740
 
3637
3741
  /**
3638
- * List tokens. List tokens associated with the given project ID.
3742
+ * List tokens. Get a list of tokens associated with the specified Project ID.
3639
3743
  *
3640
3744
  * @param request - The request {@link ListTokensRequest}
3641
3745
  * @returns A Promise of ListTokensResponse
@@ -3643,7 +3747,7 @@ let API$l = class API extends API$q {
3643
3747
  listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
3644
3748
 
3645
3749
  /**
3646
- * Get token. Get the token associated with the given ID.
3750
+ * Get a token. Retrieve the token associated with the specified token ID.
3647
3751
  *
3648
3752
  * @param request - The request {@link GetTokenRequest}
3649
3753
  * @returns A Promise of Token
@@ -3654,7 +3758,7 @@ let API$l = class API extends API$q {
3654
3758
  }, unmarshalToken$2);
3655
3759
 
3656
3760
  /**
3657
- * Delete token. Delete the token associated with the given ID.
3761
+ * Delete a token. Delete the token associated with the specified token ID.
3658
3762
  *
3659
3763
  * @param request - The request {@link DeleteTokenRequest}
3660
3764
  */
@@ -3664,7 +3768,7 @@ let API$l = class API extends API$q {
3664
3768
  });
3665
3769
 
3666
3770
  /**
3667
- * Create an alert contact point. Create an alert contact point for the
3771
+ * Create a contact point. Create a contact point to receive alerts for the
3668
3772
  * default receiver.
3669
3773
  *
3670
3774
  * @param request - The request {@link CreateContactPointRequest}
@@ -3683,8 +3787,8 @@ let API$l = class API extends API$q {
3683
3787
  }, unmarshalListContactPointsResponse);
3684
3788
 
3685
3789
  /**
3686
- * List alert contact points. List alert contact points associated with the
3687
- * given cockpit ID.
3790
+ * List contact points. Get a list of contact points for the Cockpit
3791
+ * associated with the specified Project ID.
3688
3792
  *
3689
3793
  * @param request - The request {@link ListContactPointsRequest}
3690
3794
  * @returns A Promise of ListContactPointsResponse
@@ -3692,8 +3796,8 @@ let API$l = class API extends API$q {
3692
3796
  listContactPoints = (request = {}) => enrichForPagination('contactPoints', this.pageOfListContactPoints, request);
3693
3797
 
3694
3798
  /**
3695
- * Delete an alert contact point. Delete an alert contact point for the
3696
- * default receiver.
3799
+ * Delete an alert contact point. Delete a contact point for the default
3800
+ * receiver.
3697
3801
  *
3698
3802
  * @param request - The request {@link DeleteContactPointRequest}
3699
3803
  */
@@ -3705,7 +3809,8 @@ let API$l = class API extends API$q {
3705
3809
  });
3706
3810
 
3707
3811
  /**
3708
- * Enable managed alerts.
3812
+ * Enable managed alerts. Enable the sending of managed alerts for the
3813
+ * specified Project's Cockpit.
3709
3814
  *
3710
3815
  * @param request - The request {@link EnableManagedAlertsRequest}
3711
3816
  */
@@ -3717,7 +3822,8 @@ let API$l = class API extends API$q {
3717
3822
  });
3718
3823
 
3719
3824
  /**
3720
- * Disable managed alerts.
3825
+ * Disable managed alerts. Disable the sending of managed alerts for the
3826
+ * specified Project's Cockpit.
3721
3827
  *
3722
3828
  * @param request - The request {@link DisableManagedAlertsRequest}
3723
3829
  */
@@ -3729,7 +3835,8 @@ let API$l = class API extends API$q {
3729
3835
  });
3730
3836
 
3731
3837
  /**
3732
- * Trigger a test alert. Trigger a test alert to all receivers.
3838
+ * Trigger a test alert. Trigger a test alert to all of the Cockpit's
3839
+ * receivers.
3733
3840
  *
3734
3841
  * @param request - The request {@link TriggerTestAlertRequest}
3735
3842
  */
@@ -3741,7 +3848,9 @@ let API$l = class API extends API$q {
3741
3848
  });
3742
3849
 
3743
3850
  /**
3744
- * Create a grafana user. Create a grafana user for your grafana instance.
3851
+ * Create a Grafana user. Create a Grafana user for your Cockpit's Grafana
3852
+ * instance. Make sure you save the automatically-generated password and the
3853
+ * Grafana user ID.
3745
3854
  *
3746
3855
  * @param request - The request {@link CreateGrafanaUserRequest}
3747
3856
  * @returns A Promise of GrafanaUser
@@ -3759,8 +3868,8 @@ let API$l = class API extends API$q {
3759
3868
  }, unmarshalListGrafanaUsersResponse);
3760
3869
 
3761
3870
  /**
3762
- * List grafana users. List grafana users who are able to connect to your
3763
- * grafana instance.
3871
+ * List Grafana users. Get a list of Grafana users who are able to connect to
3872
+ * the Cockpit's Grafana instance.
3764
3873
  *
3765
3874
  * @param request - The request {@link ListGrafanaUsersRequest}
3766
3875
  * @returns A Promise of ListGrafanaUsersResponse
@@ -3768,7 +3877,8 @@ let API$l = class API extends API$q {
3768
3877
  listGrafanaUsers = (request = {}) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request);
3769
3878
 
3770
3879
  /**
3771
- * Delete a grafana user. Delete a grafana user from your grafana instance.
3880
+ * Delete a Grafana user. Delete a Grafana user from a Grafana instance,
3881
+ * specified by the Cockpit's Project ID and the Grafana user ID.
3772
3882
  *
3773
3883
  * @param request - The request {@link DeleteGrafanaUserRequest}
3774
3884
  */
@@ -3780,8 +3890,8 @@ let API$l = class API extends API$q {
3780
3890
  });
3781
3891
 
3782
3892
  /**
3783
- * Reset Grafana user password. Reset the Grafana user password from your
3784
- * grafana instance.
3893
+ * Reset a Grafana user's password. Reset a Grafana user's password specified
3894
+ * by the Cockpit's Project ID and the Grafana user ID.
3785
3895
  *
3786
3896
  * @param request - The request {@link ResetGrafanaUserPasswordRequest}
3787
3897
  * @returns A Promise of GrafanaUser
@@ -3792,6 +3902,34 @@ let API$l = class API extends API$q {
3792
3902
  method: 'POST',
3793
3903
  path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/reset-password`
3794
3904
  }, unmarshalGrafanaUser);
3905
+ pageOfListPlans = (request = {}) => this.client.fetch({
3906
+ method: 'GET',
3907
+ path: `/cockpit/v1beta1/plans`,
3908
+ urlParams: urlParams(['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
3909
+ }, unmarshalListPlansResponse);
3910
+
3911
+ /**
3912
+ * List pricing plans. Get a list of all pricing plans available.
3913
+ *
3914
+ * @param request - The request {@link ListPlansRequest}
3915
+ * @returns A Promise of ListPlansResponse
3916
+ */
3917
+ listPlans = (request = {}) => enrichForPagination('plans', this.pageOfListPlans, request);
3918
+
3919
+ /**
3920
+ * Select pricing plan. Select your chosen pricing plan for your Cockpit,
3921
+ * specifying the Cockpit's Project ID and the pricing plan's ID in the
3922
+ * request.
3923
+ *
3924
+ * @param request - The request {@link SelectPlanRequest}
3925
+ * @returns A Promise of SelectPlanResponse
3926
+ */
3927
+ selectPlan = request => this.client.fetch({
3928
+ body: JSON.stringify(marshalSelectPlanRequest(request, this.client.settings)),
3929
+ headers: jsonContentHeaders$j,
3930
+ method: 'POST',
3931
+ path: `/cockpit/v1beta1/select-plan`
3932
+ }, unmarshalSelectPlanResponse);
3795
3933
  };
3796
3934
 
3797
3935
  // This file was automatically generated. DO NOT EDIT.
@@ -4002,7 +4140,7 @@ const marshalCreateContainerRequest = (request, defaults) => ({
4002
4140
  max_scale: request.maxScale,
4003
4141
  memory_limit: request.memoryLimit,
4004
4142
  min_scale: request.minScale,
4005
- name: request.name || randomName('ctnr'),
4143
+ name: request.name,
4006
4144
  namespace_id: request.namespaceId,
4007
4145
  port: request.port,
4008
4146
  privacy: request.privacy ?? 'unknown_privacy',
@@ -4087,7 +4225,7 @@ let API$k = class API extends API$q {
4087
4225
  }, unmarshalListNamespacesResponse$3);
4088
4226
 
4089
4227
  /**
4090
- * List all your namespaces.
4228
+ * List all your namespaces. List all namespaces in a specified region.
4091
4229
  *
4092
4230
  * @param request - The request {@link ListNamespacesRequest}
4093
4231
  * @returns A Promise of ListNamespacesResponse
@@ -4095,7 +4233,7 @@ let API$k = class API extends API$q {
4095
4233
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
4096
4234
 
4097
4235
  /**
4098
- * Get a namespace. Get the namespace associated with the given id.
4236
+ * Get a namespace. Get the namespace associated with the specified ID.
4099
4237
  *
4100
4238
  * @param request - The request {@link GetNamespaceRequest}
4101
4239
  * @returns A Promise of Namespace
@@ -4115,7 +4253,7 @@ let API$k = class API extends API$q {
4115
4253
  waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$2.includes(res.status))), this.getNamespace, request, options);
4116
4254
 
4117
4255
  /**
4118
- * Create a new namespace.
4256
+ * Create a new namespace. Create a new namespace in a specified region.
4119
4257
  *
4120
4258
  * @param request - The request {@link CreateNamespaceRequest}
4121
4259
  * @returns A Promise of Namespace
@@ -4128,8 +4266,8 @@ let API$k = class API extends API$q {
4128
4266
  }, unmarshalNamespace$3);
4129
4267
 
4130
4268
  /**
4131
- * Update an existing namespace. Update the space associated with the given
4132
- * id.
4269
+ * Update an existing namespace. Update the space associated with the
4270
+ * specified ID.
4133
4271
  *
4134
4272
  * @param request - The request {@link UpdateNamespaceRequest}
4135
4273
  * @returns A Promise of Namespace
@@ -4143,7 +4281,7 @@ let API$k = class API extends API$q {
4143
4281
 
4144
4282
  /**
4145
4283
  * Delete an existing namespace. Delete the namespace associated with the
4146
- * given id.
4284
+ * specified ID.
4147
4285
  *
4148
4286
  * @param request - The request {@link DeleteNamespaceRequest}
4149
4287
  * @returns A Promise of Namespace
@@ -4159,7 +4297,7 @@ let API$k = class API extends API$q {
4159
4297
  }, unmarshalListContainersResponse);
4160
4298
 
4161
4299
  /**
4162
- * List all your containers.
4300
+ * List all your containers. List all containers for a specified region.
4163
4301
  *
4164
4302
  * @param request - The request {@link ListContainersRequest}
4165
4303
  * @returns A Promise of ListContainersResponse
@@ -4167,7 +4305,7 @@ let API$k = class API extends API$q {
4167
4305
  listContainers = request => enrichForPagination('containers', this.pageOfListContainers, request);
4168
4306
 
4169
4307
  /**
4170
- * Get a container. Get the container associated with the given id.
4308
+ * Get a container. Get the container associated with the specified ID.
4171
4309
  *
4172
4310
  * @param request - The request {@link GetContainerRequest}
4173
4311
  * @returns A Promise of Container
@@ -4187,7 +4325,7 @@ let API$k = class API extends API$q {
4187
4325
  waitForContainer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
4188
4326
 
4189
4327
  /**
4190
- * Create a new container.
4328
+ * Create a new container. Create a new container in the specified region.
4191
4329
  *
4192
4330
  * @param request - The request {@link CreateContainerRequest}
4193
4331
  * @returns A Promise of Container
@@ -4201,7 +4339,7 @@ let API$k = class API extends API$q {
4201
4339
 
4202
4340
  /**
4203
4341
  * Update an existing container. Update the container associated with the
4204
- * given id.
4342
+ * specified ID.
4205
4343
  *
4206
4344
  * @param request - The request {@link UpdateContainerRequest}
4207
4345
  * @returns A Promise of Container
@@ -4214,7 +4352,7 @@ let API$k = class API extends API$q {
4214
4352
  }, unmarshalContainer);
4215
4353
 
4216
4354
  /**
4217
- * Delete a container. Delete the container associated with the given id.
4355
+ * Delete a container. Delete the container associated with the specified ID.
4218
4356
  *
4219
4357
  * @param request - The request {@link DeleteContainerRequest}
4220
4358
  * @returns A Promise of Container
@@ -4225,7 +4363,7 @@ let API$k = class API extends API$q {
4225
4363
  }, unmarshalContainer);
4226
4364
 
4227
4365
  /**
4228
- * Deploy a container. Deploy a container associated with the given id.
4366
+ * Deploy a container. Deploy a container associated with the specified ID.
4229
4367
  *
4230
4368
  * @param request - The request {@link DeployContainerRequest}
4231
4369
  * @returns A Promise of Container
@@ -4251,7 +4389,7 @@ let API$k = class API extends API$q {
4251
4389
  listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
4252
4390
 
4253
4391
  /**
4254
- * Get a cron. Get the cron associated with the given id.
4392
+ * Get a cron. Get the cron associated with the specified ID.
4255
4393
  *
4256
4394
  * @param request - The request {@link GetCronRequest}
4257
4395
  * @returns A Promise of Cron
@@ -4284,7 +4422,7 @@ let API$k = class API extends API$q {
4284
4422
  }, unmarshalCron$1);
4285
4423
 
4286
4424
  /**
4287
- * Update an existing cron. Update the cron associated with the given id.
4425
+ * Update an existing cron. Update the cron associated with the specified ID.
4288
4426
  *
4289
4427
  * @param request - The request {@link UpdateCronRequest}
4290
4428
  * @returns A Promise of Cron
@@ -4297,7 +4435,7 @@ let API$k = class API extends API$q {
4297
4435
  }, unmarshalCron$1);
4298
4436
 
4299
4437
  /**
4300
- * Delete an existing cron. Delete the cron associated with the given id.
4438
+ * Delete an existing cron. Delete the cron associated with the specified ID.
4301
4439
  *
4302
4440
  * @param request - The request {@link DeleteCronRequest}
4303
4441
  * @returns A Promise of Cron
@@ -4313,7 +4451,8 @@ let API$k = class API extends API$q {
4313
4451
  }, unmarshalListLogsResponse$1);
4314
4452
 
4315
4453
  /**
4316
- * List your container logs.
4454
+ * List your container logs. List the logs of the container with the specified
4455
+ * ID.
4317
4456
  *
4318
4457
  * @param request - The request {@link ListLogsRequest}
4319
4458
  * @returns A Promise of ListLogsResponse
@@ -4326,7 +4465,8 @@ let API$k = class API extends API$q {
4326
4465
  }, unmarshalListDomainsResponse$3);
4327
4466
 
4328
4467
  /**
4329
- * List all domain name bindings.
4468
+ * List all domain name bindings. List all domain name bindings in a specified
4469
+ * region.
4330
4470
  *
4331
4471
  * @param request - The request {@link ListDomainsRequest}
4332
4472
  * @returns A Promise of ListDomainsResponse
@@ -4334,7 +4474,8 @@ let API$k = class API extends API$q {
4334
4474
  listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
4335
4475
 
4336
4476
  /**
4337
- * Get a domain name binding.
4477
+ * Get a domain name binding. Get a domain name binding for the container with
4478
+ * the specified ID.
4338
4479
  *
4339
4480
  * @param request - The request {@link GetDomainRequest}
4340
4481
  * @returns A Promise of Domain
@@ -4354,7 +4495,8 @@ let API$k = class API extends API$q {
4354
4495
  waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$3.includes(res.status))), this.getDomain, request, options);
4355
4496
 
4356
4497
  /**
4357
- * Create a domain name binding.
4498
+ * Create a domain name binding. Create a domain name binding for the
4499
+ * container with the specified ID.
4358
4500
  *
4359
4501
  * @param request - The request {@link CreateDomainRequest}
4360
4502
  * @returns A Promise of Domain
@@ -4367,7 +4509,8 @@ let API$k = class API extends API$q {
4367
4509
  }, unmarshalDomain$3);
4368
4510
 
4369
4511
  /**
4370
- * Delete a domain name binding.
4512
+ * Delete a domain name binding. Delete the domain name binding with the
4513
+ * specific ID.
4371
4514
  *
4372
4515
  * @param request - The request {@link DeleteDomainRequest}
4373
4516
  * @returns A Promise of Domain
@@ -4408,7 +4551,7 @@ let API$k = class API extends API$q {
4408
4551
  }, unmarshalToken$1);
4409
4552
 
4410
4553
  /**
4411
- * Get a token.
4554
+ * Get a token. Get a token with a specified ID.
4412
4555
  *
4413
4556
  * @param request - The request {@link GetTokenRequest}
4414
4557
  * @returns A Promise of Token
@@ -4433,7 +4576,8 @@ let API$k = class API extends API$q {
4433
4576
  }, unmarshalListTokensResponse$1);
4434
4577
 
4435
4578
  /**
4436
- * List all tokens.
4579
+ * List all tokens. List all tokens belonging to a specified Organization or
4580
+ * Project.
4437
4581
  *
4438
4582
  * @param request - The request {@link ListTokensRequest}
4439
4583
  * @returns A Promise of ListTokensResponse
@@ -4441,7 +4585,7 @@ let API$k = class API extends API$q {
4441
4585
  listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
4442
4586
 
4443
4587
  /**
4444
- * Delete a token.
4588
+ * Delete a token. Delete a token with a specified ID.
4445
4589
  *
4446
4590
  * @param request - The request {@link DeleteTokenRequest}
4447
4591
  * @returns A Promise of Token
@@ -6816,6 +6960,7 @@ const unmarshalFunction = data => {
6816
6960
  throw new TypeError(`Unmarshalling the type 'Function' failed as data isn't a dictionary.`);
6817
6961
  }
6818
6962
  return {
6963
+ buildMessage: data.build_message,
6819
6964
  cpuLimit: data.cpu_limit,
6820
6965
  description: data.description,
6821
6966
  domainName: data.domain_name,
@@ -7031,22 +7176,8 @@ const marshalSecret = (request, defaults) => ({
7031
7176
  key: request.key,
7032
7177
  value: request.value
7033
7178
  });
7034
- const marshalUpdateTriggerRequestMnqNatsClientConfig = (request, defaults) => ({
7035
- mnq_namespace_id: request.mnqNamespaceId,
7036
- mnq_project_id: request.mnqProjectId,
7037
- mnq_region: request.mnqRegion,
7038
- subject: request.subject
7039
- });
7040
- const marshalUpdateTriggerRequestMnqSqsClientConfig = (request, defaults) => ({
7041
- mnq_namespace_id: request.mnqNamespaceId,
7042
- mnq_project_id: request.mnqProjectId,
7043
- mnq_region: request.mnqRegion,
7044
- queue: request.queue
7045
- });
7046
7179
  const marshalUpdateTriggerRequestSqsClientConfig = (request, defaults) => ({
7047
7180
  access_key: request.accessKey,
7048
- endpoint: request.endpoint,
7049
- queue_url: request.queueUrl,
7050
7181
  secret_key: request.secretKey
7051
7182
  });
7052
7183
  const marshalCreateCronRequest = (request, defaults) => ({
@@ -7136,14 +7267,8 @@ const marshalUpdateTriggerRequest = (request, defaults) => ({
7136
7267
  description: request.description,
7137
7268
  name: request.name,
7138
7269
  ...resolveOneOf([{
7139
- param: 'scw_sqs_config',
7140
- value: request.scwSqsConfig ? marshalUpdateTriggerRequestMnqSqsClientConfig(request.scwSqsConfig) : undefined
7141
- }, {
7142
7270
  param: 'sqs_config',
7143
7271
  value: request.sqsConfig ? marshalUpdateTriggerRequestSqsClientConfig(request.sqsConfig) : undefined
7144
- }, {
7145
- param: 'scw_nats_config',
7146
- value: request.scwNatsConfig ? marshalUpdateTriggerRequestMnqNatsClientConfig(request.scwNatsConfig) : undefined
7147
7272
  }])
7148
7273
  });
7149
7274
 
@@ -7167,7 +7292,8 @@ let API$h = class API extends API$q {
7167
7292
  }, unmarshalListNamespacesResponse$2);
7168
7293
 
7169
7294
  /**
7170
- * List all your namespaces.
7295
+ * List all your namespaces. List all existing namespaces in the specified
7296
+ * region.
7171
7297
  *
7172
7298
  * @param request - The request {@link ListNamespacesRequest}
7173
7299
  * @returns A Promise of ListNamespacesResponse
@@ -7175,7 +7301,7 @@ let API$h = class API extends API$q {
7175
7301
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
7176
7302
 
7177
7303
  /**
7178
- * Get a namespace. Get the namespace associated with the given id.
7304
+ * Get a namespace. Get the namespace associated with the specified ID.
7179
7305
  *
7180
7306
  * @param request - The request {@link GetNamespaceRequest}
7181
7307
  * @returns A Promise of Namespace
@@ -7195,7 +7321,8 @@ let API$h = class API extends API$q {
7195
7321
  waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$1.includes(res.status))), this.getNamespace, request, options);
7196
7322
 
7197
7323
  /**
7198
- * Create a new namespace.
7324
+ * Create a new namespace. Create a new namespace in a specified Organization
7325
+ * or Proejct.
7199
7326
  *
7200
7327
  * @param request - The request {@link CreateNamespaceRequest}
7201
7328
  * @returns A Promise of Namespace
@@ -7208,8 +7335,8 @@ let API$h = class API extends API$q {
7208
7335
  }, unmarshalNamespace$2);
7209
7336
 
7210
7337
  /**
7211
- * Update an existing namespace. Update the space associated with the given
7212
- * id.
7338
+ * Update an existing namespace. Update the namespace associated with the
7339
+ * specified ID.
7213
7340
  *
7214
7341
  * @param request - The request {@link UpdateNamespaceRequest}
7215
7342
  * @returns A Promise of Namespace
@@ -7223,7 +7350,7 @@ let API$h = class API extends API$q {
7223
7350
 
7224
7351
  /**
7225
7352
  * Delete an existing namespace. Delete the namespace associated with the
7226
- * given id.
7353
+ * specified ID.
7227
7354
  *
7228
7355
  * @param request - The request {@link DeleteNamespaceRequest}
7229
7356
  * @returns A Promise of Namespace
@@ -7247,7 +7374,7 @@ let API$h = class API extends API$q {
7247
7374
  listFunctions = request => enrichForPagination('functions', this.pageOfListFunctions, request);
7248
7375
 
7249
7376
  /**
7250
- * Get a function. Get the function associated with the given id.
7377
+ * Get a function. Get the function associated with the specified ID.
7251
7378
  *
7252
7379
  * @param request - The request {@link GetFunctionRequest}
7253
7380
  * @returns A Promise of Function
@@ -7267,7 +7394,8 @@ let API$h = class API extends API$q {
7267
7394
  waitForFunction = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!FUNCTION_TRANSIENT_STATUSES.includes(res.status))), this.getFunction, request, options);
7268
7395
 
7269
7396
  /**
7270
- * Create a new function.
7397
+ * Create a new function. Create a new function in the specified region for a
7398
+ * specified Organization or Project.
7271
7399
  *
7272
7400
  * @param request - The request {@link CreateFunctionRequest}
7273
7401
  * @returns A Promise of Function
@@ -7280,8 +7408,8 @@ let API$h = class API extends API$q {
7280
7408
  }, unmarshalFunction);
7281
7409
 
7282
7410
  /**
7283
- * Update an existing function. Update the function associated with the given
7284
- * id.
7411
+ * Update an existing function. Update the function associated with the
7412
+ * specified ID.
7285
7413
  *
7286
7414
  * @param request - The request {@link UpdateFunctionRequest}
7287
7415
  * @returns A Promise of Function
@@ -7294,7 +7422,7 @@ let API$h = class API extends API$q {
7294
7422
  }, unmarshalFunction);
7295
7423
 
7296
7424
  /**
7297
- * Delete a function. Delete the function associated with the given id.
7425
+ * Delete a function. Delete the function associated with the specified ID.
7298
7426
  *
7299
7427
  * @param request - The request {@link DeleteFunctionRequest}
7300
7428
  * @returns A Promise of Function
@@ -7305,7 +7433,7 @@ let API$h = class API extends API$q {
7305
7433
  }, unmarshalFunction);
7306
7434
 
7307
7435
  /**
7308
- * Deploy a function. Deploy a function associated with the given id.
7436
+ * Deploy a function. Deploy a function associated with the specified ID.
7309
7437
  *
7310
7438
  * @param request - The request {@link DeployFunctionRequest}
7311
7439
  * @returns A Promise of Function
@@ -7330,7 +7458,7 @@ let API$h = class API extends API$q {
7330
7458
 
7331
7459
  /**
7332
7460
  * Get an upload URL of a function. Get an upload URL of a function associated
7333
- * with the given id.
7461
+ * with the specified ID.
7334
7462
  *
7335
7463
  * @param request - The request {@link GetFunctionUploadURLRequest}
7336
7464
  * @returns A Promise of UploadURL
@@ -7343,7 +7471,7 @@ let API$h = class API extends API$q {
7343
7471
 
7344
7472
  /**
7345
7473
  * Get a download URL of a function. Get a download URL for a function
7346
- * associated with the given id.
7474
+ * associated with the specified ID.
7347
7475
  *
7348
7476
  * @param request - The request {@link GetFunctionDownloadURLRequest}
7349
7477
  * @returns A Promise of DownloadURL
@@ -7359,7 +7487,7 @@ let API$h = class API extends API$q {
7359
7487
  }, unmarshalListCronsResponse);
7360
7488
 
7361
7489
  /**
7362
- * List all your crons.
7490
+ * List all crons. List all the cronjobs in a specified region.
7363
7491
  *
7364
7492
  * @param request - The request {@link ListCronsRequest}
7365
7493
  * @returns A Promise of ListCronsResponse
@@ -7367,7 +7495,7 @@ let API$h = class API extends API$q {
7367
7495
  listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
7368
7496
 
7369
7497
  /**
7370
- * Get a cron. Get the cron associated with the given id.
7498
+ * Get a cron. Get the cron associated with the specified ID.
7371
7499
  *
7372
7500
  * @param request - The request {@link GetCronRequest}
7373
7501
  * @returns A Promise of Cron
@@ -7387,7 +7515,8 @@ let API$h = class API extends API$q {
7387
7515
  waitForCron = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
7388
7516
 
7389
7517
  /**
7390
- * Create a new cron.
7518
+ * Create a new cron. Create a new cronjob for a function with the specified
7519
+ * ID.
7391
7520
  *
7392
7521
  * @param request - The request {@link CreateCronRequest}
7393
7522
  * @returns A Promise of Cron
@@ -7400,7 +7529,7 @@ let API$h = class API extends API$q {
7400
7529
  }, unmarshalCron);
7401
7530
 
7402
7531
  /**
7403
- * Update an existing cron. Update the cron associated with the given id.
7532
+ * Update an existing cron. Update the cron associated with the specified ID.
7404
7533
  *
7405
7534
  * @param request - The request {@link UpdateCronRequest}
7406
7535
  * @returns A Promise of Cron
@@ -7413,7 +7542,7 @@ let API$h = class API extends API$q {
7413
7542
  }, unmarshalCron);
7414
7543
 
7415
7544
  /**
7416
- * Delete an existing cron. Delete the cron associated with the given id.
7545
+ * Delete an existing cron. Delete the cron associated with the specified ID.
7417
7546
  *
7418
7547
  * @param request - The request {@link DeleteCronRequest}
7419
7548
  * @returns A Promise of Cron
@@ -7429,7 +7558,8 @@ let API$h = class API extends API$q {
7429
7558
  }, unmarshalListLogsResponse);
7430
7559
 
7431
7560
  /**
7432
- * List your application logs.
7561
+ * List application logs. List the application logs of the function with the
7562
+ * specified ID.
7433
7563
  *
7434
7564
  * @param request - The request {@link ListLogsRequest}
7435
7565
  * @returns A Promise of ListLogsResponse
@@ -7442,7 +7572,8 @@ let API$h = class API extends API$q {
7442
7572
  }, unmarshalListDomainsResponse$1);
7443
7573
 
7444
7574
  /**
7445
- * List all domain name bindings.
7575
+ * List all domain name bindings. List all domain name bindings in a specified
7576
+ * region.
7446
7577
  *
7447
7578
  * @param request - The request {@link ListDomainsRequest}
7448
7579
  * @returns A Promise of ListDomainsResponse
@@ -7450,7 +7581,8 @@ let API$h = class API extends API$q {
7450
7581
  listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
7451
7582
 
7452
7583
  /**
7453
- * Get a domain name binding.
7584
+ * Get a domain name binding. Get a domain name binding for the function with
7585
+ * the specified ID.
7454
7586
  *
7455
7587
  * @param request - The request {@link GetDomainRequest}
7456
7588
  * @returns A Promise of Domain
@@ -7470,7 +7602,8 @@ let API$h = class API extends API$q {
7470
7602
  waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$1.includes(res.status))), this.getDomain, request, options);
7471
7603
 
7472
7604
  /**
7473
- * Create a domain name binding.
7605
+ * Create a domain name binding. Create a domain name binding for the function
7606
+ * with the specified ID.
7474
7607
  *
7475
7608
  * @param request - The request {@link CreateDomainRequest}
7476
7609
  * @returns A Promise of Domain
@@ -7483,7 +7616,8 @@ let API$h = class API extends API$q {
7483
7616
  }, unmarshalDomain$1);
7484
7617
 
7485
7618
  /**
7486
- * Delete a domain name binding.
7619
+ * Delete a domain name binding. Delete a domain name binding for the function
7620
+ * with the specified ID.
7487
7621
  *
7488
7622
  * @param request - The request {@link DeleteDomainRequest}
7489
7623
  * @returns A Promise of Domain
@@ -7777,6 +7911,7 @@ const unmarshalUser$1 = data => {
7777
7911
  email: data.email,
7778
7912
  id: data.id,
7779
7913
  lastLoginAt: unmarshalDate(data.last_login_at),
7914
+ mfa: data.mfa,
7780
7915
  organizationId: data.organization_id,
7781
7916
  status: data.status,
7782
7917
  twoFactorEnabled: data.two_factor_enabled,
@@ -8077,7 +8212,7 @@ let API$g = class API extends API$q {
8077
8212
  pageOfListUsers = (request = {}) => this.client.fetch({
8078
8213
  method: 'GET',
8079
8214
  path: `/iam/v1alpha1/users`,
8080
- 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], ['user_ids', request.userIds])
8215
+ urlParams: urlParams(['mfa', request.mfa], ['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], ['user_ids', request.userIds])
8081
8216
  }, unmarshalListUsersResponse$1);
8082
8217
 
8083
8218
  /**
@@ -8095,8 +8230,7 @@ let API$g = class API extends API$q {
8095
8230
  /**
8096
8231
  * Get a given user. Retrieve information about a user, specified by the
8097
8232
  * `user_id` parameter. The user's full details, including `id`, `email`,
8098
- * `organization_id`, `status` and `two_factor_enabled` are returned in the
8099
- * response.
8233
+ * `organization_id`, `status` and `mfa` are returned in the response.
8100
8234
  *
8101
8235
  * @param request - The request {@link GetUserRequest}
8102
8236
  * @returns A Promise of User
@@ -8661,7 +8795,7 @@ const ListAPIKeysRequest = {
8661
8795
  maxLength: 200
8662
8796
  },
8663
8797
  page: {
8664
- greaterThanOrEqual: 1
8798
+ greaterThan: 0
8665
8799
  },
8666
8800
  pageSize: {
8667
8801
  greaterThanOrEqual: 1,
@@ -8675,7 +8809,7 @@ const ListApplicationsRequest = {
8675
8809
  pattern: /^[a-zA-Z0-9\(\)\._\- ]+$/
8676
8810
  },
8677
8811
  page: {
8678
- greaterThanOrEqual: 1
8812
+ greaterThan: 0
8679
8813
  },
8680
8814
  pageSize: {
8681
8815
  greaterThanOrEqual: 1,
@@ -8687,7 +8821,7 @@ const ListGroupsRequest = {
8687
8821
  minLength: 1
8688
8822
  },
8689
8823
  page: {
8690
- greaterThanOrEqual: 1
8824
+ greaterThan: 0
8691
8825
  },
8692
8826
  pageSize: {
8693
8827
  greaterThanOrEqual: 1,
@@ -8696,7 +8830,7 @@ const ListGroupsRequest = {
8696
8830
  };
8697
8831
  const ListJWTsRequest = {
8698
8832
  page: {
8699
- greaterThanOrEqual: 1
8833
+ greaterThan: 0
8700
8834
  },
8701
8835
  pageSize: {
8702
8836
  greaterThanOrEqual: 1,
@@ -8705,7 +8839,7 @@ const ListJWTsRequest = {
8705
8839
  };
8706
8840
  const ListPermissionSetsRequest = {
8707
8841
  page: {
8708
- greaterThanOrEqual: 1
8842
+ greaterThan: 0
8709
8843
  },
8710
8844
  pageSize: {
8711
8845
  greaterThanOrEqual: 1,
@@ -8714,7 +8848,7 @@ const ListPermissionSetsRequest = {
8714
8848
  };
8715
8849
  const ListPoliciesRequest = {
8716
8850
  page: {
8717
- greaterThanOrEqual: 1
8851
+ greaterThan: 0
8718
8852
  },
8719
8853
  pageSize: {
8720
8854
  greaterThanOrEqual: 1,
@@ -8726,7 +8860,7 @@ const ListPoliciesRequest = {
8726
8860
  };
8727
8861
  const ListQuotaRequest = {
8728
8862
  page: {
8729
- greaterThanOrEqual: 1
8863
+ greaterThan: 0
8730
8864
  },
8731
8865
  pageSize: {
8732
8866
  greaterThanOrEqual: 1,
@@ -8735,7 +8869,7 @@ const ListQuotaRequest = {
8735
8869
  };
8736
8870
  const ListRulesRequest = {
8737
8871
  page: {
8738
- greaterThanOrEqual: 1
8872
+ greaterThan: 0
8739
8873
  },
8740
8874
  pageSize: {
8741
8875
  greaterThanOrEqual: 1,
@@ -8748,7 +8882,7 @@ const ListSSHKeysRequest = {
8748
8882
  minLength: 1
8749
8883
  },
8750
8884
  page: {
8751
- greaterThanOrEqual: 1
8885
+ greaterThan: 0
8752
8886
  },
8753
8887
  pageSize: {
8754
8888
  greaterThanOrEqual: 1,
@@ -8757,7 +8891,7 @@ const ListSSHKeysRequest = {
8757
8891
  };
8758
8892
  const ListUsersRequest = {
8759
8893
  page: {
8760
- greaterThanOrEqual: 1
8894
+ greaterThan: 0
8761
8895
  },
8762
8896
  pageSize: {
8763
8897
  greaterThanOrEqual: 1,
@@ -10183,7 +10317,7 @@ let API$f = class API extends API$q {
10183
10317
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'fr-par-3', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
10184
10318
 
10185
10319
  /**
10186
- * Get availability. Get availability for all server types.
10320
+ * Get availability. Get availability for all Instance types.
10187
10321
  *
10188
10322
  * @param request - The request {@link GetServerTypesAvailabilityRequest}
10189
10323
  * @returns A Promise of GetServerTypesAvailabilityResponse
@@ -10195,7 +10329,8 @@ let API$f = class API extends API$q {
10195
10329
  }, unmarshalGetServerTypesAvailabilityResponse);
10196
10330
 
10197
10331
  /**
10198
- * List server types. Get server types technical details.
10332
+ * List Instance types. List available Instance types and their technical
10333
+ * details.
10199
10334
  *
10200
10335
  * @param request - The request {@link ListServersTypesRequest}
10201
10336
  * @returns A Promise of ListServersTypesResponse
@@ -10207,7 +10342,7 @@ let API$f = class API extends API$q {
10207
10342
  }, unmarshalListServersTypesResponse);
10208
10343
 
10209
10344
  /**
10210
- * List volumes types. Get volumes technical details.
10345
+ * List volumes types. List all volume types and their technical details.
10211
10346
  *
10212
10347
  * @param request - The request {@link ListVolumesTypesRequest}
10213
10348
  * @returns A Promise of ListVolumesTypesResponse
@@ -10224,7 +10359,8 @@ let API$f = class API extends API$q {
10224
10359
  }, unmarshalListServersResponse);
10225
10360
 
10226
10361
  /**
10227
- * List all servers.
10362
+ * List all Instances. List all Instances in a specified Availability Zone,
10363
+ * e.g. `fr-par-1`.
10228
10364
  *
10229
10365
  * @param request - The request {@link ListServersRequest}
10230
10366
  * @returns A Promise of ListServersResponse
@@ -10238,7 +10374,7 @@ let API$f = class API extends API$q {
10238
10374
  }, unmarshalCreateServerResponse);
10239
10375
 
10240
10376
  /**
10241
- * Delete a server. Delete a server with the given ID.
10377
+ * Delete an Instance. Delete the Instance with the specified ID.
10242
10378
  *
10243
10379
  * @param request - The request {@link DeleteServerRequest}
10244
10380
  */
@@ -10248,7 +10384,7 @@ let API$f = class API extends API$q {
10248
10384
  });
10249
10385
 
10250
10386
  /**
10251
- * Get a server. Get the details of a specified Server.
10387
+ * Get an Instance. Get the details of a specified Instance.
10252
10388
  *
10253
10389
  * @param request - The request {@link GetServerRequest}
10254
10390
  * @returns A Promise of GetServerResponse
@@ -10271,8 +10407,8 @@ let API$f = class API extends API$q {
10271
10407
  }, unmarshalUpdateServerResponse);
10272
10408
 
10273
10409
  /**
10274
- * List server actions. List all actions that can currently be performed on a
10275
- * server.
10410
+ * List Instance actions. List all actions (e.g. power on, power off, reboot)
10411
+ * that can currently be performed on an Instance.
10276
10412
  *
10277
10413
  * @param request - The request {@link ListServerActionsRequest}
10278
10414
  * @returns A Promise of ListServerActionsResponse
@@ -10283,13 +10419,19 @@ let API$f = class API extends API$q {
10283
10419
  }, unmarshalListServerActionsResponse);
10284
10420
 
10285
10421
  /**
10286
- * Perform action. Perform power related actions on a server. Be wary that
10287
- * when terminating a server, all the attached volumes (local _and_ block
10288
- * storage) are deleted. So, if you want to keep your local volumes, you must
10289
- * use the `archive` action instead of `terminate`. And if you want to keep
10290
- * block-storage volumes, **you must** detach it beforehand you issue the
10291
- * `terminate` call. For more information, read the [Volumes](#volumes-7e8a39)
10292
- * documentation.
10422
+ * Perform action. Perform an action on an Instance. Available actions are:
10423
+ * `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance
10424
+ * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
10425
+ * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
10426
+ * it. `backup`: Create an image with all the volumes of an Instance.
10427
+ * `terminate`: Delete the Instance along with all attached volumes.
10428
+ *
10429
+ * Keep in mind that terminating an Instance will result in the deletion of
10430
+ * all attached volumes, including local and block storage. If you want to
10431
+ * preserve your local volumes, you should use the `archive` action instead of
10432
+ * `terminate`. Similarly, if you want to keep your block storage volumes, you
10433
+ * must first detach them before issuing the `terminate` command. For more
10434
+ * information, read the [Volumes](#volumes-7e8a39) documentation.
10293
10435
  *
10294
10436
  * @param request - The request {@link ServerActionRequest}
10295
10437
  * @returns A Promise of ServerActionResponse
@@ -10302,7 +10444,7 @@ let API$f = class API extends API$q {
10302
10444
  }, unmarshalServerActionResponse);
10303
10445
 
10304
10446
  /**
10305
- * List user data. List all user data keys registered on a given server.
10447
+ * List user data. List all user data keys registered on a specified Instance.
10306
10448
  *
10307
10449
  * @param request - The request {@link ListServerUserDataRequest}
10308
10450
  * @returns A Promise of ListServerUserDataResponse
@@ -10313,7 +10455,7 @@ let API$f = class API extends API$q {
10313
10455
  }, unmarshalListServerUserDataResponse);
10314
10456
 
10315
10457
  /**
10316
- * Delete user data. Delete the given key from a server user data.
10458
+ * Delete user data. Delete the specified key from an Instance's user data.
10317
10459
  *
10318
10460
  * @param request - The request {@link DeleteServerUserDataRequest}
10319
10461
  */
@@ -10328,7 +10470,7 @@ let API$f = class API extends API$q {
10328
10470
  }, unmarshalListImagesResponse$3);
10329
10471
 
10330
10472
  /**
10331
- * List instance images. List all images available in an account.
10473
+ * List Instance images. List all existing Instance images.
10332
10474
  *
10333
10475
  * @param request - The request {@link ListImagesRequest}
10334
10476
  * @returns A Promise of ListImagesResponse
@@ -10336,7 +10478,7 @@ let API$f = class API extends API$q {
10336
10478
  listImages = (request = {}) => enrichForPagination('images', this.pageOfListImages, request);
10337
10479
 
10338
10480
  /**
10339
- * Get an instance image. Get details of an image with the given ID.
10481
+ * Get an Instance image. Get details of an image with the specified ID.
10340
10482
  *
10341
10483
  * @param request - The request {@link GetImageRequest}
10342
10484
  * @returns A Promise of GetImageResponse
@@ -10347,7 +10489,8 @@ let API$f = class API extends API$q {
10347
10489
  }, unmarshalGetImageResponse$1);
10348
10490
 
10349
10491
  /**
10350
- * Create an instance image.
10492
+ * Create an Instance image. Create an Instance image from the specified
10493
+ * snapshot ID.
10351
10494
  *
10352
10495
  * @param request - The request {@link CreateImageRequest}
10353
10496
  * @returns A Promise of CreateImageResponse
@@ -10366,7 +10509,7 @@ let API$f = class API extends API$q {
10366
10509
  }, unmarshalSetImageResponse);
10367
10510
 
10368
10511
  /**
10369
- * Delete an instance image. Delete the image with the given ID.
10512
+ * Delete an Instance image. Delete the image with the specified ID.
10370
10513
  *
10371
10514
  * @param request - The request {@link DeleteImageRequest}
10372
10515
  */
@@ -10381,7 +10524,8 @@ let API$f = class API extends API$q {
10381
10524
  }, unmarshalListSnapshotsResponse$1);
10382
10525
 
10383
10526
  /**
10384
- * List snapshots.
10527
+ * List snapshots. List all snapshots of an Organization in a specified
10528
+ * Availability Zone.
10385
10529
  *
10386
10530
  * @param request - The request {@link ListSnapshotsRequest}
10387
10531
  * @returns A Promise of ListSnapshotsResponse
@@ -10389,7 +10533,9 @@ let API$f = class API extends API$q {
10389
10533
  listSnapshots = (request = {}) => enrichForPagination('snapshots', this.pageOfListSnapshots, request);
10390
10534
 
10391
10535
  /**
10392
- * Create a snapshot from a given volume or from a QCOW2 file.
10536
+ * Create a snapshot from a specified volume or from a QCOW2 file. Create a
10537
+ * snapshot from a specified volume or from a QCOW2 file in a specified
10538
+ * Availability Zone.
10393
10539
  *
10394
10540
  * @param request - The request {@link CreateSnapshotRequest}
10395
10541
  * @returns A Promise of CreateSnapshotResponse
@@ -10402,7 +10548,7 @@ let API$f = class API extends API$q {
10402
10548
  }, unmarshalCreateSnapshotResponse);
10403
10549
 
10404
10550
  /**
10405
- * Get a snapshot. Get details of a snapshot with the given ID.
10551
+ * Get a snapshot. Get details of a snapshot with the specified ID.
10406
10552
  *
10407
10553
  * @param request - The request {@link GetSnapshotRequest}
10408
10554
  * @returns A Promise of GetSnapshotResponse
@@ -10419,7 +10565,7 @@ let API$f = class API extends API$q {
10419
10565
  }, unmarshalSetSnapshotResponse);
10420
10566
 
10421
10567
  /**
10422
- * Delete a snapshot. Delete the snapshot with the given ID.
10568
+ * Delete a snapshot. Delete the snapshot with the specified ID.
10423
10569
  *
10424
10570
  * @param request - The request {@link DeleteSnapshotRequest}
10425
10571
  */
@@ -10429,7 +10575,7 @@ let API$f = class API extends API$q {
10429
10575
  });
10430
10576
 
10431
10577
  /**
10432
- * Export a snapshot. Export a snapshot to a given S3 bucket in the same
10578
+ * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
10433
10579
  * region.
10434
10580
  *
10435
10581
  * @param request - The request {@link ExportSnapshotRequest}
@@ -10448,7 +10594,8 @@ let API$f = class API extends API$q {
10448
10594
  }, unmarshalListVolumesResponse);
10449
10595
 
10450
10596
  /**
10451
- * List volumes.
10597
+ * List volumes. List volumes in the specified Availability Zone. You can
10598
+ * filter the output by volume type.
10452
10599
  *
10453
10600
  * @param request - The request {@link ListVolumesRequest}
10454
10601
  * @returns A Promise of ListVolumesResponse
@@ -10456,7 +10603,8 @@ let API$f = class API extends API$q {
10456
10603
  listVolumes = (request = {}) => enrichForPagination('volumes', this.pageOfListVolumes, request);
10457
10604
 
10458
10605
  /**
10459
- * Create a volume.
10606
+ * Create a volume. Create a volume of a specified type in an Availability
10607
+ * Zone.
10460
10608
  *
10461
10609
  * @param request - The request {@link CreateVolumeRequest}
10462
10610
  * @returns A Promise of CreateVolumeResponse
@@ -10469,7 +10617,7 @@ let API$f = class API extends API$q {
10469
10617
  }, unmarshalCreateVolumeResponse);
10470
10618
 
10471
10619
  /**
10472
- * Get a volume. Get details of a volume with the given ID.
10620
+ * Get a volume. Get details of a volume with the specified ID.
10473
10621
  *
10474
10622
  * @param request - The request {@link GetVolumeRequest}
10475
10623
  * @returns A Promise of GetVolumeResponse
@@ -10480,9 +10628,9 @@ let API$f = class API extends API$q {
10480
10628
  }, unmarshalGetVolumeResponse);
10481
10629
 
10482
10630
  /**
10483
- * Update a volume. Replace name and/or size properties of given ID volume
10484
- * with the given value(s). Any volume name can be changed while, for now,
10485
- * only `b_ssd` volume growing is supported.
10631
+ * Update a volume. Replace the name and/or size properties of a volume
10632
+ * specified by its ID, with the specified value(s). Any volume name can be
10633
+ * changed, however only `b_ssd` volumes can currently be increased in size.
10486
10634
  *
10487
10635
  * @param request - The request {@link UpdateVolumeRequest}
10488
10636
  * @returns A Promise of UpdateVolumeResponse
@@ -10495,7 +10643,7 @@ let API$f = class API extends API$q {
10495
10643
  }, unmarshalUpdateVolumeResponse);
10496
10644
 
10497
10645
  /**
10498
- * Delete a volume. Delete the volume with the given ID.
10646
+ * Delete a volume. Delete the volume with the specified ID.
10499
10647
  *
10500
10648
  * @param request - The request {@link DeleteVolumeRequest}
10501
10649
  */
@@ -10510,7 +10658,7 @@ let API$f = class API extends API$q {
10510
10658
  }, unmarshalListSecurityGroupsResponse);
10511
10659
 
10512
10660
  /**
10513
- * List security groups. List all security groups available in an account.
10661
+ * List security groups. List all existing security groups.
10514
10662
  *
10515
10663
  * @param request - The request {@link ListSecurityGroupsRequest}
10516
10664
  * @returns A Promise of ListSecurityGroupsResponse
@@ -10518,7 +10666,8 @@ let API$f = class API extends API$q {
10518
10666
  listSecurityGroups = (request = {}) => enrichForPagination('securityGroups', this.pageOfListSecurityGroups, request);
10519
10667
 
10520
10668
  /**
10521
- * Create a security group.
10669
+ * Create a security group. Create a security group with a specified name and
10670
+ * description.
10522
10671
  *
10523
10672
  * @param request - The request {@link CreateSecurityGroupRequest}
10524
10673
  * @returns A Promise of CreateSecurityGroupResponse
@@ -10531,8 +10680,8 @@ let API$f = class API extends API$q {
10531
10680
  }, unmarshalCreateSecurityGroupResponse);
10532
10681
 
10533
10682
  /**
10534
- * Get a security group. Get the details of a Security Group with the given
10535
- * ID.
10683
+ * Get a security group. Get the details of a security group with the
10684
+ * specified ID.
10536
10685
  *
10537
10686
  * @param request - The request {@link GetSecurityGroupRequest}
10538
10687
  * @returns A Promise of GetSecurityGroupResponse
@@ -10543,7 +10692,7 @@ let API$f = class API extends API$q {
10543
10692
  }, unmarshalGetSecurityGroupResponse);
10544
10693
 
10545
10694
  /**
10546
- * Delete a security group.
10695
+ * Delete a security group. Delete a security group with the specified ID.
10547
10696
  *
10548
10697
  * @param request - The request {@link DeleteSecurityGroupRequest}
10549
10698
  */
@@ -10576,7 +10725,7 @@ let API$f = class API extends API$q {
10576
10725
  }, unmarshalListSecurityGroupRulesResponse);
10577
10726
 
10578
10727
  /**
10579
- * List rules.
10728
+ * List rules. List the rules of the a specified security group ID.
10580
10729
  *
10581
10730
  * @param request - The request {@link ListSecurityGroupRulesRequest}
10582
10731
  * @returns A Promise of ListSecurityGroupRulesResponse
@@ -10584,7 +10733,7 @@ let API$f = class API extends API$q {
10584
10733
  listSecurityGroupRules = request => enrichForPagination('rules', this.pageOfListSecurityGroupRules, request);
10585
10734
 
10586
10735
  /**
10587
- * Create rule.
10736
+ * Create rule. Create a rule in the specified security group ID.
10588
10737
  *
10589
10738
  * @param request - The request {@link CreateSecurityGroupRuleRequest}
10590
10739
  * @returns A Promise of CreateSecurityGroupRuleResponse
@@ -10597,10 +10746,10 @@ let API$f = class API extends API$q {
10597
10746
  }, unmarshalCreateSecurityGroupRuleResponse);
10598
10747
 
10599
10748
  /**
10600
- * Update all the rules of a security group. Replaces the rules of the
10601
- * security group with the rules provided. This endpoint supports the update
10602
- * of existing rules, creation of new rules and deletion of existing rules
10603
- * when they are not passed in the request.
10749
+ * Update all the rules of a security group. Replaces the existing rules of
10750
+ * the security group with the rules provided. This endpoint supports the
10751
+ * update of existing rules, creation of new rules and deletion of existing
10752
+ * rules when they are not passed in the request.
10604
10753
  *
10605
10754
  * @param request - The request {@link SetSecurityGroupRulesRequest}
10606
10755
  * @returns A Promise of SetSecurityGroupRulesResponse
@@ -10613,7 +10762,7 @@ let API$f = class API extends API$q {
10613
10762
  }, unmarshalSetSecurityGroupRulesResponse);
10614
10763
 
10615
10764
  /**
10616
- * Delete rule. Delete a security group rule with the given ID.
10765
+ * Delete rule. Delete a security group rule with the specified ID.
10617
10766
  *
10618
10767
  * @param request - The request {@link DeleteSecurityGroupRuleRequest}
10619
10768
  */
@@ -10623,7 +10772,7 @@ let API$f = class API extends API$q {
10623
10772
  });
10624
10773
 
10625
10774
  /**
10626
- * Get rule. Get details of a security group rule with the given ID.
10775
+ * Get rule. Get details of a security group rule with the specified ID.
10627
10776
  *
10628
10777
  * @param request - The request {@link GetSecurityGroupRuleRequest}
10629
10778
  * @returns A Promise of GetSecurityGroupRuleResponse
@@ -10645,7 +10794,8 @@ let API$f = class API extends API$q {
10645
10794
  }, unmarshalListPlacementGroupsResponse);
10646
10795
 
10647
10796
  /**
10648
- * List placement groups. List all placement groups.
10797
+ * List placement groups. List all placement groups in a specified
10798
+ * Availability Zone.
10649
10799
  *
10650
10800
  * @param request - The request {@link ListPlacementGroupsRequest}
10651
10801
  * @returns A Promise of ListPlacementGroupsResponse
@@ -10653,7 +10803,8 @@ let API$f = class API extends API$q {
10653
10803
  listPlacementGroups = (request = {}) => enrichForPagination('placementGroups', this.pageOfListPlacementGroups, request);
10654
10804
 
10655
10805
  /**
10656
- * Create a placement group. Create a new placement group.
10806
+ * Create a placement group. Create a new placement group in a specified
10807
+ * Availability Zone.
10657
10808
  *
10658
10809
  * @param request - The request {@link CreatePlacementGroupRequest}
10659
10810
  * @returns A Promise of CreatePlacementGroupResponse
@@ -10666,7 +10817,7 @@ let API$f = class API extends API$q {
10666
10817
  }, unmarshalCreatePlacementGroupResponse);
10667
10818
 
10668
10819
  /**
10669
- * Get a placement group. Get the given placement group.
10820
+ * Get a placement group. Get the specified placement group.
10670
10821
  *
10671
10822
  * @param request - The request {@link GetPlacementGroupRequest}
10672
10823
  * @returns A Promise of GetPlacementGroupResponse
@@ -10677,7 +10828,7 @@ let API$f = class API extends API$q {
10677
10828
  }, unmarshalGetPlacementGroupResponse);
10678
10829
 
10679
10830
  /**
10680
- * Set placement group. Set all parameters of the given placement group.
10831
+ * Set placement group. Set all parameters of the specified placement group.
10681
10832
  *
10682
10833
  * @param request - The request {@link SetPlacementGroupRequest}
10683
10834
  * @returns A Promise of SetPlacementGroupResponse
@@ -10690,7 +10841,7 @@ let API$f = class API extends API$q {
10690
10841
  }, unmarshalSetPlacementGroupResponse);
10691
10842
 
10692
10843
  /**
10693
- * Update a placement group. Update one or more parameter of the given
10844
+ * Update a placement group. Update one or more parameter of the specified
10694
10845
  * placement group.
10695
10846
  *
10696
10847
  * @param request - The request {@link UpdatePlacementGroupRequest}
@@ -10704,7 +10855,7 @@ let API$f = class API extends API$q {
10704
10855
  }, unmarshalUpdatePlacementGroupResponse);
10705
10856
 
10706
10857
  /**
10707
- * Delete the given placement group.
10858
+ * Delete the specified placement group.
10708
10859
  *
10709
10860
  * @param request - The request {@link DeletePlacementGroupRequest}
10710
10861
  */
@@ -10714,7 +10865,7 @@ let API$f = class API extends API$q {
10714
10865
  });
10715
10866
 
10716
10867
  /**
10717
- * Get placement group servers. Get all servers belonging to the given
10868
+ * Get placement group servers. Get all Instances belonging to the specified
10718
10869
  * placement group.
10719
10870
  *
10720
10871
  * @param request - The request {@link GetPlacementGroupServersRequest}
@@ -10726,7 +10877,7 @@ let API$f = class API extends API$q {
10726
10877
  }, unmarshalGetPlacementGroupServersResponse);
10727
10878
 
10728
10879
  /**
10729
- * Set placement group servers. Set all servers belonging to the given
10880
+ * Set placement group servers. Set all Instances belonging to the specified
10730
10881
  * placement group.
10731
10882
  *
10732
10883
  * @param request - The request {@link SetPlacementGroupServersRequest}
@@ -10740,8 +10891,8 @@ let API$f = class API extends API$q {
10740
10891
  }, unmarshalSetPlacementGroupServersResponse);
10741
10892
 
10742
10893
  /**
10743
- * Update placement group servers. Update all servers belonging to the given
10744
- * placement group.
10894
+ * Update placement group servers. Update all Instances belonging to the
10895
+ * specified placement group.
10745
10896
  *
10746
10897
  * @param request - The request {@link UpdatePlacementGroupServersRequest}
10747
10898
  * @returns A Promise of UpdatePlacementGroupServersResponse
@@ -10759,7 +10910,7 @@ let API$f = class API extends API$q {
10759
10910
  }, unmarshalListIpsResponse$1);
10760
10911
 
10761
10912
  /**
10762
- * List all flexible IPs.
10913
+ * List all flexible IPs. List all flexible IPs in a specified zone.
10763
10914
  *
10764
10915
  * @param request - The request {@link ListIpsRequest}
10765
10916
  * @returns A Promise of ListIpsResponse
@@ -10767,7 +10918,8 @@ let API$f = class API extends API$q {
10767
10918
  listIps = (request = {}) => enrichForPagination('ips', this.pageOfListIps, request);
10768
10919
 
10769
10920
  /**
10770
- * Reserve a flexible IP.
10921
+ * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified
10922
+ * Instance.
10771
10923
  *
10772
10924
  * @param request - The request {@link CreateIpRequest}
10773
10925
  * @returns A Promise of CreateIpResponse
@@ -10780,7 +10932,7 @@ let API$f = class API extends API$q {
10780
10932
  }, unmarshalCreateIpResponse);
10781
10933
 
10782
10934
  /**
10783
- * Get a flexible IP. Get details of an IP with the given ID or address.
10935
+ * Get a flexible IP. Get details of an IP with the specified ID or address.
10784
10936
  *
10785
10937
  * @param request - The request {@link GetIpRequest}
10786
10938
  * @returns A Promise of GetIpResponse
@@ -10791,7 +10943,8 @@ let API$f = class API extends API$q {
10791
10943
  }, unmarshalGetIpResponse);
10792
10944
 
10793
10945
  /**
10794
- * Update a flexible IP.
10946
+ * Update a flexible IP. Update a flexible IP in the specified zone with the
10947
+ * specified ID.
10795
10948
  *
10796
10949
  * @param request - The request {@link UpdateIpRequest}
10797
10950
  * @returns A Promise of UpdateIpResponse
@@ -10804,7 +10957,7 @@ let API$f = class API extends API$q {
10804
10957
  }, unmarshalUpdateIpResponse);
10805
10958
 
10806
10959
  /**
10807
- * Delete a flexible IP. Delete the IP with the given ID.
10960
+ * Delete a flexible IP. Delete the IP with the specified ID.
10808
10961
  *
10809
10962
  * @param request - The request {@link DeleteIpRequest}
10810
10963
  */
@@ -10819,7 +10972,7 @@ let API$f = class API extends API$q {
10819
10972
  }, unmarshalListPrivateNICsResponse);
10820
10973
 
10821
10974
  /**
10822
- * List all private NICs. List all private NICs of a given server.
10975
+ * List all private NICs. List all private NICs of a specified Instance.
10823
10976
  *
10824
10977
  * @param request - The request {@link ListPrivateNICsRequest}
10825
10978
  * @returns A Promise of ListPrivateNICsResponse
@@ -10827,7 +10980,7 @@ let API$f = class API extends API$q {
10827
10980
  listPrivateNICs = request => enrichForPagination('privateNics', this.pageOfListPrivateNICs, request);
10828
10981
 
10829
10982
  /**
10830
- * Create a private NIC connecting a server to a private network.
10983
+ * Create a private NIC connecting an Instance to a Private Network.
10831
10984
  *
10832
10985
  * @param request - The request {@link CreatePrivateNICRequest}
10833
10986
  * @returns A Promise of CreatePrivateNICResponse
@@ -10851,8 +11004,8 @@ let API$f = class API extends API$q {
10851
11004
  }, unmarshalGetPrivateNICResponse);
10852
11005
 
10853
11006
  /**
10854
- * Update a private NIC. Update one or more parameter/s to a given private
10855
- * NIC.
11007
+ * Update a private NIC. Update one or more parameter(s) of a specified
11008
+ * private NIC.
10856
11009
  *
10857
11010
  * @param request - The request {@link UpdatePrivateNICRequest}
10858
11011
  * @returns A Promise of PrivateNIC
@@ -10889,7 +11042,7 @@ let API$f = class API extends API$q {
10889
11042
  listBootscripts = (request = {}) => enrichForPagination('bootscripts', this.pageOfListBootscripts, request);
10890
11043
 
10891
11044
  /**
10892
- * Get bootscripts. Get details of a bootscript with the given ID.
11045
+ * Get bootscripts. Get details of a bootscript with the specified ID.
10893
11046
  *
10894
11047
  * @deprecated
10895
11048
  * @param request - The request {@link GetBootscriptRequest}
@@ -13319,7 +13472,8 @@ const unmarshalHealthCheck = data => {
13319
13472
  pgsqlConfig: data.pgsql_config ? unmarshalHealthCheckPgsqlConfig(data.pgsql_config) : undefined,
13320
13473
  port: data.port,
13321
13474
  redisConfig: data.redis_config ? unmarshalHealthCheckRedisConfig(data.redis_config) : undefined,
13322
- tcpConfig: data.tcp_config ? unmarshalHealthCheckTcpConfig(data.tcp_config) : undefined
13475
+ tcpConfig: data.tcp_config ? unmarshalHealthCheckTcpConfig(data.tcp_config) : undefined,
13476
+ transientCheckDelay: data.transient_check_delay
13323
13477
  };
13324
13478
  };
13325
13479
  const unmarshalLb = data => {
@@ -13373,10 +13527,12 @@ const unmarshalBackend = data => {
13373
13527
  id: data.id,
13374
13528
  ignoreSslServerVerify: data.ignore_ssl_server_verify,
13375
13529
  lb: data.lb ? unmarshalLb(data.lb) : undefined,
13530
+ maxRetries: data.max_retries,
13376
13531
  name: data.name,
13377
13532
  onMarkedDownAction: data.on_marked_down_action,
13378
13533
  pool: data.pool,
13379
13534
  proxyProtocol: data.proxy_protocol,
13535
+ redispatchAttemptCount: data.redispatch_attempt_count,
13380
13536
  sendProxyV2: data.send_proxy_v2,
13381
13537
  sslBridging: data.ssl_bridging,
13382
13538
  stickySessions: data.sticky_sessions,
@@ -13718,21 +13874,22 @@ const marshalHealthCheck = (request, defaults) => ({
13718
13874
  check_send_proxy: request.checkSendProxy,
13719
13875
  check_timeout: request.checkTimeout,
13720
13876
  port: request.port,
13877
+ transient_check_delay: request.transientCheckDelay,
13721
13878
  ...resolveOneOf([{
13879
+ param: 'tcp_config',
13880
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13881
+ }, {
13722
13882
  param: 'mysql_config',
13723
13883
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
13884
+ }, {
13885
+ param: 'pgsql_config',
13886
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13724
13887
  }, {
13725
13888
  param: 'ldap_config',
13726
13889
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
13727
13890
  }, {
13728
13891
  param: 'redis_config',
13729
13892
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
13730
- }, {
13731
- param: 'tcp_config',
13732
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13733
- }, {
13734
- param: 'pgsql_config',
13735
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13736
13893
  }, {
13737
13894
  param: 'http_config',
13738
13895
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -13790,9 +13947,11 @@ const marshalCreateBackendRequest = (request, defaults) => ({
13790
13947
  forward_protocol: request.forwardProtocol,
13791
13948
  health_check: marshalHealthCheck(request.healthCheck),
13792
13949
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
13950
+ max_retries: request.maxRetries,
13793
13951
  name: request.name || randomName('lbb'),
13794
13952
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
13795
13953
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
13954
+ redispatch_attempt_count: request.redispatchAttemptCount,
13796
13955
  send_proxy_v2: request.sendProxyV2,
13797
13956
  server_ip: request.serverIp,
13798
13957
  ssl_bridging: request.sslBridging,
@@ -13899,9 +14058,11 @@ const marshalUpdateBackendRequest = (request, defaults) => ({
13899
14058
  forward_port_algorithm: request.forwardPortAlgorithm,
13900
14059
  forward_protocol: request.forwardProtocol,
13901
14060
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14061
+ max_retries: request.maxRetries,
13902
14062
  name: request.name,
13903
14063
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
13904
14064
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14065
+ redispatch_attempt_count: request.redispatchAttemptCount,
13905
14066
  send_proxy_v2: request.sendProxyV2,
13906
14067
  ssl_bridging: request.sslBridging,
13907
14068
  sticky_sessions: request.stickySessions,
@@ -13928,21 +14089,22 @@ const marshalUpdateHealthCheckRequest = (request, defaults) => ({
13928
14089
  check_send_proxy: request.checkSendProxy,
13929
14090
  check_timeout: request.checkTimeout,
13930
14091
  port: request.port,
14092
+ transient_check_delay: request.transientCheckDelay,
13931
14093
  ...resolveOneOf([{
14094
+ param: 'tcp_config',
14095
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14096
+ }, {
13932
14097
  param: 'mysql_config',
13933
14098
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
14099
+ }, {
14100
+ param: 'pgsql_config',
14101
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13934
14102
  }, {
13935
14103
  param: 'ldap_config',
13936
14104
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
13937
14105
  }, {
13938
14106
  param: 'redis_config',
13939
14107
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
13940
- }, {
13941
- param: 'pgsql_config',
13942
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13943
- }, {
13944
- param: 'tcp_config',
13945
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13946
14108
  }, {
13947
14109
  param: 'http_config',
13948
14110
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -14003,9 +14165,11 @@ const marshalZonedApiCreateBackendRequest = (request, defaults) => ({
14003
14165
  forward_protocol: request.forwardProtocol,
14004
14166
  health_check: marshalHealthCheck(request.healthCheck),
14005
14167
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14168
+ max_retries: request.maxRetries,
14006
14169
  name: request.name || randomName('lbb'),
14007
14170
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
14008
14171
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14172
+ redispatch_attempt_count: request.redispatchAttemptCount,
14009
14173
  send_proxy_v2: request.sendProxyV2,
14010
14174
  server_ip: request.serverIp,
14011
14175
  ssl_bridging: request.sslBridging,
@@ -14115,9 +14279,11 @@ const marshalZonedApiUpdateBackendRequest = (request, defaults) => ({
14115
14279
  forward_port_algorithm: request.forwardPortAlgorithm,
14116
14280
  forward_protocol: request.forwardProtocol,
14117
14281
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14282
+ max_retries: request.maxRetries,
14118
14283
  name: request.name,
14119
14284
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
14120
14285
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14286
+ redispatch_attempt_count: request.redispatchAttemptCount,
14121
14287
  send_proxy_v2: request.sendProxyV2,
14122
14288
  ssl_bridging: request.sslBridging,
14123
14289
  sticky_sessions: request.stickySessions,
@@ -14144,21 +14310,22 @@ const marshalZonedApiUpdateHealthCheckRequest = (request, defaults) => ({
14144
14310
  check_send_proxy: request.checkSendProxy,
14145
14311
  check_timeout: request.checkTimeout,
14146
14312
  port: request.port,
14313
+ transient_check_delay: request.transientCheckDelay,
14147
14314
  ...resolveOneOf([{
14315
+ param: 'tcp_config',
14316
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14317
+ }, {
14148
14318
  param: 'mysql_config',
14149
14319
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
14320
+ }, {
14321
+ param: 'pgsql_config',
14322
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
14150
14323
  }, {
14151
14324
  param: 'ldap_config',
14152
14325
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
14153
14326
  }, {
14154
14327
  param: 'redis_config',
14155
14328
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
14156
- }, {
14157
- param: 'pgsql_config',
14158
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
14159
- }, {
14160
- param: 'tcp_config',
14161
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14162
14329
  }, {
14163
14330
  param: 'http_config',
14164
14331
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -15987,7 +16154,8 @@ let API$a = class API extends API$q {
15987
16154
  }, unmarshalListImagesResponse$1);
15988
16155
 
15989
16156
  /**
15990
- * List marketplace images.
16157
+ * List marketplace images. List all available images on the marketplace,
16158
+ * their UUID, CPU architecture and description.
15991
16159
  *
15992
16160
  * @param request - The request {@link ListImagesRequest}
15993
16161
  * @returns A Promise of ListImagesResponse
@@ -15995,7 +16163,8 @@ let API$a = class API extends API$q {
15995
16163
  listImages = request => enrichForPagination('images', this.pageOfListImages, request);
15996
16164
 
15997
16165
  /**
15998
- * Get a specific marketplace image.
16166
+ * Get a specific marketplace image. Get detailed information about a
16167
+ * marketplace image, specified by its `image_id` (UUID format).
15999
16168
  *
16000
16169
  * @param request - The request {@link GetImageRequest}
16001
16170
  * @returns A Promise of Image
@@ -16009,7 +16178,24 @@ let API$a = class API extends API$q {
16009
16178
  path: `/marketplace/v2/versions`,
16010
16179
  urlParams: urlParams(['image_id', request.imageId], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
16011
16180
  }, unmarshalListVersionsResponse);
16181
+
16182
+ /**
16183
+ * List versions of an Image. Get a list of all available version of an image,
16184
+ * specified by its `image_id` (UUID format).
16185
+ *
16186
+ * @param request - The request {@link ListVersionsRequest}
16187
+ * @returns A Promise of ListVersionsResponse
16188
+ */
16012
16189
  listVersions = request => enrichForPagination('versions', this.pageOfListVersions, request);
16190
+
16191
+ /**
16192
+ * Get a specific image version. Get information such as the name, creation
16193
+ * date, last update and published date for an image version specified by its
16194
+ * `version_id` (UUID format).
16195
+ *
16196
+ * @param request - The request {@link GetVersionRequest}
16197
+ * @returns A Promise of Version
16198
+ */
16013
16199
  getVersion = request => this.client.fetch({
16014
16200
  method: 'GET',
16015
16201
  path: `/marketplace/v2/versions/${validatePathParam('versionId', request.versionId)}`
@@ -16030,12 +16216,25 @@ let API$a = class API extends API$q {
16030
16216
  }, unmarshalListLocalImagesResponse);
16031
16217
 
16032
16218
  /**
16033
- * List local images from a specific image or version.
16219
+ * List local images from a specific image or version. List information about
16220
+ * local images in a specific Availability Zone, specified by its `image_id`
16221
+ * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
16222
+ * these three parameters may be set.
16034
16223
  *
16035
16224
  * @param request - The request {@link ListLocalImagesRequest}
16036
16225
  * @returns A Promise of ListLocalImagesResponse
16037
16226
  */
16038
16227
  listLocalImages = (request = {}) => enrichForPagination('localImages', this.pageOfListLocalImages, request);
16228
+
16229
+ /**
16230
+ * Get a specific local image by ID. Get detailed information about a local
16231
+ * image, including compatible commercial types, supported architecture,
16232
+ * labels and the Availability Zone of the image, specified by its
16233
+ * `local_image_id` (UUID format).
16234
+ *
16235
+ * @param request - The request {@link GetLocalImageRequest}
16236
+ * @returns A Promise of LocalImage
16237
+ */
16039
16238
  getLocalImage = request => this.client.fetch({
16040
16239
  method: 'GET',
16041
16240
  path: `/marketplace/v2/local-images/${validatePathParam('localImageId', request.localImageId)}`
@@ -16045,7 +16244,23 @@ let API$a = class API extends API$q {
16045
16244
  path: `/marketplace/v2/categories`,
16046
16245
  urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
16047
16246
  }, unmarshalListCategoriesResponse);
16247
+
16248
+ /**
16249
+ * List existing image categories. Get a list of all existing categories. The
16250
+ * output can be paginated.
16251
+ *
16252
+ * @param request - The request {@link ListCategoriesRequest}
16253
+ * @returns A Promise of ListCategoriesResponse
16254
+ */
16048
16255
  listCategories = (request = {}) => enrichForPagination('categories', this.pageOfListCategories, request);
16256
+
16257
+ /**
16258
+ * Get a specific category. Get information about a specific category of the
16259
+ * marketplace catalog, specified by its `category_id` (UUID format).
16260
+ *
16261
+ * @param request - The request {@link GetCategoryRequest}
16262
+ * @returns A Promise of Category
16263
+ */
16049
16264
  getCategory = request => this.client.fetch({
16050
16265
  method: 'GET',
16051
16266
  path: `/marketplace/v2/categories/${validatePathParam('categoryId', request.categoryId)}`
@@ -16199,7 +16414,8 @@ const jsonContentHeaders$9 = {
16199
16414
  /**
16200
16415
  * MnQ API (beta).
16201
16416
  *
16202
- * This API allows you to manage Messaging or Queueing brokers. MnQ API (beta).
16417
+ * This API allows you to manage Scaleway Messaging and Queueing brokers. MnQ
16418
+ * API (beta).
16203
16419
  */
16204
16420
  let API$9 = class API extends API$q {
16205
16421
  /** Lists the available regions of the API. */
@@ -16211,7 +16427,10 @@ let API$9 = class API extends API$q {
16211
16427
  }, unmarshalListNamespacesResponse$1);
16212
16428
 
16213
16429
  /**
16214
- * List namespaces.
16430
+ * List namespaces. List all Messaging and Queuing namespaces in the specified
16431
+ * region, for a Scaleway Organization or Project. By default, the namespaces
16432
+ * returned in the list are ordered by creation date in ascending order,
16433
+ * though this can be modified via the `order_by` field.
16215
16434
  *
16216
16435
  * @param request - The request {@link ListNamespacesRequest}
16217
16436
  * @returns A Promise of ListNamespacesResponse
@@ -16219,7 +16438,8 @@ let API$9 = class API extends API$q {
16219
16438
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
16220
16439
 
16221
16440
  /**
16222
- * Create a namespace.
16441
+ * Create a namespace. Create a Messaging and Queuing namespace, set to the
16442
+ * desired protocol.
16223
16443
  *
16224
16444
  * @param request - The request {@link CreateNamespaceRequest}
16225
16445
  * @returns A Promise of Namespace
@@ -16232,7 +16452,8 @@ let API$9 = class API extends API$q {
16232
16452
  }, unmarshalNamespace$1);
16233
16453
 
16234
16454
  /**
16235
- * Update the name of a namespace.
16455
+ * Update the name of a namespace. Update the name of a Messaging and Queuing
16456
+ * namespace, specified by its namespace ID.
16236
16457
  *
16237
16458
  * @param request - The request {@link UpdateNamespaceRequest}
16238
16459
  * @returns A Promise of Namespace
@@ -16245,7 +16466,9 @@ let API$9 = class API extends API$q {
16245
16466
  }, unmarshalNamespace$1);
16246
16467
 
16247
16468
  /**
16248
- * Get a namespace.
16469
+ * Get a namespace. Retrieve information about an existing Messaging and
16470
+ * Queuing namespace, identified by its namespace ID. Its full details,
16471
+ * including name, endpoint and protocol, are returned in the response.
16249
16472
  *
16250
16473
  * @param request - The request {@link GetNamespaceRequest}
16251
16474
  * @returns A Promise of Namespace
@@ -16256,7 +16479,10 @@ let API$9 = class API extends API$q {
16256
16479
  }, unmarshalNamespace$1);
16257
16480
 
16258
16481
  /**
16259
- * Delete a namespace.
16482
+ * Delete a namespace. Delete a Messaging and Queuing namespace, specified by
16483
+ * its namespace ID. Note that deleting a namespace is irreversible, and any
16484
+ * URLs, credentials and queued messages belonging to this namespace will also
16485
+ * be deleted.
16260
16486
  *
16261
16487
  * @param request - The request {@link DeleteNamespaceRequest}
16262
16488
  */
@@ -16266,8 +16492,11 @@ let API$9 = class API extends API$q {
16266
16492
  });
16267
16493
 
16268
16494
  /**
16269
- * Create a set of credentials. Create a set of credentials for a specific
16270
- * namespace.
16495
+ * Create credentials. Create a set of credentials for a Messaging and Queuing
16496
+ * namespace, specified by its namespace ID. If creating credentials for a
16497
+ * NATS namespace, the `permissions` object must not be included in the
16498
+ * request. If creating credentials for an SQS/SNS namespace, the
16499
+ * `permissions` object is required, with all three of its child attributes.
16271
16500
  *
16272
16501
  * @param request - The request {@link CreateCredentialRequest}
16273
16502
  * @returns A Promise of Credential
@@ -16280,7 +16509,9 @@ let API$9 = class API extends API$q {
16280
16509
  }, unmarshalCredential);
16281
16510
 
16282
16511
  /**
16283
- * Delete credentials.
16512
+ * Delete credentials. Delete a set of credentials, specified by their
16513
+ * credential ID. Deleting credentials is irreversible and cannot be undone.
16514
+ * The credentials can no longer be used to access the namespace.
16284
16515
  *
16285
16516
  * @param request - The request {@link DeleteCredentialRequest}
16286
16517
  */
@@ -16295,7 +16526,9 @@ let API$9 = class API extends API$q {
16295
16526
  }, unmarshalListCredentialsResponse);
16296
16527
 
16297
16528
  /**
16298
- * List credentials.
16529
+ * List credentials. List existing credentials in the specified region. The
16530
+ * response contains only the metadata for the credentials, not the
16531
+ * credentials themselves (for this, use **Get Credentials**).
16299
16532
  *
16300
16533
  * @param request - The request {@link ListCredentialsRequest}
16301
16534
  * @returns A Promise of ListCredentialsResponse
@@ -16303,7 +16536,10 @@ let API$9 = class API extends API$q {
16303
16536
  listCredentials = (request = {}) => enrichForPagination('credentials', this.pageOfListCredentials, request);
16304
16537
 
16305
16538
  /**
16306
- * Update a set of credentials.
16539
+ * Update credentials. Update a set of credentials. You can update the
16540
+ * credentials' name, or (in the case of SQS/SNS credentials only) their
16541
+ * permissions. To update the name of NATS credentials, do not include the
16542
+ * `permissions` object in your request.
16307
16543
  *
16308
16544
  * @param request - The request {@link UpdateCredentialRequest}
16309
16545
  * @returns A Promise of Credential
@@ -16316,7 +16552,9 @@ let API$9 = class API extends API$q {
16316
16552
  }, unmarshalCredential);
16317
16553
 
16318
16554
  /**
16319
- * Get a set of credentials.
16555
+ * Get credentials. Retrieve an existing set of credentials, identified by the
16556
+ * `credential_id`. The credentials themselves, as well as their metadata
16557
+ * (protocol, namespace ID etc), are returned in the response.
16320
16558
  *
16321
16559
  * @param request - The request {@link GetCredentialRequest}
16322
16560
  * @returns A Promise of Credential
@@ -18142,8 +18380,10 @@ const unmarshalSetEndpointsResponse = data => {
18142
18380
  endpoints: unmarshalArrayOfObject(data.endpoints, unmarshalEndpoint)
18143
18381
  };
18144
18382
  };
18383
+ const marshalEndpointSpecPrivateNetworkSpecIpamConfig = (request, defaults) => ({});
18145
18384
  const marshalEndpointSpecPrivateNetworkSpec = (request, defaults) => ({
18146
18385
  id: request.id,
18386
+ ipam_config: request.ipamConfig ? marshalEndpointSpecPrivateNetworkSpecIpamConfig(request.ipamConfig) : undefined,
18147
18387
  service_ips: request.serviceIps
18148
18388
  });
18149
18389
  const marshalEndpointSpecPublicNetworkSpec = (request, defaults) => ({});
@@ -18928,6 +19168,7 @@ const unmarshalSecret = data => {
18928
19168
  createdAt: unmarshalDate(data.created_at),
18929
19169
  description: data.description,
18930
19170
  id: data.id,
19171
+ isManaged: data.is_managed,
18931
19172
  name: data.name,
18932
19173
  projectId: data.project_id,
18933
19174
  region: data.region,
@@ -18944,6 +19185,7 @@ const unmarshalSecretVersion = data => {
18944
19185
  return {
18945
19186
  createdAt: unmarshalDate(data.created_at),
18946
19187
  description: data.description,
19188
+ isLatest: data.is_latest,
18947
19189
  revision: data.revision,
18948
19190
  secretId: data.secret_id,
18949
19191
  status: data.status,
@@ -18956,6 +19198,7 @@ const unmarshalAccessSecretVersionResponse = data => {
18956
19198
  }
18957
19199
  return {
18958
19200
  data: data.data,
19201
+ dataCrc32: data.data_crc32,
18959
19202
  revision: data.revision,
18960
19203
  secretId: data.secret_id
18961
19204
  };
@@ -18978,6 +19221,16 @@ const unmarshalListSecretsResponse = data => {
18978
19221
  totalCount: data.total_count
18979
19222
  };
18980
19223
  };
19224
+ const marshalPasswordGenerationParams = (request, defaults) => ({
19225
+ additional_chars: request.additionalChars,
19226
+ length: request.length,
19227
+ no_digits: request.noDigits,
19228
+ no_lowercase_letters: request.noLowercaseLetters,
19229
+ no_uppercase_letters: request.noUppercaseLetters
19230
+ });
19231
+ const marshalAddSecretOwnerRequest = (request, defaults) => ({
19232
+ product_name: request.productName
19233
+ });
18981
19234
  const marshalCreateSecretRequest = (request, defaults) => ({
18982
19235
  description: request.description,
18983
19236
  name: request.name,
@@ -18986,7 +19239,13 @@ const marshalCreateSecretRequest = (request, defaults) => ({
18986
19239
  });
18987
19240
  const marshalCreateSecretVersionRequest = (request, defaults) => ({
18988
19241
  data: request.data,
18989
- description: request.description
19242
+ data_crc32: request.dataCrc32,
19243
+ description: request.description,
19244
+ disable_previous: request.disablePrevious,
19245
+ ...resolveOneOf([{
19246
+ param: 'password_generation',
19247
+ value: request.passwordGeneration ? marshalPasswordGenerationParams(request.passwordGeneration) : undefined
19248
+ }])
18990
19249
  });
18991
19250
  const marshalUpdateSecretRequest = (request, defaults) => ({
18992
19251
  description: request.description,
@@ -19066,7 +19325,7 @@ let API$5 = class API extends API$q {
19066
19325
  pageOfListSecrets = (request = {}) => this.client.fetch({
19067
19326
  method: 'GET',
19068
19327
  path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`,
19069
- urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
19328
+ urlParams: urlParams(['is_managed', request.isManaged], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
19070
19329
  }, unmarshalListSecretsResponse);
19071
19330
 
19072
19331
  /**
@@ -19090,6 +19349,18 @@ let API$5 = class API extends API$q {
19090
19349
  path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
19091
19350
  });
19092
19351
 
19352
+ /**
19353
+ * Allow a product to use the secret.
19354
+ *
19355
+ * @param request - The request {@link AddSecretOwnerRequest}
19356
+ */
19357
+ addSecretOwner = request => this.client.fetch({
19358
+ body: JSON.stringify(marshalAddSecretOwnerRequest(request, this.client.settings)),
19359
+ headers: jsonContentHeaders$5,
19360
+ method: 'POST',
19361
+ path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/add-owner`
19362
+ });
19363
+
19093
19364
  /**
19094
19365
  * Create a version. Create a version of a given secret specified by the
19095
19366
  * `region` and `secret_id` parameters.
@@ -19174,20 +19445,6 @@ let API$5 = class API extends API$q {
19174
19445
  */
19175
19446
  listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
19176
19447
 
19177
- /**
19178
- * Delete a version. Delete a secret's version and the sensitive data
19179
- * contained in it. Deleting a version is permanent and cannot be undone.
19180
- *
19181
- * @param request - The request {@link DestroySecretVersionRequest}
19182
- * @returns A Promise of SecretVersion
19183
- */
19184
- destroySecretVersion = request => this.client.fetch({
19185
- body: '{}',
19186
- headers: jsonContentHeaders$5,
19187
- method: 'POST',
19188
- path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
19189
- }, unmarshalSecretVersion);
19190
-
19191
19448
  /**
19192
19449
  * Enable a version. Make a specific version accessible. You must specify the
19193
19450
  * `region`, `secret_id` and `revision` parameters.
@@ -19241,6 +19498,20 @@ let API$5 = class API extends API$q {
19241
19498
  method: 'GET',
19242
19499
  path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}/versions/${validatePathParam('revision', request.revision)}/access`
19243
19500
  }, unmarshalAccessSecretVersionResponse);
19501
+
19502
+ /**
19503
+ * Delete a version. Delete a secret's version and the sensitive data
19504
+ * contained in it. Deleting a version is permanent and cannot be undone.
19505
+ *
19506
+ * @param request - The request {@link DestroySecretVersionRequest}
19507
+ * @returns A Promise of SecretVersion
19508
+ */
19509
+ destroySecretVersion = request => this.client.fetch({
19510
+ body: '{}',
19511
+ headers: jsonContentHeaders$5,
19512
+ method: 'POST',
19513
+ path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
19514
+ }, unmarshalSecretVersion);
19244
19515
  };
19245
19516
 
19246
19517
  // This file was automatically generated. DO NOT EDIT.
@@ -19860,11 +20131,14 @@ let API$2 = class API extends API$q {
19860
20131
  pageOfListPrivateNetworks = (request = {}) => this.client.fetch({
19861
20132
  method: 'GET',
19862
20133
  path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks`,
19863
- urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags])
20134
+ urlParams: urlParams(['include_regional', request.includeRegional], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags])
19864
20135
  }, unmarshalListPrivateNetworksResponse);
19865
20136
 
19866
20137
  /**
19867
- * List private networks.
20138
+ * List Private Networks. List existing Private Networks in a specified
20139
+ * Availability Zone. By default, the Private Networks returned in the list
20140
+ * are ordered by creation date in ascending order, though this can be
20141
+ * modified via the order_by field.
19868
20142
  *
19869
20143
  * @param request - The request {@link ListPrivateNetworksRequest}
19870
20144
  * @returns A Promise of ListPrivateNetworksResponse
@@ -19872,7 +20146,8 @@ let API$2 = class API extends API$q {
19872
20146
  listPrivateNetworks = (request = {}) => enrichForPagination('privateNetworks', this.pageOfListPrivateNetworks, request);
19873
20147
 
19874
20148
  /**
19875
- * Create a private network.
20149
+ * Create a Private Network. Create a new Private Network. Once created, you
20150
+ * can attach Scaleway resources in the same Availability Zone.
19876
20151
  *
19877
20152
  * @param request - The request {@link CreatePrivateNetworkRequest}
19878
20153
  * @returns A Promise of PrivateNetwork
@@ -19885,7 +20160,9 @@ let API$2 = class API extends API$q {
19885
20160
  }, unmarshalPrivateNetwork);
19886
20161
 
19887
20162
  /**
19888
- * Get a private network.
20163
+ * Get a Private Network. Retrieve information about an existing Private
20164
+ * Network, specified by its Private Network ID. Its full details are returned
20165
+ * in the response object.
19889
20166
  *
19890
20167
  * @param request - The request {@link GetPrivateNetworkRequest}
19891
20168
  * @returns A Promise of PrivateNetwork
@@ -19896,7 +20173,8 @@ let API$2 = class API extends API$q {
19896
20173
  }, unmarshalPrivateNetwork);
19897
20174
 
19898
20175
  /**
19899
- * Update private network.
20176
+ * Update Private Network. Update parameters (such as name or tags) of an
20177
+ * existing Private Network, specified by its Private Network ID.
19900
20178
  *
19901
20179
  * @param request - The request {@link UpdatePrivateNetworkRequest}
19902
20180
  * @returns A Promise of PrivateNetwork
@@ -19909,7 +20187,8 @@ let API$2 = class API extends API$q {
19909
20187
  }, unmarshalPrivateNetwork);
19910
20188
 
19911
20189
  /**
19912
- * Delete a private network.
20190
+ * Delete a Private Network. Delete an existing Private Network. Note that you
20191
+ * must first detach all resources from the network, in order to delete it.
19913
20192
  *
19914
20193
  * @param request - The request {@link DeletePrivateNetworkRequest}
19915
20194
  */