@scaleway/sdk 2.72.0 → 2.74.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 (209) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/index.gen.d.ts +1 -1
  5. package/dist/api/account/v3/marshalling.gen.cjs +94 -65
  6. package/dist/api/account/v3/marshalling.gen.js +94 -65
  7. package/dist/api/account/v3/types.gen.d.ts +224 -104
  8. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  9. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  10. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  11. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  12. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  13. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  14. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  15. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  16. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  17. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  18. package/dist/api/baremetal/v1/api.gen.js +28 -61
  19. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  20. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  21. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  22. package/dist/api/baremetal/v3/api.gen.js +7 -14
  23. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  24. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  25. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  26. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  27. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  28. package/dist/api/block/v1/api.gen.cjs +37 -55
  29. package/dist/api/block/v1/api.gen.d.ts +19 -37
  30. package/dist/api/block/v1/api.gen.js +37 -55
  31. package/dist/api/block/v1/types.gen.d.ts +306 -125
  32. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  33. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  34. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  35. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  36. package/dist/api/cockpit/v1/api.gen.cjs +132 -156
  37. package/dist/api/cockpit/v1/api.gen.d.ts +66 -113
  38. package/dist/api/cockpit/v1/api.gen.js +133 -157
  39. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  40. package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
  41. package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
  42. package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
  43. package/dist/api/cockpit/v1/types.gen.d.ts +628 -246
  44. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  45. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  46. package/dist/api/container/v1beta1/api.gen.js +7 -14
  47. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  48. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  49. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  50. package/dist/api/dedibox/v1/api.gen.js +45 -69
  51. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  52. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  53. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  54. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  55. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  56. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  57. package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
  58. package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
  59. package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
  60. package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
  61. package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
  62. package/dist/api/file/index.gen.cjs +4 -0
  63. package/dist/api/file/index.gen.d.ts +5 -0
  64. package/dist/api/file/index.gen.js +4 -0
  65. package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
  66. package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
  67. package/dist/api/file/v1alpha1/api.gen.js +142 -0
  68. package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
  69. package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
  70. package/dist/api/file/v1alpha1/content.gen.js +7 -0
  71. package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
  72. package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
  73. package/dist/api/file/v1alpha1/index.gen.js +8 -0
  74. package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
  75. package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
  76. package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
  77. package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
  78. package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
  79. package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
  80. package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
  81. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  82. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  83. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  84. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  85. package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
  86. package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
  87. package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
  88. package/dist/api/iam/v1alpha1/api.gen.js +4 -4
  89. package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
  90. package/dist/api/index.gen.d.ts +3 -1
  91. package/dist/api/inference/v1/api.gen.cjs +8 -11
  92. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  93. package/dist/api/inference/v1/api.gen.js +8 -11
  94. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  95. package/dist/api/inference/v1beta1/api.gen.cjs +9 -12
  96. package/dist/api/inference/v1beta1/api.gen.d.ts +7 -10
  97. package/dist/api/inference/v1beta1/api.gen.js +9 -12
  98. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  99. package/dist/api/instance/v1/api.gen.cjs +64 -113
  100. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  101. package/dist/api/instance/v1/api.gen.js +64 -113
  102. package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
  103. package/dist/api/instance/v1/marshalling.gen.js +4 -1
  104. package/dist/api/instance/v1/types.gen.d.ts +1368 -600
  105. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  106. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  107. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  108. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  109. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  110. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  111. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  112. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  113. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  114. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  115. package/dist/api/iot/v1/api.gen.cjs +37 -70
  116. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  117. package/dist/api/iot/v1/api.gen.js +37 -70
  118. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  119. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  120. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  121. package/dist/api/ipam/v1/api.gen.js +6 -26
  122. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  123. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  124. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  125. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  126. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  127. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  128. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  129. package/dist/api/k8s/v1/api.gen.js +33 -78
  130. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  131. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  132. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  133. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  134. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  135. package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
  136. package/dist/api/lb/v1/marshalling.gen.js +4 -2
  137. package/dist/api/lb/v1/types.gen.d.ts +4 -0
  138. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  139. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  140. package/dist/api/marketplace/v2/api.gen.js +8 -21
  141. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  142. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  143. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  144. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  145. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  146. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  147. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  148. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  149. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  150. package/dist/api/product_catalog/index.gen.cjs +4 -0
  151. package/dist/api/product_catalog/index.gen.d.ts +5 -0
  152. package/dist/api/product_catalog/index.gen.js +4 -0
  153. package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
  154. package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
  155. package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
  156. package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
  157. package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
  158. package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
  159. package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
  160. package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
  161. package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
  162. package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
  163. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
  164. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
  165. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
  166. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  167. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  168. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  169. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  170. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  171. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  172. package/dist/api/rdb/v1/api.gen.js +62 -202
  173. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  174. package/dist/api/redis/v1/api.gen.cjs +23 -83
  175. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  176. package/dist/api/redis/v1/api.gen.js +23 -83
  177. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  178. package/dist/api/registry/v1/api.gen.cjs +12 -40
  179. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  180. package/dist/api/registry/v1/api.gen.js +12 -40
  181. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  182. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  183. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  184. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  185. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  186. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  187. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  188. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  189. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  190. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  191. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  192. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  193. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  194. package/dist/api/test/v1/api.gen.cjs +8 -11
  195. package/dist/api/test/v1/api.gen.d.ts +6 -9
  196. package/dist/api/test/v1/api.gen.js +8 -11
  197. package/dist/api/test/v1/types.gen.d.ts +21 -10
  198. package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
  199. package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
  200. package/dist/api/vpcgw/v1/api.gen.js +37 -0
  201. package/dist/client/dist/package.json.cjs +1 -1
  202. package/dist/client/dist/package.json.js +1 -1
  203. package/dist/index.cjs +36 -32
  204. package/dist/index.js +36 -32
  205. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  206. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  207. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  208. package/package.json +2 -2
  209. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -73,99 +73,138 @@ export interface OSOSField {
73
73
  defaultValue?: string;
74
74
  }
75
75
  export interface CPU {
76
- /** Name of the CPU. */
76
+ /**
77
+ * Name of the CPU.
78
+ */
77
79
  name: string;
78
- /** Number of CPU cores. */
80
+ /**
81
+ * Number of CPU cores.
82
+ */
79
83
  coreCount: number;
80
- /** Number CPU threads. */
84
+ /**
85
+ * Number CPU threads.
86
+ */
81
87
  threadCount: number;
82
- /** Frequency of the CPU in MHz. */
88
+ /**
89
+ * Frequency of the CPU in MHz.
90
+ */
83
91
  frequency: number;
84
- /** Benchmark of the CPU. */
92
+ /**
93
+ * Benchmark of the CPU.
94
+ */
85
95
  benchmark: string;
86
96
  }
87
97
  export interface Disk {
88
- /** Capacity of the disk in bytes. */
98
+ /**
99
+ * Capacity of the disk in bytes.
100
+ */
89
101
  capacity: number;
90
- /** Type of the disk. */
102
+ /**
103
+ * Type of the disk.
104
+ */
91
105
  type: string;
92
106
  }
