@scaleway/sdk 1.6.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 (36) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.js +1 -1
  2. package/dist/api/baremetal/v1/api.gen.js +1 -1
  3. package/dist/api/baremetal/v1/api.utils.js +1 -1
  4. package/dist/api/cockpit/v1beta1/api.gen.js +41 -31
  5. package/dist/api/container/v1beta1/api.gen.js +34 -28
  6. package/dist/api/container/v1beta1/marshalling.gen.js +1 -1
  7. package/dist/api/domain/v2beta1/api.gen.js +2 -2
  8. package/dist/api/flexibleip/v1alpha1/api.gen.js +1 -1
  9. package/dist/api/function/v1beta1/api.gen.js +39 -30
  10. package/dist/api/function/v1beta1/marshalling.gen.js +1 -0
  11. package/dist/api/iam/v1alpha1/api.gen.js +2 -3
  12. package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
  13. package/dist/api/instance/v1/api.utils.js +7 -13
  14. package/dist/api/iot/v1/api.gen.js +1 -1
  15. package/dist/api/k8s/v1/api.gen.js +3 -3
  16. package/dist/api/lb/v1/api.gen.js +4 -4
  17. package/dist/api/lb/v1/api.utils.js +4 -4
  18. package/dist/api/marketplace/v2/api.gen.js +46 -3
  19. package/dist/api/mnq/v1alpha1/api.gen.js +35 -12
  20. package/dist/api/rdb/v1/api.gen.js +5 -5
  21. package/dist/api/redis/v1/api.gen.js +1 -1
  22. package/dist/api/registry/v1/api.gen.js +3 -3
  23. package/dist/api/secret/v1alpha1/api.gen.js +26 -15
  24. package/dist/api/secret/v1alpha1/marshalling.gen.js +8 -1
  25. package/dist/api/tem/v1alpha1/api.gen.js +2 -2
  26. package/dist/api/test/v1/api.gen.js +1 -1
  27. package/dist/api/vpc/v1/api.gen.js +13 -5
  28. package/dist/api/vpcgw/v1/api.gen.js +2 -2
  29. package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
  30. package/dist/helpers/marshalling.js +1 -1
  31. package/dist/index.cjs +241 -117
  32. package/dist/index.d.ts +825 -257
  33. package/dist/internal/async/interval-retrier.js +2 -2
  34. package/dist/scw/constants.js +1 -1
  35. package/dist/scw/custom-marshalling.js +4 -7
  36. package/package.json +2 -2
package/dist/index.cjs CHANGED
@@ -426,7 +426,7 @@ const assertValidSettings = obj => {
426
426
  }
427
427
  };
428
428
 
429
- const version = 'v1.5.0';
429
+ const version = 'v1.6.0';
430
430
  const userAgent = `scaleway-sdk-js/${version}`;
431
431
 
432
432
  const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -3638,14 +3638,16 @@ const jsonContentHeaders$j = {
3638
3638
  };
3639
3639
 
3640
3640
  /**
3641
- * Cockpit API.
3641
+ * Cockpit API documentation.
3642
3642
  *
3643
- * 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.
3644
3647
  */
3645
3648
  let API$l = class API extends API$q {
3646
3649
  /**
3647
- * Activate a cockpit. Activate a cockpit associated with the given project
3648
- * ID.
3650
+ * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
3649
3651
  *
3650
3652
  * @param request - The request {@link ActivateCockpitRequest}
3651
3653
  * @returns A Promise of Cockpit
@@ -3658,7 +3660,7 @@ let API$l = class API extends API$q {
3658
3660
  }, unmarshalCockpit);
3659
3661
 
3660
3662
  /**
3661
- * Get cockpit. Get the cockpit associated with the given project ID.
3663
+ * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
3662
3664
  *
3663
3665
  * @param request - The request {@link GetCockpitRequest}
3664
3666
  * @returns A Promise of Cockpit
@@ -3679,7 +3681,8 @@ let API$l = class API extends API$q {
3679
3681
  waitForCockpit = (request = {}, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), this.getCockpit, request, options);
3680
3682
 
3681
3683
  /**
3682
- * Get cockpit metrics. Get the cockpit metrics with the given project ID.
3684
+ * Get Cockpit metrics. Get metrics from your Cockpit with the specified
3685
+ * Project ID.
3683
3686
  *
3684
3687
  * @param request - The request {@link GetCockpitMetricsRequest}
3685
3688
  * @returns A Promise of CockpitMetrics
@@ -3691,8 +3694,7 @@ let API$l = class API extends API$q {
3691
3694
  }, unmarshalCockpitMetrics);
3692
3695
 
3693
3696
  /**
3694
- * Deactivate a cockpit. Deactivate a cockpit associated with the given
3695
- * project ID.
3697
+ * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
3696
3698
  *
3697
3699
  * @param request - The request {@link DeactivateCockpitRequest}
3698
3700
  * @returns A Promise of Cockpit
@@ -3705,8 +3707,8 @@ let API$l = class API extends API$q {
3705
3707
  }, unmarshalCockpit);
3706
3708
 
3707
3709
  /**
3708
- * Reset Grafana. Reset the Grafana of your cockpit associated with the given
3709
- * project ID.
3710
+ * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
3711
+ * Project ID.
3710
3712
  *
3711
3713
  * @param request - The request {@link ResetCockpitGrafanaRequest}
3712
3714
  * @returns A Promise of Cockpit
@@ -3719,7 +3721,7 @@ let API$l = class API extends API$q {
3719
3721
  }, unmarshalCockpit);
3720
3722
 
3721
3723
  /**
3722
- * 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.
3723
3725
  *
3724
3726
  * @param request - The request {@link CreateTokenRequest}
3725
3727
  * @returns A Promise of Token
@@ -3737,7 +3739,7 @@ let API$l = class API extends API$q {
3737
3739
  }, unmarshalListTokensResponse$2);
3738
3740
 
3739
3741
  /**
3740
- * List tokens. List tokens associated with the given project ID.
3742
+ * List tokens. Get a list of tokens associated with the specified Project ID.
3741
3743
  *
3742
3744
  * @param request - The request {@link ListTokensRequest}
3743
3745
  * @returns A Promise of ListTokensResponse
@@ -3745,7 +3747,7 @@ let API$l = class API extends API$q {
3745
3747
  listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
3746
3748
 
3747
3749
  /**
3748
- * Get token. Get the token associated with the given ID.
3750
+ * Get a token. Retrieve the token associated with the specified token ID.
3749
3751
  *
3750
3752
  * @param request - The request {@link GetTokenRequest}
3751
3753
  * @returns A Promise of Token
@@ -3756,7 +3758,7 @@ let API$l = class API extends API$q {
3756
3758
  }, unmarshalToken$2);
3757
3759
 
3758
3760
  /**
3759
- * Delete token. Delete the token associated with the given ID.
3761
+ * Delete a token. Delete the token associated with the specified token ID.
3760
3762
  *
3761
3763
  * @param request - The request {@link DeleteTokenRequest}
3762
3764
  */
@@ -3766,7 +3768,7 @@ let API$l = class API extends API$q {
3766
3768
  });
