@scaleway/sdk 2.67.0 → 2.69.0

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