93
107
  export interface GPU {
94
- /** Name of the GPU. */
108
+ /**
109
+ * Name of the GPU.
110
+ */
95
111
  name: string;
96
- /** Capacity of the vram in bytes. */
112
+ /**
113
+ * Capacity of the vram in bytes.
114
+ */
97
115
  vram: number;
98
116
  }
99
117
  export interface Memory {
100
- /** Capacity of the memory in bytes. */
118
+ /**
119
+ * Capacity of the memory in bytes.
120
+ */
101
121
  capacity: number;
102
- /** Type of the memory. */
122
+ /**
123
+ * Type of the memory.
124
+ */
103
125
  type: string;
104
- /** Frequency of the memory in MHz. */
126
+ /**
127
+ * Frequency of the memory in MHz.
128
+ */
105
129
  frequency: number;
106
- /** True if the memory is an error-correcting code memory. */
130
+ /**
131
+ * True if the memory is an error-correcting code memory.
132
+ */
107
133
  isEcc: boolean;
108
134
  }
109
135
  export interface OfferOptionOffer {
110
- /** ID of the option. */
136
+ /**
137
+ * ID of the option.
138
+ */
111
139
  id: string;
112
- /** Name of the option. */
140
+ /**
141
+ * Name of the option.
142
+ */
113
143
  name: string;
114
144
  /**
115
- * If true the option is enabled and included by default in the offer If false
116
- * the option is available for the offer but not included by default.
145
+ * If true the option is enabled and included by default in the offer
146
+ If false the option is available for the offer but not included by default.
117
147
  */
118
148
  enabled: boolean;
119
- /** Period of subscription for the offer. */
149
+ /**
150
+ * Period of subscription for the offer.
151
+ */
120
152
  subscriptionPeriod: OfferSubscriptionPeriod;
121
- /** Price of the option. */
153
+ /**
154
+ * Price of the option.
155
+ */
122
156
  price?: Money;
123
- /** Boolean to know if option could be managed. */
157
+ /**
158
+ * Boolean to know if option could be managed.
159
+ */
124
160
  manageable: boolean;
125
- /** @deprecated Deprecated, use LicenseOptionVars.os_id instead. */
161
+ /**
162
+ * @deprecated Deprecated, use LicenseOptionVars.os_id instead.
163
+ */
126
164
  osId?: string;
127
165
  /**
128
166
  * License option, contains the ID of the OS linked to the option.
129
167
  *
130
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
131
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
168
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
132
169
  */
133
170
  license?: LicenseOption;
134
171
  /**
135
172
  * Public_bandwidth option, contains the bandwidth_in_bps.
136
173
  *
137
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
138
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
174
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
139
175
  */
140
176
  publicBandwidth?: PublicBandwidthOption;
141
177
  /**
142
178
  * Private_network option, contains the bandwidth_in_bps.
143
179
  *
144
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
145
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
180
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
146
181
  */
147
182
  privateNetwork?: PrivateNetworkOption;
148
183
  /**
149
184
  * Remote_access option.
150
185
  *
151
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
152
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
186
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
153
187
  */
154
188
  remoteAccess?: RemoteAccessOption;
155
189
  /**
156
190
  * Certification option.
157
191
  *
158
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
159
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
192
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
160
193
  */
161
194
  certification?: CertificationOption;
162
195
  }
163
196
  export interface PersistentMemory {
164
- /** Capacity of the memory in bytes. */
197
+ /**
198
+ * Capacity of the memory in bytes.
199
+ */
165
200
  capacity: number;
166
- /** Type of the memory. */
201
+ /**
202
+ * Type of the memory.
203
+ */
167
204
  type: string;
168
- /** Frequency of the memory in MHz. */
205
+ /**
206
+ * Frequency of the memory in MHz.
207
+ */
169
208
  frequency: number;
170
209
  }