3767
3769
 
3768
3770
  /**
3769
- * 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
3770
3772
  * default receiver.
3771
3773
  *
3772
3774
  * @param request - The request {@link CreateContactPointRequest}
@@ -3785,8 +3787,8 @@ let API$l = class API extends API$q {
3785
3787
  }, unmarshalListContactPointsResponse);
3786
3788
 
3787
3789
  /**
3788
- * List alert contact points. List alert contact points associated with the
3789
- * given cockpit ID.
3790
+ * List contact points. Get a list of contact points for the Cockpit
3791
+ * associated with the specified Project ID.
3790
3792
  *
3791
3793
  * @param request - The request {@link ListContactPointsRequest}
3792
3794
  * @returns A Promise of ListContactPointsResponse
@@ -3794,8 +3796,8 @@ let API$l = class API extends API$q {
3794
3796
  listContactPoints = (request = {}) => enrichForPagination('contactPoints', this.pageOfListContactPoints, request);
3795
3797
 
3796
3798
  /**
3797
- * Delete an alert contact point. Delete an alert contact point for the
3798
- * default receiver.
3799
+ * Delete an alert contact point. Delete a contact point for the default
3800
+ * receiver.
3799
3801
  *
3800
3802
  * @param request - The request {@link DeleteContactPointRequest}
3801
3803
  */
@@ -3807,7 +3809,8 @@ let API$l = class API extends API$q {
3807
3809
  });
3808
3810
 
3809
3811
  /**
3810
- * Enable managed alerts.
3812
+ * Enable managed alerts. Enable the sending of managed alerts for the
3813
+ * specified Project's Cockpit.
3811
3814
  *
3812
3815
  * @param request - The request {@link EnableManagedAlertsRequest}
3813
3816
  */
@@ -3819,7 +3822,8 @@ let API$l = class API extends API$q {
3819
3822
  });
3820
3823
 
3821
3824
  /**
3822
- * Disable managed alerts.
3825
+ * Disable managed alerts. Disable the sending of managed alerts for the
3826
+ * specified Project's Cockpit.
3823
3827
  *
3824
3828
  * @param request - The request {@link DisableManagedAlertsRequest}
3825
3829
  */
@@ -3831,7 +3835,8 @@ let API$l = class API extends API$q {
3831
3835
  });
3832
3836
 
3833
3837
  /**
3834
- * 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.
3835
3840
  *
3836
3841
  * @param request - The request {@link TriggerTestAlertRequest}
3837
3842
  */
@@ -3843,7 +3848,9 @@ let API$l = class API extends API$q {
3843
3848
  });
3844
3849
 
3845
3850
  /**
3846
- * 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.
3847
3854
  *
3848
3855
  * @param request - The request {@link CreateGrafanaUserRequest}
3849
3856
  * @returns A Promise of GrafanaUser
@@ -3861,8 +3868,8 @@ let API$l = class API extends API$q {
3861
3868
  }, unmarshalListGrafanaUsersResponse);
3862
3869
 
3863
3870
  /**
3864
- * List grafana users. List grafana users who are able to connect to your
3865
- * grafana instance.
3871
+ * List Grafana users. Get a list of Grafana users who are able to connect to
3872
+ * the Cockpit's Grafana instance.
3866
3873
  *
3867
3874
  * @param request - The request {@link ListGrafanaUsersRequest}
3868
3875
  * @returns A Promise of ListGrafanaUsersResponse
@@ -3870,7 +3877,8 @@ let API$l = class API extends API$q {
3870
3877
  listGrafanaUsers = (request = {}) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request);
3871
3878
 
3872
3879
  /**
3873
- * 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.
3874
3882
  *
3875
3883
  * @param request - The request {@link DeleteGrafanaUserRequest}
3876
3884
  */
@@ -3882,8 +3890,8 @@ let API$l = class API extends API$q {
3882
3890
  });
3883
3891
 
