@scaleway/sdk 1.7.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 +4 -3
- package/dist/api/baremetal/v1/api.gen.js +5 -5
- package/dist/api/cockpit/v1beta1/api.gen.js +2 -3
- package/dist/api/container/v1beta1/api.gen.js +1 -5
- package/dist/api/container/v1beta1/marshalling.gen.js +2 -0
- package/dist/api/domain/v2beta1/api.gen.js +61 -52
- package/dist/api/flexibleip/v1alpha1/api.gen.js +27 -14
- package/dist/api/instance/v1/api.gen.js +2 -2
- package/dist/api/iot/v1/api.gen.js +67 -35
- package/dist/api/k8s/v1/api.gen.js +1 -1
- package/dist/api/mnq/v1alpha1/api.gen.js +3 -3
- package/dist/api/mnq/v1alpha1/marshalling.gen.js +3 -9
- package/dist/api/registry/v1/api.gen.js +41 -19
- package/dist/api/secret/v1alpha1/api.gen.js +3 -3
- package/dist/api/tem/v1alpha1/api.gen.js +1 -5
- package/dist/index.cjs +223 -159
- package/dist/index.d.ts +603 -495
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1238,7 +1238,7 @@ type ReinstallServerRequest = {
|
|
|
1238
1238
|
};
|
|
1239
1239
|
|
|
1240
1240
|
/**
|
|
1241
|
-
* Apple silicon.
|
|
1241
|
+
* Apple silicon API.
|
|
1242
1242
|
*
|
|
1243
1243
|
* Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built
|
|
1244
1244
|
* using the latest generation of Apple Mac mini hardware (fifth generation).
|
|
@@ -1271,7 +1271,8 @@ declare class API$o extends API$q {
|
|
|
1271
1271
|
*/
|
|
1272
1272
|
listServerTypes: (request?: Readonly<ListServerTypesRequest>) => Promise<ListServerTypesResponse>;
|
|
1273
1273
|
/**
|
|
1274
|
-
* Get a server type. Get
|
|
1274
|
+
* Get a server type. Get technical details (CPU, disk size etc.) of a server
|
|
1275
|
+
* type.
|
|
1275
1276
|
*
|
|
1276
1277
|
* @param request - The request {@link GetServerTypeRequest}
|
|
1277
1278
|
* @returns A Promise of ServerType
|
|
@@ -1300,7 +1301,7 @@ declare class API$o extends API$q {
|
|
|
1300
1301
|
};
|
|
1301
1302
|
protected pageOfListOS: (request?: Readonly<ListOSRequest$2>) => Promise<ListOSResponse$1>;
|
|
1302
1303
|
/**
|
|
1303
|
-
* List all Operating
|
|
1304
|
+
* List all Operating Systems (OS). List all Operating Systems (OS). The
|
|
1304
1305
|
* response will include the total number of OS as well as their associated
|
|
1305
1306
|
* IDs, names and labels.
|
|
1306
1307
|
*
|
|
@@ -1817,7 +1818,7 @@ interface Setting {
|
|
|
1817
1818
|
id: string;
|
|
1818
1819
|
/** Type of the setting. */
|
|
1819
1820
|
type: SettingType;
|
|
1820
|
-
/** ID of the
|
|
1821
|
+
/** ID of the Project ID. */
|
|
1821
1822
|
projectId: string;
|
|
1822
1823
|
/** Defines whether the setting is enabled. */
|
|
1823
1824
|
enabled: boolean;
|
|
@@ -2055,7 +2056,7 @@ type ListSettingsRequest$1 = {
|
|
|
2055
2056
|
pageSize?: number;
|
|
2056
2057
|
/** Sort order for items in the response. */
|
|
2057
2058
|
orderBy?: ListSettingsRequestOrderBy;
|
|
2058
|
-
/** ID of the
|
|
2059
|
+
/** ID of the Project. */
|
|
2059
2060
|
projectId?: string;
|
|
2060
2061
|
};
|
|
2061
2062
|
type UpdateSettingRequest = {
|
|
@@ -2135,8 +2136,8 @@ declare class API$n extends API$q {
|
|
|
2135
2136
|
static readonly LOCALITIES: Zone[];
|
|
2136
2137
|
protected pageOfListServers: (request?: Readonly<ListServersRequest$2>) => Promise<ListServersResponse$1>;
|
|
2137
2138
|
/**
|
|
2138
|
-
* List Elastic Metal servers for an
|
|
2139
|
-
* for a specific
|
|
2139
|
+
* List Elastic Metal servers for an Organization. List Elastic Metal servers
|
|
2140
|
+
* for a specific Organization.
|
|
2140
2141
|
*
|
|
2141
2142
|
* @param request - The request {@link ListServersRequest}
|
|
2142
2143
|
* @returns A Promise of ListServersResponse
|
|
@@ -2333,7 +2334,7 @@ declare class API$n extends API$q {
|
|
|
2333
2334
|
};
|
|
2334
2335
|
protected pageOfListSettings: (request?: Readonly<ListSettingsRequest$1>) => Promise<ListSettingsResponse>;
|
|
2335
2336
|
/**
|
|
2336
|
-
* List all settings. Return all settings for a
|
|
2337
|
+
* List all settings. Return all settings for a Project ID.
|
|
2337
2338
|
*
|
|
2338
2339
|
* @param request - The request {@link ListSettingsRequest}
|
|
2339
2340
|
* @returns A Promise of ListSettingsResponse
|
|
@@ -2343,7 +2344,7 @@ declare class API$n extends API$q {
|
|
|
2343
2344
|
[Symbol.asyncIterator]: () => AsyncGenerator<Setting[], void, void>;
|
|
2344
2345
|
};
|
|
2345
2346
|
/**
|
|
2346
|
-
* Update setting. Update a setting for a
|
|
2347
|
+
* Update setting. Update a setting for a Project ID (enable or disable).
|
|
2347
2348
|
*
|
|
2348
2349
|
* @param request - The request {@link UpdateSettingRequest}
|
|
2349
2350
|
* @returns A Promise of Setting
|
|
@@ -2362,7 +2363,7 @@ declare class API$n extends API$q {
|
|
|
2362
2363
|
[Symbol.asyncIterator]: () => AsyncGenerator<OS[], void, void>;
|
|
2363
2364
|
};
|
|
2364
2365
|
/**
|
|
2365
|
-
* Get
|
|
2366
|
+
* Get OS with an ID. Return the specific OS for the ID.
|
|
2366
2367
|
*
|
|
2367
2368
|
* @param request - The request {@link GetOSRequest}
|
|
2368
2369
|
* @returns A Promise of OS
|
|
@@ -3109,10 +3110,9 @@ type SelectPlanRequest = {
|
|
|
3109
3110
|
};
|
|
3110
3111
|
|
|
3111
3112
|
/**
|
|
3112
|
-
* Cockpit API
|
|
3113
|
+
* Cockpit API.
|
|
3113
3114
|
*
|
|
3114
|
-
* Cockpit's API allows you to
|
|
3115
|
-
* infrastructure. Cockpit's API allows you to activate your Cockpit on your
|
|
3115
|
+
* Cockpit API. Cockpit's API allows you to activate your Cockpit on your
|
|
3116
3116
|
* Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
|
|
3117
3117
|
* Grafana for dashboarding to visualize them.
|
|
3118
3118
|
*/
|
|
@@ -3425,7 +3425,7 @@ interface Container {
|
|
|
3425
3425
|
maxScale: number;
|
|
3426
3426
|
/** Memory limit of the container in MB. */
|
|
3427
3427
|
memoryLimit: number;
|
|
3428
|
-
/** CPU limit of the container. */
|
|
3428
|
+
/** CPU limit of the container in mvCPU. */
|
|
3429
3429
|
cpuLimit: number;
|
|
3430
3430
|
/** Processing time limit for the container. */
|
|
3431
3431
|
timeout?: string;
|
|
@@ -3719,6 +3719,8 @@ type CreateContainerRequest = {
|
|
|
3719
3719
|
maxScale?: number;
|
|
3720
3720
|
/** Memory limit of the container in MB. */
|
|
3721
3721
|
memoryLimit?: number;
|
|
3722
|
+
/** CPU limit of the container in mvCPU. */
|
|
3723
|
+
cpuLimit?: number;
|
|
3722
3724
|
/** Processing time limit for the container. */
|
|
3723
3725
|
timeout?: string;
|
|
3724
3726
|
/** Privacy setting of the container. */
|
|
@@ -3763,6 +3765,8 @@ type UpdateContainerRequest = {
|
|
|
3763
3765
|
maxScale?: number;
|
|
3764
3766
|
/** Memory limit of the container in MB. */
|
|
3765
3767
|
memoryLimit?: number;
|
|
3768
|
+
/** CPU limit of the container in mvCPU. */
|
|
3769
|
+
cpuLimit?: number;
|
|
3766
3770
|
/** Processing time limit for the container. */
|
|
3767
3771
|
timeout?: string;
|
|
3768
3772
|
/** Defines whether to redeploy failed containers. */
|
|
@@ -4003,11 +4007,7 @@ type DeleteTokenRequest$1 = {
|
|
|
4003
4007
|
tokenId: string;
|
|
4004
4008
|
};
|
|
4005
4009
|
|
|
4006
|
-
/**
|
|
4007
|
-
* Containers API.
|
|
4008
|
-
*
|
|
4009
|
-
* Serverless Containers API. Containers API.
|
|
4010
|
-
*/
|
|
4010
|
+
/** Serverless Containers API. */
|
|
4011
4011
|
declare class API$k extends API$q {
|
|
4012
4012
|
/** Lists the available regions of the API. */
|
|
4013
4013
|
static readonly LOCALITIES: Region[];
|
|
@@ -4719,33 +4719,33 @@ interface ListContactsResponse {
|
|
|
4719
4719
|
}
|
|
4720
4720
|
/** List dns zone nameservers response. */
|
|
4721
4721
|
interface ListDNSZoneNameserversResponse {
|
|
4722
|
-
/**
|
|
4722
|
+
/** DNS zone name servers returned. */
|
|
4723
4723
|
ns: Nameserver$1[];
|
|
4724
4724
|
}
|
|
4725
4725
|
/** List dns zone records response. */
|
|
4726
4726
|
interface ListDNSZoneRecordsResponse {
|
|
4727
|
-
/**
|
|
4727
|
+
/** Total number of DNS zone records. */
|
|
4728
4728
|
totalCount: number;
|
|
4729
|
-
/**
|
|
4729
|
+
/** Paginated returned DNS zone records. */
|
|
4730
4730
|
records: DomainRecord[];
|
|
4731
4731
|
}
|
|
4732
4732
|
/** List dns zone version records response. */
|
|
4733
4733
|
interface ListDNSZoneVersionRecordsResponse {
|
|
4734
|
-
/**
|
|
4734
|
+
/** Total number of DNS zones versions records. */
|
|
4735
4735
|
totalCount: number;
|
|
4736
4736
|
records: DomainRecord[];
|
|
4737
4737
|
}
|
|
4738
4738
|
/** List dns zone versions response. */
|
|
4739
4739
|
interface ListDNSZoneVersionsResponse {
|
|
4740
|
-
/**
|
|
4740
|
+
/** Total number of DNS zones versions. */
|
|
4741
4741
|
totalCount: number;
|
|
4742
4742
|
versions: DNSZoneVersion[];
|
|
4743
4743
|
}
|
|
4744
4744
|
/** List dns zones response. */
|
|
4745
4745
|
interface ListDNSZonesResponse {
|
|
4746
|
-
/**
|
|
4746
|
+
/** Total number of DNS zones matching the requested criteria. */
|
|
4747
4747
|
totalCount: number;
|
|
4748
|
-
/**
|
|
4748
|
+
/** Paginated returned DNS zones. */
|
|
4749
4749
|
dnsZones: DNSZone[];
|
|
4750
4750
|
}
|
|
4751
4751
|
/** List domain hosts response. */
|
|
@@ -4858,7 +4858,7 @@ interface RecordIdentifier {
|
|
|
4858
4858
|
}
|
|
4859
4859
|
/** Refresh dns zone response. */
|
|
4860
4860
|
interface RefreshDNSZoneResponse {
|
|
4861
|
-
/**
|
|
4861
|
+
/** DNS zones returned. */
|
|
4862
4862
|
dnsZones: DNSZone[];
|
|
4863
4863
|
}
|
|
4864
4864
|
interface RegisterExternalDomainResponse {
|
|
@@ -4932,122 +4932,119 @@ interface UpdateContactRequestQuestion {
|
|
|
4932
4932
|
}
|
|
4933
4933
|
/** Update dns zone nameservers response. */
|
|
4934
4934
|
interface UpdateDNSZoneNameserversResponse {
|
|
4935
|
-
/**
|
|
4935
|
+
/** DNS zone name servers returned. */
|
|
4936
4936
|
ns: Nameserver$1[];
|
|
4937
4937
|
}
|
|
4938
4938
|
/** Update dns zone records response. */
|
|
4939
4939
|
interface UpdateDNSZoneRecordsResponse {
|
|
4940
|
-
/**
|
|
4940
|
+
/** DNS zone records returned. */
|
|
4941
4941
|
records: DomainRecord[];
|
|
4942
4942
|
}
|
|
4943
4943
|
type ListDNSZonesRequest = {
|
|
4944
|
-
/**
|
|
4944
|
+
/** Organization ID on which to filter the returned DNS zones. */
|
|
4945
4945
|
organizationId?: string;
|
|
4946
|
-
/**
|
|
4946
|
+
/** Project ID on which to filter the returned DNS zones. */
|
|
4947
4947
|
projectId?: string;
|
|
4948
|
-
/**
|
|
4948
|
+
/** Sort order of the returned DNS zones. */
|
|
4949
4949
|
orderBy?: ListDNSZonesRequestOrderBy;
|
|
4950
|
-
/**
|
|
4950
|
+
/** Page number to return, from the paginated results. */
|
|
4951
4951
|
page?: number;
|
|
4952
|
-
/**
|
|
4952
|
+
/** Maximum number of DNS zones to return per page. */
|
|
4953
4953
|
pageSize?: number;
|
|
4954
|
-
/**
|
|
4954
|
+
/** Domain on which to filter the returned DNS zones. */
|
|
4955
4955
|
domain: string;
|
|
4956
|
-
/**
|
|
4956
|
+
/** DNS zone on which to filter the returned DNS zones. */
|
|
4957
4957
|
dnsZone: string;
|
|
4958
4958
|
};
|
|
4959
4959
|
type CreateDNSZoneRequest = {
|
|
4960
|
-
/**
|
|
4960
|
+
/** Domain in which to crreate the DNS zone. */
|
|
4961
4961
|
domain: string;
|
|
4962
|
-
/**
|
|
4962
|
+
/** Subdomain of the DNS zone to create. */
|
|
4963
4963
|
subdomain: string;
|
|
4964
|
-
/**
|
|
4964
|
+
/** Project ID in which to create the DNS zone. */
|
|
4965
4965
|
projectId?: string;
|
|
4966
4966
|
};
|
|
4967
4967
|
type UpdateDNSZoneRequest = {
|
|
4968
|
-
/**
|
|
4968
|
+
/** DNS zone to update. */
|
|
4969
4969
|
dnsZone: string;
|
|
4970
|
-
/**
|
|
4970
|
+
/** Name of the new DNS zone to create. */
|
|
4971
4971
|
newDnsZone: string;
|
|
4972
|
-
/**
|
|
4972
|
+
/** Project ID in which to create the new DNS zone. */
|
|
4973
4973
|
projectId?: string;
|
|
4974
4974
|
};
|
|
4975
4975
|
type CloneDNSZoneRequest = {
|
|
4976
|
-
/**
|
|
4976
|
+
/** DNS zone to clone. */
|
|
4977
4977
|
dnsZone: string;
|
|
4978
|
-
/**
|
|
4978
|
+
/** Destination DNS zone in which to clone the chosen DNS zone. */
|
|
4979
4979
|
destDnsZone: string;
|
|
4980
|
-
/**
|
|
4980
|
+
/** Specifies whether or not the destination DNS zone will be overwritten. */
|
|
4981
4981
|
overwrite: boolean;
|
|
4982
|
-
/**
|
|
4982
|
+
/** Project ID of the destination DNS zone. */
|
|
4983
4983
|
projectId?: string;
|
|
4984
4984
|
};
|
|
4985
4985
|
type DeleteDNSZoneRequest = {
|
|
4986
|
-
/**
|
|
4986
|
+
/** DNS zone to delete. */
|
|
4987
4987
|
dnsZone: string;
|
|
4988
|
-
/**
|
|
4988
|
+
/** Project ID of the DNS zone to delete. */
|
|
4989
4989
|
projectId?: string;
|
|
4990
4990
|
};
|
|
4991
4991
|
type ListDNSZoneRecordsRequest = {
|
|
4992
|
-
/**
|
|
4992
|
+
/** DNS zone on which to filter the returned DNS zone records. */
|
|
4993
4993
|
dnsZone: string;
|
|
4994
|
-
/**
|
|
4994
|
+
/** Project ID on which to filter the returned DNS zone records. */
|
|
4995
4995
|
projectId?: string;
|
|
4996
|
-
/**
|
|
4996
|
+
/** Sort order of the returned DNS zone records. */
|
|
4997
4997
|
orderBy?: ListDNSZoneRecordsRequestOrderBy;
|
|
4998
|
-
/**
|
|
4998
|
+
/** Page number to return, from the paginated results. */
|
|
4999
4999
|
page?: number;
|
|
5000
|
-
/**
|
|
5000
|
+
/** Maximum number of DNS zone records per page. */
|
|
5001
5001
|
pageSize?: number;
|
|
5002
|
-
/**
|
|
5002
|
+
/** Name on which to filter the returned DNS zone records. */
|
|
5003
5003
|
name: string;
|
|
5004
|
-
/**
|
|
5004
|
+
/** Record type on which to filter the returned DNS zone records. */
|
|
5005
5005
|
type?: DomainRecordType;
|
|
5006
|
-
/**
|
|
5006
|
+
/** Record ID on which to filter the returned DNS zone records. */
|
|
5007
5007
|
id?: string;
|
|
5008
5008
|
};
|
|
5009
5009
|
type UpdateDNSZoneRecordsRequest = {
|
|
5010
|
-
/**
|
|
5010
|
+
/** DNS zone in which to update the DNS zone records. */
|
|
5011
5011
|
dnsZone: string;
|
|
5012
|
-
/**
|
|
5012
|
+
/** Changes made to the records. */
|
|
5013
5013
|
changes: RecordChange[];
|
|
5014
|
-
/**
|
|
5014
|
+
/** Specifies whether or not to return all the records. */
|
|
5015
5015
|
returnAllRecords?: boolean;
|
|
5016
5016
|
/**
|
|
5017
|
-
*
|
|
5018
|
-
*
|
|
5017
|
+
* Disable the creation of the target zone if it does not exist. Target zone
|
|
5018
|
+
* creation is disabled by default.
|
|
5019
5019
|
*/
|
|
5020
5020
|
disallowNewZoneCreation: boolean;
|
|
5021
|
-
/**
|
|
5022
|
-
* Don't use the autoincremenent serial but the provided one (0 to keep the
|
|
5023
|
-
* same).
|
|
5024
|
-
*/
|
|
5021
|
+
/** Use the provided serial (0) instead of the auto-increment serial. */
|
|
5025
5022
|
serial?: number;
|
|
5026
5023
|
};
|
|
5027
5024
|
type ListDNSZoneNameserversRequest = {
|
|
5028
|
-
/**
|
|
5025
|
+
/** DNS zone on which to filter the returned DNS zone name servers. */
|
|
5029
5026
|
dnsZone: string;
|
|
5030
|
-
/**
|
|
5027
|
+
/** Project ID on which to filter the returned DNS zone name servers. */
|
|
5031
5028
|
projectId?: string;
|
|
5032
5029
|
};
|
|
5033
5030
|
type UpdateDNSZoneNameserversRequest = {
|
|
5034
|
-
/**
|
|
5031
|
+
/** DNS zone in which to update the DNS zone name servers. */
|
|
5035
5032
|
dnsZone: string;
|
|
5036
|
-
/**
|
|
5033
|
+
/** New DNS zone name servers. */
|
|
5037
5034
|
ns: Nameserver$1[];
|
|
5038
5035
|
};
|
|
5039
5036
|
type ClearDNSZoneRecordsRequest = {
|
|
5040
|
-
/**
|
|
5037
|
+
/** DNS zone to clear. */
|
|
5041
5038
|
dnsZone: string;
|
|
5042
5039
|
};
|
|
5043
5040
|
type ExportRawDNSZoneRequest = {
|
|
5044
|
-
/**
|
|
5041
|
+
/** DNS zone to export. */
|
|
5045
5042
|
dnsZone: string;
|
|
5046
|
-
/**
|
|
5043
|
+
/** DNS zone format. */
|
|
5047
5044
|
format?: RawFormat;
|
|
5048
5045
|
};
|
|
5049
5046
|
type ImportRawDNSZoneRequest = {
|
|
5050
|
-
/**
|
|
5047
|
+
/** DNS zone to import. */
|
|
5051
5048
|
dnsZone: string;
|
|
5052
5049
|
/** @deprecated */
|
|
5053
5050
|
content?: string;
|
|
@@ -5061,7 +5058,7 @@ type ImportRawDNSZoneRequest = {
|
|
|
5061
5058
|
*/
|
|
5062
5059
|
bindSource?: ImportRawDNSZoneRequestBindSource;
|
|
5063
5060
|
/**
|
|
5064
|
-
* Import from the
|
|
5061
|
+
* Import from the name server given with TSIG, to use or not.
|
|
5065
5062
|
*
|
|
5066
5063
|
* One-of ('source'): at most one of 'bindSource', 'axfrSource' could be set.
|
|
5067
5064
|
*/
|
|
@@ -5073,25 +5070,25 @@ type ImportProviderDNSZoneRequest = {
|
|
|
5073
5070
|
onlineV1?: ImportProviderDNSZoneRequestOnlineV1;
|
|
5074
5071
|
};
|
|
5075
5072
|
type RefreshDNSZoneRequest = {
|
|
5076
|
-
/**
|
|
5073
|
+
/** DNS zone to refresh. */
|
|
5077
5074
|
dnsZone: string;
|
|
5078
|
-
/**
|
|
5075
|
+
/** Specifies whether or not to recreate the DNS zone. */
|
|
5079
5076
|
recreateDnsZone: boolean;
|
|
5080
|
-
/**
|
|
5077
|
+
/** Specifies whether or not to recreate the sub DNS zone. */
|
|
5081
5078
|
recreateSubDnsZone: boolean;
|
|
5082
5079
|
};
|
|
5083
5080
|
type ListDNSZoneVersionsRequest = {
|
|
5084
5081
|
dnsZone: string;
|
|
5085
|
-
/**
|
|
5082
|
+
/** Page number to return, from the paginated results. */
|
|
5086
5083
|
page?: number;
|
|
5087
|
-
/**
|
|
5084
|
+
/** Maximum number of DNS zones versions per page. */
|
|
5088
5085
|
pageSize?: number;
|
|
5089
5086
|
};
|
|
5090
5087
|
type ListDNSZoneVersionRecordsRequest = {
|
|
5091
5088
|
dnsZoneVersionId: string;
|
|
5092
|
-
/**
|
|
5089
|
+
/** Page number to return, from the paginated results. */
|
|
5093
5090
|
page?: number;
|
|
5094
|
-
/**
|
|
5091
|
+
/** Maximum number of DNS zones versions records per page. */
|
|
5095
5092
|
pageSize?: number;
|
|
5096
5093
|
};
|
|
5097
5094
|
type GetDNSZoneVersionDiffRequest = {
|
|
@@ -5399,15 +5396,16 @@ type RegistrarApiDeleteDomainHostRequest = {
|
|
|
5399
5396
|
};
|
|
5400
5397
|
|
|
5401
5398
|
/**
|
|
5402
|
-
* DNS API.
|
|
5399
|
+
* Domains and DNS API.
|
|
5403
5400
|
*
|
|
5404
|
-
* DNS API. Manage your DNS zones and records
|
|
5401
|
+
* Domains and DNS API. Manage your domains, DNS zones and records with the
|
|
5402
|
+
* Domains and DNS API.
|
|
5405
5403
|
*/
|
|
5406
5404
|
declare class API$j extends API$q {
|
|
5407
5405
|
protected pageOfListDNSZones: (request: Readonly<ListDNSZonesRequest>) => Promise<ListDNSZonesResponse>;
|
|
5408
5406
|
/**
|
|
5409
|
-
* List DNS zones.
|
|
5410
|
-
* DNS zones
|
|
5407
|
+
* List DNS zones. Retrieve the list of DNS zones you can manage and filter
|
|
5408
|
+
* DNS zones associated with specific domain names.
|
|
5411
5409
|
*
|
|
5412
5410
|
* @param request - The request {@link ListDNSZonesRequest}
|
|
5413
5411
|
* @returns A Promise of ListDNSZonesResponse
|
|
@@ -5417,29 +5415,30 @@ declare class API$j extends API$q {
|
|
|
5417
5415
|
[Symbol.asyncIterator]: () => AsyncGenerator<DNSZone[], void, void>;
|
|
5418
5416
|
};
|
|
5419
5417
|
/**
|
|
5420
|
-
* Create a DNS zone. Create a new DNS zone
|
|
5418
|
+
* Create a DNS zone. Create a new DNS zone specified by the domain name, the
|
|
5419
|
+
* subdomain and the Project ID.
|
|
5421
5420
|
*
|
|
5422
5421
|
* @param request - The request {@link CreateDNSZoneRequest}
|
|
5423
5422
|
* @returns A Promise of DNSZone
|
|
5424
5423
|
*/
|
|
5425
5424
|
createDNSZone: (request: Readonly<CreateDNSZoneRequest>) => Promise<DNSZone>;
|
|
5426
5425
|
/**
|
|
5427
|
-
* Update a DNS zone. Update the name and/or the
|
|
5426
|
+
* Update a DNS zone. Update the name and/or the Organizations for a DNS zone.
|
|
5428
5427
|
*
|
|
5429
5428
|
* @param request - The request {@link UpdateDNSZoneRequest}
|
|
5430
5429
|
* @returns A Promise of DNSZone
|
|
5431
5430
|
*/
|
|
5432
5431
|
updateDNSZone: (request: Readonly<UpdateDNSZoneRequest>) => Promise<DNSZone>;
|
|
5433
5432
|
/**
|
|
5434
|
-
* Clone a DNS zone. Clone an
|
|
5435
|
-
*
|
|
5433
|
+
* Clone a DNS zone. Clone an existing DNS zone with all its records into a
|
|
5434
|
+
* new DNS zone.
|
|
5436
5435
|
*
|
|
5437
5436
|
* @param request - The request {@link CloneDNSZoneRequest}
|
|
5438
5437
|
* @returns A Promise of DNSZone
|
|
5439
5438
|
*/
|
|
5440
5439
|
cloneDNSZone: (request: Readonly<CloneDNSZoneRequest>) => Promise<DNSZone>;
|
|
5441
5440
|
/**
|
|
5442
|
-
* Delete DNS zone. Delete a DNS zone and all
|
|
5441
|
+
* Delete a DNS zone. Delete a DNS zone and all its records.
|
|
5443
5442
|
*
|
|
5444
5443
|
* @param request - The request {@link DeleteDNSZoneRequest}
|
|
5445
5444
|
* @returns A Promise of DeleteDNSZoneResponse
|
|
@@ -5447,8 +5446,9 @@ declare class API$j extends API$q {
|
|
|
5447
5446
|
deleteDNSZone: (request: Readonly<DeleteDNSZoneRequest>) => Promise<DeleteDNSZoneResponse>;
|
|
5448
5447
|
protected pageOfListDNSZoneRecords: (request: Readonly<ListDNSZoneRecordsRequest>) => Promise<ListDNSZoneRecordsResponse>;
|
|
5449
5448
|
/**
|
|
5450
|
-
* List DNS zone
|
|
5451
|
-
* default
|
|
5449
|
+
* List records within a DNS zone. Retrieve a list of DNS records within a DNS
|
|
5450
|
+
* zone that has default name servers. You can filter records by type and
|
|
5451
|
+
* name.
|
|
5452
5452
|
*
|
|
5453
5453
|
* @param request - The request {@link ListDNSZoneRecordsRequest}
|
|
5454
5454
|
* @returns A Promise of ListDNSZoneRecordsResponse
|
|
@@ -5458,22 +5458,18 @@ declare class API$j extends API$q {
|
|
|
5458
5458
|
[Symbol.asyncIterator]: () => AsyncGenerator<DomainRecord[], void, void>;
|
|
5459
5459
|
};
|
|
5460
5460
|
/**
|
|
5461
|
-
* Update DNS zone
|
|
5462
|
-
*
|
|
5461
|
+
* Update records within a DNS zone. Update records within a DNS zone that has
|
|
5462
|
+
* default name servers and perform several actions on your records.
|
|
5463
5463
|
*
|
|
5464
|
-
*
|
|
5464
|
+
* Actions include:
|
|
5465
5465
|
*
|
|
5466
|
-
* - Add:
|
|
5467
|
-
*
|
|
5468
|
-
* -
|
|
5469
|
-
*
|
|
5470
|
-
* -
|
|
5471
|
-
*
|
|
5472
|
-
* -
|
|
5473
|
-
* - Delete a record
|
|
5474
|
-
* - Can be more specific and delete an IP from an existing A record for example
|
|
5475
|
-
* - Clear:
|
|
5476
|
-
* - Delete all records from a DNS zone
|
|
5466
|
+
* - Add: allows you to add a new record or add a new IP to an existing A
|
|
5467
|
+
* record, for example
|
|
5468
|
+
* - Set: allows you to edit a record or edit an IP from an existing A record,
|
|
5469
|
+
* for example
|
|
5470
|
+
* - Delete: allows you to delete a record or delete an IP from an existing A
|
|
5471
|
+
* record, for example
|
|
5472
|
+
* - Clear: allows you to delete all records from a DNS zone
|
|
5477
5473
|
*
|
|
5478
5474
|
* All edits will be versioned.
|
|
5479
5475
|
*
|
|
@@ -5482,55 +5478,57 @@ declare class API$j extends API$q {
|
|
|
5482
5478
|
*/
|
|
5483
5479
|
updateDNSZoneRecords: (request: Readonly<UpdateDNSZoneRecordsRequest>) => Promise<UpdateDNSZoneRecordsResponse>;
|
|
5484
5480
|
/**
|
|
5485
|
-
* List DNS zone
|
|
5486
|
-
*
|
|
5481
|
+
* List name servers within a DNS zone. Retrieve a list of name servers within
|
|
5482
|
+
* a DNS zone and their optional glue records.
|
|
5487
5483
|
*
|
|
5488
5484
|
* @param request - The request {@link ListDNSZoneNameserversRequest}
|
|
5489
5485
|
* @returns A Promise of ListDNSZoneNameserversResponse
|
|
5490
5486
|
*/
|
|
5491
5487
|
listDNSZoneNameservers: (request: Readonly<ListDNSZoneNameserversRequest>) => Promise<ListDNSZoneNameserversResponse>;
|
|
5492
5488
|
/**
|
|
5493
|
-
* Update DNS zone
|
|
5494
|
-
* glue records.
|
|
5489
|
+
* Update name servers within a DNS zone. Update name servers within a DNS
|
|
5490
|
+
* zone and set optional glue records.
|
|
5495
5491
|
*
|
|
5496
5492
|
* @param request - The request {@link UpdateDNSZoneNameserversRequest}
|
|
5497
5493
|
* @returns A Promise of UpdateDNSZoneNameserversResponse
|
|
5498
5494
|
*/
|
|
5499
5495
|
updateDNSZoneNameservers: (request: Readonly<UpdateDNSZoneNameserversRequest>) => Promise<UpdateDNSZoneNameserversResponse>;
|
|
5500
5496
|
/**
|
|
5501
|
-
* Clear DNS zone
|
|
5502
|
-
*
|
|
5497
|
+
* Clear records within a DNS zone. Delete all records within a DNS zone that
|
|
5498
|
+
* has default name servers.<br/> All edits will be versioned.
|
|
5503
5499
|
*
|
|
5504
5500
|
* @param request - The request {@link ClearDNSZoneRecordsRequest}
|
|
5505
5501
|
* @returns A Promise of ClearDNSZoneRecordsResponse
|
|
5506
5502
|
*/
|
|
5507
5503
|
clearDNSZoneRecords: (request: Readonly<ClearDNSZoneRecordsRequest>) => Promise<ClearDNSZoneRecordsResponse>;
|
|
5508
5504
|
/**
|
|
5509
|
-
* Export raw DNS zone.
|
|
5505
|
+
* Export a raw DNS zone. Export a DNS zone with default name servers, in a
|
|
5506
|
+
* specific format.
|
|
5510
5507
|
*
|
|
5511
5508
|
* @param request - The request {@link ExportRawDNSZoneRequest}
|
|
5512
5509
|
* @returns A Promise of Blob
|
|
5513
5510
|
*/
|
|
5514
5511
|
exportRawDNSZone: (request: Readonly<ExportRawDNSZoneRequest>) => Promise<Blob>;
|
|
5515
5512
|
/**
|
|
5516
|
-
* Import raw DNS zone. Import and replace records from a
|
|
5517
|
-
*
|
|
5513
|
+
* Import a raw DNS zone. Import and replace the format of records from a
|
|
5514
|
+
* given provider, with default name servers.
|
|
5518
5515
|
*
|
|
5519
5516
|
* @param request - The request {@link ImportRawDNSZoneRequest}
|
|
5520
5517
|
* @returns A Promise of ImportRawDNSZoneResponse
|
|
5521
5518
|
*/
|
|
5522
5519
|
importRawDNSZone: (request: Readonly<ImportRawDNSZoneRequest>) => Promise<ImportRawDNSZoneResponse>;
|
|
5523
5520
|
/**
|
|
5524
|
-
* Import
|
|
5525
|
-
*
|
|
5521
|
+
* Import a DNS zone from another provider. Import and replace the format of
|
|
5522
|
+
* records from a given provider, with default name servers.
|
|
5526
5523
|
*
|
|
5527
5524
|
* @param request - The request {@link ImportProviderDNSZoneRequest}
|
|
5528
5525
|
* @returns A Promise of ImportProviderDNSZoneResponse
|
|
5529
5526
|
*/
|
|
5530
5527
|
importProviderDNSZone: (request: Readonly<ImportProviderDNSZoneRequest>) => Promise<ImportProviderDNSZoneResponse>;
|
|
5531
5528
|
/**
|
|
5532
|
-
* Refresh DNS zone. Refresh SOA DNS zone
|
|
5533
|
-
* and
|
|
5529
|
+
* Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
|
|
5530
|
+
* DNS zone and update the SOA serial. You can recreate the given DNS zone and
|
|
5531
|
+
* its sub DNS zone if needed.
|
|
5534
5532
|
*
|
|
5535
5533
|
* @param request - The request {@link RefreshDNSZoneRequest}
|
|
5536
5534
|
* @returns A Promise of RefreshDNSZoneResponse
|
|
@@ -5538,9 +5536,9 @@ declare class API$j extends API$q {
|
|
|
5538
5536
|
refreshDNSZone: (request: Readonly<RefreshDNSZoneRequest>) => Promise<RefreshDNSZoneResponse>;
|
|
5539
5537
|
protected pageOfListDNSZoneVersions: (request: Readonly<ListDNSZoneVersionsRequest>) => Promise<ListDNSZoneVersionsResponse>;
|
|
5540
5538
|
/**
|
|
5541
|
-
* List DNS zone
|
|
5542
|
-
* version count is 100
|
|
5543
|
-
* version will be deleted after each new modification.
|
|
5539
|
+
* List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
|
|
5540
|
+
* The maximum version count is 100. If the count reaches this limit, the
|
|
5541
|
+
* oldest version will be deleted after each new modification.
|
|
5544
5542
|
*
|
|
5545
5543
|
* @param request - The request {@link ListDNSZoneVersionsRequest}
|
|
5546
5544
|
* @returns A Promise of ListDNSZoneVersionsResponse
|
|
@@ -5551,8 +5549,8 @@ declare class API$j extends API$q {
|
|
|
5551
5549
|
};
|
|
5552
5550
|
protected pageOfListDNSZoneVersionRecords: (request: Readonly<ListDNSZoneVersionRecordsRequest>) => Promise<ListDNSZoneVersionRecordsResponse>;
|
|
5553
5551
|
/**
|
|
5554
|
-
* List
|
|
5555
|
-
* zone version.
|
|
5552
|
+
* List records from a given version of a specific DNS zone. Retrieve a list
|
|
5553
|
+
* of records from a specific DNS zone version.
|
|
5556
5554
|
*
|
|
5557
5555
|
* @param request - The request {@link ListDNSZoneVersionRecordsRequest}
|
|
5558
5556
|
* @returns A Promise of ListDNSZoneVersionRecordsResponse
|
|
@@ -5562,22 +5560,24 @@ declare class API$j extends API$q {
|
|
|
5562
5560
|
[Symbol.asyncIterator]: () => AsyncGenerator<DomainRecord[], void, void>;
|
|
5563
5561
|
};
|
|
5564
5562
|
/**
|
|
5565
|
-
*
|
|
5566
|
-
* version.
|
|
5563
|
+
* Access differences from a specific DNS zone version. Access a previous DNS
|
|
5564
|
+
* zone version to see the differences from another specific version.
|
|
5567
5565
|
*
|
|
5568
5566
|
* @param request - The request {@link GetDNSZoneVersionDiffRequest}
|
|
5569
5567
|
* @returns A Promise of GetDNSZoneVersionDiffResponse
|
|
5570
5568
|
*/
|
|
5571
5569
|
getDNSZoneVersionDiff: (request: Readonly<GetDNSZoneVersionDiffRequest>) => Promise<GetDNSZoneVersionDiffResponse>;
|
|
5572
5570
|
/**
|
|
5573
|
-
* Restore DNS zone version. Restore and activate a
|
|
5571
|
+
* Restore a DNS zone version. Restore and activate a version of a specific
|
|
5572
|
+
* DNS zone.
|
|
5574
5573
|
*
|
|
5575
5574
|
* @param request - The request {@link RestoreDNSZoneVersionRequest}
|
|
5576
5575
|
* @returns A Promise of RestoreDNSZoneVersionResponse
|
|
5577
5576
|
*/
|
|
5578
5577
|
restoreDNSZoneVersion: (request: Readonly<RestoreDNSZoneVersionRequest>) => Promise<RestoreDNSZoneVersionResponse>;
|
|
5579
5578
|
/**
|
|
5580
|
-
* Get
|
|
5579
|
+
* Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
|
|
5580
|
+
* you do not have a certificate, the ouptut returns `no certificate found`.
|
|
5581
5581
|
*
|
|
5582
5582
|
* @param request - The request {@link GetSSLCertificateRequest}
|
|
5583
5583
|
* @returns A Promise of SSLCertificate
|
|
@@ -5592,7 +5592,8 @@ declare class API$j extends API$q {
|
|
|
5592
5592
|
*/
|
|
5593
5593
|
waitForSSLCertificate: (request: Readonly<GetSSLCertificateRequest>, options?: Readonly<WaitForOptions<SSLCertificate>>) => Promise<SSLCertificate>;
|
|
5594
5594
|
/**
|
|
5595
|
-
* Create or
|
|
5595
|
+
* Create or get the DNS zone's TLS certificate. Create a new TLS certificate
|
|
5596
|
+
* or retrieve information about an existing TLS certificate.
|
|
5596
5597
|
*
|
|
5597
5598
|
* @param request - The request {@link CreateSSLCertificateRequest}
|
|
5598
5599
|
* @returns A Promise of SSLCertificate
|
|
@@ -5600,7 +5601,8 @@ declare class API$j extends API$q {
|
|
|
5600
5601
|
createSSLCertificate: (request: Readonly<CreateSSLCertificateRequest>) => Promise<SSLCertificate>;
|
|
5601
5602
|
protected pageOfListSSLCertificates: (request: Readonly<ListSSLCertificatesRequest>) => Promise<ListSSLCertificatesResponse>;
|
|
5602
5603
|
/**
|
|
5603
|
-
* List
|
|
5604
|
+
* List a user's TLS certificates. List all the TLS certificates a user has
|
|
5605
|
+
* created, specified by the user's Project ID and the DNS zone.
|
|
5604
5606
|
*
|
|
5605
5607
|
* @param request - The request {@link ListSSLCertificatesRequest}
|
|
5606
5608
|
* @returns A Promise of ListSSLCertificatesResponse
|
|
@@ -5610,21 +5612,25 @@ declare class API$j extends API$q {
|
|
|
5610
5612
|
[Symbol.asyncIterator]: () => AsyncGenerator<SSLCertificate[], void, void>;
|
|
5611
5613
|
};
|
|
5612
5614
|
/**
|
|
5613
|
-
* Delete an TLS certificate
|
|
5615
|
+
* Delete a TLS certificate. Delete an existing TLS certificate specified by
|
|
5616
|
+
* its DNS zone. Deleting a TLS certificate is permanent and cannot be
|
|
5617
|
+
* undone.
|
|
5614
5618
|
*
|
|
5615
5619
|
* @param request - The request {@link DeleteSSLCertificateRequest}
|
|
5616
5620
|
* @returns A Promise of DeleteSSLCertificateResponse
|
|
5617
5621
|
*/
|
|
5618
5622
|
deleteSSLCertificate: (request: Readonly<DeleteSSLCertificateRequest>) => Promise<DeleteSSLCertificateResponse>;
|
|
5619
5623
|
/**
|
|
5620
|
-
* Get the DNS zone TSIG
|
|
5624
|
+
* Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
|
|
5625
|
+
* given DNS zone to allow AXFR requests.
|
|
5621
5626
|
*
|
|
5622
5627
|
* @param request - The request {@link GetDNSZoneTsigKeyRequest}
|
|
5623
5628
|
* @returns A Promise of GetDNSZoneTsigKeyResponse
|
|
5624
5629
|
*/
|
|
5625
5630
|
getDNSZoneTsigKey: (request: Readonly<GetDNSZoneTsigKeyRequest>) => Promise<GetDNSZoneTsigKeyResponse>;
|
|
5626
5631
|
/**
|
|
5627
|
-
* Delete the DNS zone TSIG
|
|
5632
|
+
* Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
|
|
5633
|
+
* its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
|
|
5628
5634
|
*
|
|
5629
5635
|
* @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
|
|
5630
5636
|
*/
|
|
@@ -6258,80 +6264,80 @@ type MACAddressStatus = 'unknown' | 'ready' | 'updating' | 'used' | 'error' | 'd
|
|
|
6258
6264
|
type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm';
|
|
6259
6265
|
/** Attach flexible i ps response. */
|
|
6260
6266
|
interface AttachFlexibleIPsResponse {
|
|
6261
|
-
/** Total count of
|
|
6267
|
+
/** Total count of flexible IPs that are being updated. */
|
|
6262
6268
|
totalCount: number;
|
|
6263
|
-
/**
|
|
6269
|
+
/** List of flexible IPs in an updating state. */
|
|
6264
6270
|
flexibleIps: FlexibleIP[];
|
|
6265
6271
|
}
|
|
6266
6272
|
/** Detach flexible i ps response. */
|
|
6267
6273
|
interface DetachFlexibleIPsResponse {
|
|
6268
|
-
/** Total count of
|
|
6274
|
+
/** Total count of flexible IPs that are being detached. */
|
|
6269
6275
|
totalCount: number;
|
|
6270
|
-
/**
|
|
6276
|
+
/** List of flexible IPs in a detaching state. */
|
|
6271
6277
|
flexibleIps: FlexibleIP[];
|
|
6272
6278
|
}
|
|
6273
6279
|
/** Flexible ip. */
|
|
6274
6280
|
interface FlexibleIP {
|
|
6275
|
-
/** ID of the
|
|
6281
|
+
/** ID of the flexible IP. */
|
|
6276
6282
|
id: string;
|
|
6277
|
-
/**
|
|
6283
|
+
/** ID of the Organization the flexible IP is attached to. */
|
|
6278
6284
|
organizationId: string;
|
|
6279
|
-
/**
|
|
6285
|
+
/** ID of the Project the flexible IP is attached to. */
|
|
6280
6286
|
projectId: string;
|
|
6281
|
-
/**
|
|
6287
|
+
/** Flexible IP description. */
|
|
6282
6288
|
description: string;
|
|
6283
|
-
/**
|
|
6289
|
+
/** Flexible IP tags. */
|
|
6284
6290
|
tags: string[];
|
|
6285
|
-
/** Date
|
|
6291
|
+
/** Date on which the flexible IP was last updated. */
|
|
6286
6292
|
updatedAt?: Date;
|
|
6287
|
-
/** Date
|
|
6293
|
+
/** Date on which the flexible IP was created. */
|
|
6288
6294
|
createdAt?: Date;
|
|
6289
6295
|
/**
|
|
6290
|
-
*
|
|
6296
|
+
* Flexible IP status.
|
|
6291
6297
|
*
|
|
6292
|
-
* - Ready :
|
|
6293
|
-
*
|
|
6294
|
-
* - Updating:
|
|
6298
|
+
* - Ready : flexible IP is created and ready to be attached to a server or to
|
|
6299
|
+
* be associated with a virtual MAC.
|
|
6300
|
+
* - Updating: flexible IP is being attached to a server or a virtual MAC
|
|
6295
6301
|
* operation is ongoing
|
|
6296
|
-
* - Attached:
|
|
6297
|
-
* - Error: a
|
|
6298
|
-
* - Detaching:
|
|
6299
|
-
* - Locked:
|
|
6302
|
+
* - Attached: flexible IP is attached to a server
|
|
6303
|
+
* - Error: a flexible IP operation resulted in an error
|
|
6304
|
+
* - Detaching: flexible IP is being detached from a server
|
|
6305
|
+
* - Locked: the resource of the flexible IP is locked.
|
|
6300
6306
|
*/
|
|
6301
6307
|
status: FlexibleIPStatus;
|
|
6302
|
-
/** IP of the
|
|
6308
|
+
/** IP of the flexible IP. */
|
|
6303
6309
|
ipAddress: string;
|
|
6304
|
-
/** MAC address of the
|
|
6310
|
+
/** MAC address of the flexible IP. */
|
|
6305
6311
|
macAddress?: MACAddress;
|
|
6306
|
-
/** ID of the server linked to the
|
|
6312
|
+
/** ID of the server linked to the flexible IP. */
|
|
6307
6313
|
serverId?: string;
|
|
6308
6314
|
/** Reverse DNS value. */
|
|
6309
6315
|
reverse: string;
|
|
6310
|
-
/**
|
|
6316
|
+
/** Availability Zone of the flexible IP. */
|
|
6311
6317
|
zone: Zone;
|
|
6312
6318
|
}
|
|
6313
6319
|
/** List flexible i ps response. */
|
|
6314
6320
|
interface ListFlexibleIPsResponse {
|
|
6315
|
-
/** Total count of matching
|
|
6321
|
+
/** Total count of matching flexible IPs. */
|
|
6316
6322
|
totalCount: number;
|
|
6317
|
-
/**
|
|
6323
|
+
/** List of all flexible IPs. */
|
|
6318
6324
|
flexibleIps: FlexibleIP[];
|
|
6319
6325
|
}
|
|
6320
6326
|
/** Mac address. */
|
|
6321
6327
|
interface MACAddress {
|
|
6322
|
-
/** ID of the
|
|
6328
|
+
/** ID of the flexible IP. */
|
|
6323
6329
|
id: string;
|
|
6324
6330
|
/** MAC address of the Virtual MAC. */
|
|
6325
6331
|
macAddress: string;
|
|
6326
|
-
/**
|
|
6332
|
+
/** Type of virtual MAC. */
|
|
6327
6333
|
macType: MACAddressType;
|
|
6328
|
-
/**
|
|
6334
|
+
/** Status of virtual MAC. */
|
|
6329
6335
|
status: MACAddressStatus;
|
|
6330
|
-
/** Date
|
|
6336
|
+
/** Date on which the virtual MAC was last updated. */
|
|
6331
6337
|
updatedAt?: Date;
|
|
6332
|
-
/** Date
|
|
6338
|
+
/** Date on which the virtual MAC was created. */
|
|
6333
6339
|
createdAt?: Date;
|
|
6334
|
-
/** MAC
|
|
6340
|
+
/** MAC address IP Availability Zone. */
|
|
6335
6341
|
zone: Zone;
|
|
6336
6342
|
}
|
|
6337
6343
|
type CreateFlexibleIPRequest = {
|
|
@@ -6339,87 +6345,95 @@ type CreateFlexibleIPRequest = {
|
|
|
6339
6345
|
zone?: Zone;
|
|
6340
6346
|
/** ID of the project to associate with the Flexible IP. */
|
|
6341
6347
|
projectId?: string;
|
|
6342
|
-
/**
|
|
6348
|
+
/** Flexible IP description (max. of 255 characters). */
|
|
6343
6349
|
description: string;
|
|
6344
|
-
/** Tags to associate to the
|
|
6350
|
+
/** Tags to associate to the flexible IP. */
|
|
6345
6351
|
tags?: string[];
|
|
6346
|
-
/**
|
|
6352
|
+
/** ID of the server to which the newly created flexible IP will be attached. */
|
|
6347
6353
|
serverId?: string;
|
|
6348
|
-
/**
|
|
6354
|
+
/** Value of the reverse DNS. */
|
|
6349
6355
|
reverse?: string;
|
|
6350
|
-
/**
|
|
6356
|
+
/** Defines whether the flexible IP has an IPv6 address. */
|
|
6351
6357
|
isIpv6: boolean;
|
|
6352
6358
|
};
|
|
6353
6359
|
type GetFlexibleIPRequest = {
|
|
6354
6360
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6355
6361
|
zone?: Zone;
|
|
6356
|
-
/**
|
|
6362
|
+
/** ID of the flexible IP. */
|
|
6357
6363
|
fipId: string;
|
|
6358
6364
|
};
|
|
6359
6365
|
type ListFlexibleIPsRequest$1 = {
|
|
6360
6366
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6361
6367
|
zone?: Zone;
|
|
6362
|
-
/**
|
|
6368
|
+
/** Sort order of the returned flexible IPs. */
|
|
6363
6369
|
orderBy?: ListFlexibleIPsRequestOrderBy;
|
|
6364
|
-
/**
|
|
6370
|
+
/** Page number. */
|
|
6365
6371
|
page?: number;
|
|
6366
|
-
/**
|
|
6372
|
+
/** Maximum number of flexible IPs per page. */
|
|
6367
6373
|
pageSize?: number;
|
|
6368
|
-
/**
|
|
6374
|
+
/**
|
|
6375
|
+
* Filter by tag, only flexible IPs with one or more matching tags will be
|
|
6376
|
+
* returned.
|
|
6377
|
+
*/
|
|
6369
6378
|
tags?: string[];
|
|
6370
|
-
/** Filter
|
|
6379
|
+
/** Filter by status, only flexible IPs with this status will be returned. */
|
|
6371
6380
|
status?: FlexibleIPStatus[];
|
|
6372
|
-
/**
|
|
6381
|
+
/**
|
|
6382
|
+
* Filter by server IDs, only flexible IPs with these server IDs will be
|
|
6383
|
+
* returned.
|
|
6384
|
+
*/
|
|
6373
6385
|
serverIds?: string[];
|
|
6374
|
-
/**
|
|
6386
|
+
/**
|
|
6387
|
+
* Filter by Organization ID, only flexible IPs from this Organization will be
|
|
6388
|
+
* returned.
|
|
6389
|
+
*/
|
|
6375
6390
|
organizationId?: string;
|
|
6376
|
-
/** Filter
|
|
6391
|
+
/** Filter by Project ID, only flexible IPs from this Project will be returned. */
|
|
6377
6392
|
projectId?: string;
|
|
6378
6393
|
};
|
|
6379
6394
|
type UpdateFlexibleIPRequest = {
|
|
6380
6395
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6381
6396
|
zone?: Zone;
|
|
6382
|
-
/** ID of the
|
|
6397
|
+
/** ID of the flexible IP to update. */
|
|
6383
6398
|
fipId: string;
|
|
6384
|
-
/**
|
|
6399
|
+
/** Flexible IP description (max. 255 characters). */
|
|
6385
6400
|
description?: string;
|
|
6386
|
-
/** Tags
|
|
6401
|
+
/** Tags associated with the flexible IP. */
|
|
6387
6402
|
tags?: string[];
|
|
6388
|
-
/**
|
|
6403
|
+
/** Value of the reverse DNS. */
|
|
6389
6404
|
reverse?: string;
|
|
6390
6405
|
};
|
|
6391
6406
|
type DeleteFlexibleIPRequest = {
|
|
6392
6407
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6393
6408
|
zone?: Zone;
|
|
6394
|
-
/** ID of the
|
|
6409
|
+
/** ID of the flexible IP to delete. */
|
|
6395
6410
|
fipId: string;
|
|
6396
6411
|
};
|
|
6397
6412
|
type AttachFlexibleIPRequest = {
|
|
6398
6413
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6399
6414
|
zone?: Zone;
|
|
6400
6415
|
/**
|
|
6401
|
-
*
|
|
6402
|
-
*
|
|
6403
|
-
* groups).
|
|
6416
|
+
* List of flexible IP IDs to attach to a server. Multiple IDs can be
|
|
6417
|
+
* provided, but note that flexible IPs must belong to the same MAC group (see
|
|
6418
|
+
* details about MAC groups).
|
|
6404
6419
|
*/
|
|
6405
6420
|
fipsIds: string[];
|
|
6406
|
-
/**
|
|
6421
|
+
/** ID of the server on which to attach the flexible IPs. */
|
|
6407
6422
|
serverId: string;
|
|
6408
6423
|
};
|
|
6409
6424
|
type DetachFlexibleIPRequest = {
|
|
6410
6425
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6411
6426
|
zone?: Zone;
|
|
6412
6427
|
/**
|
|
6413
|
-
*
|
|
6414
|
-
*
|
|
6415
|
-
* groups).
|
|
6428
|
+
* List of flexible IP IDs to detach from a server. Multiple IDs can be
|
|
6429
|
+
* provided. Note that flexible IPs must belong to the same MAC group.
|
|
6416
6430
|
*/
|
|
6417
6431
|
fipsIds: string[];
|
|
6418
6432
|
};
|
|
6419
6433
|
type GenerateMACAddrRequest = {
|
|
6420
6434
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6421
6435
|
zone?: Zone;
|
|
6422
|
-
/**
|
|
6436
|
+
/** ID of the flexible IP for which to generate a virtual MAC. */
|
|
6423
6437
|
fipId: string;
|
|
6424
6438
|
/** TODO. */
|
|
6425
6439
|
macType: MACAddressType;
|
|
@@ -6428,13 +6442,13 @@ type DuplicateMACAddrRequest = {
|
|
|
6428
6442
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6429
6443
|
zone?: Zone;
|
|
6430
6444
|
/**
|
|
6431
|
-
*
|
|
6432
|
-
* be attached to the same server.
|
|
6445
|
+
* ID of the flexible IP on which to duplicate the virtual MAC. Note that the
|
|
6446
|
+
* flexible IPs need to be attached to the same server.
|
|
6433
6447
|
*/
|
|
6434
6448
|
fipId: string;
|
|
6435
6449
|
/**
|
|
6436
|
-
*
|
|
6437
|
-
* attached to the same server.
|
|
6450
|
+
* ID of the flexible IP to duplicate the Virtual MAC from. Note that flexible
|
|
6451
|
+
* IPs need to be attached to the same server.
|
|
6438
6452
|
*/
|
|
6439
6453
|
duplicateFromFipId: string;
|
|
6440
6454
|
};
|
|
@@ -6448,26 +6462,29 @@ type DeleteMACAddrRequest = {
|
|
|
6448
6462
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
6449
6463
|
zone?: Zone;
|
|
6450
6464
|
/**
|
|
6451
|
-
*
|
|
6452
|
-
* belongs to a MAC group, the MAC will be removed from the MAC group
|
|
6453
|
-
*
|
|
6465
|
+
* ID of the flexible IP from which to delete the virtual MAC. If the flexible
|
|
6466
|
+
* IP belongs to a MAC group, the MAC will be removed from both the MAC group
|
|
6467
|
+
* and flexible IP.
|
|
6454
6468
|
*/
|
|
6455
6469
|
fipId: string;
|
|
6456
6470
|
};
|
|
6457
6471
|
|
|
6458
|
-
/** Flexible IP API. */
|
|
6472
|
+
/** Elastic Metal - Flexible IP API. */
|
|
6459
6473
|
declare class API$i extends API$q {
|
|
6460
6474
|
/** Lists the available zones of the API. */
|
|
6461
6475
|
static readonly LOCALITIES: Zone[];
|
|
6462
6476
|
/**
|
|
6463
|
-
* Create a
|
|
6477
|
+
* Create a new flexible IP. Generate a new flexible IP within a given zone,
|
|
6478
|
+
* specifying its configuration including Project ID and description.
|
|
6464
6479
|
*
|
|
6465
6480
|
* @param request - The request {@link CreateFlexibleIPRequest}
|
|
6466
6481
|
* @returns A Promise of FlexibleIP
|
|
6467
6482
|
*/
|
|
6468
6483
|
createFlexibleIP: (request: Readonly<CreateFlexibleIPRequest>) => Promise<FlexibleIP>;
|
|
6469
6484
|
/**
|
|
6470
|
-
* Get
|
|
6485
|
+
* Get an existing flexible IP. Retrieve information about an existing
|
|
6486
|
+
* flexible IP, specified by its ID and zone. Its full details, including
|
|
6487
|
+
* Project ID, description and status, are returned in the response object.
|
|
6471
6488
|
*
|
|
6472
6489
|
* @param request - The request {@link GetFlexibleIPRequest}
|
|
6473
6490
|
* @returns A Promise of FlexibleIP
|
|
@@ -6483,7 +6500,7 @@ declare class API$i extends API$q {
|
|
|
6483
6500
|
waitForFlexibleIP: (request: Readonly<GetFlexibleIPRequest>, options?: Readonly<WaitForOptions<FlexibleIP>>) => Promise<FlexibleIP>;
|
|
6484
6501
|
protected pageOfListFlexibleIPs: (request?: Readonly<ListFlexibleIPsRequest$1>) => Promise<ListFlexibleIPsResponse>;
|
|
6485
6502
|
/**
|
|
6486
|
-
* List
|
|
6503
|
+
* List flexible IPs. List all flexible IPs within a given zone.
|
|
6487
6504
|
*
|
|
6488
6505
|
* @param request - The request {@link ListFlexibleIPsRequest}
|
|
6489
6506
|
* @returns A Promise of ListFlexibleIPsResponse
|
|
@@ -6493,57 +6510,67 @@ declare class API$i extends API$q {
|
|
|
6493
6510
|
[Symbol.asyncIterator]: () => AsyncGenerator<FlexibleIP[], void, void>;
|
|
6494
6511
|
};
|
|
6495
6512
|
/**
|
|
6496
|
-
* Update
|
|
6513
|
+
* Update an existing flexible IP. Update the parameters of an existing
|
|
6514
|
+
* flexible IP, specified by its ID and zone. These parameters include tags
|
|
6515
|
+
* and description.
|
|
6497
6516
|
*
|
|
6498
6517
|
* @param request - The request {@link UpdateFlexibleIPRequest}
|
|
6499
6518
|
* @returns A Promise of FlexibleIP
|
|
6500
6519
|
*/
|
|
6501
6520
|
updateFlexibleIP: (request: Readonly<UpdateFlexibleIPRequest>) => Promise<FlexibleIP>;
|
|
6502
6521
|
/**
|
|
6503
|
-
* Delete
|
|
6522
|
+
* Delete an existing flexible IP. Delete an existing flexible IP, specified
|
|
6523
|
+
* by its ID and zone. Note that deleting a flexible IP is permanent and
|
|
6524
|
+
* cannot be undone.
|
|
6504
6525
|
*
|
|
6505
6526
|
* @param request - The request {@link DeleteFlexibleIPRequest}
|
|
6506
6527
|
*/
|
|
6507
6528
|
deleteFlexibleIP: (request: Readonly<DeleteFlexibleIPRequest>) => Promise<void>;
|
|
6508
6529
|
/**
|
|
6509
|
-
* Attach
|
|
6530
|
+
* Attach an existing flexible IP to a server. Attach an existing flexible IP
|
|
6531
|
+
* to a specified Elastic Metal server.
|
|
6510
6532
|
*
|
|
6511
6533
|
* @param request - The request {@link AttachFlexibleIPRequest}
|
|
6512
6534
|
* @returns A Promise of AttachFlexibleIPsResponse
|
|
6513
6535
|
*/
|
|
6514
6536
|
attachFlexibleIP: (request: Readonly<AttachFlexibleIPRequest>) => Promise<AttachFlexibleIPsResponse>;
|
|
6515
6537
|
/**
|
|
6516
|
-
* Detach
|
|
6538
|
+
* Detach an existing flexible IP from a server. Detach an existing flexible
|
|
6539
|
+
* IP from a specified Elastic Metal server.
|
|
6517
6540
|
*
|
|
6518
6541
|
* @param request - The request {@link DetachFlexibleIPRequest}
|
|
6519
6542
|
* @returns A Promise of DetachFlexibleIPsResponse
|
|
6520
6543
|
*/
|
|
6521
6544
|
detachFlexibleIP: (request: Readonly<DetachFlexibleIPRequest>) => Promise<DetachFlexibleIPsResponse>;
|
|
6522
6545
|
/**
|
|
6523
|
-
* Generate a virtual MAC on
|
|
6546
|
+
* Generate a virtual MAC address on an existing flexible IP. Generate a
|
|
6547
|
+
* virtual MAC (Media Access Control) address on an existing flexible IP.
|
|
6524
6548
|
*
|
|
6525
6549
|
* @param request - The request {@link GenerateMACAddrRequest}
|
|
6526
6550
|
* @returns A Promise of FlexibleIP
|
|
6527
6551
|
*/
|
|
6528
6552
|
generateMACAddr: (request: Readonly<GenerateMACAddrRequest>) => Promise<FlexibleIP>;
|
|
6529
6553
|
/**
|
|
6530
|
-
* Duplicate a
|
|
6531
|
-
*
|
|
6554
|
+
* Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
|
|
6555
|
+
* MAC address from a given flexible IP to another flexible IP attached to the
|
|
6556
|
+
* same server.
|
|
6532
6557
|
*
|
|
6533
6558
|
* @param request - The request {@link DuplicateMACAddrRequest}
|
|
6534
6559
|
* @returns A Promise of FlexibleIP
|
|
6535
6560
|
*/
|
|
6536
6561
|
duplicateMACAddr: (request: Readonly<DuplicateMACAddrRequest>) => Promise<FlexibleIP>;
|
|
6537
6562
|
/**
|
|
6538
|
-
*
|
|
6539
|
-
*
|
|
6563
|
+
* Relocate an existing virtual MAC address to a different flexible IP.
|
|
6564
|
+
* Relocate a virtual MAC (Media Access Control) address from an existing
|
|
6565
|
+
* flexible IP to a different flexible IP.
|
|
6540
6566
|
*
|
|
6541
6567
|
* @param request - The request {@link MoveMACAddrRequest}
|
|
6542
6568
|
* @returns A Promise of FlexibleIP
|
|
6543
6569
|
*/
|
|
6544
6570
|
moveMACAddr: (request: Readonly<MoveMACAddrRequest>) => Promise<FlexibleIP>;
|
|
6545
6571
|
/**
|
|
6546
|
-
*
|
|
6572
|
+
* Detach a given virtual MAC address from an existing flexible IP. Detach a
|
|
6573
|
+
* given MAC (Media Access Control) address from an existing flexible IP.
|
|
6547
6574
|
*
|
|
6548
6575
|
* @param request - The request {@link DeleteMACAddrRequest}
|
|
6549
6576
|
*/
|
|
@@ -7960,9 +7987,9 @@ interface APIKey {
|
|
|
7960
7987
|
updatedAt?: Date;
|
|
7961
7988
|
/** Date and time of API key expiration. */
|
|
7962
7989
|
expiresAt?: Date;
|
|
7963
|
-
/**
|
|
7990
|
+
/** Default Project ID specified for this API key. */
|
|
7964
7991
|
defaultProjectId: string;
|
|
7965
|
-
/**
|
|
7992
|
+
/** Defines whether or not the API key is editable. */
|
|
7966
7993
|
editable: boolean;
|
|
7967
7994
|
/** IP address of the device that created the API key. */
|
|
7968
7995
|
creationIp: string;
|
|
@@ -7981,7 +8008,7 @@ interface Application {
|
|
|
7981
8008
|
updatedAt?: Date;
|
|
7982
8009
|
/** ID of the Organization. */
|
|
7983
8010
|
organizationId: string;
|
|
7984
|
-
/**
|
|
8011
|
+
/** Defines whether or not the application is editable. */
|
|
7985
8012
|
editable: boolean;
|
|
7986
8013
|
/** Number of API keys attributed to the application. */
|
|
7987
8014
|
nbApiKeys: number;
|
|
@@ -8118,7 +8145,7 @@ interface Policy {
|
|
|
8118
8145
|
createdAt?: Date;
|
|
8119
8146
|
/** Date and time of last policy update. */
|
|
8120
8147
|
updatedAt?: Date;
|
|
8121
|
-
/**
|
|
8148
|
+
/** Defines whether or not a policy is editable. */
|
|
8122
8149
|
editable: boolean;
|
|
8123
8150
|
/** Number of rules of the policy. */
|
|
8124
8151
|
nbRules: number;
|
|
@@ -8148,7 +8175,7 @@ interface Policy {
|
|
|
8148
8175
|
*/
|
|
8149
8176
|
applicationId?: string;
|
|
8150
8177
|
/**
|
|
8151
|
-
*
|
|
8178
|
+
* Defines whether or not a policy is attributed to a principal.
|
|
8152
8179
|
*
|
|
8153
8180
|
* One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId',
|
|
8154
8181
|
* 'noPrincipal' could be set.
|
|
@@ -8166,7 +8193,7 @@ interface Quotum {
|
|
|
8166
8193
|
*/
|
|
8167
8194
|
limit?: number;
|
|
8168
8195
|
/**
|
|
8169
|
-
*
|
|
8196
|
+
* Defines whether or not the quota is unlimited.
|
|
8170
8197
|
*
|
|
8171
8198
|
* One-of ('value'): at most one of 'limit', 'unlimited' could be set.
|
|
8172
8199
|
*/
|
|
@@ -8269,7 +8296,7 @@ interface User$1 {
|
|
|
8269
8296
|
twoFactorEnabled?: boolean;
|
|
8270
8297
|
/** Status of user invitation. */
|
|
8271
8298
|
status: UserStatus;
|
|
8272
|
-
/**
|
|
8299
|
+
/** Defines whether MFA is enabled. */
|
|
8273
8300
|
mfa: boolean;
|
|
8274
8301
|
}
|
|
8275
8302
|
type ListSSHKeysRequest$1 = {
|
|
@@ -8285,11 +8312,11 @@ type ListSSHKeysRequest$1 = {
|
|
|
8285
8312
|
name?: string;
|
|
8286
8313
|
/** Filter by Project ID. */
|
|
8287
8314
|
projectId?: string;
|
|
8288
|
-
/**
|
|
8315
|
+
/** Defines whether to include disabled SSH keys or not. */
|
|
8289
8316
|
disabled?: boolean;
|
|
8290
8317
|
};
|
|
8291
8318
|
type CreateSSHKeyRequest$1 = {
|
|
8292
|
-
/**
|
|
8319
|
+
/** Name of the SSH key. Max length is 1000. */
|
|
8293
8320
|
name?: string;
|
|
8294
8321
|
/**
|
|
8295
8322
|
* SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and
|
|
@@ -8300,7 +8327,7 @@ type CreateSSHKeyRequest$1 = {
|
|
|
8300
8327
|
projectId?: string;
|
|
8301
8328
|
};
|
|
8302
8329
|
type GetSSHKeyRequest = {
|
|
8303
|
-
/**
|
|
8330
|
+
/** ID of the SSH key. */
|
|
8304
8331
|
sshKeyId: string;
|
|
8305
8332
|
};
|
|
8306
8333
|
type UpdateSSHKeyRequest$1 = {
|
|
@@ -8346,7 +8373,7 @@ type ListApplicationsRequest$1 = {
|
|
|
8346
8373
|
name?: string;
|
|
8347
8374
|
/** ID of the Organization to filter. */
|
|
8348
8375
|
organizationId?: string;
|
|
8349
|
-
/**
|
|
8376
|
+
/** Defines whether to filter out editable applications or not. */
|
|
8350
8377
|
editable?: boolean;
|
|
8351
8378
|
/** Filter by list of IDs. */
|
|
8352
8379
|
applicationIds?: string[];
|
|
@@ -8469,15 +8496,15 @@ type ListPoliciesRequest$1 = {
|
|
|
8469
8496
|
page?: number;
|
|
8470
8497
|
/** ID of the Organization to filter. */
|
|
8471
8498
|
organizationId?: string;
|
|
8472
|
-
/**
|
|
8499
|
+
/** Defines whether or not filter out editable policies. */
|
|
8473
8500
|
editable?: boolean;
|
|
8474
|
-
/**
|
|
8501
|
+
/** Defines whether or not to filter by list of user IDs. */
|
|
8475
8502
|
userIds?: string[];
|
|
8476
|
-
/**
|
|
8503
|
+
/** Defines whether or not to filter by list of group IDs. */
|
|
8477
8504
|
groupIds?: string[];
|
|
8478
8505
|
/** Filter by a list of application IDs. */
|
|
8479
8506
|
applicationIds?: string[];
|
|
8480
|
-
/**
|
|
8507
|
+
/** Defines whether or not the policy is attributed to a principal. */
|
|
8481
8508
|
noPrincipal?: boolean;
|
|
8482
8509
|
/** Name of the policy to fetch. */
|
|
8483
8510
|
policyName?: string;
|
|
@@ -8513,7 +8540,7 @@ type CreatePolicyRequest$1 = {
|
|
|
8513
8540
|
*/
|
|
8514
8541
|
applicationId?: string;
|
|
8515
8542
|
/**
|
|
8516
|
-
*
|
|
8543
|
+
* Defines whether or not a policy is attributed to a principal.
|
|
8517
8544
|
*
|
|
8518
8545
|
* One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId',
|
|
8519
8546
|
* 'noPrincipal' could be set.
|
|
@@ -8553,7 +8580,7 @@ type UpdatePolicyRequest$1 = {
|
|
|
8553
8580
|
*/
|
|
8554
8581
|
applicationId?: string;
|
|
8555
8582
|
/**
|
|
8556
|
-
*
|
|
8583
|
+
* Defines whether or not the policy is attributed to a principal.
|
|
8557
8584
|
*
|
|
8558
8585
|
* One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId',
|
|
8559
8586
|
* 'noPrincipal' could be set.
|
|
@@ -8612,9 +8639,9 @@ type ListAPIKeysRequest$1 = {
|
|
|
8612
8639
|
* One-of ('bearer'): at most one of 'applicationId', 'userId' could be set.
|
|
8613
8640
|
*/
|
|
8614
8641
|
userId?: string;
|
|
8615
|
-
/**
|
|
8642
|
+
/** Defines whether to filter out editable API keys or not. */
|
|
8616
8643
|
editable?: boolean;
|
|
8617
|
-
/**
|
|
8644
|
+
/** Defines whether to filter out expired API keys or not. */
|
|
8618
8645
|
expired?: boolean;
|
|
8619
8646
|
/** Filter by access key. */
|
|
8620
8647
|
accessKey?: string;
|
|
@@ -8640,9 +8667,9 @@ type CreateAPIKeyRequest$1 = {
|
|
|
8640
8667
|
userId?: string;
|
|
8641
8668
|
/** Expiration date of the API key. */
|
|
8642
8669
|
expiresAt?: Date;
|
|
8643
|
-
/**
|
|
8670
|
+
/** Default Project ID to use with Object Storage. */
|
|
8644
8671
|
defaultProjectId?: string;
|
|
8645
|
-
/**
|
|
8672
|
+
/** Description of the API key (max length is 200 characters). */
|
|
8646
8673
|
description: string;
|
|
8647
8674
|
};
|
|
8648
8675
|
type GetAPIKeyRequest = {
|
|
@@ -8652,9 +8679,9 @@ type GetAPIKeyRequest = {
|
|
|
8652
8679
|
type UpdateAPIKeyRequest$1 = {
|
|
8653
8680
|
/** Access key to update. */
|
|
8654
8681
|
accessKey: string;
|
|
8655
|
-
/**
|
|
8682
|
+
/** New default Project ID to set. */
|
|
8656
8683
|
defaultProjectId?: string;
|
|
8657
|
-
/**
|
|
8684
|
+
/** New description to update. */
|
|
8658
8685
|
description?: string;
|
|
8659
8686
|
};
|
|
8660
8687
|
type DeleteAPIKeyRequest = {
|
|
@@ -9824,7 +9851,10 @@ interface SecurityGroup {
|
|
|
9824
9851
|
name: string;
|
|
9825
9852
|
/** Security group description. */
|
|
9826
9853
|
description: string;
|
|
9827
|
-
/**
|
|
9854
|
+
/**
|
|
9855
|
+
* True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please
|
|
9856
|
+
* open a support ticket if you need to make it configurable.
|
|
9857
|
+
*/
|
|
9828
9858
|
enableDefaultSecurity: boolean;
|
|
9829
9859
|
/** Default inbound policy. */
|
|
9830
9860
|
inboundDefaultPolicy: SecurityGroupPolicy;
|
|
@@ -10666,7 +10696,10 @@ type CreateSecurityGroupRequest = {
|
|
|
10666
10696
|
inboundDefaultPolicy?: SecurityGroupPolicy;
|
|
10667
10697
|
/** Default policy for outbound rules. */
|
|
10668
10698
|
outboundDefaultPolicy?: SecurityGroupPolicy;
|
|
10669
|
-
/**
|
|
10699
|
+
/**
|
|
10700
|
+
* True to block SMTP on IPv4 and IPv6. This feature is read only, please open
|
|
10701
|
+
* a support ticket if you need to make it configurable.
|
|
10702
|
+
*/
|
|
10670
10703
|
enableDefaultSecurity?: boolean;
|
|
10671
10704
|
};
|
|
10672
10705
|
type GetSecurityGroupRequest = {
|
|
@@ -11183,7 +11216,10 @@ type SetSecurityGroupRequest = {
|
|
|
11183
11216
|
modificationDate?: Date;
|
|
11184
11217
|
/** Description of the security group. */
|
|
11185
11218
|
description: string;
|
|
11186
|
-
/**
|
|
11219
|
+
/**
|
|
11220
|
+
* True to block SMTP on IPv4 and IPv6. This feature is read only, please open
|
|
11221
|
+
* a support ticket if you need to make it configurable.
|
|
11222
|
+
*/
|
|
11187
11223
|
enableDefaultSecurity: boolean;
|
|
11188
11224
|
/** Default inbound policy. */
|
|
11189
11225
|
inboundDefaultPolicy?: SecurityGroupPolicy;
|
|
@@ -11238,7 +11274,7 @@ declare class API$f extends API$q {
|
|
|
11238
11274
|
*/
|
|
11239
11275
|
listServersTypes: (request?: Readonly<ListServersTypesRequest>) => Promise<ListServersTypesResponse>;
|
|
11240
11276
|
/**
|
|
11241
|
-
* List
|
|
11277
|
+
* List volume types. List all volume types and their technical details.
|
|
11242
11278
|
*
|
|
11243
11279
|
* @param request - The request {@link ListVolumesTypesRequest}
|
|
11244
11280
|
* @returns A Promise of ListVolumesTypesResponse
|
|
@@ -11293,7 +11329,7 @@ declare class API$f extends API$q {
|
|
|
11293
11329
|
* preserve your local volumes, you should use the `archive` action instead of
|
|
11294
11330
|
* `terminate`. Similarly, if you want to keep your block storage volumes, you
|
|
11295
11331
|
* must first detach them before issuing the `terminate` command. For more
|
|
11296
|
-
* information, read the [Volumes](#volumes-
|
|
11332
|
+
* information, read the [Volumes](#path-volumes-list-volumes) documentation.
|
|
11297
11333
|
*
|
|
11298
11334
|
* @param request - The request {@link ServerActionRequest}
|
|
11299
11335
|
* @returns A Promise of ServerActionResponse
|
|
@@ -12304,14 +12340,14 @@ interface Certificate$1 {
|
|
|
12304
12340
|
}
|
|
12305
12341
|
/** Create device response. */
|
|
12306
12342
|
interface CreateDeviceResponse {
|
|
12307
|
-
/**
|
|
12343
|
+
/** Information related to the created device. */
|
|
12308
12344
|
device?: Device;
|
|
12309
12345
|
/** Device certificate. */
|
|
12310
12346
|
certificate?: Certificate$1;
|
|
12311
12347
|
}
|
|
12312
12348
|
/** Create network response. */
|
|
12313
12349
|
interface CreateNetworkResponse {
|
|
12314
|
-
/**
|
|
12350
|
+
/** Information related to the created network. */
|
|
12315
12351
|
network?: Network;
|
|
12316
12352
|
/** Endpoint Key to keep secret. This cannot be retrieved later. */
|
|
12317
12353
|
secret: string;
|
|
@@ -12338,7 +12374,7 @@ interface CreateRouteRequestS3Config {
|
|
|
12338
12374
|
}
|
|
12339
12375
|
/** Device. */
|
|
12340
12376
|
interface Device {
|
|
12341
|
-
/** Device ID, also used as MQTT Client ID or
|
|
12377
|
+
/** Device ID, also used as MQTT Client ID or username. */
|
|
12342
12378
|
id: string;
|
|
12343
12379
|
/** Device name. */
|
|
12344
12380
|
name: string;
|
|
@@ -12348,28 +12384,31 @@ interface Device {
|
|
|
12348
12384
|
status: DeviceStatus;
|
|
12349
12385
|
/** Hub ID. */
|
|
12350
12386
|
hubId: string;
|
|
12351
|
-
/**
|
|
12387
|
+
/** Last connection/activity date of a device. */
|
|
12352
12388
|
lastActivityAt?: Date;
|
|
12353
|
-
/**
|
|
12389
|
+
/** Defines whether the device is connected to the Hub. */
|
|
12354
12390
|
isConnected: boolean;
|
|
12355
|
-
/**
|
|
12391
|
+
/**
|
|
12392
|
+
* Defines whether to allow the device to connect to the Hub without TLS
|
|
12393
|
+
* mutual authentication.
|
|
12394
|
+
*/
|
|
12356
12395
|
allowInsecure: boolean;
|
|
12357
12396
|
/**
|
|
12358
|
-
*
|
|
12359
|
-
* credentials.
|
|
12397
|
+
* Defines whether to allow multiple physical devices to connect to the Hub
|
|
12398
|
+
* with this device's credentials.
|
|
12360
12399
|
*/
|
|
12361
12400
|
allowMultipleConnections: boolean;
|
|
12362
12401
|
/** Filter-sets to restrict the topics the device can publish/subscribe to. */
|
|
12363
12402
|
messageFilters?: DeviceMessageFilters;
|
|
12364
12403
|
/**
|
|
12365
|
-
*
|
|
12366
|
-
* certificate allows a device to authenticate using that specific
|
|
12367
|
-
* without checking the
|
|
12404
|
+
* Defines whether the device was assigned a custom certificate. Assigning a
|
|
12405
|
+
* custom certificate allows a device to authenticate using that specific
|
|
12406
|
+
* certificate without checking the Hub's CA certificate.
|
|
12368
12407
|
*/
|
|
12369
12408
|
hasCustomCertificate: boolean;
|
|
12370
|
-
/**
|
|
12409
|
+
/** Date at which the device was added. */
|
|
12371
12410
|
createdAt?: Date;
|
|
12372
|
-
/**
|
|
12411
|
+
/** Date at which the device was last modified. */
|
|
12373
12412
|
updatedAt?: Date;
|
|
12374
12413
|
}
|
|
12375
12414
|
/** Device. message filters. */
|
|
@@ -12382,9 +12421,10 @@ interface DeviceMessageFilters {
|
|
|
12382
12421
|
/** Device. message filters. rule. */
|
|
12383
12422
|
interface DeviceMessageFiltersRule {
|
|
12384
12423
|
/**
|
|
12385
|
-
* How to use the topic list. If
|
|
12386
|
-
*
|
|
12387
|
-
* topics
|
|
12424
|
+
* How to use the topic list. If set to `accept`, all topics in the topics
|
|
12425
|
+
* list will be allowed, with all other topics being denied. If set to
|
|
12426
|
+
* `reject`, all topics in the topics list will be denied, with all other
|
|
12427
|
+
* topics being allowed.
|
|
12388
12428
|
*/
|
|
12389
12429
|
policy: DeviceMessageFiltersRulePolicy;
|
|
12390
12430
|
/**
|
|
@@ -12395,7 +12435,7 @@ interface DeviceMessageFiltersRule {
|
|
|
12395
12435
|
}
|
|
12396
12436
|
/** Get device certificate response. */
|
|
12397
12437
|
interface GetDeviceCertificateResponse {
|
|
12398
|
-
/**
|
|
12438
|
+
/** Information related to the created device. */
|
|
12399
12439
|
device?: Device;
|
|
12400
12440
|
/** Device certificate. */
|
|
12401
12441
|
certificatePem: string;
|
|
@@ -12410,7 +12450,7 @@ interface GetHubCAResponse {
|
|
|
12410
12450
|
}
|
|
12411
12451
|
/** Get hub metrics response. */
|
|
12412
12452
|
interface GetHubMetricsResponse {
|
|
12413
|
-
/** Metrics for a
|
|
12453
|
+
/** Metrics for a Hub over the requested period. */
|
|
12414
12454
|
metrics: TimeSeries[];
|
|
12415
12455
|
}
|
|
12416
12456
|
/** Hub. */
|
|
@@ -12423,19 +12463,19 @@ interface Hub {
|
|
|
12423
12463
|
status: HubStatus;
|
|
12424
12464
|
/** Hub feature set. */
|
|
12425
12465
|
productPlan: HubProductPlan;
|
|
12426
|
-
/**
|
|
12466
|
+
/** Defines whether the hub has been enabled. */
|
|
12427
12467
|
enabled: boolean;
|
|
12428
12468
|
/** Number of registered devices. */
|
|
12429
12469
|
deviceCount: number;
|
|
12430
12470
|
/** Number of currently connected devices. */
|
|
12431
12471
|
connectedDeviceCount: number;
|
|
12432
12472
|
/**
|
|
12433
|
-
* Host to connect your devices to. Devices should be connected to this host
|
|
12434
|
-
*
|
|
12473
|
+
* Host to connect your devices to. Devices should be connected to this host.
|
|
12474
|
+
* Port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or
|
|
12435
12475
|
* 443 (MQTT over Websocket over TLS).
|
|
12436
12476
|
*/
|
|
12437
12477
|
endpoint: string;
|
|
12438
|
-
/**
|
|
12478
|
+
/** Defines whether to disable Hub events. */
|
|
12439
12479
|
disableEvents: boolean;
|
|
12440
12480
|
/** Hub events topic prefix. */
|
|
12441
12481
|
eventsTopicPrefix: string;
|
|
@@ -12450,18 +12490,19 @@ interface Hub {
|
|
|
12450
12490
|
/** Organization owning the resource. */
|
|
12451
12491
|
organizationId: string;
|
|
12452
12492
|
/**
|
|
12453
|
-
*
|
|
12454
|
-
* hub using a valid certificate chain, it will be
|
|
12455
|
-
* inside your
|
|
12456
|
-
* find out if a device with the same name already
|
|
12457
|
-
* only be enabled on a hub with a custom certificate
|
|
12493
|
+
* Defines whether to enable device auto provisioning. When an unknown device
|
|
12494
|
+
* connects to your hub using a valid certificate chain, it will be
|
|
12495
|
+
* automatically provisioned inside your Hub. The Hub uses the common name of
|
|
12496
|
+
* the device certifcate to find out if a device with the same name already
|
|
12497
|
+
* exists. This setting can only be enabled on a hub with a custom certificate
|
|
12498
|
+
* authority.
|
|
12458
12499
|
*/
|
|
12459
12500
|
enableDeviceAutoProvisioning: boolean;
|
|
12460
12501
|
/**
|
|
12461
|
-
*
|
|
12462
|
-
*
|
|
12463
|
-
* Scaleway. Once a custom certificate authority is
|
|
12464
|
-
* be set to true
|
|
12502
|
+
* Defines whether the hub is using a custom certificate authority. Flag is
|
|
12503
|
+
* automatically set to `false` after Hub creation, as Hub certificates are
|
|
12504
|
+
* managed by Scaleway. Once a custom certificate authority is set, the flag
|
|
12505
|
+
* will be set to `true`.
|
|
12465
12506
|
*/
|
|
12466
12507
|
hasCustomCa: boolean;
|
|
12467
12508
|
/**
|
|
@@ -12479,12 +12520,12 @@ interface HubTwinsGraphiteConfig {
|
|
|
12479
12520
|
interface ListDevicesResponse {
|
|
12480
12521
|
/** Total number of devices. */
|
|
12481
12522
|
totalCount: number;
|
|
12482
|
-
/**
|
|
12523
|
+
/** Page of devices. */
|
|
12483
12524
|
devices: Device[];
|
|
12484
12525
|
}
|
|
12485
12526
|
/** List hubs response. */
|
|
12486
12527
|
interface ListHubsResponse {
|
|
12487
|
-
/** Total number of
|
|
12528
|
+
/** Total number of Hubs. */
|
|
12488
12529
|
totalCount: number;
|
|
12489
12530
|
/** A page of hubs. */
|
|
12490
12531
|
hubs: Hub[];
|
|
@@ -12493,24 +12534,24 @@ interface ListHubsResponse {
|
|
|
12493
12534
|
interface ListNetworksResponse {
|
|
12494
12535
|
/** Total number of Networks. */
|
|
12495
12536
|
totalCount: number;
|
|
12496
|
-
/**
|
|
12537
|
+
/** Page of networks. */
|
|
12497
12538
|
networks: Network[];
|
|
12498
12539
|
}
|
|
12499
12540
|
/** List routes response. */
|
|
12500
12541
|
interface ListRoutesResponse$1 {
|
|
12501
12542
|
/** Total number of routes. */
|
|
12502
12543
|
totalCount: number;
|
|
12503
|
-
/**
|
|
12544
|
+
/** Page of routes. */
|
|
12504
12545
|
routes: RouteSummary[];
|
|
12505
12546
|
}
|
|
12506
12547
|
/** List twin documents response. */
|
|
12507
12548
|
interface ListTwinDocumentsResponse {
|
|
12508
|
-
/**
|
|
12549
|
+
/** List of the twin document. */
|
|
12509
12550
|
documents: ListTwinDocumentsResponseDocumentSummary[];
|
|
12510
12551
|
}
|
|
12511
12552
|
/** List twin documents response. document summary. */
|
|
12512
12553
|
interface ListTwinDocumentsResponseDocumentSummary {
|
|
12513
|
-
/**
|
|
12554
|
+
/** Name of the document. */
|
|
12514
12555
|
documentName: string;
|
|
12515
12556
|
}
|
|
12516
12557
|
/** Network. */
|
|
@@ -12525,7 +12566,7 @@ interface Network {
|
|
|
12525
12566
|
endpoint: string;
|
|
12526
12567
|
/** Hub ID to connect the Network to. */
|
|
12527
12568
|
hubId: string;
|
|
12528
|
-
/**
|
|
12569
|
+
/** Date at which the network was created. */
|
|
12529
12570
|
createdAt?: Date;
|
|
12530
12571
|
/**
|
|
12531
12572
|
* Topic prefix for the Network. This prefix will be prepended to all topics
|
|
@@ -12535,7 +12576,7 @@ interface Network {
|
|
|
12535
12576
|
}
|
|
12536
12577
|
/** Renew device certificate response. */
|
|
12537
12578
|
interface RenewDeviceCertificateResponse {
|
|
12538
|
-
/**
|
|
12579
|
+
/** Information related to the created device. */
|
|
12539
12580
|
device?: Device;
|
|
12540
12581
|
/** Device certificate. */
|
|
12541
12582
|
certificate?: Certificate$1;
|
|
@@ -12546,7 +12587,7 @@ interface Route$1 {
|
|
|
12546
12587
|
id: string;
|
|
12547
12588
|
/** Route name. */
|
|
12548
12589
|
name: string;
|
|
12549
|
-
/** ID of the route
|
|
12590
|
+
/** Hub ID of the route. */
|
|
12550
12591
|
hubId: string;
|
|
12551
12592
|
/**
|
|
12552
12593
|
* Topic the route subscribes to. It must be a valid MQTT topic and up to
|
|
@@ -12555,7 +12596,7 @@ interface Route$1 {
|
|
|
12555
12596
|
topic: string;
|
|
12556
12597
|
/** Route type. */
|
|
12557
12598
|
type: RouteRouteType;
|
|
12558
|
-
/**
|
|
12599
|
+
/** Date at which the route was created. */
|
|
12559
12600
|
createdAt?: Date;
|
|
12560
12601
|
/**
|
|
12561
12602
|
* When using S3 Route, S3-specific configuration fields.
|
|
@@ -12578,14 +12619,14 @@ interface Route$1 {
|
|
|
12578
12619
|
* could be set.
|
|
12579
12620
|
*/
|
|
12580
12621
|
restConfig?: RouteRestConfig;
|
|
12581
|
-
/**
|
|
12622
|
+
/** Date at which the route was last updated. */
|
|
12582
12623
|
updatedAt?: Date;
|
|
12583
12624
|
}
|
|
12584
12625
|
/** Route. database config. */
|
|
12585
12626
|
interface RouteDatabaseConfig {
|
|
12586
12627
|
/**
|
|
12587
|
-
* Database engine the route will connect to. If not specified,
|
|
12588
|
-
*
|
|
12628
|
+
* Database engine the route will connect to. If not specified, the default
|
|
12629
|
+
* database will be 'PostgreSQL'.
|
|
12589
12630
|
*/
|
|
12590
12631
|
engine: RouteDatabaseConfigEngine;
|
|
12591
12632
|
/** Database host. */
|
|
@@ -12606,7 +12647,7 @@ interface RouteDatabaseConfig {
|
|
|
12606
12647
|
}
|
|
12607
12648
|
/** Route. rest config. */
|
|
12608
12649
|
interface RouteRestConfig {
|
|
12609
|
-
/** HTTP
|
|
12650
|
+
/** HTTP verb used to call REST URI. */
|
|
12610
12651
|
verb: RouteRestConfigHttpVerb;
|
|
12611
12652
|
/** URI of the REST endpoint. */
|
|
12612
12653
|
uri: string;
|
|
@@ -12615,9 +12656,9 @@ interface RouteRestConfig {
|
|
|
12615
12656
|
}
|
|
12616
12657
|
/** Route.s3 config. */
|
|
12617
12658
|
interface RouteS3Config {
|
|
12618
|
-
/** Region of the S3 route's destination bucket (
|
|
12659
|
+
/** Region of the S3 route's destination bucket (e.g., 'fr-par'). */
|
|
12619
12660
|
bucketRegion: string;
|
|
12620
|
-
/**
|
|
12661
|
+
/** Destination bucket name of the S3 route. */
|
|
12621
12662
|
bucketName: string;
|
|
12622
12663
|
/** Optional string to prefix object names with. */
|
|
12623
12664
|
objectPrefix: string;
|
|
@@ -12633,7 +12674,7 @@ interface RouteSummary {
|
|
|
12633
12674
|
id: string;
|
|
12634
12675
|
/** Route name. */
|
|
12635
12676
|
name: string;
|
|
12636
|
-
/** ID of the route
|
|
12677
|
+
/** Hub ID of the route. */
|
|
12637
12678
|
hubId: string;
|
|
12638
12679
|
/**
|
|
12639
12680
|
* Topic the route subscribes to. It must be a valid MQTT topic and up to
|
|
@@ -12642,9 +12683,9 @@ interface RouteSummary {
|
|
|
12642
12683
|
topic: string;
|
|
12643
12684
|
/** Route type. */
|
|
12644
12685
|
type: RouteRouteType;
|
|
12645
|
-
/**
|
|
12686
|
+
/** Date at which the route was created. */
|
|
12646
12687
|
createdAt?: Date;
|
|
12647
|
-
/**
|
|
12688
|
+
/** Date at which the route was last updated. */
|
|
12648
12689
|
updatedAt?: Date;
|
|
12649
12690
|
}
|
|
12650
12691
|
interface SetDeviceCertificateResponse {
|
|
@@ -12653,13 +12694,13 @@ interface SetDeviceCertificateResponse {
|
|
|
12653
12694
|
}
|
|
12654
12695
|
/** Twin document. */
|
|
12655
12696
|
interface TwinDocument {
|
|
12656
|
-
/**
|
|
12697
|
+
/** Parent twin ID of the document. */
|
|
12657
12698
|
twinId: string;
|
|
12658
|
-
/**
|
|
12699
|
+
/** Name of the document. */
|
|
12659
12700
|
documentName: string;
|
|
12660
|
-
/**
|
|
12701
|
+
/** New version of the document. */
|
|
12661
12702
|
version: number;
|
|
12662
|
-
/**
|
|
12703
|
+
/** New data related to the document. */
|
|
12663
12704
|
data?: Record<string, unknown>;
|
|
12664
12705
|
}
|
|
12665
12706
|
interface UpdateRouteRequestDatabaseConfig {
|
|
@@ -12688,17 +12729,17 @@ type ListHubsRequest = {
|
|
|
12688
12729
|
* config.
|
|
12689
12730
|
*/
|
|
12690
12731
|
region?: Region;
|
|
12691
|
-
/** Page number. */
|
|
12732
|
+
/** Page number to return, from the paginated results. */
|
|
12692
12733
|
page?: number;
|
|
12693
|
-
/**
|
|
12734
|
+
/** Number of Hubs to return within a page. Maximum value is 100. */
|
|
12694
12735
|
pageSize?: number;
|
|
12695
|
-
/**
|
|
12736
|
+
/** Sort order of Hubs in the response. */
|
|
12696
12737
|
orderBy?: ListHubsRequestOrderBy;
|
|
12697
|
-
/**
|
|
12738
|
+
/** Only list Hubs of this Project ID. */
|
|
12698
12739
|
projectId?: string;
|
|
12699
|
-
/**
|
|
12740
|
+
/** Only list Hubs of this Organization ID. */
|
|
12700
12741
|
organizationId?: string;
|
|
12701
|
-
/**
|
|
12742
|
+
/** Hub name. */
|
|
12702
12743
|
name?: string;
|
|
12703
12744
|
};
|
|
12704
12745
|
type CreateHubRequest = {
|
|
@@ -12709,13 +12750,16 @@ type CreateHubRequest = {
|
|
|
12709
12750
|
region?: Region;
|
|
12710
12751
|
/** Hub name (up to 255 characters). */
|
|
12711
12752
|
name?: string;
|
|
12712
|
-
/**
|
|
12753
|
+
/**
|
|
12754
|
+
* Project/Organization ID to filter for, only Hubs from this
|
|
12755
|
+
* Project/Organization will be returned.
|
|
12756
|
+
*/
|
|
12713
12757
|
projectId?: string;
|
|
12714
|
-
/** Hub
|
|
12758
|
+
/** Hub product plan. */
|
|
12715
12759
|
productPlan: HubProductPlan;
|
|
12716
12760
|
/** Disable Hub events. */
|
|
12717
12761
|
disableEvents?: boolean;
|
|
12718
|
-
/**
|
|
12762
|
+
/** Topic prefix (default '$SCW/events') of Hub events. */
|
|
12719
12763
|
eventsTopicPrefix?: string;
|
|
12720
12764
|
/**
|
|
12721
12765
|
* BETA - not implemented yet.
|
|
@@ -12740,15 +12784,15 @@ type UpdateHubRequest = {
|
|
|
12740
12784
|
* config.
|
|
12741
12785
|
*/
|
|
12742
12786
|
region?: Region;
|
|
12743
|
-
/** Hub
|
|
12787
|
+
/** ID of the Hub you want to update. */
|
|
12744
12788
|
hubId: string;
|
|
12745
12789
|
/** Hub name (up to 255 characters). */
|
|
12746
12790
|
name?: string;
|
|
12747
|
-
/** Hub
|
|
12791
|
+
/** Hub product plan. */
|
|
12748
12792
|
productPlan?: HubProductPlan;
|
|
12749
12793
|
/** Disable Hub events. */
|
|
12750
12794
|
disableEvents?: boolean;
|
|
12751
|
-
/** Hub events
|
|
12795
|
+
/** Topic prefix of Hub events. */
|
|
12752
12796
|
eventsTopicPrefix?: string;
|
|
12753
12797
|
/** Enable device auto provisioning. */
|
|
12754
12798
|
enableDeviceAutoProvisioning?: boolean;
|
|
@@ -12786,7 +12830,10 @@ type DeleteHubRequest = {
|
|
|
12786
12830
|
region?: Region;
|
|
12787
12831
|
/** Hub ID. */
|
|
12788
12832
|
hubId: string;
|
|
12789
|
-
/**
|
|
12833
|
+
/**
|
|
12834
|
+
* Defines whether to force the deletion of devices added to this Hub or
|
|
12835
|
+
* reject the operation.
|
|
12836
|
+
*/
|
|
12790
12837
|
deleteDevices?: boolean;
|
|
12791
12838
|
};
|
|
12792
12839
|
type GetHubMetricsRequest = {
|
|
@@ -12797,7 +12844,7 @@ type GetHubMetricsRequest = {
|
|
|
12797
12844
|
region?: Region;
|
|
12798
12845
|
/** Hub ID. */
|
|
12799
12846
|
hubId: string;
|
|
12800
|
-
/** Start date used to compute the best scale for
|
|
12847
|
+
/** Start date used to compute the best scale for returned metrics. */
|
|
12801
12848
|
startDate: Date;
|
|
12802
12849
|
};
|
|
12803
12850
|
type SetHubCARequest = {
|
|
@@ -12808,12 +12855,12 @@ type SetHubCARequest = {
|
|
|
12808
12855
|
region?: Region;
|
|
12809
12856
|
/** Hub ID. */
|
|
12810
12857
|
hubId: string;
|
|
12811
|
-
/**
|
|
12858
|
+
/** CA's PEM-encoded certificate. */
|
|
12812
12859
|
caCertPem: string;
|
|
12813
12860
|
/**
|
|
12814
|
-
* Proof of possession PEM-encoded certificate.
|
|
12815
|
-
* certificate
|
|
12816
|
-
* and have a Common Name equal to the Hub ID.
|
|
12861
|
+
* Proof of possession of PEM-encoded certificate. Challenge is a PEM-encoded
|
|
12862
|
+
* certificate that acts as proof of possession of the CA. It must be signed
|
|
12863
|
+
* by the CA, and have a Common Name equal to the Hub ID.
|
|
12817
12864
|
*/
|
|
12818
12865
|
challengeCertPem: string;
|
|
12819
12866
|
};
|
|
@@ -12831,17 +12878,17 @@ type ListDevicesRequest = {
|
|
|
12831
12878
|
* config.
|
|
12832
12879
|
*/
|
|
12833
12880
|
region?: Region;
|
|
12834
|
-
/** Page number. */
|
|
12881
|
+
/** Page number to return, from the paginated results. */
|
|
12835
12882
|
page?: number;
|
|
12836
|
-
/**
|
|
12883
|
+
/** Number of devices to return within a page. Maximum value is 100. */
|
|
12837
12884
|
pageSize?: number;
|
|
12838
12885
|
/** Ordering of requested devices. */
|
|
12839
12886
|
orderBy?: ListDevicesRequestOrderBy;
|
|
12840
|
-
/**
|
|
12887
|
+
/** Name to filter for, only devices with this name will be returned. */
|
|
12841
12888
|
name?: string;
|
|
12842
|
-
/**
|
|
12889
|
+
/** Hub ID to filter for, only devices attached to this Hub will be returned. */
|
|
12843
12890
|
hubId?: string;
|
|
12844
|
-
/**
|
|
12891
|
+
/** Defines wheter to filter the allow_insecure flag. */
|
|
12845
12892
|
allowInsecure?: boolean;
|
|
12846
12893
|
/** Device status (enabled, disabled, etc.). */
|
|
12847
12894
|
status?: DeviceStatus;
|
|
@@ -12854,14 +12901,17 @@ type CreateDeviceRequest = {
|
|
|
12854
12901
|
region?: Region;
|
|
12855
12902
|
/** Device name. */
|
|
12856
12903
|
name?: string;
|
|
12857
|
-
/** ID of the device
|
|
12904
|
+
/** Hub ID of the device. */
|
|
12858
12905
|
hubId: string;
|
|
12859
12906
|
/**
|
|
12860
|
-
*
|
|
12861
|
-
* mutually-authenticated ones.
|
|
12907
|
+
* Defines whether to allow plain and server-authenticated SSL connections in
|
|
12908
|
+
* addition to mutually-authenticated ones.
|
|
12862
12909
|
*/
|
|
12863
12910
|
allowInsecure: boolean;
|
|
12864
|
-
/**
|
|
12911
|
+
/**
|
|
12912
|
+
* Defines whether to allow multiple physical devices to connect with this
|
|
12913
|
+
* device's credentials.
|
|
12914
|
+
*/
|
|
12865
12915
|
allowMultipleConnections: boolean;
|
|
12866
12916
|
/**
|
|
12867
12917
|
* Filter-sets to authorize or deny the device to publish/subscribe to
|
|
@@ -12888,14 +12938,17 @@ type UpdateDeviceRequest = {
|
|
|
12888
12938
|
region?: Region;
|
|
12889
12939
|
/** Device ID. */
|
|
12890
12940
|
deviceId: string;
|
|
12891
|
-
/**
|
|
12941
|
+
/** Description for the device. */
|
|
12892
12942
|
description?: string;
|
|
12893
12943
|
/**
|
|
12894
|
-
*
|
|
12895
|
-
* mutually-authenticated ones.
|
|
12944
|
+
* Defines whether to allow plain and server-authenticated SSL connections in
|
|
12945
|
+
* addition to mutually-authenticated ones.
|
|
12896
12946
|
*/
|
|
12897
12947
|
allowInsecure?: boolean;
|
|
12898
|
-
/**
|
|
12948
|
+
/**
|
|
12949
|
+
* Defines whether to allow multiple physical devices to connect with this
|
|
12950
|
+
* device's credentials.
|
|
12951
|
+
*/
|
|
12899
12952
|
allowMultipleConnections?: boolean;
|
|
12900
12953
|
/** Filter-sets to restrict the topics the device can publish/subscribe to. */
|
|
12901
12954
|
messageFilters?: DeviceMessageFilters;
|
|
@@ -12937,7 +12990,7 @@ type SetDeviceCertificateRequest = {
|
|
|
12937
12990
|
region?: Region;
|
|
12938
12991
|
/** Device ID. */
|
|
12939
12992
|
deviceId: string;
|
|
12940
|
-
/**
|
|
12993
|
+
/** PEM-encoded custom certificate. */
|
|
12941
12994
|
certificatePem: string;
|
|
12942
12995
|
};
|
|
12943
12996
|
type GetDeviceCertificateRequest = {
|
|
@@ -12975,15 +13028,15 @@ type ListRoutesRequest$1 = {
|
|
|
12975
13028
|
* config.
|
|
12976
13029
|
*/
|
|
12977
13030
|
region?: Region;
|
|
12978
|
-
/** Page number. */
|
|
13031
|
+
/** Page number to return, from the paginated results. */
|
|
12979
13032
|
page?: number;
|
|
12980
|
-
/**
|
|
13033
|
+
/** Number of routes to return within a page. Maximum value is 100. */
|
|
12981
13034
|
pageSize?: number;
|
|
12982
13035
|
/** Ordering of requested routes. */
|
|
12983
13036
|
orderBy?: ListRoutesRequestOrderBy$1;
|
|
12984
|
-
/**
|
|
13037
|
+
/** Hub ID to filter for. */
|
|
12985
13038
|
hubId?: string;
|
|
12986
|
-
/**
|
|
13039
|
+
/** Route name to filter for. */
|
|
12987
13040
|
name?: string;
|
|
12988
13041
|
};
|
|
12989
13042
|
type CreateRouteRequest$1 = {
|
|
@@ -12994,7 +13047,7 @@ type CreateRouteRequest$1 = {
|
|
|
12994
13047
|
region?: Region;
|
|
12995
13048
|
/** Route name. */
|
|
12996
13049
|
name?: string;
|
|
12997
|
-
/** ID of the route
|
|
13050
|
+
/** Hub ID of the route. */
|
|
12998
13051
|
hubId: string;
|
|
12999
13052
|
/**
|
|
13000
13053
|
* Topic the route subscribes to. It must be a valid MQTT topic and up to
|
|
@@ -13084,17 +13137,17 @@ type ListNetworksRequest = {
|
|
|
13084
13137
|
* config.
|
|
13085
13138
|
*/
|
|
13086
13139
|
region?: Region;
|
|
13087
|
-
/** Page number. */
|
|
13140
|
+
/** Page number to return, from the paginated results. */
|
|
13088
13141
|
page?: number;
|
|
13089
|
-
/**
|
|
13142
|
+
/** Number of networks to return. The maximum value is 100. */
|
|
13090
13143
|
pageSize?: number;
|
|
13091
13144
|
/** Ordering of requested routes. */
|
|
13092
13145
|
orderBy?: ListNetworksRequestOrderBy;
|
|
13093
|
-
/**
|
|
13146
|
+
/** Network name to filter for. */
|
|
13094
13147
|
name?: string;
|
|
13095
|
-
/**
|
|
13148
|
+
/** Hub ID to filter for. */
|
|
13096
13149
|
hubId?: string;
|
|
13097
|
-
/**
|
|
13150
|
+
/** Topic prefix to filter for. */
|
|
13098
13151
|
topicPrefix?: string;
|
|
13099
13152
|
};
|
|
13100
13153
|
type CreateNetworkRequest = {
|
|
@@ -13138,7 +13191,7 @@ type GetTwinDocumentRequest = {
|
|
|
13138
13191
|
region?: Region;
|
|
13139
13192
|
/** Twin ID. */
|
|
13140
13193
|
twinId: string;
|
|
13141
|
-
/**
|
|
13194
|
+
/** Name of the document. */
|
|
13142
13195
|
documentName: string;
|
|
13143
13196
|
};
|
|
13144
13197
|
type PutTwinDocumentRequest = {
|
|
@@ -13149,15 +13202,15 @@ type PutTwinDocumentRequest = {
|
|
|
13149
13202
|
region?: Region;
|
|
13150
13203
|
/** Twin ID. */
|
|
13151
13204
|
twinId: string;
|
|
13152
|
-
/**
|
|
13205
|
+
/** Name of the document. */
|
|
13153
13206
|
documentName: string;
|
|
13154
13207
|
/**
|
|
13155
|
-
*
|
|
13156
|
-
*
|
|
13208
|
+
* Version of the document to update. If set, ensures that the current version
|
|
13209
|
+
* of the document matches before persisting the update.
|
|
13157
13210
|
*/
|
|
13158
13211
|
version?: number;
|
|
13159
13212
|
/**
|
|
13160
|
-
*
|
|
13213
|
+
* Data of the new document. New data that will replace the contents of the
|
|
13161
13214
|
* document.
|
|
13162
13215
|
*/
|
|
13163
13216
|
data?: Record<string, unknown>;
|
|
@@ -13170,20 +13223,20 @@ type PatchTwinDocumentRequest = {
|
|
|
13170
13223
|
region?: Region;
|
|
13171
13224
|
/** Twin ID. */
|
|
13172
13225
|
twinId: string;
|
|
13173
|
-
/**
|
|
13226
|
+
/** Name of the document. */
|
|
13174
13227
|
documentName: string;
|
|
13175
13228
|
/**
|
|
13176
|
-
* The version of the document to update. If set, ensures that the
|
|
13177
|
-
*
|
|
13229
|
+
* The version of the document to update. If set, ensures that the current
|
|
13230
|
+
* version of the document matches before persisting the update.
|
|
13178
13231
|
*/
|
|
13179
13232
|
version?: number;
|
|
13180
13233
|
/**
|
|
13181
13234
|
* Patch data. A json data that will be applied on the document's current
|
|
13182
13235
|
* data. Patching rules: The patch goes recursively through the patch objects.
|
|
13183
|
-
* If the patch object property is null,
|
|
13184
|
-
*
|
|
13185
|
-
*
|
|
13186
|
-
*
|
|
13236
|
+
* If the patch object property is null, it is removed from the final object.
|
|
13237
|
+
* If the patch object property is a value (number, strings, bool, arrays), it
|
|
13238
|
+
* is replaced. If the patch object property is an object, the previous rules
|
|
13239
|
+
* will be applied recursively on it.
|
|
13187
13240
|
*/
|
|
13188
13241
|
data?: Record<string, unknown>;
|
|
13189
13242
|
};
|
|
@@ -13195,7 +13248,7 @@ type DeleteTwinDocumentRequest = {
|
|
|
13195
13248
|
region?: Region;
|
|
13196
13249
|
/** Twin ID. */
|
|
13197
13250
|
twinId: string;
|
|
13198
|
-
/**
|
|
13251
|
+
/** Name of the document. */
|
|
13199
13252
|
documentName: string;
|
|
13200
13253
|
};
|
|
13201
13254
|
type ListTwinDocumentsRequest = {
|
|
@@ -13218,16 +13271,18 @@ type DeleteTwinDocumentsRequest = {
|
|
|
13218
13271
|
};
|
|
13219
13272
|
|
|
13220
13273
|
/**
|
|
13221
|
-
* IoT API.
|
|
13274
|
+
* IoT Hub API.
|
|
13222
13275
|
*
|
|
13223
|
-
* This API allows you to manage IoT hubs and devices. IoT API.
|
|
13276
|
+
* This API allows you to manage IoT hubs and devices. IoT Hub API.
|
|
13224
13277
|
*/
|
|
13225
13278
|
declare class API$e extends API$q {
|
|
13226
13279
|
/** Lists the available regions of the API. */
|
|
13227
13280
|
static readonly LOCALITIES: Region[];
|
|
13228
13281
|
protected pageOfListHubs: (request?: Readonly<ListHubsRequest>) => Promise<ListHubsResponse>;
|
|
13229
13282
|
/**
|
|
13230
|
-
* List hubs.
|
|
13283
|
+
* List hubs. List all Hubs in the specified zone. By default, returned Hubs
|
|
13284
|
+
* are ordered by creation date in ascending order, though this can be
|
|
13285
|
+
* modified via the `order_by` field.
|
|
13231
13286
|
*
|
|
13232
13287
|
* @param request - The request {@link ListHubsRequest}
|
|
13233
13288
|
* @returns A Promise of ListHubsResponse
|
|
@@ -13237,14 +13292,17 @@ declare class API$e extends API$q {
|
|
|
13237
13292
|
[Symbol.asyncIterator]: () => AsyncGenerator<Hub[], void, void>;
|
|
13238
13293
|
};
|
|
13239
13294
|
/**
|
|
13240
|
-
* Create a hub.
|
|
13295
|
+
* Create a hub. Create a new Hub in the targeted region, specifying its
|
|
13296
|
+
* configuration including name and product plan.
|
|
13241
13297
|
*
|
|
13242
13298
|
* @param request - The request {@link CreateHubRequest}
|
|
13243
13299
|
* @returns A Promise of Hub
|
|
13244
13300
|
*/
|
|
13245
13301
|
createHub: (request: Readonly<CreateHubRequest>) => Promise<Hub>;
|
|
13246
13302
|
/**
|
|
13247
|
-
* Get a hub.
|
|
13303
|
+
* Get a hub. Retrieve information about an existing IoT Hub, specified by its
|
|
13304
|
+
* Hub ID. Its full details, including name, status and endpoint, are returned
|
|
13305
|
+
* in the response object.
|
|
13248
13306
|
*
|
|
13249
13307
|
* @param request - The request {@link GetHubRequest}
|
|
13250
13308
|
* @returns A Promise of Hub
|
|
@@ -13259,34 +13317,37 @@ declare class API$e extends API$q {
|
|
|
13259
13317
|
*/
|
|
13260
13318
|
waitForHub: (request: Readonly<GetHubRequest>, options?: Readonly<WaitForOptions<Hub>>) => Promise<Hub>;
|
|
13261
13319
|
/**
|
|
13262
|
-
* Update a hub.
|
|
13320
|
+
* Update a hub. Update the parameters of an existing IoT Hub, specified by
|
|
13321
|
+
* its Hub ID.
|
|
13263
13322
|
*
|
|
13264
13323
|
* @param request - The request {@link UpdateHubRequest}
|
|
13265
13324
|
* @returns A Promise of Hub
|
|
13266
13325
|
*/
|
|
13267
13326
|
updateHub: (request: Readonly<UpdateHubRequest>) => Promise<Hub>;
|
|
13268
13327
|
/**
|
|
13269
|
-
* Enable a hub.
|
|
13328
|
+
* Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
|
|
13270
13329
|
*
|
|
13271
13330
|
* @param request - The request {@link EnableHubRequest}
|
|
13272
13331
|
* @returns A Promise of Hub
|
|
13273
13332
|
*/
|
|
13274
13333
|
enableHub: (request: Readonly<EnableHubRequest>) => Promise<Hub>;
|
|
13275
13334
|
/**
|
|
13276
|
-
* Disable a hub.
|
|
13335
|
+
* Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
|
|
13277
13336
|
*
|
|
13278
13337
|
* @param request - The request {@link DisableHubRequest}
|
|
13279
13338
|
* @returns A Promise of Hub
|
|
13280
13339
|
*/
|
|
13281
13340
|
disableHub: (request: Readonly<DisableHubRequest>) => Promise<Hub>;
|
|
13282
13341
|
/**
|
|
13283
|
-
* Delete a hub.
|
|
13342
|
+
* Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
|
|
13343
|
+
* a Hub is permanent, and cannot be undone.
|
|
13284
13344
|
*
|
|
13285
13345
|
* @param request - The request {@link DeleteHubRequest}
|
|
13286
13346
|
*/
|
|
13287
13347
|
deleteHub: (request: Readonly<DeleteHubRequest>) => Promise<void>;
|
|
13288
13348
|
/**
|
|
13289
|
-
* Get a hub's metrics.
|
|
13349
|
+
* Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
|
|
13350
|
+
* its Hub ID.
|
|
13290
13351
|
*
|
|
13291
13352
|
* @deprecated
|
|
13292
13353
|
* @param request - The request {@link GetHubMetricsRequest}
|
|
@@ -13294,14 +13355,16 @@ declare class API$e extends API$q {
|
|
|
13294
13355
|
*/
|
|
13295
13356
|
getHubMetrics: (request: Readonly<GetHubMetricsRequest>) => Promise<GetHubMetricsResponse>;
|
|
13296
13357
|
/**
|
|
13297
|
-
* Set the certificate authority of a hub.
|
|
13358
|
+
* Set the certificate authority of a hub. Set a particular PEM-encoded
|
|
13359
|
+
* certificate, specified by the Hub ID.
|
|
13298
13360
|
*
|
|
13299
13361
|
* @param request - The request {@link SetHubCARequest}
|
|
13300
13362
|
* @returns A Promise of Hub
|
|
13301
13363
|
*/
|
|
13302
13364
|
setHubCA: (request: Readonly<SetHubCARequest>) => Promise<Hub>;
|
|
13303
13365
|
/**
|
|
13304
|
-
* Get the certificate authority of a hub.
|
|
13366
|
+
* Get the certificate authority of a hub. Get information for a particular
|
|
13367
|
+
* PEM-encoded certificate, specified by the Hub ID.
|
|
13305
13368
|
*
|
|
13306
13369
|
* @param request - The request {@link GetHubCARequest}
|
|
13307
13370
|
* @returns A Promise of GetHubCAResponse
|
|
@@ -13309,7 +13372,9 @@ declare class API$e extends API$q {
|
|
|
13309
13372
|
getHubCA: (request: Readonly<GetHubCARequest>) => Promise<GetHubCAResponse>;
|
|
13310
13373
|
protected pageOfListDevices: (request?: Readonly<ListDevicesRequest>) => Promise<ListDevicesResponse>;
|
|
13311
13374
|
/**
|
|
13312
|
-
* List devices.
|
|
13375
|
+
* List devices. List all devices in the specified region. By default,
|
|
13376
|
+
* returned devices are ordered by creation date in ascending order, though
|
|
13377
|
+
* this can be modified via the `order_by` field.
|
|
13313
13378
|
*
|
|
13314
13379
|
* @param request - The request {@link ListDevicesRequest}
|
|
13315
13380
|
* @returns A Promise of ListDevicesResponse
|
|
@@ -13319,69 +13384,78 @@ declare class API$e extends API$q {
|
|
|
13319
13384
|
[Symbol.asyncIterator]: () => AsyncGenerator<Device[], void, void>;
|
|
13320
13385
|
};
|
|
13321
13386
|
/**
|
|
13322
|
-
* Add a device.
|
|
13387
|
+
* Add a device. Attach a device to a given Hub.
|
|
13323
13388
|
*
|
|
13324
13389
|
* @param request - The request {@link CreateDeviceRequest}
|
|
13325
13390
|
* @returns A Promise of CreateDeviceResponse
|
|
13326
13391
|
*/
|
|
13327
13392
|
createDevice: (request: Readonly<CreateDeviceRequest>) => Promise<CreateDeviceResponse>;
|
|
13328
13393
|
/**
|
|
13329
|
-
* Get a device.
|
|
13394
|
+
* Get a device. Retrieve information about an existing device, specified by
|
|
13395
|
+
* its device ID. Its full details, including name, status and ID, are
|
|
13396
|
+
* returned in the response object.
|
|
13330
13397
|
*
|
|
13331
13398
|
* @param request - The request {@link GetDeviceRequest}
|
|
13332
13399
|
* @returns A Promise of Device
|
|
13333
13400
|
*/
|
|
13334
13401
|
getDevice: (request: Readonly<GetDeviceRequest>) => Promise<Device>;
|
|
13335
13402
|
/**
|
|
13336
|
-
* Update a device.
|
|
13403
|
+
* Update a device. Update the parameters of an existing device, specified by
|
|
13404
|
+
* its device ID.
|
|
13337
13405
|
*
|
|
13338
13406
|
* @param request - The request {@link UpdateDeviceRequest}
|
|
13339
13407
|
* @returns A Promise of Device
|
|
13340
13408
|
*/
|
|
13341
13409
|
updateDevice: (request: Readonly<UpdateDeviceRequest>) => Promise<Device>;
|
|
13342
13410
|
/**
|
|
13343
|
-
* Enable a device.
|
|
13411
|
+
* Enable a device. Enable a specific device, specified by its device ID.
|
|
13344
13412
|
*
|
|
13345
13413
|
* @param request - The request {@link EnableDeviceRequest}
|
|
13346
13414
|
* @returns A Promise of Device
|
|
13347
13415
|
*/
|
|
13348
13416
|
enableDevice: (request: Readonly<EnableDeviceRequest>) => Promise<Device>;
|
|
13349
13417
|
/**
|
|
13350
|
-
* Disable a device.
|
|
13418
|
+
* Disable a device. Disable an existing device, specified by its device ID.
|
|
13351
13419
|
*
|
|
13352
13420
|
* @param request - The request {@link DisableDeviceRequest}
|
|
13353
13421
|
* @returns A Promise of Device
|
|
13354
13422
|
*/
|
|
13355
13423
|
disableDevice: (request: Readonly<DisableDeviceRequest>) => Promise<Device>;
|
|
13356
13424
|
/**
|
|
13357
|
-
* Renew a device certificate.
|
|
13425
|
+
* Renew a device certificate. Renew the certificate of an existing device,
|
|
13426
|
+
* specified by its device ID.
|
|
13358
13427
|
*
|
|
13359
13428
|
* @param request - The request {@link RenewDeviceCertificateRequest}
|
|
13360
13429
|
* @returns A Promise of RenewDeviceCertificateResponse
|
|
13361
13430
|
*/
|
|
13362
13431
|
renewDeviceCertificate: (request: Readonly<RenewDeviceCertificateRequest>) => Promise<RenewDeviceCertificateResponse>;
|
|
13363
13432
|
/**
|
|
13364
|
-
* Set a custom certificate on a device.
|
|
13433
|
+
* Set a custom certificate on a device. Switch the existing certificate of a
|
|
13434
|
+
* given device with an EM-encoded custom certificate.
|
|
13365
13435
|
*
|
|
13366
13436
|
* @param request - The request {@link SetDeviceCertificateRequest}
|
|
13367
13437
|
* @returns A Promise of SetDeviceCertificateResponse
|
|
13368
13438
|
*/
|
|
13369
13439
|
setDeviceCertificate: (request: Readonly<SetDeviceCertificateRequest>) => Promise<SetDeviceCertificateResponse>;
|
|
13370
13440
|
/**
|
|
13371
|
-
* Get a device's certificate.
|
|
13441
|
+
* Get a device's certificate. Get information for a particular PEM-encoded
|
|
13442
|
+
* certificate, specified by the device ID. The response returns full details
|
|
13443
|
+
* of the device, including its type of certificate.
|
|
13372
13444
|
*
|
|
13373
13445
|
* @param request - The request {@link GetDeviceCertificateRequest}
|
|
13374
13446
|
* @returns A Promise of GetDeviceCertificateResponse
|
|
13375
13447
|
*/
|
|
13376
13448
|
getDeviceCertificate: (request: Readonly<GetDeviceCertificateRequest>) => Promise<GetDeviceCertificateResponse>;
|
|
13377
13449
|
/**
|
|
13378
|
-
* Remove a device.
|
|
13450
|
+
* Remove a device. Remove a specific device from the specific Hub it is
|
|
13451
|
+
* attached to.
|
|
13379
13452
|
*
|
|
13380
13453
|
* @param request - The request {@link DeleteDeviceRequest}
|
|
13381
13454
|
*/
|
|
13382
13455
|
deleteDevice: (request: Readonly<DeleteDeviceRequest>) => Promise<void>;
|
|
13383
13456
|
/**
|
|
13384
|
-
* Get a device's metrics.
|
|
13457
|
+
* Get a device's metrics. Get the metrics of an existing device, specified by
|
|
13458
|
+
* its device ID.
|
|
13385
13459
|
*
|
|
13386
13460
|
* @deprecated
|
|
13387
13461
|
* @param request - The request {@link GetDeviceMetricsRequest}
|
|
@@ -13390,7 +13464,9 @@ declare class API$e extends API$q {
|
|
|
13390
13464
|
getDeviceMetrics: (request: Readonly<GetDeviceMetricsRequest>) => Promise<GetDeviceMetricsResponse>;
|
|
13391
13465
|
protected pageOfListRoutes: (request?: Readonly<ListRoutesRequest$1>) => Promise<ListRoutesResponse$1>;
|
|
13392
13466
|
/**
|
|
13393
|
-
* List routes.
|
|
13467
|
+
* List routes. List all routes in the specified region. By default, returned
|
|
13468
|
+
* routes are ordered by creation date in ascending order, though this can be
|
|
13469
|
+
* modified via the `order_by` field.
|
|
13394
13470
|
*
|
|
13395
13471
|
* @param request - The request {@link ListRoutesRequest}
|
|
13396
13472
|
* @returns A Promise of ListRoutesResponse
|
|
@@ -13400,15 +13476,15 @@ declare class API$e extends API$q {
|
|
|
13400
13476
|
[Symbol.asyncIterator]: () => AsyncGenerator<RouteSummary[], void, void>;
|
|
13401
13477
|
};
|
|
13402
13478
|
/**
|
|
13403
|
-
* Create a route. Multiple
|
|
13479
|
+
* Create a route. Multiple kinds of routes can be created, such as:
|
|
13404
13480
|
*
|
|
13405
|
-
* - Database Route
|
|
13481
|
+
* - Database Route Create a route that will record subscribed MQTT messages
|
|
13406
13482
|
* into your database. <b>You need to manage the database by yourself</b>.
|
|
13407
13483
|
* - REST Route. Create a route that will call a REST API on received subscribed
|
|
13408
13484
|
* MQTT messages.
|
|
13409
13485
|
* - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
|
|
13410
|
-
* bucket. You need to create the bucket yourself and grant
|
|
13411
|
-
*
|
|
13486
|
+
* bucket. You need to create the bucket yourself and grant write access.
|
|
13487
|
+
* Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
|
|
13412
13488
|
* --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
|
|
13413
13489
|
*
|
|
13414
13490
|
* @param request - The request {@link CreateRouteRequest}
|
|
@@ -13416,28 +13492,32 @@ declare class API$e extends API$q {
|
|
|
13416
13492
|
*/
|
|
13417
13493
|
createRoute: (request: Readonly<CreateRouteRequest$1>) => Promise<Route$1>;
|
|
13418
13494
|
/**
|
|
13419
|
-
* Update a route.
|
|
13495
|
+
* Update a route. Update the parameters of an existing route, specified by
|
|
13496
|
+
* its route ID.
|
|
13420
13497
|
*
|
|
13421
13498
|
* @param request - The request {@link UpdateRouteRequest}
|
|
13422
13499
|
* @returns A Promise of Route
|
|
13423
13500
|
*/
|
|
13424
13501
|
updateRoute: (request: Readonly<UpdateRouteRequest$1>) => Promise<Route$1>;
|
|
13425
13502
|
/**
|
|
13426
|
-
* Get a route.
|
|
13503
|
+
* Get a route. Get information for a particular route, specified by the route
|
|
13504
|
+
* ID. The response returns full details of the route, including its type, the
|
|
13505
|
+
* topic it subscribes to and its configuration.
|
|
13427
13506
|
*
|
|
13428
13507
|
* @param request - The request {@link GetRouteRequest}
|
|
13429
13508
|
* @returns A Promise of Route
|
|
13430
13509
|
*/
|
|
13431
13510
|
getRoute: (request: Readonly<GetRouteRequest$1>) => Promise<Route$1>;
|
|
13432
13511
|
/**
|
|
13433
|
-
* Delete a route.
|
|
13512
|
+
* Delete a route. Delete an existing route, specified by its route ID.
|
|
13513
|
+
* Deleting a route is permanent, and cannot be undone.
|
|
13434
13514
|
*
|
|
13435
13515
|
* @param request - The request {@link DeleteRouteRequest}
|
|
13436
13516
|
*/
|
|
13437
13517
|
deleteRoute: (request: Readonly<DeleteRouteRequest$1>) => Promise<void>;
|
|
13438
13518
|
protected pageOfListNetworks: (request?: Readonly<ListNetworksRequest>) => Promise<ListNetworksResponse>;
|
|
13439
13519
|
/**
|
|
13440
|
-
* List the
|
|
13520
|
+
* List the networks.
|
|
13441
13521
|
*
|
|
13442
13522
|
* @param request - The request {@link ListNetworksRequest}
|
|
13443
13523
|
* @returns A Promise of ListNetworksResponse
|
|
@@ -13447,21 +13527,26 @@ declare class API$e extends API$q {
|
|
|
13447
13527
|
[Symbol.asyncIterator]: () => AsyncGenerator<Network[], void, void>;
|
|
13448
13528
|
};
|
|
13449
13529
|
/**
|
|
13450
|
-
* Create a new
|
|
13530
|
+
* Create a new network. Create a new network for an existing hub. Beside the
|
|
13531
|
+
* default network, you can add networks for different data providers.
|
|
13532
|
+
* Possible network types are Sigfox and REST.
|
|
13451
13533
|
*
|
|
13452
13534
|
* @param request - The request {@link CreateNetworkRequest}
|
|
13453
13535
|
* @returns A Promise of CreateNetworkResponse
|
|
13454
13536
|
*/
|
|
13455
13537
|
createNetwork: (request: Readonly<CreateNetworkRequest>) => Promise<CreateNetworkResponse>;
|
|
13456
13538
|
/**
|
|
13457
|
-
* Retrieve a specific
|
|
13539
|
+
* Retrieve a specific network. Retrieve an existing network, specified by its
|
|
13540
|
+
* network ID. The response returns full details of the network, including its
|
|
13541
|
+
* type, the topic prefix and its endpoint.
|
|
13458
13542
|
*
|
|
13459
13543
|
* @param request - The request {@link GetNetworkRequest}
|
|
13460
13544
|
* @returns A Promise of Network
|
|
13461
13545
|
*/
|
|
13462
13546
|
getNetwork: (request: Readonly<GetNetworkRequest>) => Promise<Network>;
|
|
13463
13547
|
/**
|
|
13464
|
-
* Delete a Network.
|
|
13548
|
+
* Delete a Network. Delete an existing network, specified by its network ID.
|
|
13549
|
+
* Deleting a network is permanent, and cannot be undone.
|
|
13465
13550
|
*
|
|
13466
13551
|
* @param request - The request {@link DeleteNetworkRequest}
|
|
13467
13552
|
*/
|
|
@@ -14350,7 +14435,8 @@ type CreateClusterRequest$2 = {
|
|
|
14350
14435
|
/**
|
|
14351
14436
|
* Autoscaler config for the cluster. This field allows to specify some
|
|
14352
14437
|
* configuration for the autoscaler, which is an implementation of the
|
|
14353
|
-
*
|
|
14438
|
+
* cluster-autoscaler
|
|
14439
|
+
* (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
|
|
14354
14440
|
*/
|
|
14355
14441
|
autoscalerConfig?: CreateClusterRequestAutoscalerConfig$1;
|
|
14356
14442
|
/**
|
|
@@ -14737,7 +14823,7 @@ type GetClusterKubeConfigRequest = {
|
|
|
14737
14823
|
clusterId: string;
|
|
14738
14824
|
};
|
|
14739
14825
|
|
|
14740
|
-
/**
|
|
14826
|
+
/** Kubernetes API. */
|
|
14741
14827
|
declare class API$d extends API$q {
|
|
14742
14828
|
/** Lists the available regions of the API. */
|
|
14743
14829
|
static readonly LOCALITIES: Region[];
|
|
@@ -19916,11 +20002,7 @@ type CreateCredentialRequest = {
|
|
|
19916
20002
|
namespaceId: string;
|
|
19917
20003
|
/** Name of the credentials. */
|
|
19918
20004
|
name?: string;
|
|
19919
|
-
/**
|
|
19920
|
-
* Permissions associated with these credentials.
|
|
19921
|
-
*
|
|
19922
|
-
* One-of ('optionalPermissions'): at most one of 'permissions' could be set.
|
|
19923
|
-
*/
|
|
20005
|
+
/** Permissions associated with these credentials. */
|
|
19924
20006
|
permissions?: Permissions;
|
|
19925
20007
|
};
|
|
19926
20008
|
type DeleteCredentialRequest = {
|
|
@@ -19957,11 +20039,7 @@ type UpdateCredentialRequest = {
|
|
|
19957
20039
|
credentialId: string;
|
|
19958
20040
|
/** Name of the credentials. */
|
|
19959
20041
|
name?: string;
|
|
19960
|
-
/**
|
|
19961
|
-
* Permissions associated with these credentials.
|
|
19962
|
-
*
|
|
19963
|
-
* One-of ('optionalPermissions'): at most one of 'permissions' could be set.
|
|
19964
|
-
*/
|
|
20042
|
+
/** Permissions associated with these credentials. */
|
|
19965
20043
|
permissions?: Permissions;
|
|
19966
20044
|
};
|
|
19967
20045
|
type GetCredentialRequest = {
|
|
@@ -19975,10 +20053,10 @@ type GetCredentialRequest = {
|
|
|
19975
20053
|
};
|
|
19976
20054
|
|
|
19977
20055
|
/**
|
|
19978
|
-
*
|
|
20056
|
+
* Messaging and Queuing API.
|
|
19979
20057
|
*
|
|
19980
|
-
* This API allows you to manage Scaleway Messaging and Queueing brokers.
|
|
19981
|
-
* API
|
|
20058
|
+
* This API allows you to manage Scaleway Messaging and Queueing brokers.
|
|
20059
|
+
* Messaging and Queuing API.
|
|
19982
20060
|
*/
|
|
19983
20061
|
declare class API$9 extends API$q {
|
|
19984
20062
|
/** Lists the available regions of the API. */
|
|
@@ -22449,7 +22527,7 @@ interface AvailableClusterSetting {
|
|
|
22449
22527
|
minValue?: number;
|
|
22450
22528
|
/** Optional validation rule of the setting. */
|
|
22451
22529
|
regex?: string;
|
|
22452
|
-
/**
|
|
22530
|
+
/** Defines whether or not the setting is deprecated. */
|
|
22453
22531
|
deprecated: boolean;
|
|
22454
22532
|
}
|
|
22455
22533
|
/** Cluster. */
|
|
@@ -22474,7 +22552,7 @@ interface Cluster {
|
|
|
22474
22552
|
createdAt?: Date;
|
|
22475
22553
|
/** Update date (Format ISO 8601). */
|
|
22476
22554
|
updatedAt?: Date;
|
|
22477
|
-
/**
|
|
22555
|
+
/** Defines whether or not TLS is enabled. */
|
|
22478
22556
|
tlsEnabled: boolean;
|
|
22479
22557
|
/** List of Database Instance settings. */
|
|
22480
22558
|
clusterSettings: ClusterSetting[];
|
|
@@ -22612,9 +22690,9 @@ interface NodeType {
|
|
|
22612
22690
|
vcpus: number;
|
|
22613
22691
|
/** Quantity of RAM. */
|
|
22614
22692
|
memory: number;
|
|
22615
|
-
/**
|
|
22693
|
+
/** Defines whether node type is currently disabled or not. */
|
|
22616
22694
|
disabled: boolean;
|
|
22617
|
-
/**
|
|
22695
|
+
/** Defines whether node type is currently in beta. */
|
|
22618
22696
|
beta: boolean;
|
|
22619
22697
|
/** Zone of the node type. */
|
|
22620
22698
|
zone: Zone;
|
|
@@ -22643,7 +22721,7 @@ interface SetEndpointsResponse {
|
|
|
22643
22721
|
type CreateClusterRequest = {
|
|
22644
22722
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
22645
22723
|
zone?: Zone;
|
|
22646
|
-
/**
|
|
22724
|
+
/** Project ID in which to create the Database Instance. */
|
|
22647
22725
|
projectId?: string;
|
|
22648
22726
|
/** Name of the Database Instance. */
|
|
22649
22727
|
name?: string;
|
|
@@ -22668,7 +22746,7 @@ type CreateClusterRequest = {
|
|
|
22668
22746
|
* the cluster will be publicly exposed by default.
|
|
22669
22747
|
*/
|
|
22670
22748
|
endpoints?: EndpointSpec[];
|
|
22671
|
-
/**
|
|
22749
|
+
/** Defines whether or not TLS is enabled. */
|
|
22672
22750
|
tlsEnabled: boolean;
|
|
22673
22751
|
/** List of advanced settings to be set upon Database Instance initialization. */
|
|
22674
22752
|
clusterSettings?: ClusterSetting[];
|
|
@@ -22759,7 +22837,7 @@ type GetClusterMetricsRequest = {
|
|
|
22759
22837
|
type ListNodeTypesRequest = {
|
|
22760
22838
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
22761
22839
|
zone?: Zone;
|
|
22762
|
-
/**
|
|
22840
|
+
/** Defines whether or not to include disabled types. */
|
|
22763
22841
|
includeDisabledTypes: boolean;
|
|
22764
22842
|
page?: number;
|
|
22765
22843
|
pageSize?: number;
|
|
@@ -22767,11 +22845,11 @@ type ListNodeTypesRequest = {
|
|
|
22767
22845
|
type ListClusterVersionsRequest = {
|
|
22768
22846
|
/** Zone to target. If none is passed will use default zone from the config. */
|
|
22769
22847
|
zone?: Zone;
|
|
22770
|
-
/**
|
|
22848
|
+
/** Defines whether or not to include disabled Redis™ engine versions. */
|
|
22771
22849
|
includeDisabled: boolean;
|
|
22772
|
-
/**
|
|
22850
|
+
/** Defines whether or not to include beta Redis™ engine versions. */
|
|
22773
22851
|
includeBeta: boolean;
|
|
22774
|
-
/**
|
|
22852
|
+
/** Defines whether or not to include deprecated Redis™ engine versions. */
|
|
22775
22853
|
includeDeprecated: boolean;
|
|
22776
22854
|
/** List Redis™ engine versions that match a given name pattern. */
|
|
22777
22855
|
version?: string;
|
|
@@ -23258,20 +23336,20 @@ type NamespaceStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked';
|
|
|
23258
23336
|
type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked';
|
|
23259
23337
|
/** Image. */
|
|
23260
23338
|
interface Image {
|
|
23261
|
-
/**
|
|
23339
|
+
/** UUID of the image. */
|
|
23262
23340
|
id: string;
|
|
23263
|
-
/**
|
|
23341
|
+
/** Name of the image, it must be unique within the namespace. */
|
|
23264
23342
|
name: string;
|
|
23265
|
-
/**
|
|
23343
|
+
/** UUID of the namespace the image belongs to. */
|
|
23266
23344
|
namespaceId: string;
|
|
23267
|
-
/**
|
|
23345
|
+
/** Status of the image. */
|
|
23268
23346
|
status: ImageStatus;
|
|
23269
23347
|
/** Details of the image status. */
|
|
23270
23348
|
statusMessage?: string;
|
|
23271
23349
|
/**
|
|
23272
|
-
*
|
|
23273
|
-
* to
|
|
23274
|
-
*
|
|
23350
|
+
* Set to `public` to allow the image to be pulled without authentication.
|
|
23351
|
+
* Else, set to `private`. Set to `inherit` to keep the same visibility
|
|
23352
|
+
* configuration as the namespace.
|
|
23275
23353
|
*/
|
|
23276
23354
|
visibility: ImageVisibility;
|
|
23277
23355
|
/**
|
|
@@ -23281,39 +23359,39 @@ interface Image {
|
|
|
23281
23359
|
* counted twice.
|
|
23282
23360
|
*/
|
|
23283
23361
|
size: number;
|
|
23284
|
-
/**
|
|
23362
|
+
/** Date and time of image creation. */
|
|
23285
23363
|
createdAt?: Date;
|
|
23286
|
-
/**
|
|
23364
|
+
/** Date and time of last update. */
|
|
23287
23365
|
updatedAt?: Date;
|
|
23288
23366
|
/** List of docker tags of the image. */
|
|
23289
23367
|
tags: string[];
|
|
23290
23368
|
}
|
|
23291
23369
|
/** List images response. */
|
|
23292
23370
|
interface ListImagesResponse {
|
|
23293
|
-
/** Paginated list of images
|
|
23371
|
+
/** Paginated list of images that match the selected filters. */
|
|
23294
23372
|
images: Image[];
|
|
23295
|
-
/** Total number of images
|
|
23373
|
+
/** Total number of images that match the selected filters. */
|
|
23296
23374
|
totalCount: number;
|
|
23297
23375
|
}
|
|
23298
23376
|
/** List namespaces response. */
|
|
23299
23377
|
interface ListNamespacesResponse {
|
|
23300
|
-
/** Paginated list of namespaces
|
|
23378
|
+
/** Paginated list of namespaces that match the selected filters. */
|
|
23301
23379
|
namespaces: Namespace[];
|
|
23302
|
-
/** Total number of namespaces
|
|
23380
|
+
/** Total number of namespaces that match the selected filters. */
|
|
23303
23381
|
totalCount: number;
|
|
23304
23382
|
}
|
|
23305
23383
|
/** List tags response. */
|
|
23306
23384
|
interface ListTagsResponse {
|
|
23307
|
-
/** Paginated list of tags
|
|
23385
|
+
/** Paginated list of tags that match the selected filters. */
|
|
23308
23386
|
tags: Tag[];
|
|
23309
|
-
/** Total number of tags
|
|
23387
|
+
/** Total number of tags that match the selected filters. */
|
|
23310
23388
|
totalCount: number;
|
|
23311
23389
|
}
|
|
23312
23390
|
/** Namespace. */
|
|
23313
23391
|
interface Namespace {
|
|
23314
|
-
/**
|
|
23392
|
+
/** UUID of the namespace. */
|
|
23315
23393
|
id: string;
|
|
23316
|
-
/**
|
|
23394
|
+
/** Name of the namespace, unique in a region accross all organizations. */
|
|
23317
23395
|
name: string;
|
|
23318
23396
|
/** Description of the namespace. */
|
|
23319
23397
|
description: string;
|
|
@@ -23327,16 +23405,16 @@ interface Namespace {
|
|
|
23327
23405
|
statusMessage: string;
|
|
23328
23406
|
/** Endpoint reachable by docker. */
|
|
23329
23407
|
endpoint: string;
|
|
23330
|
-
/**
|
|
23408
|
+
/** Defines whether or not namespace is public. */
|
|
23331
23409
|
isPublic: boolean;
|
|
23332
23410
|
/**
|
|
23333
23411
|
* Total size of the namespace, calculated as the sum of the size of all
|
|
23334
23412
|
* images in the namespace.
|
|
23335
23413
|
*/
|
|
23336
23414
|
size: number;
|
|
23337
|
-
/**
|
|
23415
|
+
/** Date and time of creation. */
|
|
23338
23416
|
createdAt?: Date;
|
|
23339
|
-
/**
|
|
23417
|
+
/** Date and time of last update. */
|
|
23340
23418
|
updatedAt?: Date;
|
|
23341
23419
|
/** Number of images in the namespace. */
|
|
23342
23420
|
imageCount: number;
|
|
@@ -23345,22 +23423,22 @@ interface Namespace {
|
|
|
23345
23423
|
}
|
|
23346
23424
|
/** Tag. */
|
|
23347
23425
|
interface Tag {
|
|
23348
|
-
/**
|
|
23426
|
+
/** UUID of the tag. */
|
|
23349
23427
|
id: string;
|
|
23350
|
-
/** Tag name, unique
|
|
23428
|
+
/** Tag name, unique to an image. */
|
|
23351
23429
|
name: string;
|
|
23352
|
-
/** Image ID
|
|
23430
|
+
/** Image ID the of the image the tag belongs to. */
|
|
23353
23431
|
imageId: string;
|
|
23354
23432
|
/** Tag status. */
|
|
23355
23433
|
status: TagStatus;
|
|
23356
23434
|
/**
|
|
23357
|
-
* Hash of the tag
|
|
23358
|
-
*
|
|
23435
|
+
* Hash of the tag content. Several tags of a same image may have the same
|
|
23436
|
+
* digest.
|
|
23359
23437
|
*/
|
|
23360
23438
|
digest: string;
|
|
23361
|
-
/**
|
|
23439
|
+
/** Date and time of creation. */
|
|
23362
23440
|
createdAt?: Date;
|
|
23363
|
-
/**
|
|
23441
|
+
/** Date and time of last update. */
|
|
23364
23442
|
updatedAt?: Date;
|
|
23365
23443
|
}
|
|
23366
23444
|
type ListNamespacesRequest = {
|
|
@@ -23376,7 +23454,11 @@ type ListNamespacesRequest = {
|
|
|
23376
23454
|
* display.
|
|
23377
23455
|
*/
|
|
23378
23456
|
pageSize?: number;
|
|
23379
|
-
/**
|
|
23457
|
+
/**
|
|
23458
|
+
* Criteria to use when ordering namespace listings. Possible values are
|
|
23459
|
+
* `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
|
|
23460
|
+
* `status_asc` and `status_desc`. The default value is `created_at_asc`.
|
|
23461
|
+
*/
|
|
23380
23462
|
orderBy?: ListNamespacesRequestOrderBy;
|
|
23381
23463
|
/** Filter by Organization ID. */
|
|
23382
23464
|
organizationId?: string;
|
|
@@ -23391,7 +23473,7 @@ type GetNamespaceRequest = {
|
|
|
23391
23473
|
* config.
|
|
23392
23474
|
*/
|
|
23393
23475
|
region?: Region;
|
|
23394
|
-
/**
|
|
23476
|
+
/** UUID of the namespace. */
|
|
23395
23477
|
namespaceId: string;
|
|
23396
23478
|
};
|
|
23397
23479
|
type CreateNamespaceRequest = {
|
|
@@ -23400,25 +23482,25 @@ type CreateNamespaceRequest = {
|
|
|
23400
23482
|
* config.
|
|
23401
23483
|
*/
|
|
23402
23484
|
region?: Region;
|
|
23403
|
-
/**
|
|
23485
|
+
/** Name of the namespace. */
|
|
23404
23486
|
name?: string;
|
|
23405
|
-
/**
|
|
23487
|
+
/** Description of the namespace. */
|
|
23406
23488
|
description: string;
|
|
23407
23489
|
/**
|
|
23408
|
-
* @deprecated
|
|
23490
|
+
* @deprecated Namespace owner (deprecated).
|
|
23409
23491
|
*
|
|
23410
23492
|
* One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId'
|
|
23411
23493
|
* could be set.
|
|
23412
23494
|
*/
|
|
23413
23495
|
organizationId?: string;
|
|
23414
23496
|
/**
|
|
23415
|
-
*
|
|
23497
|
+
* Project ID on which the namespace will be created.
|
|
23416
23498
|
*
|
|
23417
23499
|
* One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId'
|
|
23418
23500
|
* could be set.
|
|
23419
23501
|
*/
|
|
23420
23502
|
projectId?: string;
|
|
23421
|
-
/**
|
|
23503
|
+
/** Defines whether or not namespace is public. */
|
|
23422
23504
|
isPublic: boolean;
|
|
23423
23505
|
};
|
|
23424
23506
|
type UpdateNamespaceRequest = {
|
|
@@ -23427,11 +23509,11 @@ type UpdateNamespaceRequest = {
|
|
|
23427
23509
|
* config.
|
|
23428
23510
|
*/
|
|
23429
23511
|
region?: Region;
|
|
23430
|
-
/**
|
|
23512
|
+
/** ID of the namespace to update. */
|
|
23431
23513
|
namespaceId: string;
|
|
23432
|
-
/**
|
|
23514
|
+
/** Namespace description. */
|
|
23433
23515
|
description?: string;
|
|
23434
|
-
/**
|
|
23516
|
+
/** Defines whether or not the namespace is public. */
|
|
23435
23517
|
isPublic?: boolean;
|
|
23436
23518
|
};
|
|
23437
23519
|
type DeleteNamespaceRequest = {
|
|
@@ -23440,7 +23522,7 @@ type DeleteNamespaceRequest = {
|
|
|
23440
23522
|
* config.
|
|
23441
23523
|
*/
|
|
23442
23524
|
region?: Region;
|
|
23443
|
-
/**
|
|
23525
|
+
/** UUID of the namespace. */
|
|
23444
23526
|
namespaceId: string;
|
|
23445
23527
|
};
|
|
23446
23528
|
type ListImagesRequest = {
|
|
@@ -23456,11 +23538,15 @@ type ListImagesRequest = {
|
|
|
23456
23538
|
* display.
|
|
23457
23539
|
*/
|
|
23458
23540
|
pageSize?: number;
|
|
23459
|
-
/**
|
|
23541
|
+
/**
|
|
23542
|
+
* Criteria to use when ordering image listings. Possible values are
|
|
23543
|
+
* `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
|
|
23544
|
+
* `status_asc` and `status_desc`. The default value is `created_at_asc`.
|
|
23545
|
+
*/
|
|
23460
23546
|
orderBy?: ListImagesRequestOrderBy;
|
|
23461
|
-
/** Filter by the
|
|
23547
|
+
/** Filter by the namespace ID. */
|
|
23462
23548
|
namespaceId?: string;
|
|
23463
|
-
/** Filter by the
|
|
23549
|
+
/** Filter by the image name (exact match). */
|
|
23464
23550
|
name?: string;
|
|
23465
23551
|
/** Filter by Organization ID. */
|
|
23466
23552
|
organizationId?: string;
|
|
@@ -23473,7 +23559,7 @@ type GetImageRequest = {
|
|
|
23473
23559
|
* config.
|
|
23474
23560
|
*/
|
|
23475
23561
|
region?: Region;
|
|
23476
|
-
/**
|
|
23562
|
+
/** UUID of the image. */
|
|
23477
23563
|
imageId: string;
|
|
23478
23564
|
};
|
|
23479
23565
|
type UpdateImageRequest = {
|
|
@@ -23482,12 +23568,12 @@ type UpdateImageRequest = {
|
|
|
23482
23568
|
* config.
|
|
23483
23569
|
*/
|
|
23484
23570
|
region?: Region;
|
|
23485
|
-
/**
|
|
23571
|
+
/** ID of the image to update. */
|
|
23486
23572
|
imageId: string;
|
|
23487
23573
|
/**
|
|
23488
|
-
*
|
|
23489
|
-
* to
|
|
23490
|
-
*
|
|
23574
|
+
* Set to `public` to allow the image to be pulled without authentication.
|
|
23575
|
+
* Else, set to `private`. Set to `inherit` to keep the same visibility
|
|
23576
|
+
* configuration as the namespace.
|
|
23491
23577
|
*/
|
|
23492
23578
|
visibility?: ImageVisibility;
|
|
23493
23579
|
};
|
|
@@ -23497,7 +23583,7 @@ type DeleteImageRequest = {
|
|
|
23497
23583
|
* config.
|
|
23498
23584
|
*/
|
|
23499
23585
|
region?: Region;
|
|
23500
|
-
/**
|
|
23586
|
+
/** UUID of the image. */
|
|
23501
23587
|
imageId: string;
|
|
23502
23588
|
};
|
|
23503
23589
|
type ListTagsRequest = {
|
|
@@ -23506,7 +23592,7 @@ type ListTagsRequest = {
|
|
|
23506
23592
|
* config.
|
|
23507
23593
|
*/
|
|
23508
23594
|
region?: Region;
|
|
23509
|
-
/**
|
|
23595
|
+
/** UUID of the image. */
|
|
23510
23596
|
imageId: string;
|
|
23511
23597
|
/** A positive integer to choose the page to display. */
|
|
23512
23598
|
page?: number;
|
|
@@ -23515,7 +23601,11 @@ type ListTagsRequest = {
|
|
|
23515
23601
|
* display.
|
|
23516
23602
|
*/
|
|
23517
23603
|
pageSize?: number;
|
|
23518
|
-
/**
|
|
23604
|
+
/**
|
|
23605
|
+
* Criteria to use when ordering tag listings. Possible values are
|
|
23606
|
+
* `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`,
|
|
23607
|
+
* `status_asc` and `status_desc`. The default value is `created_at_asc`.
|
|
23608
|
+
*/
|
|
23519
23609
|
orderBy?: ListTagsRequestOrderBy;
|
|
23520
23610
|
/** Filter by the tag name (exact match). */
|
|
23521
23611
|
name?: string;
|
|
@@ -23526,7 +23616,7 @@ type GetTagRequest = {
|
|
|
23526
23616
|
* config.
|
|
23527
23617
|
*/
|
|
23528
23618
|
region?: Region;
|
|
23529
|
-
/**
|
|
23619
|
+
/** UUID of the tag. */
|
|
23530
23620
|
tagId: string;
|
|
23531
23621
|
};
|
|
23532
23622
|
type DeleteTagRequest = {
|
|
@@ -23535,7 +23625,7 @@ type DeleteTagRequest = {
|
|
|
23535
23625
|
* config.
|
|
23536
23626
|
*/
|
|
23537
23627
|
region?: Region;
|
|
23538
|
-
/**
|
|
23628
|
+
/** UUID of the tag. */
|
|
23539
23629
|
tagId: string;
|
|
23540
23630
|
/**
|
|
23541
23631
|
* If two tags share the same digest the deletion will fail unless this
|
|
@@ -23544,17 +23634,17 @@ type DeleteTagRequest = {
|
|
|
23544
23634
|
force: boolean;
|
|
23545
23635
|
};
|
|
23546
23636
|
|
|
23547
|
-
/**
|
|
23548
|
-
* Registry API.
|
|
23549
|
-
*
|
|
23550
|
-
* Container registry API. Registry API.
|
|
23551
|
-
*/
|
|
23637
|
+
/** Container Registry API. */
|
|
23552
23638
|
declare class API$6 extends API$q {
|
|
23553
23639
|
/** Lists the available regions of the API. */
|
|
23554
23640
|
static readonly LOCALITIES: Region[];
|
|
23555
23641
|
protected pageOfListNamespaces: (request?: Readonly<ListNamespacesRequest>) => Promise<ListNamespacesResponse>;
|
|
23556
23642
|
/**
|
|
23557
|
-
* List all
|
|
23643
|
+
* List namespaces. List all namespaces in a specified region. By default, the
|
|
23644
|
+
* namespaces listed are ordered by creation date in ascending order. This can
|
|
23645
|
+
* be modified via the order_by field. You can also define additional
|
|
23646
|
+
* parameters for your query, such as the `instance_id` and `project_id`
|
|
23647
|
+
* parameters.
|
|
23558
23648
|
*
|
|
23559
23649
|
* @param request - The request {@link ListNamespacesRequest}
|
|
23560
23650
|
* @returns A Promise of ListNamespacesResponse
|
|
@@ -23564,7 +23654,10 @@ declare class API$6 extends API$q {
|
|
|
23564
23654
|
[Symbol.asyncIterator]: () => AsyncGenerator<Namespace[], void, void>;
|
|
23565
23655
|
};
|
|
23566
23656
|
/**
|
|
23567
|
-
* Get a namespace.
|
|
23657
|
+
* Get a namespace. Retrieve information about a given namespace, specified by
|
|
23658
|
+
* its `namespace_id` and region. Full details about the namespace, such as
|
|
23659
|
+
* `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
|
|
23660
|
+
* `image_count` are returned in the response.
|
|
23568
23661
|
*
|
|
23569
23662
|
* @param request - The request {@link GetNamespaceRequest}
|
|
23570
23663
|
* @returns A Promise of Namespace
|
|
@@ -23579,23 +23672,28 @@ declare class API$6 extends API$q {
|
|
|
23579
23672
|
*/
|
|
23580
23673
|
waitForNamespace: (request: Readonly<GetNamespaceRequest>, options?: Readonly<WaitForOptions<Namespace>>) => Promise<Namespace>;
|
|
23581
23674
|
/**
|
|
23582
|
-
* Create a new namespace.
|
|
23675
|
+
* Create a namespace. Create a new Container Registry namespace. You must
|
|
23676
|
+
* specify the namespace name and region in which you want it to be created.
|
|
23677
|
+
* Optionally, you can specify the `project_id` and `is_public` in the request
|
|
23678
|
+
* payload.
|
|
23583
23679
|
*
|
|
23584
23680
|
* @param request - The request {@link CreateNamespaceRequest}
|
|
23585
23681
|
* @returns A Promise of Namespace
|
|
23586
23682
|
*/
|
|
23587
23683
|
createNamespace: (request: Readonly<CreateNamespaceRequest>) => Promise<Namespace>;
|
|
23588
23684
|
/**
|
|
23589
|
-
* Update
|
|
23590
|
-
*
|
|
23685
|
+
* Update a namespace. Update the parameters of a given namespace, specified
|
|
23686
|
+
* by its `namespace_id` and `region`. You can update the `description` and
|
|
23687
|
+
* `is_public` parameters.
|
|
23591
23688
|
*
|
|
23592
23689
|
* @param request - The request {@link UpdateNamespaceRequest}
|
|
23593
23690
|
* @returns A Promise of Namespace
|
|
23594
23691
|
*/
|
|
23595
23692
|
updateNamespace: (request: Readonly<UpdateNamespaceRequest>) => Promise<Namespace>;
|
|
23596
23693
|
/**
|
|
23597
|
-
* Delete
|
|
23598
|
-
*
|
|
23694
|
+
* Delete a namespace. Delete a given namespace. You must specify, in the
|
|
23695
|
+
* endpoint, the `region` and `namespace_id` parameters of the namespace you
|
|
23696
|
+
* want to delete.
|
|
23599
23697
|
*
|
|
23600
23698
|
* @param request - The request {@link DeleteNamespaceRequest}
|
|
23601
23699
|
* @returns A Promise of Namespace
|
|
@@ -23603,7 +23701,10 @@ declare class API$6 extends API$q {
|
|
|
23603
23701
|
deleteNamespace: (request: Readonly<DeleteNamespaceRequest>) => Promise<Namespace>;
|
|
23604
23702
|
protected pageOfListImages: (request?: Readonly<ListImagesRequest>) => Promise<ListImagesResponse>;
|
|
23605
23703
|
/**
|
|
23606
|
-
* List all
|
|
23704
|
+
* List images. List all images in a specified region. By default, the images
|
|
23705
|
+
* listed are ordered by creation date in ascending order. This can be
|
|
23706
|
+
* modified via the order_by field. You can also define additional parameters
|
|
23707
|
+
* for your query, such as the `namespace_id` and `project_id` parameters.
|
|
23607
23708
|
*
|
|
23608
23709
|
* @param request - The request {@link ListImagesRequest}
|
|
23609
23710
|
* @returns A Promise of ListImagesResponse
|
|
@@ -23613,7 +23714,10 @@ declare class API$6 extends API$q {
|
|
|
23613
23714
|
[Symbol.asyncIterator]: () => AsyncGenerator<Image[], void, void>;
|
|
23614
23715
|
};
|
|
23615
23716
|
/**
|
|
23616
|
-
* Get
|
|
23717
|
+
* Get an image. Retrieve information about a given container image, specified
|
|
23718
|
+
* by its `image_id` and region. Full details about the image, such as `name`,
|
|
23719
|
+
* `namespace_id`, `status`, `visibility`, and `size` are returned in the
|
|
23720
|
+
* response.
|
|
23617
23721
|
*
|
|
23618
23722
|
* @param request - The request {@link GetImageRequest}
|
|
23619
23723
|
* @returns A Promise of Image
|
|
@@ -23628,14 +23732,16 @@ declare class API$6 extends API$q {
|
|
|
23628
23732
|
*/
|
|
23629
23733
|
waitForImage: (request: Readonly<GetImageRequest>, options?: Readonly<WaitForOptions<Image>>) => Promise<Image>;
|
|
23630
23734
|
/**
|
|
23631
|
-
* Update an
|
|
23735
|
+
* Update an image. Update the parameters of a given image, specified by its
|
|
23736
|
+
* `image_id` and `region`. You can update the `visibility` parameter.
|
|
23632
23737
|
*
|
|
23633
23738
|
* @param request - The request {@link UpdateImageRequest}
|
|
23634
23739
|
* @returns A Promise of Image
|
|
23635
23740
|
*/
|
|
23636
23741
|
updateImage: (request: Readonly<UpdateImageRequest>) => Promise<Image>;
|
|
23637
23742
|
/**
|
|
23638
|
-
* Delete an image. Delete
|
|
23743
|
+
* Delete an image. Delete a given image. You must specify, in the endpoint,
|
|
23744
|
+
* the `region` and `image_id` parameters of the image you want to delete.
|
|
23639
23745
|
*
|
|
23640
23746
|
* @param request - The request {@link DeleteImageRequest}
|
|
23641
23747
|
* @returns A Promise of Image
|
|
@@ -23643,7 +23749,10 @@ declare class API$6 extends API$q {
|
|
|
23643
23749
|
deleteImage: (request: Readonly<DeleteImageRequest>) => Promise<Image>;
|
|
23644
23750
|
protected pageOfListTags: (request: Readonly<ListTagsRequest>) => Promise<ListTagsResponse>;
|
|
23645
23751
|
/**
|
|
23646
|
-
* List all
|
|
23752
|
+
* List tags. List all tags for a given image, specified by region. By
|
|
23753
|
+
* default, the tags listed are ordered by creation date in ascending order.
|
|
23754
|
+
* This can be modified via the order_by field. You can also define additional
|
|
23755
|
+
* parameters for your query, such as the `name`.
|
|
23647
23756
|
*
|
|
23648
23757
|
* @param request - The request {@link ListTagsRequest}
|
|
23649
23758
|
* @returns A Promise of ListTagsResponse
|
|
@@ -23653,7 +23762,9 @@ declare class API$6 extends API$q {
|
|
|
23653
23762
|
[Symbol.asyncIterator]: () => AsyncGenerator<Tag[], void, void>;
|
|
23654
23763
|
};
|
|
23655
23764
|
/**
|
|
23656
|
-
* Get a tag.
|
|
23765
|
+
* Get a tag. Retrieve information about a given image tag, specified by its
|
|
23766
|
+
* `tag_id` and region. Full details about the tag, such as `name`,
|
|
23767
|
+
* `image_id`, `status`, and `digest` are returned in the response.
|
|
23657
23768
|
*
|
|
23658
23769
|
* @param request - The request {@link GetTagRequest}
|
|
23659
23770
|
* @returns A Promise of Tag
|
|
@@ -23668,7 +23779,8 @@ declare class API$6 extends API$q {
|
|
|
23668
23779
|
*/
|
|
23669
23780
|
waitForTag: (request: Readonly<GetTagRequest>, options?: Readonly<WaitForOptions<Tag>>) => Promise<Tag>;
|
|
23670
23781
|
/**
|
|
23671
|
-
* Delete a tag. Delete
|
|
23782
|
+
* Delete a tag. Delete a given image tag. You must specify, in the endpoint,
|
|
23783
|
+
* the `region` and `tag_id` parameters of the tag you want to delete.
|
|
23672
23784
|
*
|
|
23673
23785
|
* @param request - The request {@link DeleteTagRequest}
|
|
23674
23786
|
* @returns A Promise of Tag
|
|
@@ -23766,8 +23878,8 @@ interface AccessSecretVersionResponse {
|
|
|
23766
23878
|
/** The base64-encoded secret payload of the version. */
|
|
23767
23879
|
data: string;
|
|
23768
23880
|
/**
|
|
23769
|
-
* The CRC32 checksum of the data as a base-10 integer. This field is
|
|
23770
|
-
*
|
|
23881
|
+
* The CRC32 checksum of the data as a base-10 integer. This field is only
|
|
23882
|
+
* available if a CRC32 was supplied during the creation of the version.
|
|
23771
23883
|
*/
|
|
23772
23884
|
dataCrc32?: number;
|
|
23773
23885
|
}
|
|
@@ -23958,7 +24070,7 @@ type CreateSecretVersionRequest = {
|
|
|
23958
24070
|
disablePrevious?: boolean;
|
|
23959
24071
|
/**
|
|
23960
24072
|
* Options to generate a password. Optional. If specified, a random password
|
|
23961
|
-
* will be generated. The data and data_crc32 fields must be empty. By
|
|
24073
|
+
* will be generated. The `data` and `data_crc32` fields must be empty. By
|
|
23962
24074
|
* default, the generator will use upper and lower case letters, and digits.
|
|
23963
24075
|
* This behavior can be tuned using the generation parameters.
|
|
23964
24076
|
*
|
|
@@ -23968,9 +24080,9 @@ type CreateSecretVersionRequest = {
|
|
|
23968
24080
|
passwordGeneration?: PasswordGenerationParams;
|
|
23969
24081
|
/**
|
|
23970
24082
|
* The CRC32 checksum of the data as a base-10 integer. Optional. If
|
|
23971
|
-
* specified,
|
|
23972
|
-
*
|
|
23973
|
-
*
|
|
24083
|
+
* specified, Secret Manager will verify the integrity of the data received
|
|
24084
|
+
* against the given CRC32. An error is returned if the CRC32 does not match.
|
|
24085
|
+
* Otherwise, the CRC32 will be stored and returned along with the
|
|
23974
24086
|
* SecretVersion on futur accesses.
|
|
23975
24087
|
*/
|
|
23976
24088
|
dataCrc32?: number;
|
|
@@ -24117,10 +24229,10 @@ type DestroySecretVersionRequest = {
|
|
|
24117
24229
|
};
|
|
24118
24230
|
|
|
24119
24231
|
/**
|
|
24120
|
-
* Secret Manager API
|
|
24232
|
+
* Secret Manager API.
|
|
24121
24233
|
*
|
|
24122
|
-
* This API allows you to conveniently store, access and
|
|
24123
|
-
*
|
|
24234
|
+
* Secret Manager API. This API allows you to conveniently store, access and
|
|
24235
|
+
* share sensitive data.
|
|
24124
24236
|
*/
|
|
24125
24237
|
declare class API$5 extends API$q {
|
|
24126
24238
|
/** Lists the available regions of the API. */
|
|
@@ -24722,8 +24834,8 @@ interface Statistics {
|
|
|
24722
24834
|
*/
|
|
24723
24835
|
failedCount: number;
|
|
24724
24836
|
/**
|
|
24725
|
-
* Number of emails in the final `canceled` state. This
|
|
24726
|
-
*
|
|
24837
|
+
* Number of emails in the final `canceled` state. This means emails that have
|
|
24838
|
+
* been canceled upon request.
|
|
24727
24839
|
*/
|
|
24728
24840
|
canceledCount: number;
|
|
24729
24841
|
}
|
|
@@ -24875,11 +24987,7 @@ type CheckDomainRequest = {
|
|
|
24875
24987
|
domainId: string;
|
|
24876
24988
|
};
|
|
24877
24989
|
|
|
24878
|
-
/**
|
|
24879
|
-
* Transactional Email API documentation.
|
|
24880
|
-
*
|
|
24881
|
-
* Tem. Transactional Email API documentation.
|
|
24882
|
-
*/
|
|
24990
|
+
/** Transactional Email API. */
|
|
24883
24991
|
declare class API$3 extends API$q {
|
|
24884
24992
|
/** Lists the available regions of the API. */
|
|
24885
24993
|
static readonly LOCALITIES: Region[];
|