171
210
  export interface RaidController {
@@ -173,538 +212,855 @@ export interface RaidController {
173
212
  raidLevel: string[];
174
213
  }
175
214
  export interface IP {
176
- /** ID of the IP. */
215
+ /**
216
+ * ID of the IP.
217
+ */
177
218
  id: string;
178
- /** Address of the IP. */
219
+ /**
220
+ * Address of the IP.
221
+ */
179
222
  address: string;
180
- /** Reverse IP value. */
223
+ /**
224
+ * Reverse IP value.
225
+ */
181
226
  reverse: string;
182
- /** Version of IP (v4 or v6). */
227
+ /**
228
+ * Version of IP (v4 or v6).
229
+ */
183
230
  version: IPVersion;
184
- /** Status of the reverse. */
231
+ /**
232
+ * Status of the reverse.
233
+ */
185
234
  reverseStatus: IPReverseStatus;
186
- /** A message related to the reverse status, e.g. in case of an error. */
235
+ /**
236
+ * A message related to the reverse status, e.g. in case of an error.
237
+ */
187
238
  reverseStatusMessage: string;
188
239
  }
189
240
  export interface ServerInstall {
190
- /** ID of the OS. */
241
+ /**
242
+ * ID of the OS.
243
+ */
191
244
  osId: string;
192
- /** Host defined during the server installation. */
245
+ /**
246
+ * Host defined during the server installation.
247
+ */
193
248
  hostname: string;
194
- /** SSH public key IDs defined during server installation. */
249
+ /**
250
+ * SSH public key IDs defined during server installation.
251
+ */
195
252
  sshKeyIds: string[];
196
- /** Status of the server installation. */
253
+ /**
254
+ * Status of the server installation.
255
+ */
197
256
  status: ServerInstallStatus;
198
257
  /**
199
- * User defined in the server installation, or the default user if none were
200
- * specified.
258
+ * User defined in the server installation, or the default user if none were specified.
201
259
  */
202
260
  user: string;
203
261
  /**
204
- * Service user defined in the server installation, or the default user if
205
- * none were specified.
262
+ * Service user defined in the server installation, or the default user if none were specified.
206
263
  */
207
264
  serviceUser: string;
208
- /** Address of the installed service. */
265
+ /**
266
+ * Address of the installed service.
267
+ */
209
268
  serviceUrl: string;
210
- /** Partitioning schema. */
269
+ /**
270
+ * Partitioning schema.
271
+ */
211
272
  partitioningSchema?: Schema;
212
273
  }
213
274
  export interface ServerOption {
214
- /** ID of the option. */
275
+ /**
276
+ * ID of the option.
277
+ */
215
278
  id: string;
216
- /** Name of the option. */
279
+ /**
280
+ * Name of the option.
281
+ */
217
282
  name: string;
218
- /** Status of the option on this server. */
283
+ /**
284
+ * Status of the option on this server.
285
+ */
219
286
  status: ServerOptionOptionStatus;
220
- /** Defines whether the option can be managed (added or removed). */
287
+ /**
288
+ * Defines whether the option can be managed (added or removed).
289
+ */
221
290
  manageable: boolean;
222
- /** Auto expiration date for compatible options. */
291
+ /**
292
+ * Auto expiration date for compatible options.
293
+ */
223
294
  expiresAt?: Date;
224
295
  /**
225
296
  * License option, contains the ID of the OS linked to the option.
226
297
  *
227
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
228
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
298
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
229
299
  */
230
300
  license?: LicenseOption;
231
301
  /**
232
302
  * Public_bandwidth option, contains the bandwidth_in_bps.
233
303
  *
234
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
235
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
304
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
236
305
  */
237
306
  publicBandwidth?: PublicBandwidthOption;
238
307
  /**
239
308
  * Private_network option, contains the bandwidth_in_bps.
240
309
  *
241
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
242
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
310
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
243
311
  */
244
312
  privateNetwork?: PrivateNetworkOption;
245
313
  /**
246
314
  * Remote_access option.
247
315
  *
248
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
249
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
316
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
250
317
  */
251
318
  remoteAccess?: RemoteAccessOption;
252
319
  /**
253
320
  * Certification option.
254
321
  *
255
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
256
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
322
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
257
323
  */
258
324
  certification?: CertificationOption;
259
325
  }
260
326
  export interface ServerRescueServer {
261
- /** Rescue user name. */
327
+ /**
328
+ * Rescue user name.
329
+ */
262
330
  user: string;
263
- /** Rescue password. */
331
+ /**
332
+ * Rescue password.
333
+ */
264
334
  password: string;
265
335
  }
266
336
  export interface CreateServerRequestInstall {
267
- /** ID of the OS to installation on the server. */
337
+ /**
338
+ * ID of the OS to installation on the server.
339
+ */
268
340
  osId: string;
269
- /** Hostname of the server. */
341
+ /**
342
+ * Hostname of the server.
343
+ */
270
344
  hostname: string;
271
- /** SSH key IDs authorized on the server. */
345
+ /**
346
+ * SSH key IDs authorized on the server.
347
+ */
272
348
  sshKeyIds: string[];
273
- /** User for the installation. */
349
+ /**
350
+ * User for the installation.
351
+ */
274
352
  user?: string;
275
- /** Password for the installation. */
353
+ /**
354
+ * Password for the installation.
355
+ */
276
356
  password?: string;
277
- /** Regular user that runs the service to be installed on the server. */
357
+ /**
358
+ * Regular user that runs the service to be installed on the server.
359
+ */
278
360
  serviceUser?: string;
279
- /** Password used for the service to install. */
361
+ /**
362
+ * Password used for the service to install.
363
+ */
280
364
  servicePassword?: string;
281
- /** Partitioning schema. */
365
+ /**
366
+ * Partitioning schema.
367
+ */
282
368
  partitioningSchema?: Schema;
283
369
  }
284
370
  export interface OS {
285
- /** ID of the OS. */
371
+ /**
372
+ * ID of the OS.
373
+ */
286
374
  id: string;
287
- /** Name of the OS. */
375
+ /**
376
+ * Name of the OS.
377
+ */
288
378
  name: string;
289
- /** Version of the OS. */
379
+ /**
380
+ * Version of the OS.
381
+ */
290
382
  version: string;
291
- /** URL of this OS's logo. */
383
+ /**
384
+ * URL of this OS's logo.
385
+ */
292
386
  logoUrl: string;
293
- /** Object defining the SSH requirements to install the OS. */
387
+ /**
388
+ * Object defining the SSH requirements to install the OS.
389
+ */
294
390
  ssh?: OSOSField;
295
- /** Object defining the username requirements to install the OS. */
391
+ /**
392
+ * Object defining the username requirements to install the OS.
393
+ */
296
394
  user?: OSOSField;
297
- /** Object defining the password requirements to install the OS. */
395
+ /**
396
+ * Object defining the password requirements to install the OS.
397
+ */
298
398
  password?: OSOSField;
299
- /** Object defining the username requirements to install the service. */
399
+ /**
400
+ * Object defining the username requirements to install the service.
401
+ */
300
402
  serviceUser?: OSOSField;
301
- /** Object defining the password requirements to install the service. */
403
+ /**
404
+ * Object defining the password requirements to install the service.
405
+ */
302
406
  servicePassword?: OSOSField;
303
- /** Defines if the operating system is enabled or not. */
407
+ /**
408
+ * Defines if the operating system is enabled or not.
409
+ */
304
410
  enabled: boolean;
305
- /** License required (check server options for pricing details). */
411
+ /**
412
+ * License required (check server options for pricing details).
413
+ */
306
414
  licenseRequired: boolean;
307
- /** Defines if a specific Organization is allowed to install this OS type. */
415
+ /**
416
+ * Defines if a specific Organization is allowed to install this OS type.
417
+ */
308
418
  allowed: boolean;
309
- /** Defines if custom partitioning is supported by this OS. */
419
+ /**
420
+ * Defines if custom partitioning is supported by this OS.
421
+ */
310
422
  customPartitioningSupported: boolean;
311
423
  }
312
424
  export interface Offer {
313
- /** ID of the offer. */
425
+ /**
426
+ * ID of the offer.
427
+ */
314
428
  id: string;
315
- /** Name of the offer. */
429
+ /**
430
+ * Name of the offer.
431
+ */
316
432
  name: string;
317
- /** Stock level. */
433
+ /**
434
+ * Stock level.
435
+ */
318
436
  stock: OfferStock;
319
- /** Public bandwidth available (in bits/s) with the offer. */
437
+ /**
438
+ * Public bandwidth available (in bits/s) with the offer.
439
+ */
320
440
  bandwidth: number;
321
441
  /**
322
- * Maximum public bandwidth available (in bits/s) depending on available
323
- * options.
442
+ * Maximum public bandwidth available (in bits/s) depending on available options.
324
443
  */
325
444
  maxBandwidth: number;
326
- /** Commercial range of the offer. */
445
+ /**
446
+ * Commercial range of the offer.
447
+ */
327
448
  commercialRange: string;
328
449
  /**
329
- * Price of the offer for the next 60 minutes (a server order at 11h32 will be
330
- * payed until 12h32).
450
+ * Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
331
451
  */
332
452
  pricePerHour?: Money;
333
- /** Monthly price of the offer, if subscribing on a monthly basis. */
453
+ /**
454
+ * Monthly price of the offer, if subscribing on a monthly basis.
455
+ */
334
456
  pricePerMonth?: Money;
335
- /** Disks specifications of the offer. */
457
+ /**
458
+ * Disks specifications of the offer.
459
+ */
336
460
  disks: Disk[];
337
- /** Defines whether the offer is currently available. */
461
+ /**
462
+ * Defines whether the offer is currently available.
463
+ */
338
464
  enable: boolean;
339
- /** CPU specifications of the offer. */
465
+ /**
466
+ * CPU specifications of the offer.
467
+ */
340
468
  cpus: CPU[];
341
- /** Memory specifications of the offer. */
469
+ /**
470
+ * Memory specifications of the offer.
471
+ */
342
472
  memories: Memory[];
343
- /** Name of the quota associated to the offer. */
473
+ /**
474
+ * Name of the quota associated to the offer.
475
+ */
344
476
  quotaName: string;
345
- /** Persistent memory specifications of the offer. */
477
+ /**
478
+ * Persistent memory specifications of the offer.
479
+ */
346
480
  persistentMemories: PersistentMemory[];
347
- /** Raid controller specifications of the offer. */
481
+ /**
482
+ * Raid controller specifications of the offer.
483
+ */
348
484
  raidControllers: RaidController[];
349
- /** Array of OS images IDs incompatible with the server. */
485
+ /**
486
+ * Array of OS images IDs incompatible with the server.
487
+ */
350
488
  incompatibleOsIds: string[];
351
- /** Period of subscription for the offer. */
489
+ /**
490
+ * Period of subscription for the offer.
491
+ */
352
492
  subscriptionPeriod: OfferSubscriptionPeriod;
353
- /** Operation path of the service. */
493
+ /**
494
+ * Operation path of the service.
495
+ */
354
496
  operationPath: string;
355
497
  /**
356
- * One time fee invoiced by Scaleway for the setup and activation of the
357
- * server.
498
+ * One time fee invoiced by Scaleway for the setup and activation of the server.
358
499
  */
359
500
  fee?: Money;
360
- /** Available options for customization of the server. */
501
+ /**
502
+ * Available options for customization of the server.
503
+ */
361
504
  options: OfferOptionOffer[];
362
- /** Private bandwidth available in bits/s with the offer. */
505
+ /**
506
+ * Private bandwidth available in bits/s with the offer.
507
+ */
363
508
  privateBandwidth: number;
364
- /** Defines whether the offer's bandwidth is shared or not. */
509
+ /**
510
+ * Defines whether the offer's bandwidth is shared or not.
511
+ */
365
512
  sharedBandwidth: boolean;
366
- /** Array of tags attached to the offer. */
513
+ /**
514
+ * Array of tags attached to the offer.
515
+ */
367
516
  tags: string[];
368
- /** GPU specifications of the offer. */
517
+ /**
518
+ * GPU specifications of the offer.
519
+ */
369
520
  gpus: GPU[];
370
- /** Exist only for hourly offers, to migrate to the monthly offer. */
521
+ /**
522
+ * Exist only for hourly offers, to migrate to the monthly offer.
523
+ */
371
524
  monthlyOfferId?: string;
372
525
  }
373
526
  export interface Option {
374
- /** ID of the option. */
527
+ /**
528
+ * ID of the option.
529
+ */
375
530
  id: string;
376
- /** Name of the option. */
531
+ /**
532
+ * Name of the option.
533
+ */
377
534
  name: string;
378
- /** Defines whether the option is manageable (could be added or removed). */
535
+ /**
536
+ * Defines whether the option is manageable (could be added or removed).
537
+ */
379
538
  manageable: boolean;
380
539
  /**
381
540
  * License option, contains the ID of the OS linked to the option.
382
541
  *
383
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
384
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
542
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
385
543
  */
386
544
  license?: LicenseOption;
387
545
  /**
388
546
  * Public_bandwidth option, contains the bandwidth_in_bps.
389
547
  *
390
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
391
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
548
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
392
549
  */
393
550
  publicBandwidth?: PublicBandwidthOption;
394
551
  /**
395
552
  * Private_network option, contains the bandwidth_in_bps.
396
553
  *
397
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
398
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
554
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
399
555
  */
400
556
  privateNetwork?: PrivateNetworkOption;
401
557
  /**
402
558
  * Remote_access option.
403
559
  *
404
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
405
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
560
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
406
561
  */
407
562
  remoteAccess?: RemoteAccessOption;
408
563
  /**
409
564
  * Certification option.
410
565
  *
411
- * One-of ('option'): at most one of 'license', 'publicBandwidth',
412
- * 'privateNetwork', 'remoteAccess', 'certification' could be set.
566
+ * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set.
413
567
  */
414
568
  certification?: CertificationOption;
415
569
  }
416
570
  export interface ServerEvent {
417
- /** ID of the server to which the action will be applied. */
571
+ /**
572
+ * ID of the server to which the action will be applied.
573
+ */
418
574
  id: string;
419
- /** The action that will be applied to the server. */
575
+ /**
576
+ * The action that will be applied to the server.
577
+ */
420
578
  action: string;
421
- /** Date of last modification of the action. */
579
+ /**
580
+ * Date of last modification of the action.
581
+ */
422
582
  updatedAt?: Date;
423
- /** Date of creation of the action. */
583
+ /**
584
+ * Date of creation of the action.
585
+ */
424
586
  createdAt?: Date;
425
587
  }
426
588
  export interface ServerPrivateNetwork {
427
- /** The Private Network ID. */
589
+ /**
590
+ * The Private Network ID.
591
+ */
428
592
  id: string;
429
- /** The Private Network Project ID. */
593
+ /**
594
+ * The Private Network Project ID.
595
+ */
430
596
  projectId: string;
431
- /** The server ID. */
597
+ /**
598
+ * The server ID.
599
+ */
432
600
  serverId: string;
433
- /** The Private Network ID. */
601
+ /**
602
+ * The Private Network ID.
603
+ */
434
604
  privateNetworkId: string;
435
- /** The VLAN ID associated to the Private Network. */
605
+ /**
606
+ * The VLAN ID associated to the Private Network.
607
+ */
436
608
  vlan?: number;
437
- /** The configuration status of the Private Network. */
609
+ /**
610
+ * The configuration status of the Private Network.
611
+ */
438
612
  status: ServerPrivateNetworkStatus;
439
- /** The Private Network creation date. */
613
+ /**
614
+ * The Private Network creation date.
615
+ */
440
616
  createdAt?: Date;
441
- /** The date the Private Network was last modified. */
617
+ /**
618
+ * The date the Private Network was last modified.
619
+ */
442
620
  updatedAt?: Date;
443
621
  }
444
622
  export interface Server {
445
- /** ID of the server. */
623
+ /**
624
+ * ID of the server.
625
+ */
446
626
  id: string;
447
- /** Organization ID the server is attached to. */
627
+ /**
628
+ * Organization ID the server is attached to.
629
+ */
448
630
  organizationId: string;
449
- /** Project ID the server is attached to. */
631
+ /**
632
+ * Project ID the server is attached to.
633
+ */
450
634
  projectId: string;
451
- /** Name of the server. */
635
+ /**
636
+ * Name of the server.
637
+ */
452
638
  name: string;
453
- /** Description of the server. */
639
+ /**
640
+ * Description of the server.
641
+ */
454
642
  description: string;
455
- /** Last modification date of the server. */
643
+ /**
644
+ * Last modification date of the server.
645
+ */
456
646
  updatedAt?: Date;
457
- /** Creation date of the server. */
647
+ /**
648
+ * Creation date of the server.
649
+ */
458
650
  createdAt?: Date;
459
- /** Status of the server. */
651
+ /**
652
+ * Status of the server.
653
+ */
460
654
  status: ServerStatus;
461
- /** Offer ID of the server. */
655
+ /**
656
+ * Offer ID of the server.
657
+ */
462
658
  offerId: string;
463
- /** Offer name of the server. */
659
+ /**
660
+ * Offer name of the server.
661
+ */
464
662
  offerName: string;
465
- /** Array of custom tags attached to the server. */
663
+ /**
664
+ * Array of custom tags attached to the server.
665
+ */
466
666
  tags: string[];
467
- /** Array of IPs attached to the server. */
667
+ /**
668
+ * Array of IPs attached to the server.
669
+ */
468
670
  ips: IP[];
469
- /** Domain of the server. */
671
+ /**
672
+ * Domain of the server.
673
+ */
470
674
  domain: string;
471
- /** Boot type of the server. */
675
+ /**
676
+ * Boot type of the server.
677
+ */
472
678
  bootType: ServerBootType;
473
- /** Zone in which is the server located. */
679
+ /**
680
+ * Zone in which is the server located.
681
+ */
474
682
  zone: ScwZone;
475
- /** Configuration of the installation. */
683
+ /**
684
+ * Configuration of the installation.
685
+ */
476
686
  install?: ServerInstall;
477
- /** Status of server ping. */
687
+ /**
688
+ * Status of server ping.
689
+ */
478
690
  pingStatus: ServerPingStatus;
479
- /** Options enabled on the server. */
691
+ /**
692
+ * Options enabled on the server.
693
+ */
480
694
  options: ServerOption[];
481
- /** Configuration of rescue boot. */
695
+ /**
696
+ * Configuration of rescue boot.
697
+ */
482
698
  rescueServer?: ServerRescueServer;
483
699
  }
484
700
  export interface Setting {
485
- /** ID of the setting. */
701
+ /**
702
+ * ID of the setting.
703
+ */
486
704
  id: string;
487
- /** Type of the setting. */
705
+ /**
706
+ * Type of the setting.
707
+ */
488
708
  type: SettingType;
489
- /** ID of the Project ID. */
709
+ /**
710
+ * ID of the Project ID.
711
+ */
490
712
  projectId: string;
491
- /** Defines whether the setting is enabled. */
713
+ /**
714
+ * Defines whether the setting is enabled.
715
+ */
492
716
  enabled: boolean;
493
717
  }
494
718
  export type AddOptionServerRequest = {
495
- /** Zone to target. If none is passed will use default zone from the config. */
719
+ /**
720
+ * Zone to target. If none is passed will use default zone from the config.
721
+ */
496
722
  zone?: ScwZone;
497
- /** ID of the server. */
723
+ /**
724
+ * ID of the server.
725
+ */
498
726
  serverId: string;
499
- /** ID of the option to add. */
727
+ /**
728
+ * ID of the option to add.
729
+ */
500
730
  optionId: string;
501
- /** Auto expire the option after this date. */
731
+ /**
732
+ * Auto expire the option after this date.
733
+ */
502
734
  expiresAt?: Date;
503
735
  };
504
736
  export interface BMCAccess {
505
- /** URL to access to the server console. */
737
+ /**
738
+ * URL to access to the server console.
739
+ */
506
740
  url: string;
507
741
  /**
508
- * The login to use for the BMC (Baseboard Management Controller) access
509
- * authentification.
742
+ * The login to use for the BMC (Baseboard Management Controller) access authentification.
510
743
  */
511
744
  login: string;
512
745
  /**
513
- * The password to use for the BMC (Baseboard Management Controller) access
514
- * authentification.
746
+ * The password to use for the BMC (Baseboard Management Controller) access authentification.
515
747
  */
516
748
  password: string;
517
749
  /**
518
- * The date after which the BMC (Baseboard Management Controller) access will
519
- * be closed.
750
+ * The date after which the BMC (Baseboard Management Controller) access will be closed.
520
751
  */
521
752
  expiresAt?: Date;
522
753
  }
523
754
  export type CreateServerRequest = {
524
- /** Zone to target. If none is passed will use default zone from the config. */
525
- zone?: ScwZone;
526
- /** Offer ID of the new server. */
527
- offerId: string;
755
+ /**
756
+ * Zone to target. If none is passed will use default zone from the config.
757
+ */
758
+ zone?: ScwZone;
759
+ /**
760
+ * Offer ID of the new server.
761
+ */
762
+ offerId: string;
528
763
  /**
529
764
  * @deprecated Organization ID with which the server will be created.
530
765
  *
531
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
532
- * could be set.
766
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
533
767
  */
534
768
  organizationId?: string;
535
769
  /**
536
770
  * Project ID with which the server will be created.
537
771
  *
538
- * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
539
- * could be set.
772
+ * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
540
773
  */
541
774
  projectId?: string;
542
- /** Name of the server (≠hostname). */
775
+ /**
776
+ * Name of the server (≠hostname).
777
+ */
543
778
  name: string;
544
- /** Description associated with the server, max 255 characters. */
779
+ /**
780
+ * Description associated with the server, max 255 characters.
781
+ */
545
782
  description: string;
546
- /** Tags to associate to the server. */
783
+ /**
784
+ * Tags to associate to the server.
785
+ */
547
786
  tags?: string[];
548
787
  /**
549
- * Object describing the configuration details of the OS installation on the
550
- * server.
788
+ * Object describing the configuration details of the OS installation on the server.
551
789
  */
552
790
  install?: CreateServerRequestInstall;
553
- /** IDs of options to enable on server. */
791
+ /**
792
+ * IDs of options to enable on server.
793
+ */
554
794
  optionIds?: string[];
555
795
  };
556
796
  export type DeleteOptionServerRequest = {
557
- /** Zone to target. If none is passed will use default zone from the config. */
797
+ /**
798
+ * Zone to target. If none is passed will use default zone from the config.
799
+ */
558
800
  zone?: ScwZone;
559
- /** ID of the server. */
801
+ /**
802
+ * ID of the server.
803
+ */
560
804
  serverId: string;
561
- /** ID of the option to delete. */
805
+ /**
806
+ * ID of the option to delete.
807
+ */
562
808
  optionId: string;
563
809
  };
564
810
  export type DeleteServerRequest = {
565
- /** Zone to target. If none is passed will use default zone from the config. */
811
+ /**
812
+ * Zone to target. If none is passed will use default zone from the config.
813
+ */
566
814
  zone?: ScwZone;
567
- /** ID of the server to delete. */
815
+ /**
816
+ * ID of the server to delete.
817
+ */
568
818
  serverId: string;
569
819
  };
570
820
  export type GetBMCAccessRequest = {
571
- /** Zone to target. If none is passed will use default zone from the config. */
821
+ /**
822
+ * Zone to target. If none is passed will use default zone from the config.
823
+ */
572
824
  zone?: ScwZone;
573
- /** ID of the server. */
825
+ /**
826
+ * ID of the server.
827
+ */
574
828
  serverId: string;
575
829
  };
576
830
  export type GetDefaultPartitioningSchemaRequest = {
577
- /** Zone to target. If none is passed will use default zone from the config. */
831
+ /**
832
+ * Zone to target. If none is passed will use default zone from the config.
833
+ */
578
834
  zone?: ScwZone;
579
- /** ID of the offer. */
835
+ /**
836
+ * ID of the offer.
837
+ */
580
838
  offerId: string;
581
- /** ID of the OS. */
839
+ /**
840
+ * ID of the OS.
841
+ */
582
842
  osId: string;
583
843
  };
584
844
  export type GetOSRequest = {
585
- /** Zone to target. If none is passed will use default zone from the config. */
845
+ /**
846
+ * Zone to target. If none is passed will use default zone from the config.
847
+ */
586
848
  zone?: ScwZone;
587
- /** ID of the OS. */
849
+ /**
850
+ * ID of the OS.
851
+ */
588
852
  osId: string;
589
853
  };
590
854
  export type GetOfferRequest = {
591
- /** Zone to target. If none is passed will use default zone from the config. */
855
+ /**
856
+ * Zone to target. If none is passed will use default zone from the config.
857
+ */
592
858
  zone?: ScwZone;
593
- /** ID of the researched Offer. */
859
+ /**
860
+ * ID of the researched Offer.
861
+ */
594
862
  offerId: string;
595
863
  };
596
864
  export type GetOptionRequest = {
597
- /** Zone to target. If none is passed will use default zone from the config. */
865
+ /**
866
+ * Zone to target. If none is passed will use default zone from the config.
867
+ */
598
868
  zone?: ScwZone;
599
- /** ID of the option. */
869
+ /**
870
+ * ID of the option.
871
+ */
600
872
  optionId: string;
601
873
  };
602
874
  export type GetServerMetricsRequest = {
603
- /** Zone to target. If none is passed will use default zone from the config. */
875
+ /**
876
+ * Zone to target. If none is passed will use default zone from the config.
877
+ */
604
878
  zone?: ScwZone;
605
- /** Server ID to get the metrics. */
879
+ /**
880
+ * Server ID to get the metrics.
881
+ */
606
882
  serverId: string;
607
883
  };
608
884
  export interface GetServerMetricsResponse {
609
- /** Timeseries object representing pings on the server. */
885
+ /**
886
+ * Timeseries object representing pings on the server.
887
+ */
610
888
  pings?: TimeSeries;
611
889
  }
612
890
  export type GetServerRequest = {
613
- /** Zone to target. If none is passed will use default zone from the config. */
891
+ /**
892
+ * Zone to target. If none is passed will use default zone from the config.
893
+ */
614
894
  zone?: ScwZone;
615
- /** ID of the server. */
895
+ /**
896
+ * ID of the server.
897
+ */
616
898
  serverId: string;
617
899
  };
618
900
  export type InstallServerRequest = {
619
- /** Zone to target. If none is passed will use default zone from the config. */
901
+ /**
902
+ * Zone to target. If none is passed will use default zone from the config.
903
+ */
620
904
  zone?: ScwZone;
621
- /** Server ID to install. */
905
+ /**
906
+ * Server ID to install.
907
+ */
622
908
  serverId: string;
623
- /** ID of the OS to installation on the server. */
909
+ /**
910
+ * ID of the OS to installation on the server.
911
+ */
624
912
  osId: string;
625
- /** Hostname of the server. */
913
+ /**
914
+ * Hostname of the server.
915
+ */
626
916
  hostname: string;
627
- /** SSH key IDs authorized on the server. */
917
+ /**
918
+ * SSH key IDs authorized on the server.
919
+ */
628
920
  sshKeyIds: string[];
629
- /** User used for the installation. */
921
+ /**
922
+ * User used for the installation.
923
+ */
630
924
  user?: string;
631
- /** Password used for the installation. */
925
+ /**
926
+ * Password used for the installation.
927
+ */
632
928
  password?: string;
633
- /** User used for the service to install. */
929
+ /**
930
+ * User used for the service to install.
931
+ */
634
932
  serviceUser?: string;
635
- /** Password used for the service to install. */
933
+ /**
934
+ * Password used for the service to install.
935
+ */
636
936
  servicePassword?: string;
637
- /** Partitioning schema. */
937
+ /**
938
+ * Partitioning schema.
939
+ */
638
940
  partitioningSchema?: Schema;
639
941
  };
640
942
  export type ListOSRequest = {
641
- /** Zone to target. If none is passed will use default zone from the config. */
943
+ /**
944
+ * Zone to target. If none is passed will use default zone from the config.
945
+ */
642
946
  zone?: ScwZone;
643
- /** Page number. */
947
+ /**
948
+ * Page number.
949
+ */
644
950
  page?: number;
645
- /** Number of OS per page. */
951
+ /**
952
+ * Number of OS per page.
953
+ */
646
954
  pageSize?: number;
647
- /** Offer IDs to filter OSes for. */
955
+ /**
956
+ * Offer IDs to filter OSes for.
957
+ */
648
958
  offerId?: string;
649
959
  };
650
960
  export interface ListOSResponse {
651
- /** Total count of matching OS. */
961
+ /**
962
+ * Total count of matching OS.
963
+ */
652
964
  totalCount: number;
653
- /** OS that match filters. */
965
+ /**
966
+ * OS that match filters.
967
+ */
654
968
  os: OS[];
655
969
  }
656
970
  export type ListOffersRequest = {
657
- /** Zone to target. If none is passed will use default zone from the config. */
971
+ /**
972
+ * Zone to target. If none is passed will use default zone from the config.
973
+ */
658
974
  zone?: ScwZone;
659
- /** Page number. */
975
+ /**
976
+ * Page number.
977
+ */
660
978
  page?: number;
661
- /** Number of offers per page. */
979
+ /**
980
+ * Number of offers per page.
981
+ */
662
982
  pageSize?: number;
663
- /** Subscription period type to filter offers by. */
983
+ /**
984
+ * Subscription period type to filter offers by.
985
+ */
664
986
  subscriptionPeriod?: OfferSubscriptionPeriod;
665
- /** Offer name to filter offers by. */
987
+ /**
988
+ * Offer name to filter offers by.
989
+ */
666
990
  name?: string;
667
991
  };
668
992
  export interface ListOffersResponse {
669
- /** Total count of matching offers. */
993
+ /**
994
+ * Total count of matching offers.
995
+ */
670
996
  totalCount: number;
671
- /** Offers that match filters. */
997
+ /**
998
+ * Offers that match filters.
999
+ */
672
1000
  offers: Offer[];
673
1001
  }
674
1002
  export type ListOptionsRequest = {
675
- /** Zone to target. If none is passed will use default zone from the config. */
1003
+ /**
1004
+ * Zone to target. If none is passed will use default zone from the config.
1005
+ */
676
1006
  zone?: ScwZone;
677
- /** Page number. */
1007
+ /**
1008
+ * Page number.
1009
+ */
678
1010
  page?: number;
679
- /** Number of options per page. */
1011
+ /**
1012
+ * Number of options per page.
1013
+ */
680
1014
  pageSize?: number;
681
- /** Offer ID to filter options for. */
1015
+ /**
1016
+ * Offer ID to filter options for.
1017
+ */
682
1018
  offerId?: string;
683
- /** Name to filter options for. */
1019
+ /**
1020
+ * Name to filter options for.
1021
+ */
684
1022
  name?: string;
685
1023
  };
686
1024
  export interface ListOptionsResponse {
687
- /** Total count of matching options. */
1025
+ /**
1026
+ * Total count of matching options.
1027
+ */
688
1028
  totalCount: number;
689
- /** Options that match filters. */
1029
+ /**
1030
+ * Options that match filters.
1031
+ */
690
1032
  options: Option[];
691
1033
  }
692
1034
  export type ListServerEventsRequest = {
693
- /** Zone to target. If none is passed will use default zone from the config. */
1035
+ /**
1036
+ * Zone to target. If none is passed will use default zone from the config.
1037
+ */
694
1038
  zone?: ScwZone;
695
- /** ID of the server events searched. */
1039
+ /**
1040
+ * ID of the server events searched.
1041
+ */
696
1042
  serverId: string;
697
- /** Page number. */
1043
+ /**
1044
+ * Page number.
1045
+ */
698
1046
  page?: number;
699
- /** Number of server events per page. */
1047
+ /**
1048
+ * Number of server events per page.
1049
+ */
700
1050
  pageSize?: number;
701
- /** Order of the server events. */
1051
+ /**
1052
+ * Order of the server events.
1053
+ */
702
1054
  orderBy?: ListServerEventsRequestOrderBy;
703
1055
  };
704
1056
  export interface ListServerEventsResponse {
705
- /** Total count of matching events. */
1057
+ /**
1058
+ * Total count of matching events.
1059
+ */
706
1060
  totalCount: number;
707
- /** Server events that match filters. */
1061
+ /**
1062
+ * Server events that match filters.
1063
+ */
708
1064
  events: ServerEvent[];
709
1065
  }
710
1066
  export interface ListServerPrivateNetworksResponse {
@@ -712,178 +1068,309 @@ export interface ListServerPrivateNetworksResponse {
712
1068
  totalCount: number;
713
1069
  }
714
1070
  export type ListServersRequest = {
715
- /** Zone to target. If none is passed will use default zone from the config. */
1071
+ /**
1072
+ * Zone to target. If none is passed will use default zone from the config.
1073
+ */
716
1074
  zone?: ScwZone;
717
- /** Page number. */
1075
+ /**
1076
+ * Page number.
1077
+ */
718
1078
  page?: number;
719
- /** Number of servers per page. */
1079
+ /**
1080
+ * Number of servers per page.
1081
+ */
720
1082
  pageSize?: number;
721
- /** Order of the servers. */
1083
+ /**
1084
+ * Order of the servers.
1085
+ */
722
1086
  orderBy?: ListServersRequestOrderBy;
723
- /** Tags to filter for. */
1087
+ /**
1088
+ * Tags to filter for.
1089
+ */
724
1090
  tags?: string[];
725
- /** Status to filter for. */
1091
+ /**
1092
+ * Status to filter for.
1093
+ */
726
1094
  status?: string[];
727
- /** Names to filter for. */
1095
+ /**
1096
+ * Names to filter for.
1097
+ */
728
1098
  name?: string;
729
- /** Organization ID to filter for. */
1099
+ /**
1100
+ * Organization ID to filter for.
1101
+ */
730
1102
  organizationId?: string;
731
- /** Project ID to filter for. */
1103
+ /**
1104
+ * Project ID to filter for.
1105
+ */
732
1106
  projectId?: string;
733
- /** Option ID to filter for. */
1107
+ /**
1108
+ * Option ID to filter for.
1109
+ */
734
1110
  optionId?: string;
735
1111
  };
736
1112
  export interface ListServersResponse {
737
- /** Total count of matching servers. */
1113
+ /**
1114
+ * Total count of matching servers.
1115
+ */
738
1116
  totalCount: number;
739
- /** Array of Elastic Metal server objects matching the filters in the request. */
1117
+ /**
1118
+ * Array of Elastic Metal server objects matching the filters in the request.
1119
+ */
740
1120
  servers: Server[];
741
1121
  }
742
1122
  export type ListSettingsRequest = {
743
- /** Zone to target. If none is passed will use default zone from the config. */
1123
+ /**
1124
+ * Zone to target. If none is passed will use default zone from the config.
1125
+ */
744
1126
  zone?: ScwZone;
745
- /** Page number. */
1127
+ /**
1128
+ * Page number.
1129
+ */
746
1130
  page?: number;
747
- /** Set the maximum list size. */
1131
+ /**
1132
+ * Set the maximum list size.
1133
+ */
748
1134
  pageSize?: number;
749
- /** Sort order for items in the response. */
1135
+ /**
1136
+ * Sort order for items in the response.
1137
+ */
750
1138
  orderBy?: ListSettingsRequestOrderBy;
751
- /** ID of the Project. */
1139
+ /**
1140
+ * ID of the Project.
1141
+ */
752
1142
  projectId?: string;
753
1143
  };
754
1144
  export interface ListSettingsResponse {
755
- /** Total count of matching settings. */
1145
+ /**
1146
+ * Total count of matching settings.
1147
+ */
756
1148
  totalCount: number;
757
- /** Settings that match filters. */
1149
+ /**
1150
+ * Settings that match filters.
1151
+ */
758
1152
  settings: Setting[];
759
1153
  }
760
1154
  export type MigrateServerToMonthlyOfferRequest = {
761
- /** Zone to target. If none is passed will use default zone from the config. */
1155
+ /**
1156
+ * Zone to target. If none is passed will use default zone from the config.
1157
+ */
762
1158
  zone?: ScwZone;
763
- /** ID of the server. */
1159
+ /**
1160
+ * ID of the server.
1161
+ */
764
1162
  serverId: string;
765
1163
  };
766
1164
  export type PrivateNetworkApiAddServerPrivateNetworkRequest = {
767
- /** Zone to target. If none is passed will use default zone from the config. */
1165
+ /**
1166
+ * Zone to target. If none is passed will use default zone from the config.
1167
+ */
768
1168
  zone?: ScwZone;
769
- /** The ID of the server. */
1169
+ /**
1170
+ * The ID of the server.
1171
+ */
770
1172
  serverId: string;
771
- /** The ID of the Private Network. */
1173
+ /**
1174
+ * The ID of the Private Network.
1175
+ */
772
1176
  privateNetworkId: string;
773
1177
  };
774
1178
  export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = {
775
- /** Zone to target. If none is passed will use default zone from the config. */
1179
+ /**
1180
+ * Zone to target. If none is passed will use default zone from the config.
1181
+ */
776
1182
  zone?: ScwZone;
777
- /** The ID of the server. */
1183
+ /**
1184
+ * The ID of the server.
1185
+ */
778
1186
  serverId: string;
779
- /** The ID of the Private Network. */
1187
+ /**
1188
+ * The ID of the Private Network.
1189
+ */
780
1190
  privateNetworkId: string;
781
1191
  };
782
1192
  export type PrivateNetworkApiListServerPrivateNetworksRequest = {
783
- /** Zone to target. If none is passed will use default zone from the config. */
1193
+ /**
1194
+ * Zone to target. If none is passed will use default zone from the config.
1195
+ */
784
1196
  zone?: ScwZone;
785
- /** The sort order for the returned Private Networks. */
1197
+ /**
1198
+ * The sort order for the returned Private Networks.
1199
+ */
786
1200
  orderBy?: ListServerPrivateNetworksRequestOrderBy;
787
- /** The page number for the returned Private Networks. */
1201
+ /**
1202
+ * The page number for the returned Private Networks.
1203
+ */
788
1204
  page?: number;
789
- /** The maximum number of Private Networks per page. */
1205
+ /**
1206
+ * The maximum number of Private Networks per page.
1207
+ */
790
1208
  pageSize?: number;
791
- /** Filter Private Networks by server ID. */
1209
+ /**
1210
+ * Filter Private Networks by server ID.
1211
+ */
792
1212
  serverId?: string;
793
- /** Filter Private Networks by Private Network ID. */
1213
+ /**
1214
+ * Filter Private Networks by Private Network ID.
1215
+ */
794
1216
  privateNetworkId?: string;
795
- /** Filter Private Networks by Organization ID. */
1217
+ /**
1218
+ * Filter Private Networks by Organization ID.
1219
+ */
796
1220
  organizationId?: string;
797
- /** Filter Private Networks by Project ID. */
1221
+ /**
1222
+ * Filter Private Networks by Project ID.
1223
+ */
798
1224
  projectId?: string;
799
1225
  };
800
1226
  export type PrivateNetworkApiSetServerPrivateNetworksRequest = {
801
- /** Zone to target. If none is passed will use default zone from the config. */
1227
+ /**
1228
+ * Zone to target. If none is passed will use default zone from the config.
1229
+ */
802
1230
  zone?: ScwZone;
803
- /** The ID of the server. */
1231
+ /**
1232
+ * The ID of the server.
1233
+ */
804
1234
  serverId: string;
805
- /** The IDs of the Private Networks. */
1235
+ /**
1236
+ * The IDs of the Private Networks.
1237
+ */
806
1238
  privateNetworkIds: string[];
807
1239
  };
808
1240
  export type RebootServerRequest = {
809
- /** Zone to target. If none is passed will use default zone from the config. */
1241
+ /**
1242
+ * Zone to target. If none is passed will use default zone from the config.
1243
+ */
810
1244
  zone?: ScwZone;
811
- /** ID of the server to reboot. */
1245
+ /**
1246
+ * ID of the server to reboot.
1247
+ */
812
1248
  serverId: string;
813
- /** The type of boot. */
1249
+ /**
1250
+ * The type of boot.
1251
+ */
814
1252
  bootType?: ServerBootType;
815
1253
  };
816
1254
  export interface SetServerPrivateNetworksResponse {
817
1255
  serverPrivateNetworks: ServerPrivateNetwork[];
818
1256
  }
819
1257
  export type StartBMCAccessRequest = {
820
- /** Zone to target. If none is passed will use default zone from the config. */
1258
+ /**
1259
+ * Zone to target. If none is passed will use default zone from the config.
1260
+ */
821
1261
  zone?: ScwZone;
822
- /** ID of the server. */
1262
+ /**
1263
+ * ID of the server.
1264
+ */
823
1265
  serverId: string;
824
- /** The IP authorized to connect to the server. */
1266
+ /**
1267
+ * The IP authorized to connect to the server.
1268
+ */
825
1269
  ip: string;
826
1270
  };
827
1271
  export type StartServerRequest = {
828
- /** Zone to target. If none is passed will use default zone from the config. */
1272
+ /**
1273
+ * Zone to target. If none is passed will use default zone from the config.
1274
+ */
829
1275
  zone?: ScwZone;
830
- /** ID of the server to start. */
1276
+ /**
1277
+ * ID of the server to start.
1278
+ */
831
1279
  serverId: string;
832
- /** The type of boot. */
1280
+ /**
1281
+ * The type of boot.
1282
+ */
833
1283
  bootType?: ServerBootType;
834
1284
  };
835
1285
  export type StopBMCAccessRequest = {
836
- /** Zone to target. If none is passed will use default zone from the config. */
1286
+ /**
1287
+ * Zone to target. If none is passed will use default zone from the config.
1288
+ */
837
1289
  zone?: ScwZone;
838
- /** ID of the server. */
1290
+ /**
1291
+ * ID of the server.
1292
+ */
839
1293
  serverId: string;
840
1294
  };
841
1295
  export type StopServerRequest = {
842
- /** Zone to target. If none is passed will use default zone from the config. */
1296
+ /**
1297
+ * Zone to target. If none is passed will use default zone from the config.
1298
+ */
843
1299
  zone?: ScwZone;
844
- /** ID of the server to stop. */
1300
+ /**
1301
+ * ID of the server to stop.
1302
+ */
845
1303
  serverId: string;
846
1304
  };
847
1305
  export type UpdateIPRequest = {
848
- /** Zone to target. If none is passed will use default zone from the config. */
1306
+ /**
1307
+ * Zone to target. If none is passed will use default zone from the config.
1308
+ */
849
1309
  zone?: ScwZone;
850
- /** ID of the server. */
1310
+ /**
1311
+ * ID of the server.
1312
+ */
851
1313
  serverId: string;
852
- /** ID of the IP to update. */
1314
+ /**
1315
+ * ID of the IP to update.
1316
+ */
853
1317
  ipId: string;
854
- /** New reverse IP to update, not updated if null. */
1318
+ /**
1319
+ * New reverse IP to update, not updated if null.
1320
+ */
855
1321
  reverse?: string;
856
1322
  };
857
1323
  export type UpdateServerRequest = {
858
- /** Zone to target. If none is passed will use default zone from the config. */
1324
+ /**
1325
+ * Zone to target. If none is passed will use default zone from the config.
1326
+ */
859
1327
  zone?: ScwZone;
860
- /** ID of the server to update. */
1328
+ /**
1329
+ * ID of the server to update.
1330
+ */
861
1331
  serverId: string;
862
- /** Name of the server (≠hostname), not updated if null. */
1332
+ /**
1333
+ * Name of the server (≠hostname), not updated if null.
1334
+ */
863
1335
  name?: string;
864
1336
  /**
865
- * Description associated with the server, max 255 characters, not updated if
866
- * null.
1337
+ * Description associated with the server, max 255 characters, not updated if null.
867
1338
  */
868
1339
  description?: string;
869
- /** Tags associated with the server, not updated if null. */
1340
+ /**
1341
+ * Tags associated with the server, not updated if null.
1342
+ */
870
1343
  tags?: string[];
871
1344
  };
872
1345
  export type UpdateSettingRequest = {
873
- /** Zone to target. If none is passed will use default zone from the config. */
1346
+ /**
1347
+ * Zone to target. If none is passed will use default zone from the config.
1348
+ */
874
1349
  zone?: ScwZone;
875
- /** ID of the setting. */
1350
+ /**
1351
+ * ID of the setting.
1352
+ */
876
1353
  settingId: string;
877
- /** Defines whether the setting is enabled. */
1354
+ /**
1355
+ * Defines whether the setting is enabled.
1356
+ */
878
1357
  enabled?: boolean;
879
1358
  };
880
1359
  export type ValidatePartitioningSchemaRequest = {
881
- /** Zone to target. If none is passed will use default zone from the config. */
1360
+ /**
1361
+ * Zone to target. If none is passed will use default zone from the config.
1362
+ */
882
1363
  zone?: ScwZone;
883
- /** Partitioning schema. */
1364
+ /**
1365
+ * Partitioning schema.
1366
+ */
884
1367
  partitioningSchema?: Schema;
885
- /** Offer ID of the server. */
1368
+ /**
1369
+ * Offer ID of the server.
1370
+ */
886
1371
  offerId: string;
887
- /** OS ID. */
1372
+ /**
1373
+ * OS ID.
1374
+ */
888
1375
  osId: string;
889
1376
  };