3884
3892
  /**
3885
- * Reset Grafana user password. Reset the Grafana user password from your
3886
- * 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.
3887
3895
  *
3888
3896
  * @param request - The request {@link ResetGrafanaUserPasswordRequest}
3889
3897
  * @returns A Promise of GrafanaUser
@@ -3901,7 +3909,7 @@ let API$l = class API extends API$q {
3901
3909
  }, unmarshalListPlansResponse);
3902
3910
 
3903
3911
  /**
3904
- * List plans. List all pricing plans.
3912
+ * List pricing plans. Get a list of all pricing plans available.
3905
3913
  *
3906
3914
  * @param request - The request {@link ListPlansRequest}
3907
3915
  * @returns A Promise of ListPlansResponse
@@ -3909,7 +3917,9 @@ let API$l = class API extends API$q {
3909
3917
  listPlans = (request = {}) => enrichForPagination('plans', this.pageOfListPlans, request);
3910
3918
 
3911
3919
  /**
3912
- * Select pricing plan. Select the wanted pricing plan.
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.
3913
3923
  *
3914
3924
  * @param request - The request {@link SelectPlanRequest}
3915
3925
  * @returns A Promise of SelectPlanResponse
@@ -4130,7 +4140,7 @@ const marshalCreateContainerRequest = (request, defaults) => ({
4130
4140
  max_scale: request.maxScale,
4131
4141
  memory_limit: request.memoryLimit,
4132
4142
  min_scale: request.minScale,
4133
- name: request.name || randomName('ctnr'),
4143
+ name: request.name,
4134
4144
  namespace_id: request.namespaceId,
4135
4145
  port: request.port,
4136
4146
  privacy: request.privacy ?? 'unknown_privacy',
@@ -4215,7 +4225,7 @@ let API$k = class API extends API$q {
4215
4225
  }, unmarshalListNamespacesResponse$3);
4216
4226
 
4217
4227
  /**
4218
- * List all your namespaces.
4228
+ * List all your namespaces. List all namespaces in a specified region.
4219
4229
  *
4220
4230
  * @param request - The request {@link ListNamespacesRequest}
4221
4231
  * @returns A Promise of ListNamespacesResponse
@@ -4223,7 +4233,7 @@ let API$k = class API extends API$q {
4223
4233
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
4224
4234
 
4225
4235
  /**
4226
- * Get a namespace. Get the namespace associated with the given id.
4236
+ * Get a namespace. Get the namespace associated with the specified ID.
4227
4237
  *
4228
4238
  * @param request - The request {@link GetNamespaceRequest}
4229
4239
  * @returns A Promise of Namespace
@@ -4243,7 +4253,7 @@ let API$k = class API extends API$q {
4243
4253
  waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$2.includes(res.status))), this.getNamespace, request, options);
4244
4254
 
4245
4255
  /**
4246
- * Create a new namespace.
4256
+ * Create a new namespace. Create a new namespace in a specified region.
4247
4257
  *
4248
4258
  * @param request - The request {@link CreateNamespaceRequest}
4249
4259
  * @returns A Promise of Namespace
@@ -4256,8 +4266,8 @@ let API$k = class API extends API$q {
4256
4266
  }, unmarshalNamespace$3);
4257
4267
 
4258
4268
  /**
4259
- * Update an existing namespace. Update the space associated with the given
4260
- * id.
4269
+ * Update an existing namespace. Update the space associated with the
4270
+ * specified ID.
4261
4271
  *
4262
4272
  * @param request - The request {@link UpdateNamespaceRequest}
4263
4273
  * @returns A Promise of Namespace
@@ -4271,7 +4281,7 @@ let API$k = class API extends API$q {
4271
4281
 
4272
4282
  /**
4273
4283
  * Delete an existing namespace. Delete the namespace associated with the
4274
- * given id.
4284
+ * specified ID.
4275
4285
  *
4276
4286
  * @param request - The request {@link DeleteNamespaceRequest}
4277
4287
  * @returns A Promise of Namespace
@@ -4287,7 +4297,7 @@ let API$k = class API extends API$q {
4287
4297
  }, unmarshalListContainersResponse);
4288
4298
 
4289
4299
  /**
4290
- * List all your containers.
4300
+ * List all your containers. List all containers for a specified region.
4291
4301
  *
4292
4302
  * @param request - The request {@link ListContainersRequest}
4293
4303
  * @returns A Promise of ListContainersResponse
@@ -4295,7 +4305,7 @@ let API$k = class API extends API$q {
4295
4305
  listContainers = request => enrichForPagination('containers', this.pageOfListContainers, request);
4296
4306
 
4297
4307
  /**
4298
- * Get a container. Get the container associated with the given id.
4308
+ * Get a container. Get the container associated with the specified ID.
4299
4309
  *
4300
4310
  * @param request - The request {@link GetContainerRequest}
4301
4311
  * @returns A Promise of Container
@@ -4315,7 +4325,7 @@ let API$k = class API extends API$q {
4315
4325
  waitForContainer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
4316
4326
 
4317
4327
  /**
4318
- * Create a new container.
4328
+ * Create a new container. Create a new container in the specified region.
4319
4329
  *
4320
4330
  * @param request - The request {@link CreateContainerRequest}
4321
4331
  * @returns A Promise of Container
@@ -4329,7 +4339,7 @@ let API$k = class API extends API$q {
4329
4339
 
4330
4340
  /**
4331
4341
  * Update an existing container. Update the container associated with the
4332
- * given id.
4342
+ * specified ID.
4333
4343
  *
4334
4344
  * @param request - The request {@link UpdateContainerRequest}
4335
4345
  * @returns A Promise of Container
@@ -4342,7 +4352,7 @@ let API$k = class API extends API$q {
4342
4352
  }, unmarshalContainer);
4343
4353
 
4344
4354
  /**
4345
- * Delete a container. Delete the container associated with the given id.
4355
+ * Delete a container. Delete the container associated with the specified ID.
4346
4356
  *
4347
4357
  * @param request - The request {@link DeleteContainerRequest}
4348
4358
  * @returns A Promise of Container
@@ -4353,7 +4363,7 @@ let API$k = class API extends API$q {
4353
4363
  }, unmarshalContainer);
4354
4364
 
4355
4365
  /**
4356
- * Deploy a container. Deploy a container associated with the given id.
4366
+ * Deploy a container. Deploy a container associated with the specified ID.
4357
4367
  *
4358
4368
  * @param request - The request {@link DeployContainerRequest}
4359
4369
  * @returns A Promise of Container
@@ -4379,7 +4389,7 @@ let API$k = class API extends API$q {
4379
4389
  listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
4380
4390
 
4381
4391
  /**
4382
- * Get a cron. Get the cron associated with the given id.
4392
+ * Get a cron. Get the cron associated with the specified ID.
4383
4393
  *
4384
4394
  * @param request - The request {@link GetCronRequest}
4385
4395
  * @returns A Promise of Cron
@@ -4412,7 +4422,7 @@ let API$k = class API extends API$q {
4412
4422
  }, unmarshalCron$1);
4413
4423
 
4414
4424
  /**
4415
- * 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.
4416
4426
  *
4417
4427
  * @param request - The request {@link UpdateCronRequest}
4418
4428
  * @returns A Promise of Cron
@@ -4425,7 +4435,7 @@ let API$k = class API extends API$q {
4425
4435
  }, unmarshalCron$1);
4426
4436
 
4427
4437
  /**
4428
- * 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.
4429
4439
  *
4430
4440
  * @param request - The request {@link DeleteCronRequest}
4431
4441
  * @returns A Promise of Cron
@@ -4441,7 +4451,8 @@ let API$k = class API extends API$q {
4441
4451
  }, unmarshalListLogsResponse$1);
4442
4452
 
4443
4453
  /**
4444
- * List your container logs.
4454
+ * List your container logs. List the logs of the container with the specified
4455
+ * ID.
4445
4456
  *
4446
4457
  * @param request - The request {@link ListLogsRequest}
4447
4458
  * @returns A Promise of ListLogsResponse
@@ -4454,7 +4465,8 @@ let API$k = class API extends API$q {
4454
4465
  }, unmarshalListDomainsResponse$3);
4455
4466
 
4456
4467
  /**
4457
- * List all domain name bindings.
4468
+ * List all domain name bindings. List all domain name bindings in a specified
4469
+ * region.
4458
4470
  *
4459
4471
  * @param request - The request {@link ListDomainsRequest}
4460
4472
  * @returns A Promise of ListDomainsResponse
@@ -4462,7 +4474,8 @@ let API$k = class API extends API$q {
4462
4474
  listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
4463
4475
 
4464
4476
  /**
4465
- * Get a domain name binding.
4477
+ * Get a domain name binding. Get a domain name binding for the container with
4478
+ * the specified ID.
4466
4479
  *
4467
4480
  * @param request - The request {@link GetDomainRequest}
4468
4481
  * @returns A Promise of Domain
@@ -4482,7 +4495,8 @@ let API$k = class API extends API$q {
4482
4495
  waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$3.includes(res.status))), this.getDomain, request, options);
4483
4496
 
4484
4497
  /**
4485
- * Create a domain name binding.
4498
+ * Create a domain name binding. Create a domain name binding for the
4499
+ * container with the specified ID.
4486
4500
  *
4487
4501
  * @param request - The request {@link CreateDomainRequest}
4488
4502
  * @returns A Promise of Domain
@@ -4495,7 +4509,8 @@ let API$k = class API extends API$q {
4495
4509
  }, unmarshalDomain$3);
4496
4510
 
4497
4511
  /**
4498
- * Delete a domain name binding.
4512
+ * Delete a domain name binding. Delete the domain name binding with the
4513
+ * specific ID.
4499
4514
  *
4500
4515
  * @param request - The request {@link DeleteDomainRequest}
4501
4516
  * @returns A Promise of Domain
@@ -4536,7 +4551,7 @@ let API$k = class API extends API$q {
4536
4551
  }, unmarshalToken$1);
4537
4552
 
4538
4553
  /**
4539
- * Get a token.
4554
+ * Get a token. Get a token with a specified ID.
4540
4555
  *
4541
4556
  * @param request - The request {@link GetTokenRequest}
4542
4557
  * @returns A Promise of Token
@@ -4561,7 +4576,8 @@ let API$k = class API extends API$q {
4561
4576
  }, unmarshalListTokensResponse$1);
4562
4577
 
4563
4578
  /**
4564
- * List all tokens.
4579
+ * List all tokens. List all tokens belonging to a specified Organization or
4580
+ * Project.
4565
4581
  *
4566
4582
  * @param request - The request {@link ListTokensRequest}
4567
4583
  * @returns A Promise of ListTokensResponse
@@ -4569,7 +4585,7 @@ let API$k = class API extends API$q {
4569
4585
  listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
4570
4586
 
4571
4587
  /**
4572
- * Delete a token.
4588
+ * Delete a token. Delete a token with a specified ID.
4573
4589
  *
4574
4590
  * @param request - The request {@link DeleteTokenRequest}
4575
4591
  * @returns A Promise of Token
@@ -6944,6 +6960,7 @@ const unmarshalFunction = data => {
6944
6960
  throw new TypeError(`Unmarshalling the type 'Function' failed as data isn't a dictionary.`);
6945
6961
  }
6946
6962
  return {
6963
+ buildMessage: data.build_message,
6947
6964
  cpuLimit: data.cpu_limit,
6948
6965
  description: data.description,
6949
6966
  domainName: data.domain_name,
@@ -7275,7 +7292,8 @@ let API$h = class API extends API$q {
7275
7292
  }, unmarshalListNamespacesResponse$2);
7276
7293
 
7277
7294
  /**
7278
- * List all your namespaces.
7295
+ * List all your namespaces. List all existing namespaces in the specified
7296
+ * region.
7279
7297
  *
7280
7298
  * @param request - The request {@link ListNamespacesRequest}
7281
7299
  * @returns A Promise of ListNamespacesResponse
@@ -7283,7 +7301,7 @@ let API$h = class API extends API$q {
7283
7301
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
7284
7302
 
7285
7303
  /**
7286
- * Get a namespace. Get the namespace associated with the given id.
7304
+ * Get a namespace. Get the namespace associated with the specified ID.
7287
7305
  *
7288
7306
  * @param request - The request {@link GetNamespaceRequest}
7289
7307
  * @returns A Promise of Namespace
@@ -7303,7 +7321,8 @@ let API$h = class API extends API$q {
7303
7321
  waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$1.includes(res.status))), this.getNamespace, request, options);
7304
7322
 
7305
7323
  /**
7306
- * Create a new namespace.
7324
+ * Create a new namespace. Create a new namespace in a specified Organization
7325
+ * or Proejct.
7307
7326
  *
7308
7327
  * @param request - The request {@link CreateNamespaceRequest}
7309
7328
  * @returns A Promise of Namespace
@@ -7316,8 +7335,8 @@ let API$h = class API extends API$q {
7316
7335
  }, unmarshalNamespace$2);
7317
7336
 
7318
7337
  /**
7319
- * Update an existing namespace. Update the space associated with the given
7320
- * id.
7338
+ * Update an existing namespace. Update the namespace associated with the
7339
+ * specified ID.
7321
7340
  *
7322
7341
  * @param request - The request {@link UpdateNamespaceRequest}
7323
7342
  * @returns A Promise of Namespace
@@ -7331,7 +7350,7 @@ let API$h = class API extends API$q {
7331
7350
 
7332
7351
  /**
7333
7352
  * Delete an existing namespace. Delete the namespace associated with the
7334
- * given id.
7353
+ * specified ID.
7335
7354
  *
7336
7355
  * @param request - The request {@link DeleteNamespaceRequest}
7337
7356
  * @returns A Promise of Namespace
@@ -7355,7 +7374,7 @@ let API$h = class API extends API$q {
7355
7374
  listFunctions = request => enrichForPagination('functions', this.pageOfListFunctions, request);
7356
7375
 
7357
7376
  /**
7358
- * Get a function. Get the function associated with the given id.
7377
+ * Get a function. Get the function associated with the specified ID.
7359
7378
  *
7360
7379
  * @param request - The request {@link GetFunctionRequest}
7361
7380
  * @returns A Promise of Function
@@ -7375,7 +7394,8 @@ let API$h = class API extends API$q {
7375
7394
  waitForFunction = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!FUNCTION_TRANSIENT_STATUSES.includes(res.status))), this.getFunction, request, options);
7376
7395
 
7377
7396
  /**
7378
- * Create a new function.
7397
+ * Create a new function. Create a new function in the specified region for a
7398
+ * specified Organization or Project.
7379
7399
  *
7380
7400
  * @param request - The request {@link CreateFunctionRequest}
7381
7401
  * @returns A Promise of Function
@@ -7388,8 +7408,8 @@ let API$h = class API extends API$q {
7388
7408
  }, unmarshalFunction);
7389
7409
 
7390
7410
  /**
7391
- * Update an existing function. Update the function associated with the given
7392
- * id.
7411
+ * Update an existing function. Update the function associated with the
7412
+ * specified ID.
7393
7413
  *
7394
7414
  * @param request - The request {@link UpdateFunctionRequest}
7395
7415
  * @returns A Promise of Function
@@ -7402,7 +7422,7 @@ let API$h = class API extends API$q {
7402
7422
  }, unmarshalFunction);
7403
7423
 
7404
7424
  /**
7405
- * Delete a function. Delete the function associated with the given id.
7425
+ * Delete a function. Delete the function associated with the specified ID.
7406
7426
  *
7407
7427
  * @param request - The request {@link DeleteFunctionRequest}
7408
7428
  * @returns A Promise of Function
@@ -7413,7 +7433,7 @@ let API$h = class API extends API$q {
7413
7433
  }, unmarshalFunction);
7414
7434
 
7415
7435
  /**
7416
- * Deploy a function. Deploy a function associated with the given id.
7436
+ * Deploy a function. Deploy a function associated with the specified ID.
7417
7437
  *
7418
7438
  * @param request - The request {@link DeployFunctionRequest}
7419
7439
  * @returns A Promise of Function
@@ -7438,7 +7458,7 @@ let API$h = class API extends API$q {
7438
7458
 
7439
7459
  /**
7440
7460
  * Get an upload URL of a function. Get an upload URL of a function associated
7441
- * with the given id.
7461
+ * with the specified ID.
7442
7462
  *
7443
7463
  * @param request - The request {@link GetFunctionUploadURLRequest}
7444
7464
  * @returns A Promise of UploadURL
@@ -7451,7 +7471,7 @@ let API$h = class API extends API$q {
7451
7471
 
7452
7472
  /**
7453
7473
  * Get a download URL of a function. Get a download URL for a function
7454
- * associated with the given id.
7474
+ * associated with the specified ID.
7455
7475
  *
7456
7476
  * @param request - The request {@link GetFunctionDownloadURLRequest}
7457
7477
  * @returns A Promise of DownloadURL
@@ -7467,7 +7487,7 @@ let API$h = class API extends API$q {
7467
7487
  }, unmarshalListCronsResponse);
7468
7488
 
7469
7489
  /**
7470
- * List all your crons.
7490
+ * List all crons. List all the cronjobs in a specified region.
7471
7491
  *
7472
7492
  * @param request - The request {@link ListCronsRequest}
7473
7493
  * @returns A Promise of ListCronsResponse
@@ -7475,7 +7495,7 @@ let API$h = class API extends API$q {
7475
7495
  listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
7476
7496
 
7477
7497
  /**
7478
- * Get a cron. Get the cron associated with the given id.
7498
+ * Get a cron. Get the cron associated with the specified ID.
7479
7499
  *
7480
7500
  * @param request - The request {@link GetCronRequest}
7481
7501
  * @returns A Promise of Cron
@@ -7495,7 +7515,8 @@ let API$h = class API extends API$q {
7495
7515
  waitForCron = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
7496
7516
 
7497
7517
  /**
7498
- * Create a new cron.
7518
+ * Create a new cron. Create a new cronjob for a function with the specified
7519
+ * ID.
7499
7520
  *
7500
7521
  * @param request - The request {@link CreateCronRequest}
7501
7522
  * @returns A Promise of Cron
@@ -7508,7 +7529,7 @@ let API$h = class API extends API$q {
7508
7529
  }, unmarshalCron);
7509
7530
 
7510
7531
  /**
7511
- * 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.
7512
7533
  *
7513
7534
  * @param request - The request {@link UpdateCronRequest}
7514
7535
  * @returns A Promise of Cron
@@ -7521,7 +7542,7 @@ let API$h = class API extends API$q {
7521
7542
  }, unmarshalCron);
7522
7543
 
7523
7544
  /**
7524
- * 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.
7525
7546
  *
7526
7547
  * @param request - The request {@link DeleteCronRequest}
7527
7548
  * @returns A Promise of Cron
@@ -7537,7 +7558,8 @@ let API$h = class API extends API$q {
7537
7558
  }, unmarshalListLogsResponse);
7538
7559
 
7539
7560
  /**
7540
- * List your application logs.
7561
+ * List application logs. List the application logs of the function with the
7562
+ * specified ID.
7541
7563
  *
7542
7564
  * @param request - The request {@link ListLogsRequest}
7543
7565
  * @returns A Promise of ListLogsResponse
@@ -7550,7 +7572,8 @@ let API$h = class API extends API$q {
7550
7572
  }, unmarshalListDomainsResponse$1);
7551
7573
 
7552
7574
  /**
7553
- * List all domain name bindings.
7575
+ * List all domain name bindings. List all domain name bindings in a specified
7576
+ * region.
7554
7577
  *
7555
7578
  * @param request - The request {@link ListDomainsRequest}
7556
7579
  * @returns A Promise of ListDomainsResponse
@@ -7558,7 +7581,8 @@ let API$h = class API extends API$q {
7558
7581
  listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
7559
7582
 
7560
7583
  /**
7561
- * Get a domain name binding.
7584
+ * Get a domain name binding. Get a domain name binding for the function with
7585
+ * the specified ID.
7562
7586
  *
7563
7587
  * @param request - The request {@link GetDomainRequest}
7564
7588
  * @returns A Promise of Domain
@@ -7578,7 +7602,8 @@ let API$h = class API extends API$q {
7578
7602
  waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$1.includes(res.status))), this.getDomain, request, options);
7579
7603
 
7580
7604
  /**
7581
- * Create a domain name binding.
7605
+ * Create a domain name binding. Create a domain name binding for the function
7606
+ * with the specified ID.
7582
7607
  *
7583
7608
  * @param request - The request {@link CreateDomainRequest}
7584
7609
  * @returns A Promise of Domain
@@ -7591,7 +7616,8 @@ let API$h = class API extends API$q {
7591
7616
  }, unmarshalDomain$1);
7592
7617
 
7593
7618
  /**
7594
- * Delete a domain name binding.
7619
+ * Delete a domain name binding. Delete a domain name binding for the function
7620
+ * with the specified ID.
7595
7621
  *
7596
7622
  * @param request - The request {@link DeleteDomainRequest}
7597
7623
  * @returns A Promise of Domain
@@ -7885,6 +7911,7 @@ const unmarshalUser$1 = data => {
7885
7911
  email: data.email,
7886
7912
  id: data.id,
7887
7913
  lastLoginAt: unmarshalDate(data.last_login_at),
7914
+ mfa: data.mfa,
7888
7915
  organizationId: data.organization_id,
7889
7916
  status: data.status,
7890
7917
  twoFactorEnabled: data.two_factor_enabled,
@@ -8185,7 +8212,7 @@ let API$g = class API extends API$q {
8185
8212
  pageOfListUsers = (request = {}) => this.client.fetch({
8186
8213
  method: 'GET',
8187
8214
  path: `/iam/v1alpha1/users`,
8188
- 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])
8189
8216
  }, unmarshalListUsersResponse$1);
8190
8217
 
8191
8218
  /**
@@ -8203,8 +8230,7 @@ let API$g = class API extends API$q {
8203
8230
  /**
8204
8231
  * Get a given user. Retrieve information about a user, specified by the
8205
8232
  * `user_id` parameter. The user's full details, including `id`, `email`,
8206
- * `organization_id`, `status` and `two_factor_enabled` are returned in the
8207
- * response.
8233
+ * `organization_id`, `status` and `mfa` are returned in the response.
8208
8234
  *
8209
8235
  * @param request - The request {@link GetUserRequest}
8210
8236
  * @returns A Promise of User
@@ -16128,7 +16154,8 @@ let API$a = class API extends API$q {
16128
16154
  }, unmarshalListImagesResponse$1);
16129
16155
 
16130
16156
  /**
16131
- * List marketplace images.
16157
+ * List marketplace images. List all available images on the marketplace,
16158
+ * their UUID, CPU architecture and description.
16132
16159
  *
16133
16160
  * @param request - The request {@link ListImagesRequest}
16134
16161
  * @returns A Promise of ListImagesResponse
@@ -16136,7 +16163,8 @@ let API$a = class API extends API$q {
16136
16163
  listImages = request => enrichForPagination('images', this.pageOfListImages, request);
16137
16164
 
16138
16165
  /**
16139
- * 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).
16140
16168
  *
16141
16169
  * @param request - The request {@link GetImageRequest}
16142
16170
  * @returns A Promise of Image
@@ -16150,7 +16178,24 @@ let API$a = class API extends API$q {
16150
16178
  path: `/marketplace/v2/versions`,
16151
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])
16152
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
+ */
16153
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
+ */
16154
16199
  getVersion = request => this.client.fetch({
16155
16200
  method: 'GET',
16156
16201
  path: `/marketplace/v2/versions/${validatePathParam('versionId', request.versionId)}`
@@ -16171,12 +16216,25 @@ let API$a = class API extends API$q {
16171
16216
  }, unmarshalListLocalImagesResponse);
16172
16217
 
16173
16218
  /**
16174
- * 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.
16175
16223
  *
16176
16224
  * @param request - The request {@link ListLocalImagesRequest}
16177
16225
  * @returns A Promise of ListLocalImagesResponse
16178
16226
  */
16179
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
+ */
16180
16238
  getLocalImage = request => this.client.fetch({
16181
16239
  method: 'GET',
16182
16240
  path: `/marketplace/v2/local-images/${validatePathParam('localImageId', request.localImageId)}`
@@ -16186,7 +16244,23 @@ let API$a = class API extends API$q {
16186
16244
  path: `/marketplace/v2/categories`,
16187
16245
  urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
16188
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
+ */
16189
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
+ */
16190
16264
  getCategory = request => this.client.fetch({
16191
16265
  method: 'GET',
16192
16266
  path: `/marketplace/v2/categories/${validatePathParam('categoryId', request.categoryId)}`
@@ -16340,7 +16414,8 @@ const jsonContentHeaders$9 = {
16340
16414
  /**
16341
16415
  * MnQ API (beta).
16342
16416
  *
16343
- * 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).
16344
16419
  */
16345
16420
  let API$9 = class API extends API$q {
16346
16421
  /** Lists the available regions of the API. */
@@ -16352,7 +16427,10 @@ let API$9 = class API extends API$q {
16352
16427
  }, unmarshalListNamespacesResponse$1);
16353
16428
 
16354
16429
  /**
16355
- * 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.
16356
16434
  *
16357
16435
  * @param request - The request {@link ListNamespacesRequest}
16358
16436
  * @returns A Promise of ListNamespacesResponse
@@ -16360,7 +16438,8 @@ let API$9 = class API extends API$q {
16360
16438
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
16361
16439
 
16362
16440
  /**
16363
- * Create a namespace.
16441
+ * Create a namespace. Create a Messaging and Queuing namespace, set to the
16442
+ * desired protocol.
16364
16443
  *
16365
16444
  * @param request - The request {@link CreateNamespaceRequest}
16366
16445
  * @returns A Promise of Namespace
@@ -16373,7 +16452,8 @@ let API$9 = class API extends API$q {
16373
16452
  }, unmarshalNamespace$1);
16374
16453
 
16375
16454
  /**
16376
- * 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.
16377
16457
  *
16378
16458
  * @param request - The request {@link UpdateNamespaceRequest}
16379
16459
  * @returns A Promise of Namespace
@@ -16386,7 +16466,9 @@ let API$9 = class API extends API$q {
16386
16466
  }, unmarshalNamespace$1);
16387
16467
 
16388
16468
  /**
16389
- * 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.
16390
16472
  *
16391
16473
  * @param request - The request {@link GetNamespaceRequest}
16392
16474
  * @returns A Promise of Namespace
@@ -16397,7 +16479,10 @@ let API$9 = class API extends API$q {
16397
16479
  }, unmarshalNamespace$1);
16398
16480
 
16399
16481
  /**
16400
- * 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.
16401
16486
  *
16402
16487
  * @param request - The request {@link DeleteNamespaceRequest}
16403
16488
  */
@@ -16407,8 +16492,11 @@ let API$9 = class API extends API$q {
16407
16492
  });
16408
16493
 
16409
16494
  /**
16410
- * Create a set of credentials. Create a set of credentials for a specific
16411
- * 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.
16412
16500
  *
16413
16501
  * @param request - The request {@link CreateCredentialRequest}
16414
16502
  * @returns A Promise of Credential
@@ -16421,7 +16509,9 @@ let API$9 = class API extends API$q {
16421
16509
  }, unmarshalCredential);
16422
16510
 
16423
16511
  /**
16424
- * 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.
16425
16515
  *
16426
16516
  * @param request - The request {@link DeleteCredentialRequest}
16427
16517
  */
@@ -16436,7 +16526,9 @@ let API$9 = class API extends API$q {
16436
16526
  }, unmarshalListCredentialsResponse);
16437
16527
 
16438
16528
  /**
16439
- * 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**).
16440
16532
  *
16441
16533
  * @param request - The request {@link ListCredentialsRequest}
16442
16534
  * @returns A Promise of ListCredentialsResponse
@@ -16444,7 +16536,10 @@ let API$9 = class API extends API$q {
16444
16536
  listCredentials = (request = {}) => enrichForPagination('credentials', this.pageOfListCredentials, request);
16445
16537
 
16446
16538
  /**
16447
- * 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.
16448
16543
  *
16449
16544
  * @param request - The request {@link UpdateCredentialRequest}
16450
16545
  * @returns A Promise of Credential
@@ -16457,7 +16552,9 @@ let API$9 = class API extends API$q {
16457
16552
  }, unmarshalCredential);
16458
16553
 
16459
16554
  /**
16460
- * 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.
16461
16558
  *
16462
16559
  * @param request - The request {@link GetCredentialRequest}
16463
16560
  * @returns A Promise of Credential
@@ -19071,6 +19168,7 @@ const unmarshalSecret = data => {
19071
19168
  createdAt: unmarshalDate(data.created_at),
19072
19169
  description: data.description,
19073
19170
  id: data.id,
19171
+ isManaged: data.is_managed,
19074
19172
  name: data.name,
19075
19173
  projectId: data.project_id,
19076
19174
  region: data.region,
@@ -19087,6 +19185,7 @@ const unmarshalSecretVersion = data => {
19087
19185
  return {
19088
19186
  createdAt: unmarshalDate(data.created_at),
19089
19187
  description: data.description,
19188
+ isLatest: data.is_latest,
19090
19189
  revision: data.revision,
19091
19190
  secretId: data.secret_id,
19092
19191
  status: data.status,
@@ -19099,6 +19198,7 @@ const unmarshalAccessSecretVersionResponse = data => {
19099
19198
  }
19100
19199
  return {
19101
19200
  data: data.data,
19201
+ dataCrc32: data.data_crc32,
19102
19202
  revision: data.revision,
19103
19203
  secretId: data.secret_id
19104
19204
  };
@@ -19128,6 +19228,9 @@ const marshalPasswordGenerationParams = (request, defaults) => ({
19128
19228
  no_lowercase_letters: request.noLowercaseLetters,
19129
19229
  no_uppercase_letters: request.noUppercaseLetters
19130
19230
  });
19231
+ const marshalAddSecretOwnerRequest = (request, defaults) => ({
19232
+ product_name: request.productName
19233
+ });
19131
19234
  const marshalCreateSecretRequest = (request, defaults) => ({
19132
19235
  description: request.description,
19133
19236
  name: request.name,
@@ -19136,6 +19239,7 @@ const marshalCreateSecretRequest = (request, defaults) => ({
19136
19239
  });
19137
19240
  const marshalCreateSecretVersionRequest = (request, defaults) => ({
19138
19241
  data: request.data,
19242
+ data_crc32: request.dataCrc32,
19139
19243
  description: request.description,
19140
19244
  disable_previous: request.disablePrevious,
19141
19245
  ...resolveOneOf([{
@@ -19221,7 +19325,7 @@ let API$5 = class API extends API$q {
19221
19325
  pageOfListSecrets = (request = {}) => this.client.fetch({
19222
19326
  method: 'GET',
19223
19327
  path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`,
19224
- 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])
19225
19329
  }, unmarshalListSecretsResponse);
19226
19330
 
19227
19331
  /**
@@ -19245,6 +19349,18 @@ let API$5 = class API extends API$q {
19245
19349
  path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
19246
19350
  });
19247
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
+
19248
19364
  /**
19249
19365
  * Create a version. Create a version of a given secret specified by the
19250
19366
  * `region` and `secret_id` parameters.
@@ -19329,20 +19445,6 @@ let API$5 = class API extends API$q {
19329
19445
  */
19330
19446
  listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
19331
19447
 
19332
- /**
19333
- * Delete a version. Delete a secret's version and the sensitive data
19334
- * contained in it. Deleting a version is permanent and cannot be undone.
19335
- *
19336
- * @param request - The request {@link DestroySecretVersionRequest}
19337
- * @returns A Promise of SecretVersion
19338
- */
19339
- destroySecretVersion = request => this.client.fetch({
19340
- body: '{}',
19341
- headers: jsonContentHeaders$5,
19342
- method: 'POST',
19343
- path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
19344
- }, unmarshalSecretVersion);
19345
-
19346
19448
  /**
19347
19449
  * Enable a version. Make a specific version accessible. You must specify the
19348
19450
  * `region`, `secret_id` and `revision` parameters.
@@ -19396,6 +19498,20 @@ let API$5 = class API extends API$q {
19396
19498
  method: 'GET',
19397
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`
19398
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);
19399
19515
  };
19400
19516
 
19401
19517
  // This file was automatically generated. DO NOT EDIT.
@@ -20019,7 +20135,10 @@ let API$2 = class API extends API$q {
20019
20135
  }, unmarshalListPrivateNetworksResponse);
20020
20136
 
20021
20137
  /**
20022
- * 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.
20023
20142
  *
20024
20143
  * @param request - The request {@link ListPrivateNetworksRequest}
20025
20144
  * @returns A Promise of ListPrivateNetworksResponse
@@ -20027,7 +20146,8 @@ let API$2 = class API extends API$q {
20027
20146
  listPrivateNetworks = (request = {}) => enrichForPagination('privateNetworks', this.pageOfListPrivateNetworks, request);
20028
20147
 
20029
20148
  /**
20030
- * 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.
20031
20151
  *
20032
20152
  * @param request - The request {@link CreatePrivateNetworkRequest}
20033
20153
  * @returns A Promise of PrivateNetwork
@@ -20040,7 +20160,9 @@ let API$2 = class API extends API$q {
20040
20160
  }, unmarshalPrivateNetwork);
20041
20161
 
20042
20162
  /**
20043
- * 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.
20044
20166
  *
20045
20167
  * @param request - The request {@link GetPrivateNetworkRequest}
20046
20168
  * @returns A Promise of PrivateNetwork
@@ -20051,7 +20173,8 @@ let API$2 = class API extends API$q {
20051
20173
  }, unmarshalPrivateNetwork);
20052
20174
 
20053
20175
  /**
20054
- * 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.
20055
20178
  *
20056
20179
  * @param request - The request {@link UpdatePrivateNetworkRequest}
20057
20180
  * @returns A Promise of PrivateNetwork
@@ -20064,7 +20187,8 @@ let API$2 = class API extends API$q {
20064
20187
  }, unmarshalPrivateNetwork);
20065
20188
 
20066
20189
  /**
20067
- * 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.
20068
20192
  *
20069
20193
  * @param request - The request {@link DeletePrivateNetworkRequest}
20070
20194
  */