@scaleway/sdk-edge-services 2.16.4 → 2.18.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.
@@ -0,0 +1,3 @@
1
+ # Licenses
2
+
3
+ The app does not bundle any dependencies with licenses.
@@ -0,0 +1,13 @@
1
+ //#region \0rolldown/runtime.js
2
+ var __defProp = Object.defineProperty;
3
+ var __exportAll = (all, no_symbols) => {
4
+ let target = {};
5
+ for (var name in all) __defProp(target, name, {
6
+ get: all[name],
7
+ enumerable: true
8
+ });
9
+ if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
10
+ return target;
11
+ };
12
+ //#endregion
13
+ export { __exportAll };
@@ -0,0 +1,5 @@
1
+ /**
2
+ * This file is automatically generated
3
+ * PLEASE DO NOT EDIT HERE
4
+ */
5
+ export * as EdgeServicesv1beta1 from './v1beta1/index.gen.js';
@@ -0,0 +1,2 @@
1
+ import { index_gen_exports } from "./v1beta1/index.gen.js";
2
+ export { index_gen_exports as EdgeServicesv1beta1 };
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file is automatically generated
3
+ * PLEASE DO NOT EDIT HERE
4
+ */
5
+ export declare const pkgMetadata: {
6
+ readonly name: "@scaleway/sdk-edge-services";
7
+ readonly namespace: "edge-services";
8
+ readonly displayName: "Edge Services";
9
+ readonly versions: readonly ["v1beta1"];
10
+ };
11
+ export type Metadata = typeof pkgMetadata;
12
+ export default pkgMetadata;
@@ -0,0 +1,13 @@
1
+ //#region src/metadata.gen.ts
2
+ /**
3
+ * This file is automatically generated
4
+ * PLEASE DO NOT EDIT HERE
5
+ */
6
+ const pkgMetadata = {
7
+ name: "@scaleway/sdk-edge-services",
8
+ namespace: "edge-services",
9
+ displayName: "Edge Services",
10
+ versions: ["v1beta1"]
11
+ };
12
+ //#endregion
13
+ export { pkgMetadata as default, pkgMetadata };
@@ -0,0 +1,442 @@
1
+ import { API as ParentAPI } from '@scaleway/sdk-client';
2
+ import type { WaitForOptions } from '@scaleway/sdk-client';
3
+ import type { AddRouteRulesRequest, AddRouteRulesResponse, BackendStage, CacheStage, CheckDomainRequest, CheckDomainResponse, CheckLbOriginRequest, CheckLbOriginResponse, CheckPEMChainRequest, CheckPEMChainResponse, CreateBackendStageRequest, CreateCacheStageRequest, CreateDNSStageRequest, CreatePipelineRequest, CreatePurgeRequestRequest, CreateRouteStageRequest, CreateTLSStageRequest, CreateVPCEndpointRequest, CreateWafStageRequest, DNSStage, DeleteBackendStageRequest, DeleteCacheStageRequest, DeleteCurrentPlanRequest, DeleteDNSStageRequest, DeletePipelineRequest, DeleteRouteStageRequest, DeleteTLSStageRequest, DeleteVPCEndpointRequest, DeleteWafStageRequest, GetBackendStageRequest, GetBillingRequest, GetBillingResponse, GetCacheStageRequest, GetCurrentPlanRequest, GetDNSStageRequest, GetPipelineRequest, GetPurgeRequestRequest, GetRouteStageRequest, GetTLSStageRequest, GetVPCEndpointRequest, GetWafStageRequest, HeadStageResponse, ListBackendStagesRequest, ListBackendStagesResponse, ListCacheStagesRequest, ListCacheStagesResponse, ListDNSStagesRequest, ListDNSStagesResponse, ListHeadStagesRequest, ListHeadStagesResponse, ListPipelinesRequest, ListPipelinesResponse, ListPipelinesWithStagesRequest, ListPipelinesWithStagesResponse, ListPlansResponse, ListPurgeRequestsRequest, ListPurgeRequestsResponse, ListRouteRulesRequest, ListRouteRulesResponse, ListRouteStagesRequest, ListRouteStagesResponse, ListTLSStagesRequest, ListTLSStagesResponse, ListVPCEndpointsRequest, ListVPCEndpointsResponse, ListWafStagesRequest, ListWafStagesResponse, Pipeline, PipelineStages, Plan, PurgeRequest, RouteStage, SearchBackendStagesRequest, SearchRouteRulesRequest, SearchWafStagesRequest, SelectPlanRequest, SetHeadStageRequest, SetPipelineVPCEndpointsRequest, SetPipelineVPCEndpointsResponse, SetRouteRulesRequest, SetRouteRulesResponse, TLSStage, UpdateBackendStageRequest, UpdateCacheStageRequest, UpdateDNSStageRequest, UpdatePipelineRequest, UpdateRouteStageRequest, UpdateTLSStageRequest, UpdateWafStageRequest, VPCEndpoint, WafStage } from './types.gen.js';
4
+ /**
5
+ * Edge Services API.
6
+ */
7
+ export declare class API extends ParentAPI {
8
+ protected pageOfListPipelines: (request?: Readonly<ListPipelinesRequest>) => Promise<ListPipelinesResponse>;
9
+ /**
10
+ * List pipelines. List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
11
+ *
12
+ * @param request - The request {@link ListPipelinesRequest}
13
+ * @returns A Promise of ListPipelinesResponse
14
+ */
15
+ listPipelines: (request?: Readonly<ListPipelinesRequest>) => Promise<ListPipelinesResponse> & {
16
+ all: () => Promise<Pipeline[]>;
17
+ [Symbol.asyncIterator]: () => AsyncGenerator<Pipeline[], void, void>;
18
+ };
19
+ /**
20
+ * Create pipeline. Create a new pipeline. You must specify a `dns_stage_id` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
21
+ *
22
+ * @param request - The request {@link CreatePipelineRequest}
23
+ * @returns A Promise of Pipeline
24
+ */
25
+ createPipeline: (request: Readonly<CreatePipelineRequest>) => Promise<Pipeline>;
26
+ /**
27
+ * Get pipeline. Retrieve information about an existing pipeline, specified by its `pipeline_id`. Its full details, including errors, are returned in the response object.
28
+ *
29
+ * @param request - The request {@link GetPipelineRequest}
30
+ * @returns A Promise of Pipeline
31
+ */
32
+ getPipeline: (request: Readonly<GetPipelineRequest>) => Promise<Pipeline>;
33
+ /**
34
+ * Waits for {@link Pipeline} to be in a final state.
35
+ *
36
+ * @param request - The request {@link GetPipelineRequest}
37
+ * @param options - The waiting options
38
+ * @returns A Promise of Pipeline
39
+ */
40
+ waitForPipeline: (request: Readonly<GetPipelineRequest>, options?: Readonly<WaitForOptions<Pipeline>>) => Promise<Pipeline>;
41
+ protected pageOfListPipelinesWithStages: (request?: Readonly<ListPipelinesWithStagesRequest>) => Promise<ListPipelinesWithStagesResponse>;
42
+ listPipelinesWithStages: (request?: Readonly<ListPipelinesWithStagesRequest>) => Promise<ListPipelinesWithStagesResponse> & {
43
+ all: () => Promise<PipelineStages[]>;
44
+ [Symbol.asyncIterator]: () => AsyncGenerator<PipelineStages[], void, void>;
45
+ };
46
+ /**
47
+ * Update pipeline. Update the parameters of an existing pipeline, specified by its `pipeline_id`. Parameters which can be updated include the `name`, `description` and `dns_stage_id`.
48
+ *
49
+ * @param request - The request {@link UpdatePipelineRequest}
50
+ * @returns A Promise of Pipeline
51
+ */
52
+ updatePipeline: (request: Readonly<UpdatePipelineRequest>) => Promise<Pipeline>;
53
+ /**
54
+ * Delete pipeline. Delete an existing pipeline, specified by its `pipeline_id`. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted.
55
+ *
56
+ * @param request - The request {@link DeletePipelineRequest}
57
+ */
58
+ deletePipeline: (request: Readonly<DeletePipelineRequest>) => Promise<void>;
59
+ /**
60
+ * Get VPC Endpoint. Retrieve information about an existing VPC Endpoint, specified by its `vpc_endpoint_id`.
61
+ *
62
+ * @param request - The request {@link GetVPCEndpointRequest}
63
+ * @returns A Promise of VPCEndpoint
64
+ */
65
+ getVPCEndpoint: (request: Readonly<GetVPCEndpointRequest>) => Promise<VPCEndpoint>;
66
+ protected pageOfListVPCEndpoints: (request?: Readonly<ListVPCEndpointsRequest>) => Promise<ListVPCEndpointsResponse>;
67
+ /**
68
+ * List VPC Endpoints. List all VPC Endpoints, for a Scaleway Organization or Scaleway Project. By default, the VPC Endpoints returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
69
+ *
70
+ * @param request - The request {@link ListVPCEndpointsRequest}
71
+ * @returns A Promise of ListVPCEndpointsResponse
72
+ */
73
+ listVPCEndpoints: (request?: Readonly<ListVPCEndpointsRequest>) => Promise<ListVPCEndpointsResponse> & {
74
+ all: () => Promise<VPCEndpoint[]>;
75
+ [Symbol.asyncIterator]: () => AsyncGenerator<VPCEndpoint[], void, void>;
76
+ };
77
+ /**
78
+ * Create VPC Endpoint. Create a new VPC Endpoint. You must specify a `private_network_id` to define to which Private Network the VPC endpoint will be attached to.
79
+ *
80
+ * @param request - The request {@link CreateVPCEndpointRequest}
81
+ * @returns A Promise of VPCEndpoint
82
+ */
83
+ createVPCEndpoint: (request: Readonly<CreateVPCEndpointRequest>) => Promise<VPCEndpoint>;
84
+ /**
85
+ * Delete VPC Endpoint. Delete an existing VPC Endpoint, specified by its `vpc_endpoint_id`.
86
+ *
87
+ * @param request - The request {@link DeleteVPCEndpointRequest}
88
+ */
89
+ deleteVPCEndpoint: (request: Readonly<DeleteVPCEndpointRequest>) => Promise<void>;
90
+ /**
91
+ * Attach VPC Endpoints. Attach VPC Endpoint to the given Pipeline. You must specify a `pipeline_id` and `vpc_endpoint_ids` which contains the list of VPC Endpoints.
92
+ *
93
+ * @param request - The request {@link SetPipelineVPCEndpointsRequest}
94
+ * @returns A Promise of SetPipelineVPCEndpointsResponse
95
+ */
96
+ setPipelineVPCEndpoints: (request: Readonly<SetPipelineVPCEndpointsRequest>) => Promise<SetPipelineVPCEndpointsResponse>;
97
+ protected pageOfListHeadStages: (request: Readonly<ListHeadStagesRequest>) => Promise<ListHeadStagesResponse>;
98
+ /**
99
+ * List Head stage for your pipeline.. List Head stage for your pipeline.
100
+ *
101
+ * @param request - The request {@link ListHeadStagesRequest}
102
+ * @returns A Promise of ListHeadStagesResponse
103
+ */
104
+ listHeadStages: (request: Readonly<ListHeadStagesRequest>) => Promise<ListHeadStagesResponse> & {
105
+ all: () => Promise<import("./types.gen.js").ListHeadStagesResponseHeadStage[]>;
106
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").ListHeadStagesResponseHeadStage[], void, void>;
107
+ };
108
+ /**
109
+ * Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.. You must specify either a `add_new_head_stage` (to add a new head stage), `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to replace a head stage).
110
+ *
111
+ * @param request - The request {@link SetHeadStageRequest}
112
+ * @returns A Promise of HeadStageResponse
113
+ */
114
+ setHeadStage: (request: Readonly<SetHeadStageRequest>) => Promise<HeadStageResponse>;
115
+ protected pageOfListDNSStages: (request: Readonly<ListDNSStagesRequest>) => Promise<ListDNSStagesResponse>;
116
+ /**
117
+ * List DNS stages. List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
118
+ *
119
+ * @param request - The request {@link ListDNSStagesRequest}
120
+ * @returns A Promise of ListDNSStagesResponse
121
+ */
122
+ listDNSStages: (request: Readonly<ListDNSStagesRequest>) => Promise<ListDNSStagesResponse> & {
123
+ all: () => Promise<DNSStage[]>;
124
+ [Symbol.asyncIterator]: () => AsyncGenerator<DNSStage[], void, void>;
125
+ };
126
+ /**
127
+ * Create DNS stage. Create a new DNS stage. You must specify the `fqdns` field to customize the domain endpoint, using a domain you already own.
128
+ *
129
+ * @param request - The request {@link CreateDNSStageRequest}
130
+ * @returns A Promise of DNSStage
131
+ */
132
+ createDNSStage: (request: Readonly<CreateDNSStageRequest>) => Promise<DNSStage>;
133
+ /**
134
+ * Get DNS stage. Retrieve information about an existing DNS stage, specified by its `dns_stage_id`. Its full details, including FQDNs, are returned in the response object.
135
+ *
136
+ * @param request - The request {@link GetDNSStageRequest}
137
+ * @returns A Promise of DNSStage
138
+ */
139
+ getDNSStage: (request: Readonly<GetDNSStageRequest>) => Promise<DNSStage>;
140
+ /**
141
+ * Update DNS stage. Update the parameters of an existing DNS stage, specified by its `dns_stage_id`.
142
+ *
143
+ * @param request - The request {@link UpdateDNSStageRequest}
144
+ * @returns A Promise of DNSStage
145
+ */
146
+ updateDNSStage: (request: Readonly<UpdateDNSStageRequest>) => Promise<DNSStage>;
147
+ /**
148
+ * Delete DNS stage. Delete an existing DNS stage, specified by its `dns_stage_id`. Deleting a DNS stage is permanent, and cannot be undone.
149
+ *
150
+ * @param request - The request {@link DeleteDNSStageRequest}
151
+ */
152
+ deleteDNSStage: (request: Readonly<DeleteDNSStageRequest>) => Promise<void>;
153
+ protected pageOfListTLSStages: (request: Readonly<ListTLSStagesRequest>) => Promise<ListTLSStagesResponse>;
154
+ /**
155
+ * List TLS stages. List all TLS stages, for a Scaleway Organization or Scaleway Project. By default, the TLS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
156
+ *
157
+ * @param request - The request {@link ListTLSStagesRequest}
158
+ * @returns A Promise of ListTLSStagesResponse
159
+ */
160
+ listTLSStages: (request: Readonly<ListTLSStagesRequest>) => Promise<ListTLSStagesResponse> & {
161
+ all: () => Promise<TLSStage[]>;
162
+ [Symbol.asyncIterator]: () => AsyncGenerator<TLSStage[], void, void>;
163
+ };
164
+ /**
165
+ * Create TLS stage. Create a new TLS stage. You must specify either the `secrets` or `managed_certificate` fields to customize the SSL/TLS certificate of your endpoint. Choose `secrets` if you are using a pre-existing certificate held in Scaleway Secret Manager, or `managed_certificate` to let Scaleway generate and manage a Let's Encrypt certificate for your customized endpoint.
166
+ *
167
+ * @param request - The request {@link CreateTLSStageRequest}
168
+ * @returns A Promise of TLSStage
169
+ */
170
+ createTLSStage: (request: Readonly<CreateTLSStageRequest>) => Promise<TLSStage>;
171
+ /**
172
+ * Get TLS stage. Retrieve information about an existing TLS stage, specified by its `tls_stage_id`. Its full details, including secrets and certificate expiration date are returned in the response object.
173
+ *
174
+ * @param request - The request {@link GetTLSStageRequest}
175
+ * @returns A Promise of TLSStage
176
+ */
177
+ getTLSStage: (request: Readonly<GetTLSStageRequest>) => Promise<TLSStage>;
178
+ /**
179
+ * Update TLS stage. Update the parameters of an existing TLS stage, specified by its `tls_stage_id`. Both `tls_secrets_config` and `managed_certificate` parameters can be updated.
180
+ *
181
+ * @param request - The request {@link UpdateTLSStageRequest}
182
+ * @returns A Promise of TLSStage
183
+ */
184
+ updateTLSStage: (request: Readonly<UpdateTLSStageRequest>) => Promise<TLSStage>;
185
+ /**
186
+ * Delete TLS stage. Delete an existing TLS stage, specified by its `tls_stage_id`. Deleting a TLS stage is permanent, and cannot be undone.
187
+ *
188
+ * @param request - The request {@link DeleteTLSStageRequest}
189
+ */
190
+ deleteTLSStage: (request: Readonly<DeleteTLSStageRequest>) => Promise<void>;
191
+ protected pageOfListCacheStages: (request: Readonly<ListCacheStagesRequest>) => Promise<ListCacheStagesResponse>;
192
+ /**
193
+ * List cache stages. List all cache stages, for a Scaleway Organization or Scaleway Project. By default, the cache stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
194
+ *
195
+ * @param request - The request {@link ListCacheStagesRequest}
196
+ * @returns A Promise of ListCacheStagesResponse
197
+ */
198
+ listCacheStages: (request: Readonly<ListCacheStagesRequest>) => Promise<ListCacheStagesResponse> & {
199
+ all: () => Promise<CacheStage[]>;
200
+ [Symbol.asyncIterator]: () => AsyncGenerator<CacheStage[], void, void>;
201
+ };
202
+ /**
203
+ * Create cache stage. Create a new cache stage. You must specify the `fallback_ttl` field to customize the TTL of the cache.
204
+ *
205
+ * @param request - The request {@link CreateCacheStageRequest}
206
+ * @returns A Promise of CacheStage
207
+ */
208
+ createCacheStage: (request: Readonly<CreateCacheStageRequest>) => Promise<CacheStage>;
209
+ /**
210
+ * Get cache stage. Retrieve information about an existing cache stage, specified by its `cache_stage_id`. Its full details, including Time To Live (TTL), are returned in the response object.
211
+ *
212
+ * @param request - The request {@link GetCacheStageRequest}
213
+ * @returns A Promise of CacheStage
214
+ */
215
+ getCacheStage: (request: Readonly<GetCacheStageRequest>) => Promise<CacheStage>;
216
+ /**
217
+ * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl`, `include_cookies` and `backend_stage_id`.
218
+ *
219
+ * @param request - The request {@link UpdateCacheStageRequest}
220
+ * @returns A Promise of CacheStage
221
+ */
222
+ updateCacheStage: (request: Readonly<UpdateCacheStageRequest>) => Promise<CacheStage>;
223
+ /**
224
+ * Delete cache stage. Delete an existing cache stage, specified by its `cache_stage_id`. Deleting a cache stage is permanent, and cannot be undone.
225
+ *
226
+ * @param request - The request {@link DeleteCacheStageRequest}
227
+ */
228
+ deleteCacheStage: (request: Readonly<DeleteCacheStageRequest>) => Promise<void>;
229
+ protected pageOfListBackendStages: (request: Readonly<ListBackendStagesRequest>) => Promise<ListBackendStagesResponse>;
230
+ /**
231
+ * List backend stages. List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
232
+ *
233
+ * @param request - The request {@link ListBackendStagesRequest}
234
+ * @returns A Promise of ListBackendStagesResponse
235
+ */
236
+ listBackendStages: (request: Readonly<ListBackendStagesRequest>) => Promise<ListBackendStagesResponse> & {
237
+ all: () => Promise<BackendStage[]>;
238
+ [Symbol.asyncIterator]: () => AsyncGenerator<BackendStage[], void, void>;
239
+ };
240
+ /**
241
+ * Create backend stage. Create a new backend stage. You must specify a type of backend (`scaleway_s3`, `scaleway_lb`, etc.) to configure the origin.
242
+ *
243
+ * @param request - The request {@link CreateBackendStageRequest}
244
+ * @returns A Promise of BackendStage
245
+ */
246
+ createBackendStage: (request: Readonly<CreateBackendStageRequest>) => Promise<BackendStage>;
247
+ /**
248
+ * Get backend stage. Retrieve information about an existing backend stage, specified by its `backend_stage_id`. Its full details are returned in the response object.
249
+ *
250
+ * @param request - The request {@link GetBackendStageRequest}
251
+ * @returns A Promise of BackendStage
252
+ */
253
+ getBackendStage: (request: Readonly<GetBackendStageRequest>) => Promise<BackendStage>;
254
+ /**
255
+ * Update backend stage. Update the parameters of an existing backend stage, specified by its `backend_stage_id`.
256
+ *
257
+ * @param request - The request {@link UpdateBackendStageRequest}
258
+ * @returns A Promise of BackendStage
259
+ */
260
+ updateBackendStage: (request: Readonly<UpdateBackendStageRequest>) => Promise<BackendStage>;
261
+ /**
262
+ * Delete backend stage. Delete an existing backend stage, specified by its `backend_stage_id`. Deleting a backend stage is permanent, and cannot be undone.
263
+ *
264
+ * @param request - The request {@link DeleteBackendStageRequest}
265
+ */
266
+ deleteBackendStage: (request: Readonly<DeleteBackendStageRequest>) => Promise<void>;
267
+ searchBackendStages: (request?: Readonly<SearchBackendStagesRequest>) => Promise<ListBackendStagesResponse>;
268
+ protected pageOfListWafStages: (request: Readonly<ListWafStagesRequest>) => Promise<ListWafStagesResponse>;
269
+ /**
270
+ * List WAF stages. List all WAF stages, for a Scaleway Organization or Scaleway Project. By default, the WAF stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
271
+ *
272
+ * @param request - The request {@link ListWafStagesRequest}
273
+ * @returns A Promise of ListWafStagesResponse
274
+ */
275
+ listWafStages: (request: Readonly<ListWafStagesRequest>) => Promise<ListWafStagesResponse> & {
276
+ all: () => Promise<WafStage[]>;
277
+ [Symbol.asyncIterator]: () => AsyncGenerator<WafStage[], void, void>;
278
+ };
279
+ /**
280
+ * Create WAF stage. Create a new WAF stage. You must specify the `mode` and `paranoia_level` fields to customize the WAF.
281
+ *
282
+ * @param request - The request {@link CreateWafStageRequest}
283
+ * @returns A Promise of WafStage
284
+ */
285
+ createWafStage: (request: Readonly<CreateWafStageRequest>) => Promise<WafStage>;
286
+ /**
287
+ * Get WAF stage. Retrieve information about an existing WAF stage, specified by its `waf_stage_id`. Its full details are returned in the response object.
288
+ *
289
+ * @param request - The request {@link GetWafStageRequest}
290
+ * @returns A Promise of WafStage
291
+ */
292
+ getWafStage: (request: Readonly<GetWafStageRequest>) => Promise<WafStage>;
293
+ /**
294
+ * Update WAF stage. Update the parameters of an existing WAF stage, specified by its `waf_stage_id`. Both `mode` and `paranoia_level` parameters can be updated.
295
+ *
296
+ * @param request - The request {@link UpdateWafStageRequest}
297
+ * @returns A Promise of WafStage
298
+ */
299
+ updateWafStage: (request: Readonly<UpdateWafStageRequest>) => Promise<WafStage>;
300
+ /**
301
+ * Delete WAF stage. Delete an existing WAF stage, specified by its `waf_stage_id`. Deleting a WAF stage is permanent, and cannot be undone.
302
+ *
303
+ * @param request - The request {@link DeleteWafStageRequest}
304
+ */
305
+ deleteWafStage: (request: Readonly<DeleteWafStageRequest>) => Promise<void>;
306
+ searchWafStages: (request?: Readonly<SearchWafStagesRequest>) => Promise<ListWafStagesResponse>;
307
+ protected pageOfListRouteStages: (request: Readonly<ListRouteStagesRequest>) => Promise<ListRouteStagesResponse>;
308
+ /**
309
+ * List route stages. List all route stages, for a given pipeline. By default, the route stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
310
+ *
311
+ * @param request - The request {@link ListRouteStagesRequest}
312
+ * @returns A Promise of ListRouteStagesResponse
313
+ */
314
+ listRouteStages: (request: Readonly<ListRouteStagesRequest>) => Promise<ListRouteStagesResponse> & {
315
+ all: () => Promise<RouteStage[]>;
316
+ [Symbol.asyncIterator]: () => AsyncGenerator<RouteStage[], void, void>;
317
+ };
318
+ /**
319
+ * Create route stage. Create a new route stage. You must specify the `waf_stage_id` or `backend_stage_id` fields to customize the route.
320
+ *
321
+ * @param request - The request {@link CreateRouteStageRequest}
322
+ * @returns A Promise of RouteStage
323
+ */
324
+ createRouteStage: (request: Readonly<CreateRouteStageRequest>) => Promise<RouteStage>;
325
+ /**
326
+ * Get route stage. Retrieve information about an existing route stage, specified by its `route_stage_id`. The summary of the route stage (without route rules) is returned in the response object.
327
+ *
328
+ * @param request - The request {@link GetRouteStageRequest}
329
+ * @returns A Promise of RouteStage
330
+ */
331
+ getRouteStage: (request: Readonly<GetRouteStageRequest>) => Promise<RouteStage>;
332
+ /**
333
+ * Update route stage. Update the parameters of an existing route stage, specified by its `route_stage_id`.
334
+ *
335
+ * @param request - The request {@link UpdateRouteStageRequest}
336
+ * @returns A Promise of RouteStage
337
+ */
338
+ updateRouteStage: (request: Readonly<UpdateRouteStageRequest>) => Promise<RouteStage>;
339
+ /**
340
+ * Delete route stage. Delete an existing route stage, specified by its `route_stage_id`. Deleting a route stage is permanent, and cannot be undone.
341
+ *
342
+ * @param request - The request {@link DeleteRouteStageRequest}
343
+ */
344
+ deleteRouteStage: (request: Readonly<DeleteRouteStageRequest>) => Promise<void>;
345
+ /**
346
+ * List route rules. List all route rules of an existing route stage, specified by its `route_stage_id`.
347
+ *
348
+ * @param request - The request {@link ListRouteRulesRequest}
349
+ * @returns A Promise of ListRouteRulesResponse
350
+ */
351
+ listRouteRules: (request: Readonly<ListRouteRulesRequest>) => Promise<ListRouteRulesResponse>;
352
+ /**
353
+ * Set route rules. Set the rules of an existing route stage, specified by its `route_stage_id`.
354
+ *
355
+ * @param request - The request {@link SetRouteRulesRequest}
356
+ * @returns A Promise of SetRouteRulesResponse
357
+ */
358
+ setRouteRules: (request: Readonly<SetRouteRulesRequest>) => Promise<SetRouteRulesResponse>;
359
+ /**
360
+ * Add route rules. Add route rules to an existing route stage, specified by its `route_stage_id`.
361
+ *
362
+ * @param request - The request {@link AddRouteRulesRequest}
363
+ * @returns A Promise of AddRouteRulesResponse
364
+ */
365
+ addRouteRules: (request: Readonly<AddRouteRulesRequest>) => Promise<AddRouteRulesResponse>;
366
+ /**
367
+ * Search route rules. List all route rules of an organization or project.
368
+ *
369
+ * @param request - The request {@link SearchRouteRulesRequest}
370
+ * @returns A Promise of ListRouteRulesResponse
371
+ */
372
+ searchRouteRules: (request?: Readonly<SearchRouteRulesRequest>) => Promise<ListRouteRulesResponse>;
373
+ checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<CheckDomainResponse>;
374
+ checkPEMChain: (request: Readonly<CheckPEMChainRequest>) => Promise<CheckPEMChainResponse>;
375
+ protected pageOfListPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse>;
376
+ /**
377
+ * List purge requests. List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
378
+ *
379
+ * @param request - The request {@link ListPurgeRequestsRequest}
380
+ * @returns A Promise of ListPurgeRequestsResponse
381
+ */
382
+ listPurgeRequests: (request?: Readonly<ListPurgeRequestsRequest>) => Promise<ListPurgeRequestsResponse> & {
383
+ all: () => Promise<PurgeRequest[]>;
384
+ [Symbol.asyncIterator]: () => AsyncGenerator<PurgeRequest[], void, void>;
385
+ };
386
+ /**
387
+ * Create purge request. Create a new purge request. You must specify either the `all` field (to purge all content) or a list of `assets` (to define the precise assets to purge).
388
+ *
389
+ * @param request - The request {@link CreatePurgeRequestRequest}
390
+ * @returns A Promise of PurgeRequest
391
+ */
392
+ createPurgeRequest: (request: Readonly<CreatePurgeRequestRequest>) => Promise<PurgeRequest>;
393
+ /**
394
+ * Get purge request. Retrieve information about a purge request, specified by its `purge_request_id`. Its full details, including `status` and `target`, are returned in the response object.
395
+ *
396
+ * @param request - The request {@link GetPurgeRequestRequest}
397
+ * @returns A Promise of PurgeRequest
398
+ */
399
+ getPurgeRequest: (request: Readonly<GetPurgeRequestRequest>) => Promise<PurgeRequest>;
400
+ /**
401
+ * Waits for {@link PurgeRequest} to be in a final state.
402
+ *
403
+ * @param request - The request {@link GetPurgeRequestRequest}
404
+ * @param options - The waiting options
405
+ * @returns A Promise of PurgeRequest
406
+ */
407
+ waitForPurgeRequest: (request: Readonly<GetPurgeRequestRequest>, options?: Readonly<WaitForOptions<PurgeRequest>>) => Promise<PurgeRequest>;
408
+ checkLbOrigin: (request?: Readonly<CheckLbOriginRequest>) => Promise<CheckLbOriginResponse>;
409
+ /**
410
+ * List plans. List all available Edge Services subscription plans.
411
+ *
412
+ * @returns A Promise of ListPlansResponse
413
+ */
414
+ listPlans: () => Promise<ListPlansResponse>;
415
+ /**
416
+ * Select plan. Subscribe to the Edge Services subscription plan of your choice, for the given Scaleway Project.
417
+ *
418
+ * @param request - The request {@link SelectPlanRequest}
419
+ * @returns A Promise of Plan
420
+ */
421
+ selectPlan: (request?: Readonly<SelectPlanRequest>) => Promise<Plan>;
422
+ /**
423
+ * Get plan. Get the current Edge Services subscription plan for your Scaleway Project.
424
+ *
425
+ * @param request - The request {@link GetCurrentPlanRequest}
426
+ * @returns A Promise of Plan
427
+ */
428
+ getCurrentPlan: (request?: Readonly<GetCurrentPlanRequest>) => Promise<Plan>;
429
+ /**
430
+ * Delete plan. Unsubscribe from the current Edge Services subscription plan for your Scaleway Project.
431
+ *
432
+ * @param request - The request {@link DeleteCurrentPlanRequest}
433
+ */
434
+ deleteCurrentPlan: (request?: Readonly<DeleteCurrentPlanRequest>) => Promise<void>;
435
+ /**
436
+ * Gives information on the currently selected Edge Services subscription plan, resource usage and associated billing information for this calendar month (including whether consumption falls within or exceeds the currently selected subscription plan.).
437
+ *
438
+ * @param request - The request {@link GetBillingRequest}
439
+ * @returns A Promise of GetBillingResponse
440
+ */
441
+ getBilling: (request?: Readonly<GetBillingRequest>) => Promise<GetBillingResponse>;
442
+ }