@scaleway/sdk 1.6.0 → 1.8.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.
- package/dist/api/applesilicon/v1alpha1/api.gen.js +5 -4
- package/dist/api/baremetal/v1/api.gen.js +6 -6
- package/dist/api/baremetal/v1/api.utils.js +1 -1
- package/dist/api/cockpit/v1beta1/api.gen.js +39 -30
- package/dist/api/container/v1beta1/api.gen.js +35 -33
- package/dist/api/container/v1beta1/marshalling.gen.js +3 -1
- package/dist/api/domain/v2beta1/api.gen.js +63 -54
- package/dist/api/flexibleip/v1alpha1/api.gen.js +28 -15
- package/dist/api/function/v1beta1/api.gen.js +39 -30
- package/dist/api/function/v1beta1/marshalling.gen.js +1 -0
- package/dist/api/iam/v1alpha1/api.gen.js +2 -3
- package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
- package/dist/api/instance/v1/api.gen.js +2 -2
- package/dist/api/instance/v1/api.utils.js +7 -13
- package/dist/api/iot/v1/api.gen.js +68 -36
- package/dist/api/k8s/v1/api.gen.js +4 -4
- package/dist/api/lb/v1/api.gen.js +4 -4
- package/dist/api/lb/v1/api.utils.js +4 -4
- package/dist/api/marketplace/v2/api.gen.js +46 -3
- package/dist/api/mnq/v1alpha1/api.gen.js +36 -13
- package/dist/api/mnq/v1alpha1/marshalling.gen.js +3 -9
- package/dist/api/rdb/v1/api.gen.js +5 -5
- package/dist/api/redis/v1/api.gen.js +1 -1
- package/dist/api/registry/v1/api.gen.js +44 -22
- package/dist/api/secret/v1alpha1/api.gen.js +29 -18
- package/dist/api/secret/v1alpha1/marshalling.gen.js +8 -1
- package/dist/api/tem/v1alpha1/api.gen.js +3 -7
- package/dist/api/test/v1/api.gen.js +1 -1
- package/dist/api/vpc/v1/api.gen.js +13 -5
- package/dist/api/vpcgw/v1/api.gen.js +2 -2
- package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
- package/dist/helpers/marshalling.js +1 -1
- package/dist/index.cjs +457 -269
- package/dist/index.d.ts +1412 -736
- package/dist/internal/async/interval-retrier.js +2 -2
- package/dist/scw/constants.js +1 -1
- package/dist/scw/custom-marshalling.js +4 -7
- 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.
|
|
429
|
+
const version = 'v1.7.0';
|
|
430
430
|
const userAgent = `scaleway-sdk-js/${version}`;
|
|
431
431
|
|
|
432
432
|
const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
|
|
@@ -2144,7 +2144,7 @@ const jsonContentHeaders$l = {
|
|
|
2144
2144
|
};
|
|
2145
2145
|
|
|
2146
2146
|
/**
|
|
2147
|
-
* Apple silicon.
|
|
2147
|
+
* Apple silicon API.
|
|
2148
2148
|
*
|
|
2149
2149
|
* Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built
|
|
2150
2150
|
* using the latest generation of Apple Mac mini hardware (fifth generation).
|
|
@@ -2182,7 +2182,8 @@ let API$o = class API extends API$q {
|
|
|
2182
2182
|
}, unmarshalListServerTypesResponse);
|
|
2183
2183
|
|
|
2184
2184
|
/**
|
|
2185
|
-
* Get a server type. Get
|
|
2185
|
+
* Get a server type. Get technical details (CPU, disk size etc.) of a server
|
|
2186
|
+
* type.
|
|
2186
2187
|
*
|
|
2187
2188
|
* @param request - The request {@link GetServerTypeRequest}
|
|
2188
2189
|
* @returns A Promise of ServerType
|
|
@@ -2227,7 +2228,7 @@ let API$o = class API extends API$q {
|
|
|
2227
2228
|
}, unmarshalListOSResponse$1);
|
|
2228
2229
|
|
|
2229
2230
|
/**
|
|
2230
|
-
* List all Operating
|
|
2231
|
+
* List all Operating Systems (OS). List all Operating Systems (OS). The
|
|
2231
2232
|
* response will include the total number of OS as well as their associated
|
|
2232
2233
|
* IDs, names and labels.
|
|
2233
2234
|
*
|
|
@@ -2772,8 +2773,8 @@ let API$n = class API extends API$q {
|
|
|
2772
2773
|
}, unmarshalListServersResponse$1);
|
|
2773
2774
|
|
|
2774
2775
|
/**
|
|
2775
|
-
* List Elastic Metal servers for an
|
|
2776
|
-
* for a specific
|
|
2776
|
+
* List Elastic Metal servers for an Organization. List Elastic Metal servers
|
|
2777
|
+
* for a specific Organization.
|
|
2777
2778
|
*
|
|
2778
2779
|
* @param request - The request {@link ListServersRequest}
|
|
2779
2780
|
* @returns A Promise of ListServersResponse
|
|
@@ -3065,7 +3066,7 @@ let API$n = class API extends API$q {
|
|
|
3065
3066
|
}, unmarshalListSettingsResponse);
|
|
3066
3067
|
|
|
3067
3068
|
/**
|
|
3068
|
-
* List all settings. Return all settings for a
|
|
3069
|
+
* List all settings. Return all settings for a Project ID.
|
|
3069
3070
|
*
|
|
3070
3071
|
* @param request - The request {@link ListSettingsRequest}
|
|
3071
3072
|
* @returns A Promise of ListSettingsResponse
|
|
@@ -3073,7 +3074,7 @@ let API$n = class API extends API$q {
|
|
|
3073
3074
|
listSettings = (request = {}) => enrichForPagination('settings', this.pageOfListSettings, request);
|
|
3074
3075
|
|
|
3075
3076
|
/**
|
|
3076
|
-
* Update setting. Update a setting for a
|
|
3077
|
+
* Update setting. Update a setting for a Project ID (enable or disable).
|
|
3077
3078
|
*
|
|
3078
3079
|
* @param request - The request {@link UpdateSettingRequest}
|
|
3079
3080
|
* @returns A Promise of Setting
|
|
@@ -3100,7 +3101,7 @@ let API$n = class API extends API$q {
|
|
|
3100
3101
|
listOS = (request = {}) => enrichForPagination('os', this.pageOfListOS, request);
|
|
3101
3102
|
|
|
3102
3103
|
/**
|
|
3103
|
-
* Get
|
|
3104
|
+
* Get OS with an ID. Return the specific OS for the ID.
|
|
3104
3105
|
*
|
|
3105
3106
|
* @param request - The request {@link GetOSRequest}
|
|
3106
3107
|
* @returns A Promise of OS
|
|
@@ -3640,12 +3641,13 @@ const jsonContentHeaders$j = {
|
|
|
3640
3641
|
/**
|
|
3641
3642
|
* Cockpit API.
|
|
3642
3643
|
*
|
|
3643
|
-
*
|
|
3644
|
+
* Cockpit API. 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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
3709
|
-
*
|
|
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
|
|
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.
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
3789
|
-
*
|
|
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
|
|
3798
|
-
*
|
|
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
|
|
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
|
|
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
|
|
3865
|
-
*
|
|
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
|
|
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
|
|
3886
|
-
*
|
|
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.
|
|
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
|
|
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
|
|
@@ -4123,6 +4133,7 @@ const marshalSecret$1 = (request, defaults) => ({
|
|
|
4123
4133
|
value: request.value
|
|
4124
4134
|
});
|
|
4125
4135
|
const marshalCreateContainerRequest = (request, defaults) => ({
|
|
4136
|
+
cpu_limit: request.cpuLimit,
|
|
4126
4137
|
description: request.description,
|
|
4127
4138
|
environment_variables: request.environmentVariables,
|
|
4128
4139
|
http_option: request.httpOption ?? 'unknown_http_option',
|
|
@@ -4130,7 +4141,7 @@ const marshalCreateContainerRequest = (request, defaults) => ({
|
|
|
4130
4141
|
max_scale: request.maxScale,
|
|
4131
4142
|
memory_limit: request.memoryLimit,
|
|
4132
4143
|
min_scale: request.minScale,
|
|
4133
|
-
name: request.name
|
|
4144
|
+
name: request.name,
|
|
4134
4145
|
namespace_id: request.namespaceId,
|
|
4135
4146
|
port: request.port,
|
|
4136
4147
|
privacy: request.privacy ?? 'unknown_privacy',
|
|
@@ -4168,6 +4179,7 @@ const marshalCreateTokenRequest$1 = (request, defaults) => ({
|
|
|
4168
4179
|
}])
|
|
4169
4180
|
});
|
|
4170
4181
|
const marshalUpdateContainerRequest = (request, defaults) => ({
|
|
4182
|
+
cpu_limit: request.cpuLimit,
|
|
4171
4183
|
description: request.description,
|
|
4172
4184
|
environment_variables: request.environmentVariables,
|
|
4173
4185
|
http_option: request.httpOption ?? 'unknown_http_option',
|
|
@@ -4200,11 +4212,7 @@ const jsonContentHeaders$i = {
|
|
|
4200
4212
|
'Content-Type': 'application/json; charset=utf-8'
|
|
4201
4213
|
};
|
|
4202
4214
|
|
|
4203
|
-
/**
|
|
4204
|
-
* Containers API.
|
|
4205
|
-
*
|
|
4206
|
-
* Serverless Containers API. Containers API.
|
|
4207
|
-
*/
|
|
4215
|
+
/** Serverless Containers API. */
|
|
4208
4216
|
let API$k = class API extends API$q {
|
|
4209
4217
|
/** Lists the available regions of the API. */
|
|
4210
4218
|
static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
|
|
@@ -4215,7 +4223,7 @@ let API$k = class API extends API$q {
|
|
|
4215
4223
|
}, unmarshalListNamespacesResponse$3);
|
|
4216
4224
|
|
|
4217
4225
|
/**
|
|
4218
|
-
* List all your namespaces.
|
|
4226
|
+
* List all your namespaces. List all namespaces in a specified region.
|
|
4219
4227
|
*
|
|
4220
4228
|
* @param request - The request {@link ListNamespacesRequest}
|
|
4221
4229
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -4223,7 +4231,7 @@ let API$k = class API extends API$q {
|
|
|
4223
4231
|
listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
|
|
4224
4232
|
|
|
4225
4233
|
/**
|
|
4226
|
-
* Get a namespace. Get the namespace associated with the
|
|
4234
|
+
* Get a namespace. Get the namespace associated with the specified ID.
|
|
4227
4235
|
*
|
|
4228
4236
|
* @param request - The request {@link GetNamespaceRequest}
|
|
4229
4237
|
* @returns A Promise of Namespace
|
|
@@ -4243,7 +4251,7 @@ let API$k = class API extends API$q {
|
|
|
4243
4251
|
waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$2.includes(res.status))), this.getNamespace, request, options);
|
|
4244
4252
|
|
|
4245
4253
|
/**
|
|
4246
|
-
* Create a new namespace.
|
|
4254
|
+
* Create a new namespace. Create a new namespace in a specified region.
|
|
4247
4255
|
*
|
|
4248
4256
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
4249
4257
|
* @returns A Promise of Namespace
|
|
@@ -4256,8 +4264,8 @@ let API$k = class API extends API$q {
|
|
|
4256
4264
|
}, unmarshalNamespace$3);
|
|
4257
4265
|
|
|
4258
4266
|
/**
|
|
4259
|
-
* Update an existing namespace. Update the space associated with the
|
|
4260
|
-
*
|
|
4267
|
+
* Update an existing namespace. Update the space associated with the
|
|
4268
|
+
* specified ID.
|
|
4261
4269
|
*
|
|
4262
4270
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
4263
4271
|
* @returns A Promise of Namespace
|
|
@@ -4271,7 +4279,7 @@ let API$k = class API extends API$q {
|
|
|
4271
4279
|
|
|
4272
4280
|
/**
|
|
4273
4281
|
* Delete an existing namespace. Delete the namespace associated with the
|
|
4274
|
-
*
|
|
4282
|
+
* specified ID.
|
|
4275
4283
|
*
|
|
4276
4284
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
4277
4285
|
* @returns A Promise of Namespace
|
|
@@ -4287,7 +4295,7 @@ let API$k = class API extends API$q {
|
|
|
4287
4295
|
}, unmarshalListContainersResponse);
|
|
4288
4296
|
|
|
4289
4297
|
/**
|
|
4290
|
-
* List all your containers.
|
|
4298
|
+
* List all your containers. List all containers for a specified region.
|
|
4291
4299
|
*
|
|
4292
4300
|
* @param request - The request {@link ListContainersRequest}
|
|
4293
4301
|
* @returns A Promise of ListContainersResponse
|
|
@@ -4295,7 +4303,7 @@ let API$k = class API extends API$q {
|
|
|
4295
4303
|
listContainers = request => enrichForPagination('containers', this.pageOfListContainers, request);
|
|
4296
4304
|
|
|
4297
4305
|
/**
|
|
4298
|
-
* Get a container. Get the container associated with the
|
|
4306
|
+
* Get a container. Get the container associated with the specified ID.
|
|
4299
4307
|
*
|
|
4300
4308
|
* @param request - The request {@link GetContainerRequest}
|
|
4301
4309
|
* @returns A Promise of Container
|
|
@@ -4315,7 +4323,7 @@ let API$k = class API extends API$q {
|
|
|
4315
4323
|
waitForContainer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
|
|
4316
4324
|
|
|
4317
4325
|
/**
|
|
4318
|
-
* Create a new container.
|
|
4326
|
+
* Create a new container. Create a new container in the specified region.
|
|
4319
4327
|
*
|
|
4320
4328
|
* @param request - The request {@link CreateContainerRequest}
|
|
4321
4329
|
* @returns A Promise of Container
|
|
@@ -4329,7 +4337,7 @@ let API$k = class API extends API$q {
|
|
|
4329
4337
|
|
|
4330
4338
|
/**
|
|
4331
4339
|
* Update an existing container. Update the container associated with the
|
|
4332
|
-
*
|
|
4340
|
+
* specified ID.
|
|
4333
4341
|
*
|
|
4334
4342
|
* @param request - The request {@link UpdateContainerRequest}
|
|
4335
4343
|
* @returns A Promise of Container
|
|
@@ -4342,7 +4350,7 @@ let API$k = class API extends API$q {
|
|
|
4342
4350
|
}, unmarshalContainer);
|
|
4343
4351
|
|
|
4344
4352
|
/**
|
|
4345
|
-
* Delete a container. Delete the container associated with the
|
|
4353
|
+
* Delete a container. Delete the container associated with the specified ID.
|
|
4346
4354
|
*
|
|
4347
4355
|
* @param request - The request {@link DeleteContainerRequest}
|
|
4348
4356
|
* @returns A Promise of Container
|
|
@@ -4353,7 +4361,7 @@ let API$k = class API extends API$q {
|
|
|
4353
4361
|
}, unmarshalContainer);
|
|
4354
4362
|
|
|
4355
4363
|
/**
|
|
4356
|
-
* Deploy a container. Deploy a container associated with the
|
|
4364
|
+
* Deploy a container. Deploy a container associated with the specified ID.
|
|
4357
4365
|
*
|
|
4358
4366
|
* @param request - The request {@link DeployContainerRequest}
|
|
4359
4367
|
* @returns A Promise of Container
|
|
@@ -4379,7 +4387,7 @@ let API$k = class API extends API$q {
|
|
|
4379
4387
|
listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
|
|
4380
4388
|
|
|
4381
4389
|
/**
|
|
4382
|
-
* Get a cron. Get the cron associated with the
|
|
4390
|
+
* Get a cron. Get the cron associated with the specified ID.
|
|
4383
4391
|
*
|
|
4384
4392
|
* @param request - The request {@link GetCronRequest}
|
|
4385
4393
|
* @returns A Promise of Cron
|
|
@@ -4412,7 +4420,7 @@ let API$k = class API extends API$q {
|
|
|
4412
4420
|
}, unmarshalCron$1);
|
|
4413
4421
|
|
|
4414
4422
|
/**
|
|
4415
|
-
* Update an existing cron. Update the cron associated with the
|
|
4423
|
+
* Update an existing cron. Update the cron associated with the specified ID.
|
|
4416
4424
|
*
|
|
4417
4425
|
* @param request - The request {@link UpdateCronRequest}
|
|
4418
4426
|
* @returns A Promise of Cron
|
|
@@ -4425,7 +4433,7 @@ let API$k = class API extends API$q {
|
|
|
4425
4433
|
}, unmarshalCron$1);
|
|
4426
4434
|
|
|
4427
4435
|
/**
|
|
4428
|
-
* Delete an existing cron. Delete the cron associated with the
|
|
4436
|
+
* Delete an existing cron. Delete the cron associated with the specified ID.
|
|
4429
4437
|
*
|
|
4430
4438
|
* @param request - The request {@link DeleteCronRequest}
|
|
4431
4439
|
* @returns A Promise of Cron
|
|
@@ -4441,7 +4449,8 @@ let API$k = class API extends API$q {
|
|
|
4441
4449
|
}, unmarshalListLogsResponse$1);
|
|
4442
4450
|
|
|
4443
4451
|
/**
|
|
4444
|
-
* List your container logs.
|
|
4452
|
+
* List your container logs. List the logs of the container with the specified
|
|
4453
|
+
* ID.
|
|
4445
4454
|
*
|
|
4446
4455
|
* @param request - The request {@link ListLogsRequest}
|
|
4447
4456
|
* @returns A Promise of ListLogsResponse
|
|
@@ -4454,7 +4463,8 @@ let API$k = class API extends API$q {
|
|
|
4454
4463
|
}, unmarshalListDomainsResponse$3);
|
|
4455
4464
|
|
|
4456
4465
|
/**
|
|
4457
|
-
* List all domain name bindings.
|
|
4466
|
+
* List all domain name bindings. List all domain name bindings in a specified
|
|
4467
|
+
* region.
|
|
4458
4468
|
*
|
|
4459
4469
|
* @param request - The request {@link ListDomainsRequest}
|
|
4460
4470
|
* @returns A Promise of ListDomainsResponse
|
|
@@ -4462,7 +4472,8 @@ let API$k = class API extends API$q {
|
|
|
4462
4472
|
listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
|
|
4463
4473
|
|
|
4464
4474
|
/**
|
|
4465
|
-
* Get a domain name binding.
|
|
4475
|
+
* Get a domain name binding. Get a domain name binding for the container with
|
|
4476
|
+
* the specified ID.
|
|
4466
4477
|
*
|
|
4467
4478
|
* @param request - The request {@link GetDomainRequest}
|
|
4468
4479
|
* @returns A Promise of Domain
|
|
@@ -4482,7 +4493,8 @@ let API$k = class API extends API$q {
|
|
|
4482
4493
|
waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$3.includes(res.status))), this.getDomain, request, options);
|
|
4483
4494
|
|
|
4484
4495
|
/**
|
|
4485
|
-
* Create a domain name binding.
|
|
4496
|
+
* Create a domain name binding. Create a domain name binding for the
|
|
4497
|
+
* container with the specified ID.
|
|
4486
4498
|
*
|
|
4487
4499
|
* @param request - The request {@link CreateDomainRequest}
|
|
4488
4500
|
* @returns A Promise of Domain
|
|
@@ -4495,7 +4507,8 @@ let API$k = class API extends API$q {
|
|
|
4495
4507
|
}, unmarshalDomain$3);
|
|
4496
4508
|
|
|
4497
4509
|
/**
|
|
4498
|
-
* Delete a domain name binding.
|
|
4510
|
+
* Delete a domain name binding. Delete the domain name binding with the
|
|
4511
|
+
* specific ID.
|
|
4499
4512
|
*
|
|
4500
4513
|
* @param request - The request {@link DeleteDomainRequest}
|
|
4501
4514
|
* @returns A Promise of Domain
|
|
@@ -4536,7 +4549,7 @@ let API$k = class API extends API$q {
|
|
|
4536
4549
|
}, unmarshalToken$1);
|
|
4537
4550
|
|
|
4538
4551
|
/**
|
|
4539
|
-
* Get a token.
|
|
4552
|
+
* Get a token. Get a token with a specified ID.
|
|
4540
4553
|
*
|
|
4541
4554
|
* @param request - The request {@link GetTokenRequest}
|
|
4542
4555
|
* @returns A Promise of Token
|
|
@@ -4561,7 +4574,8 @@ let API$k = class API extends API$q {
|
|
|
4561
4574
|
}, unmarshalListTokensResponse$1);
|
|
4562
4575
|
|
|
4563
4576
|
/**
|
|
4564
|
-
* List all tokens.
|
|
4577
|
+
* List all tokens. List all tokens belonging to a specified Organization or
|
|
4578
|
+
* Project.
|
|
4565
4579
|
*
|
|
4566
4580
|
* @param request - The request {@link ListTokensRequest}
|
|
4567
4581
|
* @returns A Promise of ListTokensResponse
|
|
@@ -4569,7 +4583,7 @@ let API$k = class API extends API$q {
|
|
|
4569
4583
|
listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
|
|
4570
4584
|
|
|
4571
4585
|
/**
|
|
4572
|
-
* Delete a token.
|
|
4586
|
+
* Delete a token. Delete a token with a specified ID.
|
|
4573
4587
|
*
|
|
4574
4588
|
* @param request - The request {@link DeleteTokenRequest}
|
|
4575
4589
|
* @returns A Promise of Token
|
|
@@ -5787,9 +5801,10 @@ const jsonContentHeaders$h = {
|
|
|
5787
5801
|
};
|
|
5788
5802
|
|
|
5789
5803
|
/**
|
|
5790
|
-
* DNS API.
|
|
5804
|
+
* Domains and DNS API.
|
|
5791
5805
|
*
|
|
5792
|
-
* DNS API. Manage your DNS zones and records
|
|
5806
|
+
* Domains and DNS API. Manage your domains, DNS zones and records with the
|
|
5807
|
+
* Domains and DNS API.
|
|
5793
5808
|
*/
|
|
5794
5809
|
let API$j = class API extends API$q {
|
|
5795
5810
|
pageOfListDNSZones = request => this.client.fetch({
|
|
@@ -5799,8 +5814,8 @@ let API$j = class API extends API$q {
|
|
|
5799
5814
|
}, unmarshalListDNSZonesResponse);
|
|
5800
5815
|
|
|
5801
5816
|
/**
|
|
5802
|
-
* List DNS zones.
|
|
5803
|
-
* DNS zones
|
|
5817
|
+
* List DNS zones. Retrieve the list of DNS zones you can manage and filter
|
|
5818
|
+
* DNS zones associated with specific domain names.
|
|
5804
5819
|
*
|
|
5805
5820
|
* @param request - The request {@link ListDNSZonesRequest}
|
|
5806
5821
|
* @returns A Promise of ListDNSZonesResponse
|
|
@@ -5808,7 +5823,8 @@ let API$j = class API extends API$q {
|
|
|
5808
5823
|
listDNSZones = request => enrichForPagination('dnsZones', this.pageOfListDNSZones, request);
|
|
5809
5824
|
|
|
5810
5825
|
/**
|
|
5811
|
-
* Create a DNS zone. Create a new DNS zone
|
|
5826
|
+
* Create a DNS zone. Create a new DNS zone specified by the domain name, the
|
|
5827
|
+
* subdomain and the Project ID.
|
|
5812
5828
|
*
|
|
5813
5829
|
* @param request - The request {@link CreateDNSZoneRequest}
|
|
5814
5830
|
* @returns A Promise of DNSZone
|
|
@@ -5821,7 +5837,7 @@ let API$j = class API extends API$q {
|
|
|
5821
5837
|
}, unmarshalDNSZone);
|
|
5822
5838
|
|
|
5823
5839
|
/**
|
|
5824
|
-
* Update a DNS zone. Update the name and/or the
|
|
5840
|
+
* Update a DNS zone. Update the name and/or the Organizations for a DNS zone.
|
|
5825
5841
|
*
|
|
5826
5842
|
* @param request - The request {@link UpdateDNSZoneRequest}
|
|
5827
5843
|
* @returns A Promise of DNSZone
|
|
@@ -5834,8 +5850,8 @@ let API$j = class API extends API$q {
|
|
|
5834
5850
|
}, unmarshalDNSZone);
|
|
5835
5851
|
|
|
5836
5852
|
/**
|
|
5837
|
-
* Clone a DNS zone. Clone an
|
|
5838
|
-
*
|
|
5853
|
+
* Clone a DNS zone. Clone an existing DNS zone with all its records into a
|
|
5854
|
+
* new DNS zone.
|
|
5839
5855
|
*
|
|
5840
5856
|
* @param request - The request {@link CloneDNSZoneRequest}
|
|
5841
5857
|
* @returns A Promise of DNSZone
|
|
@@ -5848,7 +5864,7 @@ let API$j = class API extends API$q {
|
|
|
5848
5864
|
}, unmarshalDNSZone);
|
|
5849
5865
|
|
|
5850
5866
|
/**
|
|
5851
|
-
* Delete DNS zone. Delete a DNS zone and all
|
|
5867
|
+
* Delete a DNS zone. Delete a DNS zone and all its records.
|
|
5852
5868
|
*
|
|
5853
5869
|
* @param request - The request {@link DeleteDNSZoneRequest}
|
|
5854
5870
|
* @returns A Promise of DeleteDNSZoneResponse
|
|
@@ -5865,8 +5881,9 @@ let API$j = class API extends API$q {
|
|
|
5865
5881
|
}, unmarshalListDNSZoneRecordsResponse);
|
|
5866
5882
|
|
|
5867
5883
|
/**
|
|
5868
|
-
* List DNS zone
|
|
5869
|
-
* default
|
|
5884
|
+
* List records within a DNS zone. Retrieve a list of DNS records within a DNS
|
|
5885
|
+
* zone that has default name servers. You can filter records by type and
|
|
5886
|
+
* name.
|
|
5870
5887
|
*
|
|
5871
5888
|
* @param request - The request {@link ListDNSZoneRecordsRequest}
|
|
5872
5889
|
* @returns A Promise of ListDNSZoneRecordsResponse
|
|
@@ -5874,22 +5891,18 @@ let API$j = class API extends API$q {
|
|
|
5874
5891
|
listDNSZoneRecords = request => enrichForPagination('records', this.pageOfListDNSZoneRecords, request);
|
|
5875
5892
|
|
|
5876
5893
|
/**
|
|
5877
|
-
* Update DNS zone
|
|
5878
|
-
*
|
|
5894
|
+
* Update records within a DNS zone. Update records within a DNS zone that has
|
|
5895
|
+
* default name servers and perform several actions on your records.
|
|
5879
5896
|
*
|
|
5880
|
-
*
|
|
5897
|
+
* Actions include:
|
|
5881
5898
|
*
|
|
5882
|
-
* - Add:
|
|
5883
|
-
*
|
|
5884
|
-
* -
|
|
5885
|
-
*
|
|
5886
|
-
* -
|
|
5887
|
-
*
|
|
5888
|
-
* -
|
|
5889
|
-
* - Delete a record
|
|
5890
|
-
* - Can be more specific and delete an IP from an existing A record for example
|
|
5891
|
-
* - Clear:
|
|
5892
|
-
* - Delete all records from a DNS zone
|
|
5899
|
+
* - Add: allows you to add a new record or add a new IP to an existing A
|
|
5900
|
+
* record, for example
|
|
5901
|
+
* - Set: allows you to edit a record or edit an IP from an existing A record,
|
|
5902
|
+
* for example
|
|
5903
|
+
* - Delete: allows you to delete a record or delete an IP from an existing A
|
|
5904
|
+
* record, for example
|
|
5905
|
+
* - Clear: allows you to delete all records from a DNS zone
|
|
5893
5906
|
*
|
|
5894
5907
|
* All edits will be versioned.
|
|
5895
5908
|
*
|
|
@@ -5904,8 +5917,8 @@ let API$j = class API extends API$q {
|
|
|
5904
5917
|
}, unmarshalUpdateDNSZoneRecordsResponse);
|
|
5905
5918
|
|
|
5906
5919
|
/**
|
|
5907
|
-
* List DNS zone
|
|
5908
|
-
*
|
|
5920
|
+
* List name servers within a DNS zone. Retrieve a list of name servers within
|
|
5921
|
+
* a DNS zone and their optional glue records.
|
|
5909
5922
|
*
|
|
5910
5923
|
* @param request - The request {@link ListDNSZoneNameserversRequest}
|
|
5911
5924
|
* @returns A Promise of ListDNSZoneNameserversResponse
|
|
@@ -5917,8 +5930,8 @@ let API$j = class API extends API$q {
|
|
|
5917
5930
|
}, unmarshalListDNSZoneNameserversResponse);
|
|
5918
5931
|
|
|
5919
5932
|
/**
|
|
5920
|
-
* Update DNS zone
|
|
5921
|
-
* glue records.
|
|
5933
|
+
* Update name servers within a DNS zone. Update name servers within a DNS
|
|
5934
|
+
* zone and set optional glue records.
|
|
5922
5935
|
*
|
|
5923
5936
|
* @param request - The request {@link UpdateDNSZoneNameserversRequest}
|
|
5924
5937
|
* @returns A Promise of UpdateDNSZoneNameserversResponse
|
|
@@ -5931,8 +5944,8 @@ let API$j = class API extends API$q {
|
|
|
5931
5944
|
}, unmarshalUpdateDNSZoneNameserversResponse);
|
|
5932
5945
|
|
|
5933
5946
|
/**
|
|
5934
|
-
* Clear DNS zone
|
|
5935
|
-
*
|
|
5947
|
+
* Clear records within a DNS zone. Delete all records within a DNS zone that
|
|
5948
|
+
* has default name servers.<br/> All edits will be versioned.
|
|
5936
5949
|
*
|
|
5937
5950
|
* @param request - The request {@link ClearDNSZoneRecordsRequest}
|
|
5938
5951
|
* @returns A Promise of ClearDNSZoneRecordsResponse
|
|
@@ -5943,7 +5956,8 @@ let API$j = class API extends API$q {
|
|
|
5943
5956
|
}, unmarshalClearDNSZoneRecordsResponse);
|
|
5944
5957
|
|
|
5945
5958
|
/**
|
|
5946
|
-
* Export raw DNS zone.
|
|
5959
|
+
* Export a raw DNS zone. Export a DNS zone with default name servers, in a
|
|
5960
|
+
* specific format.
|
|
5947
5961
|
*
|
|
5948
5962
|
* @param request - The request {@link ExportRawDNSZoneRequest}
|
|
5949
5963
|
* @returns A Promise of Blob
|
|
@@ -5956,8 +5970,8 @@ let API$j = class API extends API$q {
|
|
|
5956
5970
|
});
|
|
5957
5971
|
|
|
5958
5972
|
/**
|
|
5959
|
-
* Import raw DNS zone. Import and replace records from a
|
|
5960
|
-
*
|
|
5973
|
+
* Import a raw DNS zone. Import and replace the format of records from a
|
|
5974
|
+
* given provider, with default name servers.
|
|
5961
5975
|
*
|
|
5962
5976
|
* @param request - The request {@link ImportRawDNSZoneRequest}
|
|
5963
5977
|
* @returns A Promise of ImportRawDNSZoneResponse
|
|
@@ -5970,8 +5984,8 @@ let API$j = class API extends API$q {
|
|
|
5970
5984
|
}, unmarshalImportRawDNSZoneResponse);
|
|
5971
5985
|
|
|
5972
5986
|
/**
|
|
5973
|
-
* Import
|
|
5974
|
-
*
|
|
5987
|
+
* Import a DNS zone from another provider. Import and replace the format of
|
|
5988
|
+
* records from a given provider, with default name servers.
|
|
5975
5989
|
*
|
|
5976
5990
|
* @param request - The request {@link ImportProviderDNSZoneRequest}
|
|
5977
5991
|
* @returns A Promise of ImportProviderDNSZoneResponse
|
|
@@ -5984,8 +5998,9 @@ let API$j = class API extends API$q {
|
|
|
5984
5998
|
}, unmarshalImportProviderDNSZoneResponse);
|
|
5985
5999
|
|
|
5986
6000
|
/**
|
|
5987
|
-
* Refresh DNS zone. Refresh SOA DNS zone
|
|
5988
|
-
* and
|
|
6001
|
+
* Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
|
|
6002
|
+
* DNS zone and update the SOA serial. You can recreate the given DNS zone and
|
|
6003
|
+
* its sub DNS zone if needed.
|
|
5989
6004
|
*
|
|
5990
6005
|
* @param request - The request {@link RefreshDNSZoneRequest}
|
|
5991
6006
|
* @returns A Promise of RefreshDNSZoneResponse
|
|
@@ -6003,9 +6018,9 @@ let API$j = class API extends API$q {
|
|
|
6003
6018
|
}, unmarshalListDNSZoneVersionsResponse);
|
|
6004
6019
|
|
|
6005
6020
|
/**
|
|
6006
|
-
* List DNS zone
|
|
6007
|
-
* version count is 100
|
|
6008
|
-
* version will be deleted after each new modification.
|
|
6021
|
+
* List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
|
|
6022
|
+
* The maximum version count is 100. If the count reaches this limit, the
|
|
6023
|
+
* oldest version will be deleted after each new modification.
|
|
6009
6024
|
*
|
|
6010
6025
|
* @param request - The request {@link ListDNSZoneVersionsRequest}
|
|
6011
6026
|
* @returns A Promise of ListDNSZoneVersionsResponse
|
|
@@ -6018,8 +6033,8 @@ let API$j = class API extends API$q {
|
|
|
6018
6033
|
}, unmarshalListDNSZoneVersionRecordsResponse);
|
|
6019
6034
|
|
|
6020
6035
|
/**
|
|
6021
|
-
* List
|
|
6022
|
-
* zone version.
|
|
6036
|
+
* List records from a given version of a specific DNS zone. Retrieve a list
|
|
6037
|
+
* of records from a specific DNS zone version.
|
|
6023
6038
|
*
|
|
6024
6039
|
* @param request - The request {@link ListDNSZoneVersionRecordsRequest}
|
|
6025
6040
|
* @returns A Promise of ListDNSZoneVersionRecordsResponse
|
|
@@ -6027,8 +6042,8 @@ let API$j = class API extends API$q {
|
|
|
6027
6042
|
listDNSZoneVersionRecords = request => enrichForPagination('records', this.pageOfListDNSZoneVersionRecords, request);
|
|
6028
6043
|
|
|
6029
6044
|
/**
|
|
6030
|
-
*
|
|
6031
|
-
* version.
|
|
6045
|
+
* Access differences from a specific DNS zone version. Access a previous DNS
|
|
6046
|
+
* zone version to see the differences from another specific version.
|
|
6032
6047
|
*
|
|
6033
6048
|
* @param request - The request {@link GetDNSZoneVersionDiffRequest}
|
|
6034
6049
|
* @returns A Promise of GetDNSZoneVersionDiffResponse
|
|
@@ -6039,7 +6054,8 @@ let API$j = class API extends API$q {
|
|
|
6039
6054
|
}, unmarshalGetDNSZoneVersionDiffResponse);
|
|
6040
6055
|
|
|
6041
6056
|
/**
|
|
6042
|
-
* Restore DNS zone version. Restore and activate a
|
|
6057
|
+
* Restore a DNS zone version. Restore and activate a version of a specific
|
|
6058
|
+
* DNS zone.
|
|
6043
6059
|
*
|
|
6044
6060
|
* @param request - The request {@link RestoreDNSZoneVersionRequest}
|
|
6045
6061
|
* @returns A Promise of RestoreDNSZoneVersionResponse
|
|
@@ -6052,7 +6068,8 @@ let API$j = class API extends API$q {
|
|
|
6052
6068
|
}, unmarshalRestoreDNSZoneVersionResponse);
|
|
6053
6069
|
|
|
6054
6070
|
/**
|
|
6055
|
-
* Get
|
|
6071
|
+
* Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
|
|
6072
|
+
* you do not have a certificate, the ouptut returns `no certificate found`.
|
|
6056
6073
|
*
|
|
6057
6074
|
* @param request - The request {@link GetSSLCertificateRequest}
|
|
6058
6075
|
* @returns A Promise of SSLCertificate
|
|
@@ -6072,7 +6089,8 @@ let API$j = class API extends API$q {
|
|
|
6072
6089
|
waitForSSLCertificate = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SSL_CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getSSLCertificate, request, options);
|
|
6073
6090
|
|
|
6074
6091
|
/**
|
|
6075
|
-
* Create or
|
|
6092
|
+
* Create or get the DNS zone's TLS certificate. Create a new TLS certificate
|
|
6093
|
+
* or retrieve information about an existing TLS certificate.
|
|
6076
6094
|
*
|
|
6077
6095
|
* @param request - The request {@link CreateSSLCertificateRequest}
|
|
6078
6096
|
* @returns A Promise of SSLCertificate
|
|
@@ -6090,7 +6108,8 @@ let API$j = class API extends API$q {
|
|
|
6090
6108
|
}, unmarshalListSSLCertificatesResponse);
|
|
6091
6109
|
|
|
6092
6110
|
/**
|
|
6093
|
-
* List
|
|
6111
|
+
* List a user's TLS certificates. List all the TLS certificates a user has
|
|
6112
|
+
* created, specified by the user's Project ID and the DNS zone.
|
|
6094
6113
|
*
|
|
6095
6114
|
* @param request - The request {@link ListSSLCertificatesRequest}
|
|
6096
6115
|
* @returns A Promise of ListSSLCertificatesResponse
|
|
@@ -6098,7 +6117,9 @@ let API$j = class API extends API$q {
|
|
|
6098
6117
|
listSSLCertificates = request => enrichForPagination('certificates', this.pageOfListSSLCertificates, request);
|
|
6099
6118
|
|
|
6100
6119
|
/**
|
|
6101
|
-
* Delete an TLS certificate
|
|
6120
|
+
* Delete a TLS certificate. Delete an existing TLS certificate specified by
|
|
6121
|
+
* its DNS zone. Deleting a TLS certificate is permanent and cannot be
|
|
6122
|
+
* undone.
|
|
6102
6123
|
*
|
|
6103
6124
|
* @param request - The request {@link DeleteSSLCertificateRequest}
|
|
6104
6125
|
* @returns A Promise of DeleteSSLCertificateResponse
|
|
@@ -6109,7 +6130,8 @@ let API$j = class API extends API$q {
|
|
|
6109
6130
|
}, unmarshalDeleteSSLCertificateResponse);
|
|
6110
6131
|
|
|
6111
6132
|
/**
|
|
6112
|
-
* Get the DNS zone TSIG
|
|
6133
|
+
* Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
|
|
6134
|
+
* given DNS zone to allow AXFR requests.
|
|
6113
6135
|
*
|
|
6114
6136
|
* @param request - The request {@link GetDNSZoneTsigKeyRequest}
|
|
6115
6137
|
* @returns A Promise of GetDNSZoneTsigKeyResponse
|
|
@@ -6120,7 +6142,8 @@ let API$j = class API extends API$q {
|
|
|
6120
6142
|
}, unmarshalGetDNSZoneTsigKeyResponse);
|
|
6121
6143
|
|
|
6122
6144
|
/**
|
|
6123
|
-
* Delete the DNS zone TSIG
|
|
6145
|
+
* Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
|
|
6146
|
+
* its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
|
|
6124
6147
|
*
|
|
6125
6148
|
* @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
|
|
6126
6149
|
*/
|
|
@@ -6662,13 +6685,14 @@ const jsonContentHeaders$g = {
|
|
|
6662
6685
|
'Content-Type': 'application/json; charset=utf-8'
|
|
6663
6686
|
};
|
|
6664
6687
|
|
|
6665
|
-
/** Flexible IP API. */
|
|
6688
|
+
/** Elastic Metal - Flexible IP API. */
|
|
6666
6689
|
let API$i = class API extends API$q {
|
|
6667
6690
|
/** Lists the available zones of the API. */
|
|
6668
6691
|
static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
|
|
6669
6692
|
|
|
6670
6693
|
/**
|
|
6671
|
-
* Create a
|
|
6694
|
+
* Create a new flexible IP. Generate a new flexible IP within a given zone,
|
|
6695
|
+
* specifying its configuration including Project ID and description.
|
|
6672
6696
|
*
|
|
6673
6697
|
* @param request - The request {@link CreateFlexibleIPRequest}
|
|
6674
6698
|
* @returns A Promise of FlexibleIP
|
|
@@ -6681,7 +6705,9 @@ let API$i = class API extends API$q {
|
|
|
6681
6705
|
}, unmarshalFlexibleIP);
|
|
6682
6706
|
|
|
6683
6707
|
/**
|
|
6684
|
-
* Get
|
|
6708
|
+
* Get an existing flexible IP. Retrieve information about an existing
|
|
6709
|
+
* flexible IP, specified by its ID and zone. Its full details, including
|
|
6710
|
+
* Project ID, description and status, are returned in the response object.
|
|
6685
6711
|
*
|
|
6686
6712
|
* @param request - The request {@link GetFlexibleIPRequest}
|
|
6687
6713
|
* @returns A Promise of FlexibleIP
|
|
@@ -6706,7 +6732,7 @@ let API$i = class API extends API$q {
|
|
|
6706
6732
|
}, unmarshalListFlexibleIPsResponse);
|
|
6707
6733
|
|
|
6708
6734
|
/**
|
|
6709
|
-
* List
|
|
6735
|
+
* List flexible IPs. List all flexible IPs within a given zone.
|
|
6710
6736
|
*
|
|
6711
6737
|
* @param request - The request {@link ListFlexibleIPsRequest}
|
|
6712
6738
|
* @returns A Promise of ListFlexibleIPsResponse
|
|
@@ -6714,7 +6740,9 @@ let API$i = class API extends API$q {
|
|
|
6714
6740
|
listFlexibleIPs = (request = {}) => enrichForPagination('flexibleIps', this.pageOfListFlexibleIPs, request);
|
|
6715
6741
|
|
|
6716
6742
|
/**
|
|
6717
|
-
* Update
|
|
6743
|
+
* Update an existing flexible IP. Update the parameters of an existing
|
|
6744
|
+
* flexible IP, specified by its ID and zone. These parameters include tags
|
|
6745
|
+
* and description.
|
|
6718
6746
|
*
|
|
6719
6747
|
* @param request - The request {@link UpdateFlexibleIPRequest}
|
|
6720
6748
|
* @returns A Promise of FlexibleIP
|
|
@@ -6727,7 +6755,9 @@ let API$i = class API extends API$q {
|
|
|
6727
6755
|
}, unmarshalFlexibleIP);
|
|
6728
6756
|
|
|
6729
6757
|
/**
|
|
6730
|
-
* Delete
|
|
6758
|
+
* Delete an existing flexible IP. Delete an existing flexible IP, specified
|
|
6759
|
+
* by its ID and zone. Note that deleting a flexible IP is permanent and
|
|
6760
|
+
* cannot be undone.
|
|
6731
6761
|
*
|
|
6732
6762
|
* @param request - The request {@link DeleteFlexibleIPRequest}
|
|
6733
6763
|
*/
|
|
@@ -6737,7 +6767,8 @@ let API$i = class API extends API$q {
|
|
|
6737
6767
|
});
|
|
6738
6768
|
|
|
6739
6769
|
/**
|
|
6740
|
-
* Attach
|
|
6770
|
+
* Attach an existing flexible IP to a server. Attach an existing flexible IP
|
|
6771
|
+
* to a specified Elastic Metal server.
|
|
6741
6772
|
*
|
|
6742
6773
|
* @param request - The request {@link AttachFlexibleIPRequest}
|
|
6743
6774
|
* @returns A Promise of AttachFlexibleIPsResponse
|
|
@@ -6750,7 +6781,8 @@ let API$i = class API extends API$q {
|
|
|
6750
6781
|
}, unmarshalAttachFlexibleIPsResponse);
|
|
6751
6782
|
|
|
6752
6783
|
/**
|
|
6753
|
-
* Detach
|
|
6784
|
+
* Detach an existing flexible IP from a server. Detach an existing flexible
|
|
6785
|
+
* IP from a specified Elastic Metal server.
|
|
6754
6786
|
*
|
|
6755
6787
|
* @param request - The request {@link DetachFlexibleIPRequest}
|
|
6756
6788
|
* @returns A Promise of DetachFlexibleIPsResponse
|
|
@@ -6763,7 +6795,8 @@ let API$i = class API extends API$q {
|
|
|
6763
6795
|
}, unmarshalDetachFlexibleIPsResponse);
|
|
6764
6796
|
|
|
6765
6797
|
/**
|
|
6766
|
-
* Generate a virtual MAC on
|
|
6798
|
+
* Generate a virtual MAC address on an existing flexible IP. Generate a
|
|
6799
|
+
* virtual MAC (Media Access Control) address on an existing flexible IP.
|
|
6767
6800
|
*
|
|
6768
6801
|
* @param request - The request {@link GenerateMACAddrRequest}
|
|
6769
6802
|
* @returns A Promise of FlexibleIP
|
|
@@ -6776,8 +6809,9 @@ let API$i = class API extends API$q {
|
|
|
6776
6809
|
}, unmarshalFlexibleIP);
|
|
6777
6810
|
|
|
6778
6811
|
/**
|
|
6779
|
-
* Duplicate a
|
|
6780
|
-
*
|
|
6812
|
+
* Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
|
|
6813
|
+
* MAC address from a given flexible IP to another flexible IP attached to the
|
|
6814
|
+
* same server.
|
|
6781
6815
|
*
|
|
6782
6816
|
* @param request - The request {@link DuplicateMACAddrRequest}
|
|
6783
6817
|
* @returns A Promise of FlexibleIP
|
|
@@ -6790,8 +6824,9 @@ let API$i = class API extends API$q {
|
|
|
6790
6824
|
}, unmarshalFlexibleIP);
|
|
6791
6825
|
|
|
6792
6826
|
/**
|
|
6793
|
-
*
|
|
6794
|
-
*
|
|
6827
|
+
* Relocate an existing virtual MAC address to a different flexible IP.
|
|
6828
|
+
* Relocate a virtual MAC (Media Access Control) address from an existing
|
|
6829
|
+
* flexible IP to a different flexible IP.
|
|
6795
6830
|
*
|
|
6796
6831
|
* @param request - The request {@link MoveMACAddrRequest}
|
|
6797
6832
|
* @returns A Promise of FlexibleIP
|
|
@@ -6804,7 +6839,8 @@ let API$i = class API extends API$q {
|
|
|
6804
6839
|
}, unmarshalFlexibleIP);
|
|
6805
6840
|
|
|
6806
6841
|
/**
|
|
6807
|
-
*
|
|
6842
|
+
* Detach a given virtual MAC address from an existing flexible IP. Detach a
|
|
6843
|
+
* given MAC (Media Access Control) address from an existing flexible IP.
|
|
6808
6844
|
*
|
|
6809
6845
|
* @param request - The request {@link DeleteMACAddrRequest}
|
|
6810
6846
|
*/
|
|
@@ -6944,6 +6980,7 @@ const unmarshalFunction = data => {
|
|
|
6944
6980
|
throw new TypeError(`Unmarshalling the type 'Function' failed as data isn't a dictionary.`);
|
|
6945
6981
|
}
|
|
6946
6982
|
return {
|
|
6983
|
+
buildMessage: data.build_message,
|
|
6947
6984
|
cpuLimit: data.cpu_limit,
|
|
6948
6985
|
description: data.description,
|
|
6949
6986
|
domainName: data.domain_name,
|
|
@@ -7275,7 +7312,8 @@ let API$h = class API extends API$q {
|
|
|
7275
7312
|
}, unmarshalListNamespacesResponse$2);
|
|
7276
7313
|
|
|
7277
7314
|
/**
|
|
7278
|
-
* List all your namespaces.
|
|
7315
|
+
* List all your namespaces. List all existing namespaces in the specified
|
|
7316
|
+
* region.
|
|
7279
7317
|
*
|
|
7280
7318
|
* @param request - The request {@link ListNamespacesRequest}
|
|
7281
7319
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -7283,7 +7321,7 @@ let API$h = class API extends API$q {
|
|
|
7283
7321
|
listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
|
|
7284
7322
|
|
|
7285
7323
|
/**
|
|
7286
|
-
* Get a namespace. Get the namespace associated with the
|
|
7324
|
+
* Get a namespace. Get the namespace associated with the specified ID.
|
|
7287
7325
|
*
|
|
7288
7326
|
* @param request - The request {@link GetNamespaceRequest}
|
|
7289
7327
|
* @returns A Promise of Namespace
|
|
@@ -7303,7 +7341,8 @@ let API$h = class API extends API$q {
|
|
|
7303
7341
|
waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES$1.includes(res.status))), this.getNamespace, request, options);
|
|
7304
7342
|
|
|
7305
7343
|
/**
|
|
7306
|
-
* Create a new namespace.
|
|
7344
|
+
* Create a new namespace. Create a new namespace in a specified Organization
|
|
7345
|
+
* or Proejct.
|
|
7307
7346
|
*
|
|
7308
7347
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
7309
7348
|
* @returns A Promise of Namespace
|
|
@@ -7316,8 +7355,8 @@ let API$h = class API extends API$q {
|
|
|
7316
7355
|
}, unmarshalNamespace$2);
|
|
7317
7356
|
|
|
7318
7357
|
/**
|
|
7319
|
-
* Update an existing namespace. Update the
|
|
7320
|
-
*
|
|
7358
|
+
* Update an existing namespace. Update the namespace associated with the
|
|
7359
|
+
* specified ID.
|
|
7321
7360
|
*
|
|
7322
7361
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
7323
7362
|
* @returns A Promise of Namespace
|
|
@@ -7331,7 +7370,7 @@ let API$h = class API extends API$q {
|
|
|
7331
7370
|
|
|
7332
7371
|
/**
|
|
7333
7372
|
* Delete an existing namespace. Delete the namespace associated with the
|
|
7334
|
-
*
|
|
7373
|
+
* specified ID.
|
|
7335
7374
|
*
|
|
7336
7375
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
7337
7376
|
* @returns A Promise of Namespace
|
|
@@ -7355,7 +7394,7 @@ let API$h = class API extends API$q {
|
|
|
7355
7394
|
listFunctions = request => enrichForPagination('functions', this.pageOfListFunctions, request);
|
|
7356
7395
|
|
|
7357
7396
|
/**
|
|
7358
|
-
* Get a function. Get the function associated with the
|
|
7397
|
+
* Get a function. Get the function associated with the specified ID.
|
|
7359
7398
|
*
|
|
7360
7399
|
* @param request - The request {@link GetFunctionRequest}
|
|
7361
7400
|
* @returns A Promise of Function
|
|
@@ -7375,7 +7414,8 @@ let API$h = class API extends API$q {
|
|
|
7375
7414
|
waitForFunction = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!FUNCTION_TRANSIENT_STATUSES.includes(res.status))), this.getFunction, request, options);
|
|
7376
7415
|
|
|
7377
7416
|
/**
|
|
7378
|
-
* Create a new function.
|
|
7417
|
+
* Create a new function. Create a new function in the specified region for a
|
|
7418
|
+
* specified Organization or Project.
|
|
7379
7419
|
*
|
|
7380
7420
|
* @param request - The request {@link CreateFunctionRequest}
|
|
7381
7421
|
* @returns A Promise of Function
|
|
@@ -7388,8 +7428,8 @@ let API$h = class API extends API$q {
|
|
|
7388
7428
|
}, unmarshalFunction);
|
|
7389
7429
|
|
|
7390
7430
|
/**
|
|
7391
|
-
* Update an existing function. Update the function associated with the
|
|
7392
|
-
*
|
|
7431
|
+
* Update an existing function. Update the function associated with the
|
|
7432
|
+
* specified ID.
|
|
7393
7433
|
*
|
|
7394
7434
|
* @param request - The request {@link UpdateFunctionRequest}
|
|
7395
7435
|
* @returns A Promise of Function
|
|
@@ -7402,7 +7442,7 @@ let API$h = class API extends API$q {
|
|
|
7402
7442
|
}, unmarshalFunction);
|
|
7403
7443
|
|
|
7404
7444
|
/**
|
|
7405
|
-
* Delete a function. Delete the function associated with the
|
|
7445
|
+
* Delete a function. Delete the function associated with the specified ID.
|
|
7406
7446
|
*
|
|
7407
7447
|
* @param request - The request {@link DeleteFunctionRequest}
|
|
7408
7448
|
* @returns A Promise of Function
|
|
@@ -7413,7 +7453,7 @@ let API$h = class API extends API$q {
|
|
|
7413
7453
|
}, unmarshalFunction);
|
|
7414
7454
|
|
|
7415
7455
|
/**
|
|
7416
|
-
* Deploy a function. Deploy a function associated with the
|
|
7456
|
+
* Deploy a function. Deploy a function associated with the specified ID.
|
|
7417
7457
|
*
|
|
7418
7458
|
* @param request - The request {@link DeployFunctionRequest}
|
|
7419
7459
|
* @returns A Promise of Function
|
|
@@ -7438,7 +7478,7 @@ let API$h = class API extends API$q {
|
|
|
7438
7478
|
|
|
7439
7479
|
/**
|
|
7440
7480
|
* Get an upload URL of a function. Get an upload URL of a function associated
|
|
7441
|
-
* with the
|
|
7481
|
+
* with the specified ID.
|
|
7442
7482
|
*
|
|
7443
7483
|
* @param request - The request {@link GetFunctionUploadURLRequest}
|
|
7444
7484
|
* @returns A Promise of UploadURL
|
|
@@ -7451,7 +7491,7 @@ let API$h = class API extends API$q {
|
|
|
7451
7491
|
|
|
7452
7492
|
/**
|
|
7453
7493
|
* Get a download URL of a function. Get a download URL for a function
|
|
7454
|
-
* associated with the
|
|
7494
|
+
* associated with the specified ID.
|
|
7455
7495
|
*
|
|
7456
7496
|
* @param request - The request {@link GetFunctionDownloadURLRequest}
|
|
7457
7497
|
* @returns A Promise of DownloadURL
|
|
@@ -7467,7 +7507,7 @@ let API$h = class API extends API$q {
|
|
|
7467
7507
|
}, unmarshalListCronsResponse);
|
|
7468
7508
|
|
|
7469
7509
|
/**
|
|
7470
|
-
* List all
|
|
7510
|
+
* List all crons. List all the cronjobs in a specified region.
|
|
7471
7511
|
*
|
|
7472
7512
|
* @param request - The request {@link ListCronsRequest}
|
|
7473
7513
|
* @returns A Promise of ListCronsResponse
|
|
@@ -7475,7 +7515,7 @@ let API$h = class API extends API$q {
|
|
|
7475
7515
|
listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
|
|
7476
7516
|
|
|
7477
7517
|
/**
|
|
7478
|
-
* Get a cron. Get the cron associated with the
|
|
7518
|
+
* Get a cron. Get the cron associated with the specified ID.
|
|
7479
7519
|
*
|
|
7480
7520
|
* @param request - The request {@link GetCronRequest}
|
|
7481
7521
|
* @returns A Promise of Cron
|
|
@@ -7495,7 +7535,8 @@ let API$h = class API extends API$q {
|
|
|
7495
7535
|
waitForCron = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
|
|
7496
7536
|
|
|
7497
7537
|
/**
|
|
7498
|
-
* Create a new cron.
|
|
7538
|
+
* Create a new cron. Create a new cronjob for a function with the specified
|
|
7539
|
+
* ID.
|
|
7499
7540
|
*
|
|
7500
7541
|
* @param request - The request {@link CreateCronRequest}
|
|
7501
7542
|
* @returns A Promise of Cron
|
|
@@ -7508,7 +7549,7 @@ let API$h = class API extends API$q {
|
|
|
7508
7549
|
}, unmarshalCron);
|
|
7509
7550
|
|
|
7510
7551
|
/**
|
|
7511
|
-
* Update an existing cron. Update the cron associated with the
|
|
7552
|
+
* Update an existing cron. Update the cron associated with the specified ID.
|
|
7512
7553
|
*
|
|
7513
7554
|
* @param request - The request {@link UpdateCronRequest}
|
|
7514
7555
|
* @returns A Promise of Cron
|
|
@@ -7521,7 +7562,7 @@ let API$h = class API extends API$q {
|
|
|
7521
7562
|
}, unmarshalCron);
|
|
7522
7563
|
|
|
7523
7564
|
/**
|
|
7524
|
-
* Delete an existing cron. Delete the cron associated with the
|
|
7565
|
+
* Delete an existing cron. Delete the cron associated with the specified ID.
|
|
7525
7566
|
*
|
|
7526
7567
|
* @param request - The request {@link DeleteCronRequest}
|
|
7527
7568
|
* @returns A Promise of Cron
|
|
@@ -7537,7 +7578,8 @@ let API$h = class API extends API$q {
|
|
|
7537
7578
|
}, unmarshalListLogsResponse);
|
|
7538
7579
|
|
|
7539
7580
|
/**
|
|
7540
|
-
* List
|
|
7581
|
+
* List application logs. List the application logs of the function with the
|
|
7582
|
+
* specified ID.
|
|
7541
7583
|
*
|
|
7542
7584
|
* @param request - The request {@link ListLogsRequest}
|
|
7543
7585
|
* @returns A Promise of ListLogsResponse
|
|
@@ -7550,7 +7592,8 @@ let API$h = class API extends API$q {
|
|
|
7550
7592
|
}, unmarshalListDomainsResponse$1);
|
|
7551
7593
|
|
|
7552
7594
|
/**
|
|
7553
|
-
* List all domain name bindings.
|
|
7595
|
+
* List all domain name bindings. List all domain name bindings in a specified
|
|
7596
|
+
* region.
|
|
7554
7597
|
*
|
|
7555
7598
|
* @param request - The request {@link ListDomainsRequest}
|
|
7556
7599
|
* @returns A Promise of ListDomainsResponse
|
|
@@ -7558,7 +7601,8 @@ let API$h = class API extends API$q {
|
|
|
7558
7601
|
listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
|
|
7559
7602
|
|
|
7560
7603
|
/**
|
|
7561
|
-
* Get a domain name binding.
|
|
7604
|
+
* Get a domain name binding. Get a domain name binding for the function with
|
|
7605
|
+
* the specified ID.
|
|
7562
7606
|
*
|
|
7563
7607
|
* @param request - The request {@link GetDomainRequest}
|
|
7564
7608
|
* @returns A Promise of Domain
|
|
@@ -7578,7 +7622,8 @@ let API$h = class API extends API$q {
|
|
|
7578
7622
|
waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES$1.includes(res.status))), this.getDomain, request, options);
|
|
7579
7623
|
|
|
7580
7624
|
/**
|
|
7581
|
-
* Create a domain name binding.
|
|
7625
|
+
* Create a domain name binding. Create a domain name binding for the function
|
|
7626
|
+
* with the specified ID.
|
|
7582
7627
|
*
|
|
7583
7628
|
* @param request - The request {@link CreateDomainRequest}
|
|
7584
7629
|
* @returns A Promise of Domain
|
|
@@ -7591,7 +7636,8 @@ let API$h = class API extends API$q {
|
|
|
7591
7636
|
}, unmarshalDomain$1);
|
|
7592
7637
|
|
|
7593
7638
|
/**
|
|
7594
|
-
* Delete a domain name binding.
|
|
7639
|
+
* Delete a domain name binding. Delete a domain name binding for the function
|
|
7640
|
+
* with the specified ID.
|
|
7595
7641
|
*
|
|
7596
7642
|
* @param request - The request {@link DeleteDomainRequest}
|
|
7597
7643
|
* @returns A Promise of Domain
|
|
@@ -7885,6 +7931,7 @@ const unmarshalUser$1 = data => {
|
|
|
7885
7931
|
email: data.email,
|
|
7886
7932
|
id: data.id,
|
|
7887
7933
|
lastLoginAt: unmarshalDate(data.last_login_at),
|
|
7934
|
+
mfa: data.mfa,
|
|
7888
7935
|
organizationId: data.organization_id,
|
|
7889
7936
|
status: data.status,
|
|
7890
7937
|
twoFactorEnabled: data.two_factor_enabled,
|
|
@@ -8185,7 +8232,7 @@ let API$g = class API extends API$q {
|
|
|
8185
8232
|
pageOfListUsers = (request = {}) => this.client.fetch({
|
|
8186
8233
|
method: 'GET',
|
|
8187
8234
|
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])
|
|
8235
|
+
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
8236
|
}, unmarshalListUsersResponse$1);
|
|
8190
8237
|
|
|
8191
8238
|
/**
|
|
@@ -8203,8 +8250,7 @@ let API$g = class API extends API$q {
|
|
|
8203
8250
|
/**
|
|
8204
8251
|
* Get a given user. Retrieve information about a user, specified by the
|
|
8205
8252
|
* `user_id` parameter. The user's full details, including `id`, `email`,
|
|
8206
|
-
* `organization_id`, `status` and `
|
|
8207
|
-
* response.
|
|
8253
|
+
* `organization_id`, `status` and `mfa` are returned in the response.
|
|
8208
8254
|
*
|
|
8209
8255
|
* @param request - The request {@link GetUserRequest}
|
|
8210
8256
|
* @returns A Promise of User
|
|
@@ -10316,7 +10362,7 @@ let API$f = class API extends API$q {
|
|
|
10316
10362
|
}, unmarshalListServersTypesResponse);
|
|
10317
10363
|
|
|
10318
10364
|
/**
|
|
10319
|
-
* List
|
|
10365
|
+
* List volume types. List all volume types and their technical details.
|
|
10320
10366
|
*
|
|
10321
10367
|
* @param request - The request {@link ListVolumesTypesRequest}
|
|
10322
10368
|
* @returns A Promise of ListVolumesTypesResponse
|
|
@@ -10405,7 +10451,7 @@ let API$f = class API extends API$q {
|
|
|
10405
10451
|
* preserve your local volumes, you should use the `archive` action instead of
|
|
10406
10452
|
* `terminate`. Similarly, if you want to keep your block storage volumes, you
|
|
10407
10453
|
* must first detach them before issuing the `terminate` command. For more
|
|
10408
|
-
* information, read the [Volumes](#volumes-
|
|
10454
|
+
* information, read the [Volumes](#path-volumes-list-volumes) documentation.
|
|
10409
10455
|
*
|
|
10410
10456
|
* @param request - The request {@link ServerActionRequest}
|
|
10411
10457
|
* @returns A Promise of ServerActionResponse
|
|
@@ -11942,9 +11988,9 @@ const jsonContentHeaders$c = {
|
|
|
11942
11988
|
};
|
|
11943
11989
|
|
|
11944
11990
|
/**
|
|
11945
|
-
* IoT API.
|
|
11991
|
+
* IoT Hub API.
|
|
11946
11992
|
*
|
|
11947
|
-
* This API allows you to manage IoT hubs and devices. IoT API.
|
|
11993
|
+
* This API allows you to manage IoT hubs and devices. IoT Hub API.
|
|
11948
11994
|
*/
|
|
11949
11995
|
let API$e = class API extends API$q {
|
|
11950
11996
|
/** Lists the available regions of the API. */
|
|
@@ -11956,7 +12002,9 @@ let API$e = class API extends API$q {
|
|
|
11956
12002
|
}, unmarshalListHubsResponse);
|
|
11957
12003
|
|
|
11958
12004
|
/**
|
|
11959
|
-
* List hubs.
|
|
12005
|
+
* List hubs. List all Hubs in the specified zone. By default, returned Hubs
|
|
12006
|
+
* are ordered by creation date in ascending order, though this can be
|
|
12007
|
+
* modified via the `order_by` field.
|
|
11960
12008
|
*
|
|
11961
12009
|
* @param request - The request {@link ListHubsRequest}
|
|
11962
12010
|
* @returns A Promise of ListHubsResponse
|
|
@@ -11964,7 +12012,8 @@ let API$e = class API extends API$q {
|
|
|
11964
12012
|
listHubs = (request = {}) => enrichForPagination('hubs', this.pageOfListHubs, request);
|
|
11965
12013
|
|
|
11966
12014
|
/**
|
|
11967
|
-
* Create a hub.
|
|
12015
|
+
* Create a hub. Create a new Hub in the targeted region, specifying its
|
|
12016
|
+
* configuration including name and product plan.
|
|
11968
12017
|
*
|
|
11969
12018
|
* @param request - The request {@link CreateHubRequest}
|
|
11970
12019
|
* @returns A Promise of Hub
|
|
@@ -11977,7 +12026,9 @@ let API$e = class API extends API$q {
|
|
|
11977
12026
|
}, unmarshalHub);
|
|
11978
12027
|
|
|
11979
12028
|
/**
|
|
11980
|
-
* Get a hub.
|
|
12029
|
+
* Get a hub. Retrieve information about an existing IoT Hub, specified by its
|
|
12030
|
+
* Hub ID. Its full details, including name, status and endpoint, are returned
|
|
12031
|
+
* in the response object.
|
|
11981
12032
|
*
|
|
11982
12033
|
* @param request - The request {@link GetHubRequest}
|
|
11983
12034
|
* @returns A Promise of Hub
|
|
@@ -11997,7 +12048,8 @@ let API$e = class API extends API$q {
|
|
|
11997
12048
|
waitForHub = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
|
|
11998
12049
|
|
|
11999
12050
|
/**
|
|
12000
|
-
* Update a hub.
|
|
12051
|
+
* Update a hub. Update the parameters of an existing IoT Hub, specified by
|
|
12052
|
+
* its Hub ID.
|
|
12001
12053
|
*
|
|
12002
12054
|
* @param request - The request {@link UpdateHubRequest}
|
|
12003
12055
|
* @returns A Promise of Hub
|
|
@@ -12010,7 +12062,7 @@ let API$e = class API extends API$q {
|
|
|
12010
12062
|
}, unmarshalHub);
|
|
12011
12063
|
|
|
12012
12064
|
/**
|
|
12013
|
-
* Enable a hub.
|
|
12065
|
+
* Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
|
|
12014
12066
|
*
|
|
12015
12067
|
* @param request - The request {@link EnableHubRequest}
|
|
12016
12068
|
* @returns A Promise of Hub
|
|
@@ -12023,7 +12075,7 @@ let API$e = class API extends API$q {
|
|
|
12023
12075
|
}, unmarshalHub);
|
|
12024
12076
|
|
|
12025
12077
|
/**
|
|
12026
|
-
* Disable a hub.
|
|
12078
|
+
* Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
|
|
12027
12079
|
*
|
|
12028
12080
|
* @param request - The request {@link DisableHubRequest}
|
|
12029
12081
|
* @returns A Promise of Hub
|
|
@@ -12036,7 +12088,8 @@ let API$e = class API extends API$q {
|
|
|
12036
12088
|
}, unmarshalHub);
|
|
12037
12089
|
|
|
12038
12090
|
/**
|
|
12039
|
-
* Delete a hub.
|
|
12091
|
+
* Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
|
|
12092
|
+
* a Hub is permanent, and cannot be undone.
|
|
12040
12093
|
*
|
|
12041
12094
|
* @param request - The request {@link DeleteHubRequest}
|
|
12042
12095
|
*/
|
|
@@ -12047,7 +12100,8 @@ let API$e = class API extends API$q {
|
|
|
12047
12100
|
});
|
|
12048
12101
|
|
|
12049
12102
|
/**
|
|
12050
|
-
* Get a hub's metrics.
|
|
12103
|
+
* Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
|
|
12104
|
+
* its Hub ID.
|
|
12051
12105
|
*
|
|
12052
12106
|
* @deprecated
|
|
12053
12107
|
* @param request - The request {@link GetHubMetricsRequest}
|
|
@@ -12060,7 +12114,8 @@ let API$e = class API extends API$q {
|
|
|
12060
12114
|
}, unmarshalGetHubMetricsResponse);
|
|
12061
12115
|
|
|
12062
12116
|
/**
|
|
12063
|
-
* Set the certificate authority of a hub.
|
|
12117
|
+
* Set the certificate authority of a hub. Set a particular PEM-encoded
|
|
12118
|
+
* certificate, specified by the Hub ID.
|
|
12064
12119
|
*
|
|
12065
12120
|
* @param request - The request {@link SetHubCARequest}
|
|
12066
12121
|
* @returns A Promise of Hub
|
|
@@ -12073,7 +12128,8 @@ let API$e = class API extends API$q {
|
|
|
12073
12128
|
}, unmarshalHub);
|
|
12074
12129
|
|
|
12075
12130
|
/**
|
|
12076
|
-
* Get the certificate authority of a hub.
|
|
12131
|
+
* Get the certificate authority of a hub. Get information for a particular
|
|
12132
|
+
* PEM-encoded certificate, specified by the Hub ID.
|
|
12077
12133
|
*
|
|
12078
12134
|
* @param request - The request {@link GetHubCARequest}
|
|
12079
12135
|
* @returns A Promise of GetHubCAResponse
|
|
@@ -12089,7 +12145,9 @@ let API$e = class API extends API$q {
|
|
|
12089
12145
|
}, unmarshalListDevicesResponse);
|
|
12090
12146
|
|
|
12091
12147
|
/**
|
|
12092
|
-
* List devices.
|
|
12148
|
+
* List devices. List all devices in the specified region. By default,
|
|
12149
|
+
* returned devices are ordered by creation date in ascending order, though
|
|
12150
|
+
* this can be modified via the `order_by` field.
|
|
12093
12151
|
*
|
|
12094
12152
|
* @param request - The request {@link ListDevicesRequest}
|
|
12095
12153
|
* @returns A Promise of ListDevicesResponse
|
|
@@ -12097,7 +12155,7 @@ let API$e = class API extends API$q {
|
|
|
12097
12155
|
listDevices = (request = {}) => enrichForPagination('devices', this.pageOfListDevices, request);
|
|
12098
12156
|
|
|
12099
12157
|
/**
|
|
12100
|
-
* Add a device.
|
|
12158
|
+
* Add a device. Attach a device to a given Hub.
|
|
12101
12159
|
*
|
|
12102
12160
|
* @param request - The request {@link CreateDeviceRequest}
|
|
12103
12161
|
* @returns A Promise of CreateDeviceResponse
|
|
@@ -12110,7 +12168,9 @@ let API$e = class API extends API$q {
|
|
|
12110
12168
|
}, unmarshalCreateDeviceResponse);
|
|
12111
12169
|
|
|
12112
12170
|
/**
|
|
12113
|
-
* Get a device.
|
|
12171
|
+
* Get a device. Retrieve information about an existing device, specified by
|
|
12172
|
+
* its device ID. Its full details, including name, status and ID, are
|
|
12173
|
+
* returned in the response object.
|
|
12114
12174
|
*
|
|
12115
12175
|
* @param request - The request {@link GetDeviceRequest}
|
|
12116
12176
|
* @returns A Promise of Device
|
|
@@ -12121,7 +12181,8 @@ let API$e = class API extends API$q {
|
|
|
12121
12181
|
}, unmarshalDevice);
|
|
12122
12182
|
|
|
12123
12183
|
/**
|
|
12124
|
-
* Update a device.
|
|
12184
|
+
* Update a device. Update the parameters of an existing device, specified by
|
|
12185
|
+
* its device ID.
|
|
12125
12186
|
*
|
|
12126
12187
|
* @param request - The request {@link UpdateDeviceRequest}
|
|
12127
12188
|
* @returns A Promise of Device
|
|
@@ -12134,7 +12195,7 @@ let API$e = class API extends API$q {
|
|
|
12134
12195
|
}, unmarshalDevice);
|
|
12135
12196
|
|
|
12136
12197
|
/**
|
|
12137
|
-
* Enable a device.
|
|
12198
|
+
* Enable a device. Enable a specific device, specified by its device ID.
|
|
12138
12199
|
*
|
|
12139
12200
|
* @param request - The request {@link EnableDeviceRequest}
|
|
12140
12201
|
* @returns A Promise of Device
|
|
@@ -12147,7 +12208,7 @@ let API$e = class API extends API$q {
|
|
|
12147
12208
|
}, unmarshalDevice);
|
|
12148
12209
|
|
|
12149
12210
|
/**
|
|
12150
|
-
* Disable a device.
|
|
12211
|
+
* Disable a device. Disable an existing device, specified by its device ID.
|
|
12151
12212
|
*
|
|
12152
12213
|
* @param request - The request {@link DisableDeviceRequest}
|
|
12153
12214
|
* @returns A Promise of Device
|
|
@@ -12160,7 +12221,8 @@ let API$e = class API extends API$q {
|
|
|
12160
12221
|
}, unmarshalDevice);
|
|
12161
12222
|
|
|
12162
12223
|
/**
|
|
12163
|
-
* Renew a device certificate.
|
|
12224
|
+
* Renew a device certificate. Renew the certificate of an existing device,
|
|
12225
|
+
* specified by its device ID.
|
|
12164
12226
|
*
|
|
12165
12227
|
* @param request - The request {@link RenewDeviceCertificateRequest}
|
|
12166
12228
|
* @returns A Promise of RenewDeviceCertificateResponse
|
|
@@ -12173,7 +12235,8 @@ let API$e = class API extends API$q {
|
|
|
12173
12235
|
}, unmarshalRenewDeviceCertificateResponse);
|
|
12174
12236
|
|
|
12175
12237
|
/**
|
|
12176
|
-
* Set a custom certificate on a device.
|
|
12238
|
+
* Set a custom certificate on a device. Switch the existing certificate of a
|
|
12239
|
+
* given device with an EM-encoded custom certificate.
|
|
12177
12240
|
*
|
|
12178
12241
|
* @param request - The request {@link SetDeviceCertificateRequest}
|
|
12179
12242
|
* @returns A Promise of SetDeviceCertificateResponse
|
|
@@ -12186,7 +12249,9 @@ let API$e = class API extends API$q {
|
|
|
12186
12249
|
}, unmarshalSetDeviceCertificateResponse);
|
|
12187
12250
|
|
|
12188
12251
|
/**
|
|
12189
|
-
* Get a device's certificate.
|
|
12252
|
+
* Get a device's certificate. Get information for a particular PEM-encoded
|
|
12253
|
+
* certificate, specified by the device ID. The response returns full details
|
|
12254
|
+
* of the device, including its type of certificate.
|
|
12190
12255
|
*
|
|
12191
12256
|
* @param request - The request {@link GetDeviceCertificateRequest}
|
|
12192
12257
|
* @returns A Promise of GetDeviceCertificateResponse
|
|
@@ -12197,7 +12262,8 @@ let API$e = class API extends API$q {
|
|
|
12197
12262
|
}, unmarshalGetDeviceCertificateResponse);
|
|
12198
12263
|
|
|
12199
12264
|
/**
|
|
12200
|
-
* Remove a device.
|
|
12265
|
+
* Remove a device. Remove a specific device from the specific Hub it is
|
|
12266
|
+
* attached to.
|
|
12201
12267
|
*
|
|
12202
12268
|
* @param request - The request {@link DeleteDeviceRequest}
|
|
12203
12269
|
*/
|
|
@@ -12207,7 +12273,8 @@ let API$e = class API extends API$q {
|
|
|
12207
12273
|
});
|
|
12208
12274
|
|
|
12209
12275
|
/**
|
|
12210
|
-
* Get a device's metrics.
|
|
12276
|
+
* Get a device's metrics. Get the metrics of an existing device, specified by
|
|
12277
|
+
* its device ID.
|
|
12211
12278
|
*
|
|
12212
12279
|
* @deprecated
|
|
12213
12280
|
* @param request - The request {@link GetDeviceMetricsRequest}
|
|
@@ -12225,7 +12292,9 @@ let API$e = class API extends API$q {
|
|
|
12225
12292
|
}, unmarshalListRoutesResponse$1);
|
|
12226
12293
|
|
|
12227
12294
|
/**
|
|
12228
|
-
* List routes.
|
|
12295
|
+
* List routes. List all routes in the specified region. By default, returned
|
|
12296
|
+
* routes are ordered by creation date in ascending order, though this can be
|
|
12297
|
+
* modified via the `order_by` field.
|
|
12229
12298
|
*
|
|
12230
12299
|
* @param request - The request {@link ListRoutesRequest}
|
|
12231
12300
|
* @returns A Promise of ListRoutesResponse
|
|
@@ -12233,15 +12302,15 @@ let API$e = class API extends API$q {
|
|
|
12233
12302
|
listRoutes = (request = {}) => enrichForPagination('routes', this.pageOfListRoutes, request);
|
|
12234
12303
|
|
|
12235
12304
|
/**
|
|
12236
|
-
* Create a route. Multiple
|
|
12305
|
+
* Create a route. Multiple kinds of routes can be created, such as:
|
|
12237
12306
|
*
|
|
12238
|
-
* - Database Route
|
|
12307
|
+
* - Database Route Create a route that will record subscribed MQTT messages
|
|
12239
12308
|
* into your database. <b>You need to manage the database by yourself</b>.
|
|
12240
12309
|
* - REST Route. Create a route that will call a REST API on received subscribed
|
|
12241
12310
|
* MQTT messages.
|
|
12242
12311
|
* - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
|
|
12243
|
-
* bucket. You need to create the bucket yourself and grant
|
|
12244
|
-
*
|
|
12312
|
+
* bucket. You need to create the bucket yourself and grant write access.
|
|
12313
|
+
* Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
|
|
12245
12314
|
* --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
|
|
12246
12315
|
*
|
|
12247
12316
|
* @param request - The request {@link CreateRouteRequest}
|
|
@@ -12255,7 +12324,8 @@ let API$e = class API extends API$q {
|
|
|
12255
12324
|
}, unmarshalRoute$1);
|
|
12256
12325
|
|
|
12257
12326
|
/**
|
|
12258
|
-
* Update a route.
|
|
12327
|
+
* Update a route. Update the parameters of an existing route, specified by
|
|
12328
|
+
* its route ID.
|
|
12259
12329
|
*
|
|
12260
12330
|
* @param request - The request {@link UpdateRouteRequest}
|
|
12261
12331
|
* @returns A Promise of Route
|
|
@@ -12268,7 +12338,9 @@ let API$e = class API extends API$q {
|
|
|
12268
12338
|
}, unmarshalRoute$1);
|
|
12269
12339
|
|
|
12270
12340
|
/**
|
|
12271
|
-
* Get a route.
|
|
12341
|
+
* Get a route. Get information for a particular route, specified by the route
|
|
12342
|
+
* ID. The response returns full details of the route, including its type, the
|
|
12343
|
+
* topic it subscribes to and its configuration.
|
|
12272
12344
|
*
|
|
12273
12345
|
* @param request - The request {@link GetRouteRequest}
|
|
12274
12346
|
* @returns A Promise of Route
|
|
@@ -12279,7 +12351,8 @@ let API$e = class API extends API$q {
|
|
|
12279
12351
|
}, unmarshalRoute$1);
|
|
12280
12352
|
|
|
12281
12353
|
/**
|
|
12282
|
-
* Delete a route.
|
|
12354
|
+
* Delete a route. Delete an existing route, specified by its route ID.
|
|
12355
|
+
* Deleting a route is permanent, and cannot be undone.
|
|
12283
12356
|
*
|
|
12284
12357
|
* @param request - The request {@link DeleteRouteRequest}
|
|
12285
12358
|
*/
|
|
@@ -12294,7 +12367,7 @@ let API$e = class API extends API$q {
|
|
|
12294
12367
|
}, unmarshalListNetworksResponse);
|
|
12295
12368
|
|
|
12296
12369
|
/**
|
|
12297
|
-
* List the
|
|
12370
|
+
* List the networks.
|
|
12298
12371
|
*
|
|
12299
12372
|
* @param request - The request {@link ListNetworksRequest}
|
|
12300
12373
|
* @returns A Promise of ListNetworksResponse
|
|
@@ -12302,7 +12375,9 @@ let API$e = class API extends API$q {
|
|
|
12302
12375
|
listNetworks = (request = {}) => enrichForPagination('networks', this.pageOfListNetworks, request);
|
|
12303
12376
|
|
|
12304
12377
|
/**
|
|
12305
|
-
* Create a new
|
|
12378
|
+
* Create a new network. Create a new network for an existing hub. Beside the
|
|
12379
|
+
* default network, you can add networks for different data providers.
|
|
12380
|
+
* Possible network types are Sigfox and REST.
|
|
12306
12381
|
*
|
|
12307
12382
|
* @param request - The request {@link CreateNetworkRequest}
|
|
12308
12383
|
* @returns A Promise of CreateNetworkResponse
|
|
@@ -12315,7 +12390,9 @@ let API$e = class API extends API$q {
|
|
|
12315
12390
|
}, unmarshalCreateNetworkResponse);
|
|
12316
12391
|
|
|
12317
12392
|
/**
|
|
12318
|
-
* Retrieve a specific
|
|
12393
|
+
* Retrieve a specific network. Retrieve an existing network, specified by its
|
|
12394
|
+
* network ID. The response returns full details of the network, including its
|
|
12395
|
+
* type, the topic prefix and its endpoint.
|
|
12319
12396
|
*
|
|
12320
12397
|
* @param request - The request {@link GetNetworkRequest}
|
|
12321
12398
|
* @returns A Promise of Network
|
|
@@ -12326,7 +12403,8 @@ let API$e = class API extends API$q {
|
|
|
12326
12403
|
}, unmarshalNetwork);
|
|
12327
12404
|
|
|
12328
12405
|
/**
|
|
12329
|
-
* Delete a Network.
|
|
12406
|
+
* Delete a Network. Delete an existing network, specified by its network ID.
|
|
12407
|
+
* Deleting a network is permanent, and cannot be undone.
|
|
12330
12408
|
*
|
|
12331
12409
|
* @param request - The request {@link DeleteNetworkRequest}
|
|
12332
12410
|
*/
|
|
@@ -12808,7 +12886,7 @@ const jsonContentHeaders$b = {
|
|
|
12808
12886
|
'Content-Type': 'application/json; charset=utf-8'
|
|
12809
12887
|
};
|
|
12810
12888
|
|
|
12811
|
-
/**
|
|
12889
|
+
/** Kubernetes API. */
|
|
12812
12890
|
let API$d = class API extends API$q {
|
|
12813
12891
|
/** Lists the available regions of the API. */
|
|
12814
12892
|
static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
|
|
@@ -16128,7 +16206,8 @@ let API$a = class API extends API$q {
|
|
|
16128
16206
|
}, unmarshalListImagesResponse$1);
|
|
16129
16207
|
|
|
16130
16208
|
/**
|
|
16131
|
-
* List marketplace images.
|
|
16209
|
+
* List marketplace images. List all available images on the marketplace,
|
|
16210
|
+
* their UUID, CPU architecture and description.
|
|
16132
16211
|
*
|
|
16133
16212
|
* @param request - The request {@link ListImagesRequest}
|
|
16134
16213
|
* @returns A Promise of ListImagesResponse
|
|
@@ -16136,7 +16215,8 @@ let API$a = class API extends API$q {
|
|
|
16136
16215
|
listImages = request => enrichForPagination('images', this.pageOfListImages, request);
|
|
16137
16216
|
|
|
16138
16217
|
/**
|
|
16139
|
-
* Get a specific marketplace image.
|
|
16218
|
+
* Get a specific marketplace image. Get detailed information about a
|
|
16219
|
+
* marketplace image, specified by its `image_id` (UUID format).
|
|
16140
16220
|
*
|
|
16141
16221
|
* @param request - The request {@link GetImageRequest}
|
|
16142
16222
|
* @returns A Promise of Image
|
|
@@ -16150,7 +16230,24 @@ let API$a = class API extends API$q {
|
|
|
16150
16230
|
path: `/marketplace/v2/versions`,
|
|
16151
16231
|
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
16232
|
}, unmarshalListVersionsResponse);
|
|
16233
|
+
|
|
16234
|
+
/**
|
|
16235
|
+
* List versions of an Image. Get a list of all available version of an image,
|
|
16236
|
+
* specified by its `image_id` (UUID format).
|
|
16237
|
+
*
|
|
16238
|
+
* @param request - The request {@link ListVersionsRequest}
|
|
16239
|
+
* @returns A Promise of ListVersionsResponse
|
|
16240
|
+
*/
|
|
16153
16241
|
listVersions = request => enrichForPagination('versions', this.pageOfListVersions, request);
|
|
16242
|
+
|
|
16243
|
+
/**
|
|
16244
|
+
* Get a specific image version. Get information such as the name, creation
|
|
16245
|
+
* date, last update and published date for an image version specified by its
|
|
16246
|
+
* `version_id` (UUID format).
|
|
16247
|
+
*
|
|
16248
|
+
* @param request - The request {@link GetVersionRequest}
|
|
16249
|
+
* @returns A Promise of Version
|
|
16250
|
+
*/
|
|
16154
16251
|
getVersion = request => this.client.fetch({
|
|
16155
16252
|
method: 'GET',
|
|
16156
16253
|
path: `/marketplace/v2/versions/${validatePathParam('versionId', request.versionId)}`
|
|
@@ -16171,12 +16268,25 @@ let API$a = class API extends API$q {
|
|
|
16171
16268
|
}, unmarshalListLocalImagesResponse);
|
|
16172
16269
|
|
|
16173
16270
|
/**
|
|
16174
|
-
* List local images from a specific image or version.
|
|
16271
|
+
* List local images from a specific image or version. List information about
|
|
16272
|
+
* local images in a specific Availability Zone, specified by its `image_id`
|
|
16273
|
+
* (UUID format), `version_id` (UUID format) or `image_label`. Only one of
|
|
16274
|
+
* these three parameters may be set.
|
|
16175
16275
|
*
|
|
16176
16276
|
* @param request - The request {@link ListLocalImagesRequest}
|
|
16177
16277
|
* @returns A Promise of ListLocalImagesResponse
|
|
16178
16278
|
*/
|
|
16179
16279
|
listLocalImages = (request = {}) => enrichForPagination('localImages', this.pageOfListLocalImages, request);
|
|
16280
|
+
|
|
16281
|
+
/**
|
|
16282
|
+
* Get a specific local image by ID. Get detailed information about a local
|
|
16283
|
+
* image, including compatible commercial types, supported architecture,
|
|
16284
|
+
* labels and the Availability Zone of the image, specified by its
|
|
16285
|
+
* `local_image_id` (UUID format).
|
|
16286
|
+
*
|
|
16287
|
+
* @param request - The request {@link GetLocalImageRequest}
|
|
16288
|
+
* @returns A Promise of LocalImage
|
|
16289
|
+
*/
|
|
16180
16290
|
getLocalImage = request => this.client.fetch({
|
|
16181
16291
|
method: 'GET',
|
|
16182
16292
|
path: `/marketplace/v2/local-images/${validatePathParam('localImageId', request.localImageId)}`
|
|
@@ -16186,7 +16296,23 @@ let API$a = class API extends API$q {
|
|
|
16186
16296
|
path: `/marketplace/v2/categories`,
|
|
16187
16297
|
urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
|
|
16188
16298
|
}, unmarshalListCategoriesResponse);
|
|
16299
|
+
|
|
16300
|
+
/**
|
|
16301
|
+
* List existing image categories. Get a list of all existing categories. The
|
|
16302
|
+
* output can be paginated.
|
|
16303
|
+
*
|
|
16304
|
+
* @param request - The request {@link ListCategoriesRequest}
|
|
16305
|
+
* @returns A Promise of ListCategoriesResponse
|
|
16306
|
+
*/
|
|
16189
16307
|
listCategories = (request = {}) => enrichForPagination('categories', this.pageOfListCategories, request);
|
|
16308
|
+
|
|
16309
|
+
/**
|
|
16310
|
+
* Get a specific category. Get information about a specific category of the
|
|
16311
|
+
* marketplace catalog, specified by its `category_id` (UUID format).
|
|
16312
|
+
*
|
|
16313
|
+
* @param request - The request {@link GetCategoryRequest}
|
|
16314
|
+
* @returns A Promise of Category
|
|
16315
|
+
*/
|
|
16190
16316
|
getCategory = request => this.client.fetch({
|
|
16191
16317
|
method: 'GET',
|
|
16192
16318
|
path: `/marketplace/v2/categories/${validatePathParam('categoryId', request.categoryId)}`
|
|
@@ -16310,10 +16436,7 @@ const marshalPermissions = (request, defaults) => ({
|
|
|
16310
16436
|
const marshalCreateCredentialRequest = (request, defaults) => ({
|
|
16311
16437
|
name: request.name || randomName('mnq'),
|
|
16312
16438
|
namespace_id: request.namespaceId,
|
|
16313
|
-
|
|
16314
|
-
param: 'permissions',
|
|
16315
|
-
value: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
16316
|
-
}])
|
|
16439
|
+
permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
16317
16440
|
});
|
|
16318
16441
|
const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
|
|
16319
16442
|
name: request.name || randomName('mnq'),
|
|
@@ -16322,10 +16445,7 @@ const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
|
|
|
16322
16445
|
});
|
|
16323
16446
|
const marshalUpdateCredentialRequest = (request, defaults) => ({
|
|
16324
16447
|
name: request.name,
|
|
16325
|
-
|
|
16326
|
-
param: 'permissions',
|
|
16327
|
-
value: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
16328
|
-
}])
|
|
16448
|
+
permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
|
|
16329
16449
|
});
|
|
16330
16450
|
const marshalUpdateNamespaceRequest$1 = (request, defaults) => ({
|
|
16331
16451
|
name: request.name,
|
|
@@ -16338,9 +16458,10 @@ const jsonContentHeaders$9 = {
|
|
|
16338
16458
|
};
|
|
16339
16459
|
|
|
16340
16460
|
/**
|
|
16341
|
-
*
|
|
16461
|
+
* Messaging and Queuing API.
|
|
16342
16462
|
*
|
|
16343
|
-
* This API allows you to manage Messaging
|
|
16463
|
+
* This API allows you to manage Scaleway Messaging and Queueing brokers.
|
|
16464
|
+
* Messaging and Queuing API.
|
|
16344
16465
|
*/
|
|
16345
16466
|
let API$9 = class API extends API$q {
|
|
16346
16467
|
/** Lists the available regions of the API. */
|
|
@@ -16352,7 +16473,10 @@ let API$9 = class API extends API$q {
|
|
|
16352
16473
|
}, unmarshalListNamespacesResponse$1);
|
|
16353
16474
|
|
|
16354
16475
|
/**
|
|
16355
|
-
* List namespaces.
|
|
16476
|
+
* List namespaces. List all Messaging and Queuing namespaces in the specified
|
|
16477
|
+
* region, for a Scaleway Organization or Project. By default, the namespaces
|
|
16478
|
+
* returned in the list are ordered by creation date in ascending order,
|
|
16479
|
+
* though this can be modified via the `order_by` field.
|
|
16356
16480
|
*
|
|
16357
16481
|
* @param request - The request {@link ListNamespacesRequest}
|
|
16358
16482
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -16360,7 +16484,8 @@ let API$9 = class API extends API$q {
|
|
|
16360
16484
|
listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
|
|
16361
16485
|
|
|
16362
16486
|
/**
|
|
16363
|
-
* Create a namespace.
|
|
16487
|
+
* Create a namespace. Create a Messaging and Queuing namespace, set to the
|
|
16488
|
+
* desired protocol.
|
|
16364
16489
|
*
|
|
16365
16490
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
16366
16491
|
* @returns A Promise of Namespace
|
|
@@ -16373,7 +16498,8 @@ let API$9 = class API extends API$q {
|
|
|
16373
16498
|
}, unmarshalNamespace$1);
|
|
16374
16499
|
|
|
16375
16500
|
/**
|
|
16376
|
-
* Update the name of a namespace.
|
|
16501
|
+
* Update the name of a namespace. Update the name of a Messaging and Queuing
|
|
16502
|
+
* namespace, specified by its namespace ID.
|
|
16377
16503
|
*
|
|
16378
16504
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
16379
16505
|
* @returns A Promise of Namespace
|
|
@@ -16386,7 +16512,9 @@ let API$9 = class API extends API$q {
|
|
|
16386
16512
|
}, unmarshalNamespace$1);
|
|
16387
16513
|
|
|
16388
16514
|
/**
|
|
16389
|
-
* Get a namespace.
|
|
16515
|
+
* Get a namespace. Retrieve information about an existing Messaging and
|
|
16516
|
+
* Queuing namespace, identified by its namespace ID. Its full details,
|
|
16517
|
+
* including name, endpoint and protocol, are returned in the response.
|
|
16390
16518
|
*
|
|
16391
16519
|
* @param request - The request {@link GetNamespaceRequest}
|
|
16392
16520
|
* @returns A Promise of Namespace
|
|
@@ -16397,7 +16525,10 @@ let API$9 = class API extends API$q {
|
|
|
16397
16525
|
}, unmarshalNamespace$1);
|
|
16398
16526
|
|
|
16399
16527
|
/**
|
|
16400
|
-
* Delete a namespace.
|
|
16528
|
+
* Delete a namespace. Delete a Messaging and Queuing namespace, specified by
|
|
16529
|
+
* its namespace ID. Note that deleting a namespace is irreversible, and any
|
|
16530
|
+
* URLs, credentials and queued messages belonging to this namespace will also
|
|
16531
|
+
* be deleted.
|
|
16401
16532
|
*
|
|
16402
16533
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
16403
16534
|
*/
|
|
@@ -16407,8 +16538,11 @@ let API$9 = class API extends API$q {
|
|
|
16407
16538
|
});
|
|
16408
16539
|
|
|
16409
16540
|
/**
|
|
16410
|
-
* Create
|
|
16411
|
-
* namespace.
|
|
16541
|
+
* Create credentials. Create a set of credentials for a Messaging and Queuing
|
|
16542
|
+
* namespace, specified by its namespace ID. If creating credentials for a
|
|
16543
|
+
* NATS namespace, the `permissions` object must not be included in the
|
|
16544
|
+
* request. If creating credentials for an SQS/SNS namespace, the
|
|
16545
|
+
* `permissions` object is required, with all three of its child attributes.
|
|
16412
16546
|
*
|
|
16413
16547
|
* @param request - The request {@link CreateCredentialRequest}
|
|
16414
16548
|
* @returns A Promise of Credential
|
|
@@ -16421,7 +16555,9 @@ let API$9 = class API extends API$q {
|
|
|
16421
16555
|
}, unmarshalCredential);
|
|
16422
16556
|
|
|
16423
16557
|
/**
|
|
16424
|
-
* Delete credentials.
|
|
16558
|
+
* Delete credentials. Delete a set of credentials, specified by their
|
|
16559
|
+
* credential ID. Deleting credentials is irreversible and cannot be undone.
|
|
16560
|
+
* The credentials can no longer be used to access the namespace.
|
|
16425
16561
|
*
|
|
16426
16562
|
* @param request - The request {@link DeleteCredentialRequest}
|
|
16427
16563
|
*/
|
|
@@ -16436,7 +16572,9 @@ let API$9 = class API extends API$q {
|
|
|
16436
16572
|
}, unmarshalListCredentialsResponse);
|
|
16437
16573
|
|
|
16438
16574
|
/**
|
|
16439
|
-
* List credentials.
|
|
16575
|
+
* List credentials. List existing credentials in the specified region. The
|
|
16576
|
+
* response contains only the metadata for the credentials, not the
|
|
16577
|
+
* credentials themselves (for this, use **Get Credentials**).
|
|
16440
16578
|
*
|
|
16441
16579
|
* @param request - The request {@link ListCredentialsRequest}
|
|
16442
16580
|
* @returns A Promise of ListCredentialsResponse
|
|
@@ -16444,7 +16582,10 @@ let API$9 = class API extends API$q {
|
|
|
16444
16582
|
listCredentials = (request = {}) => enrichForPagination('credentials', this.pageOfListCredentials, request);
|
|
16445
16583
|
|
|
16446
16584
|
/**
|
|
16447
|
-
* Update a set of credentials.
|
|
16585
|
+
* Update credentials. Update a set of credentials. You can update the
|
|
16586
|
+
* credentials' name, or (in the case of SQS/SNS credentials only) their
|
|
16587
|
+
* permissions. To update the name of NATS credentials, do not include the
|
|
16588
|
+
* `permissions` object in your request.
|
|
16448
16589
|
*
|
|
16449
16590
|
* @param request - The request {@link UpdateCredentialRequest}
|
|
16450
16591
|
* @returns A Promise of Credential
|
|
@@ -16457,7 +16598,9 @@ let API$9 = class API extends API$q {
|
|
|
16457
16598
|
}, unmarshalCredential);
|
|
16458
16599
|
|
|
16459
16600
|
/**
|
|
16460
|
-
* Get
|
|
16601
|
+
* Get credentials. Retrieve an existing set of credentials, identified by the
|
|
16602
|
+
* `credential_id`. The credentials themselves, as well as their metadata
|
|
16603
|
+
* (protocol, namespace ID etc), are returned in the response.
|
|
16461
16604
|
*
|
|
16462
16605
|
* @param request - The request {@link GetCredentialRequest}
|
|
16463
16606
|
* @returns A Promise of Credential
|
|
@@ -18863,11 +19006,7 @@ const jsonContentHeaders$6 = {
|
|
|
18863
19006
|
'Content-Type': 'application/json; charset=utf-8'
|
|
18864
19007
|
};
|
|
18865
19008
|
|
|
18866
|
-
/**
|
|
18867
|
-
* Registry API.
|
|
18868
|
-
*
|
|
18869
|
-
* Container registry API. Registry API.
|
|
18870
|
-
*/
|
|
19009
|
+
/** Container Registry API. */
|
|
18871
19010
|
let API$6 = class API extends API$q {
|
|
18872
19011
|
/** Lists the available regions of the API. */
|
|
18873
19012
|
static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
|
|
@@ -18878,7 +19017,11 @@ let API$6 = class API extends API$q {
|
|
|
18878
19017
|
}, unmarshalListNamespacesResponse);
|
|
18879
19018
|
|
|
18880
19019
|
/**
|
|
18881
|
-
* List all
|
|
19020
|
+
* List namespaces. List all namespaces in a specified region. By default, the
|
|
19021
|
+
* namespaces listed are ordered by creation date in ascending order. This can
|
|
19022
|
+
* be modified via the order_by field. You can also define additional
|
|
19023
|
+
* parameters for your query, such as the `instance_id` and `project_id`
|
|
19024
|
+
* parameters.
|
|
18882
19025
|
*
|
|
18883
19026
|
* @param request - The request {@link ListNamespacesRequest}
|
|
18884
19027
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -18886,7 +19029,10 @@ let API$6 = class API extends API$q {
|
|
|
18886
19029
|
listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
|
|
18887
19030
|
|
|
18888
19031
|
/**
|
|
18889
|
-
* Get a namespace.
|
|
19032
|
+
* Get a namespace. Retrieve information about a given namespace, specified by
|
|
19033
|
+
* its `namespace_id` and region. Full details about the namespace, such as
|
|
19034
|
+
* `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
|
|
19035
|
+
* `image_count` are returned in the response.
|
|
18890
19036
|
*
|
|
18891
19037
|
* @param request - The request {@link GetNamespaceRequest}
|
|
18892
19038
|
* @returns A Promise of Namespace
|
|
@@ -18906,7 +19052,10 @@ let API$6 = class API extends API$q {
|
|
|
18906
19052
|
waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
|
|
18907
19053
|
|
|
18908
19054
|
/**
|
|
18909
|
-
* Create a new namespace.
|
|
19055
|
+
* Create a namespace. Create a new Container Registry namespace. You must
|
|
19056
|
+
* specify the namespace name and region in which you want it to be created.
|
|
19057
|
+
* Optionally, you can specify the `project_id` and `is_public` in the request
|
|
19058
|
+
* payload.
|
|
18910
19059
|
*
|
|
18911
19060
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
18912
19061
|
* @returns A Promise of Namespace
|
|
@@ -18919,8 +19068,9 @@ let API$6 = class API extends API$q {
|
|
|
18919
19068
|
}, unmarshalNamespace);
|
|
18920
19069
|
|
|
18921
19070
|
/**
|
|
18922
|
-
* Update
|
|
18923
|
-
*
|
|
19071
|
+
* Update a namespace. Update the parameters of a given namespace, specified
|
|
19072
|
+
* by its `namespace_id` and `region`. You can update the `description` and
|
|
19073
|
+
* `is_public` parameters.
|
|
18924
19074
|
*
|
|
18925
19075
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
18926
19076
|
* @returns A Promise of Namespace
|
|
@@ -18933,8 +19083,9 @@ let API$6 = class API extends API$q {
|
|
|
18933
19083
|
}, unmarshalNamespace);
|
|
18934
19084
|
|
|
18935
19085
|
/**
|
|
18936
|
-
* Delete
|
|
18937
|
-
*
|
|
19086
|
+
* Delete a namespace. Delete a given namespace. You must specify, in the
|
|
19087
|
+
* endpoint, the `region` and `namespace_id` parameters of the namespace you
|
|
19088
|
+
* want to delete.
|
|
18938
19089
|
*
|
|
18939
19090
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
18940
19091
|
* @returns A Promise of Namespace
|
|
@@ -18950,7 +19101,10 @@ let API$6 = class API extends API$q {
|
|
|
18950
19101
|
}, unmarshalListImagesResponse);
|
|
18951
19102
|
|
|
18952
19103
|
/**
|
|
18953
|
-
* List all
|
|
19104
|
+
* List images. List all images in a specified region. By default, the images
|
|
19105
|
+
* listed are ordered by creation date in ascending order. This can be
|
|
19106
|
+
* modified via the order_by field. You can also define additional parameters
|
|
19107
|
+
* for your query, such as the `namespace_id` and `project_id` parameters.
|
|
18954
19108
|
*
|
|
18955
19109
|
* @param request - The request {@link ListImagesRequest}
|
|
18956
19110
|
* @returns A Promise of ListImagesResponse
|
|
@@ -18958,7 +19112,10 @@ let API$6 = class API extends API$q {
|
|
|
18958
19112
|
listImages = (request = {}) => enrichForPagination('images', this.pageOfListImages, request);
|
|
18959
19113
|
|
|
18960
19114
|
/**
|
|
18961
|
-
* Get
|
|
19115
|
+
* Get an image. Retrieve information about a given container image, specified
|
|
19116
|
+
* by its `image_id` and region. Full details about the image, such as `name`,
|
|
19117
|
+
* `namespace_id`, `status`, `visibility`, and `size` are returned in the
|
|
19118
|
+
* response.
|
|
18962
19119
|
*
|
|
18963
19120
|
* @param request - The request {@link GetImageRequest}
|
|
18964
19121
|
* @returns A Promise of Image
|
|
@@ -18978,7 +19135,8 @@ let API$6 = class API extends API$q {
|
|
|
18978
19135
|
waitForImage = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
|
|
18979
19136
|
|
|
18980
19137
|
/**
|
|
18981
|
-
* Update an
|
|
19138
|
+
* Update an image. Update the parameters of a given image, specified by its
|
|
19139
|
+
* `image_id` and `region`. You can update the `visibility` parameter.
|
|
18982
19140
|
*
|
|
18983
19141
|
* @param request - The request {@link UpdateImageRequest}
|
|
18984
19142
|
* @returns A Promise of Image
|
|
@@ -18991,7 +19149,8 @@ let API$6 = class API extends API$q {
|
|
|
18991
19149
|
}, unmarshalImage);
|
|
18992
19150
|
|
|
18993
19151
|
/**
|
|
18994
|
-
* Delete an image. Delete
|
|
19152
|
+
* Delete an image. Delete a given image. You must specify, in the endpoint,
|
|
19153
|
+
* the `region` and `image_id` parameters of the image you want to delete.
|
|
18995
19154
|
*
|
|
18996
19155
|
* @param request - The request {@link DeleteImageRequest}
|
|
18997
19156
|
* @returns A Promise of Image
|
|
@@ -19007,7 +19166,10 @@ let API$6 = class API extends API$q {
|
|
|
19007
19166
|
}, unmarshalListTagsResponse);
|
|
19008
19167
|
|
|
19009
19168
|
/**
|
|
19010
|
-
* List all
|
|
19169
|
+
* List tags. List all tags for a given image, specified by region. By
|
|
19170
|
+
* default, the tags listed are ordered by creation date in ascending order.
|
|
19171
|
+
* This can be modified via the order_by field. You can also define additional
|
|
19172
|
+
* parameters for your query, such as the `name`.
|
|
19011
19173
|
*
|
|
19012
19174
|
* @param request - The request {@link ListTagsRequest}
|
|
19013
19175
|
* @returns A Promise of ListTagsResponse
|
|
@@ -19015,7 +19177,9 @@ let API$6 = class API extends API$q {
|
|
|
19015
19177
|
listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
|
|
19016
19178
|
|
|
19017
19179
|
/**
|
|
19018
|
-
* Get a tag.
|
|
19180
|
+
* Get a tag. Retrieve information about a given image tag, specified by its
|
|
19181
|
+
* `tag_id` and region. Full details about the tag, such as `name`,
|
|
19182
|
+
* `image_id`, `status`, and `digest` are returned in the response.
|
|
19019
19183
|
*
|
|
19020
19184
|
* @param request - The request {@link GetTagRequest}
|
|
19021
19185
|
* @returns A Promise of Tag
|
|
@@ -19035,7 +19199,8 @@ let API$6 = class API extends API$q {
|
|
|
19035
19199
|
waitForTag = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
|
|
19036
19200
|
|
|
19037
19201
|
/**
|
|
19038
|
-
* Delete a tag. Delete
|
|
19202
|
+
* Delete a tag. Delete a given image tag. You must specify, in the endpoint,
|
|
19203
|
+
* the `region` and `tag_id` parameters of the tag you want to delete.
|
|
19039
19204
|
*
|
|
19040
19205
|
* @param request - The request {@link DeleteTagRequest}
|
|
19041
19206
|
* @returns A Promise of Tag
|
|
@@ -19071,6 +19236,7 @@ const unmarshalSecret = data => {
|
|
|
19071
19236
|
createdAt: unmarshalDate(data.created_at),
|
|
19072
19237
|
description: data.description,
|
|
19073
19238
|
id: data.id,
|
|
19239
|
+
isManaged: data.is_managed,
|
|
19074
19240
|
name: data.name,
|
|
19075
19241
|
projectId: data.project_id,
|
|
19076
19242
|
region: data.region,
|
|
@@ -19087,6 +19253,7 @@ const unmarshalSecretVersion = data => {
|
|
|
19087
19253
|
return {
|
|
19088
19254
|
createdAt: unmarshalDate(data.created_at),
|
|
19089
19255
|
description: data.description,
|
|
19256
|
+
isLatest: data.is_latest,
|
|
19090
19257
|
revision: data.revision,
|
|
19091
19258
|
secretId: data.secret_id,
|
|
19092
19259
|
status: data.status,
|
|
@@ -19099,6 +19266,7 @@ const unmarshalAccessSecretVersionResponse = data => {
|
|
|
19099
19266
|
}
|
|
19100
19267
|
return {
|
|
19101
19268
|
data: data.data,
|
|
19269
|
+
dataCrc32: data.data_crc32,
|
|
19102
19270
|
revision: data.revision,
|
|
19103
19271
|
secretId: data.secret_id
|
|
19104
19272
|
};
|
|
@@ -19128,6 +19296,9 @@ const marshalPasswordGenerationParams = (request, defaults) => ({
|
|
|
19128
19296
|
no_lowercase_letters: request.noLowercaseLetters,
|
|
19129
19297
|
no_uppercase_letters: request.noUppercaseLetters
|
|
19130
19298
|
});
|
|
19299
|
+
const marshalAddSecretOwnerRequest = (request, defaults) => ({
|
|
19300
|
+
product_name: request.productName
|
|
19301
|
+
});
|
|
19131
19302
|
const marshalCreateSecretRequest = (request, defaults) => ({
|
|
19132
19303
|
description: request.description,
|
|
19133
19304
|
name: request.name,
|
|
@@ -19136,6 +19307,7 @@ const marshalCreateSecretRequest = (request, defaults) => ({
|
|
|
19136
19307
|
});
|
|
19137
19308
|
const marshalCreateSecretVersionRequest = (request, defaults) => ({
|
|
19138
19309
|
data: request.data,
|
|
19310
|
+
data_crc32: request.dataCrc32,
|
|
19139
19311
|
description: request.description,
|
|
19140
19312
|
disable_previous: request.disablePrevious,
|
|
19141
19313
|
...resolveOneOf([{
|
|
@@ -19158,10 +19330,10 @@ const jsonContentHeaders$5 = {
|
|
|
19158
19330
|
};
|
|
19159
19331
|
|
|
19160
19332
|
/**
|
|
19161
|
-
* Secret Manager API
|
|
19333
|
+
* Secret Manager API.
|
|
19162
19334
|
*
|
|
19163
|
-
* This API allows you to conveniently store, access and
|
|
19164
|
-
*
|
|
19335
|
+
* Secret Manager API. This API allows you to conveniently store, access and
|
|
19336
|
+
* share sensitive data.
|
|
19165
19337
|
*/
|
|
19166
19338
|
let API$5 = class API extends API$q {
|
|
19167
19339
|
/** Lists the available regions of the API. */
|
|
@@ -19221,7 +19393,7 @@ let API$5 = class API extends API$q {
|
|
|
19221
19393
|
pageOfListSecrets = (request = {}) => this.client.fetch({
|
|
19222
19394
|
method: 'GET',
|
|
19223
19395
|
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])
|
|
19396
|
+
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
19397
|
}, unmarshalListSecretsResponse);
|
|
19226
19398
|
|
|
19227
19399
|
/**
|
|
@@ -19245,6 +19417,18 @@ let API$5 = class API extends API$q {
|
|
|
19245
19417
|
path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
|
|
19246
19418
|
});
|
|
19247
19419
|
|
|
19420
|
+
/**
|
|
19421
|
+
* Allow a product to use the secret.
|
|
19422
|
+
*
|
|
19423
|
+
* @param request - The request {@link AddSecretOwnerRequest}
|
|
19424
|
+
*/
|
|
19425
|
+
addSecretOwner = request => this.client.fetch({
|
|
19426
|
+
body: JSON.stringify(marshalAddSecretOwnerRequest(request, this.client.settings)),
|
|
19427
|
+
headers: jsonContentHeaders$5,
|
|
19428
|
+
method: 'POST',
|
|
19429
|
+
path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/add-owner`
|
|
19430
|
+
});
|
|
19431
|
+
|
|
19248
19432
|
/**
|
|
19249
19433
|
* Create a version. Create a version of a given secret specified by the
|
|
19250
19434
|
* `region` and `secret_id` parameters.
|
|
@@ -19329,20 +19513,6 @@ let API$5 = class API extends API$q {
|
|
|
19329
19513
|
*/
|
|
19330
19514
|
listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
|
|
19331
19515
|
|
|
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
19516
|
/**
|
|
19347
19517
|
* Enable a version. Make a specific version accessible. You must specify the
|
|
19348
19518
|
* `region`, `secret_id` and `revision` parameters.
|
|
@@ -19396,6 +19566,20 @@ let API$5 = class API extends API$q {
|
|
|
19396
19566
|
method: 'GET',
|
|
19397
19567
|
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
19568
|
}, unmarshalAccessSecretVersionResponse);
|
|
19569
|
+
|
|
19570
|
+
/**
|
|
19571
|
+
* Delete a version. Delete a secret's version and the sensitive data
|
|
19572
|
+
* contained in it. Deleting a version is permanent and cannot be undone.
|
|
19573
|
+
*
|
|
19574
|
+
* @param request - The request {@link DestroySecretVersionRequest}
|
|
19575
|
+
* @returns A Promise of SecretVersion
|
|
19576
|
+
*/
|
|
19577
|
+
destroySecretVersion = request => this.client.fetch({
|
|
19578
|
+
body: '{}',
|
|
19579
|
+
headers: jsonContentHeaders$5,
|
|
19580
|
+
method: 'POST',
|
|
19581
|
+
path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
|
|
19582
|
+
}, unmarshalSecretVersion);
|
|
19399
19583
|
};
|
|
19400
19584
|
|
|
19401
19585
|
// This file was automatically generated. DO NOT EDIT.
|
|
@@ -19785,11 +19969,7 @@ const jsonContentHeaders$3 = {
|
|
|
19785
19969
|
'Content-Type': 'application/json; charset=utf-8'
|
|
19786
19970
|
};
|
|
19787
19971
|
|
|
19788
|
-
/**
|
|
19789
|
-
* Transactional Email API documentation.
|
|
19790
|
-
*
|
|
19791
|
-
* Tem. Transactional Email API documentation.
|
|
19792
|
-
*/
|
|
19972
|
+
/** Transactional Email API. */
|
|
19793
19973
|
let API$3 = class API extends API$q {
|
|
19794
19974
|
/** Lists the available regions of the API. */
|
|
19795
19975
|
static LOCALITIES = ['fr-par'];
|
|
@@ -20019,7 +20199,10 @@ let API$2 = class API extends API$q {
|
|
|
20019
20199
|
}, unmarshalListPrivateNetworksResponse);
|
|
20020
20200
|
|
|
20021
20201
|
/**
|
|
20022
|
-
* List
|
|
20202
|
+
* List Private Networks. List existing Private Networks in a specified
|
|
20203
|
+
* Availability Zone. By default, the Private Networks returned in the list
|
|
20204
|
+
* are ordered by creation date in ascending order, though this can be
|
|
20205
|
+
* modified via the order_by field.
|
|
20023
20206
|
*
|
|
20024
20207
|
* @param request - The request {@link ListPrivateNetworksRequest}
|
|
20025
20208
|
* @returns A Promise of ListPrivateNetworksResponse
|
|
@@ -20027,7 +20210,8 @@ let API$2 = class API extends API$q {
|
|
|
20027
20210
|
listPrivateNetworks = (request = {}) => enrichForPagination('privateNetworks', this.pageOfListPrivateNetworks, request);
|
|
20028
20211
|
|
|
20029
20212
|
/**
|
|
20030
|
-
* Create a
|
|
20213
|
+
* Create a Private Network. Create a new Private Network. Once created, you
|
|
20214
|
+
* can attach Scaleway resources in the same Availability Zone.
|
|
20031
20215
|
*
|
|
20032
20216
|
* @param request - The request {@link CreatePrivateNetworkRequest}
|
|
20033
20217
|
* @returns A Promise of PrivateNetwork
|
|
@@ -20040,7 +20224,9 @@ let API$2 = class API extends API$q {
|
|
|
20040
20224
|
}, unmarshalPrivateNetwork);
|
|
20041
20225
|
|
|
20042
20226
|
/**
|
|
20043
|
-
* Get a
|
|
20227
|
+
* Get a Private Network. Retrieve information about an existing Private
|
|
20228
|
+
* Network, specified by its Private Network ID. Its full details are returned
|
|
20229
|
+
* in the response object.
|
|
20044
20230
|
*
|
|
20045
20231
|
* @param request - The request {@link GetPrivateNetworkRequest}
|
|
20046
20232
|
* @returns A Promise of PrivateNetwork
|
|
@@ -20051,7 +20237,8 @@ let API$2 = class API extends API$q {
|
|
|
20051
20237
|
}, unmarshalPrivateNetwork);
|
|
20052
20238
|
|
|
20053
20239
|
/**
|
|
20054
|
-
* Update
|
|
20240
|
+
* Update Private Network. Update parameters (such as name or tags) of an
|
|
20241
|
+
* existing Private Network, specified by its Private Network ID.
|
|
20055
20242
|
*
|
|
20056
20243
|
* @param request - The request {@link UpdatePrivateNetworkRequest}
|
|
20057
20244
|
* @returns A Promise of PrivateNetwork
|
|
@@ -20064,7 +20251,8 @@ let API$2 = class API extends API$q {
|
|
|
20064
20251
|
}, unmarshalPrivateNetwork);
|
|
20065
20252
|
|
|
20066
20253
|
/**
|
|
20067
|
-
* Delete a
|
|
20254
|
+
* Delete a Private Network. Delete an existing Private Network. Note that you
|
|
20255
|
+
* must first detach all resources from the network, in order to delete it.
|
|
20068
20256
|
*
|
|
20069
20257
|
* @param request - The request {@link DeletePrivateNetworkRequest}
|
|
20070
20258
|
*/
|