@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
@@ -10,6 +10,23 @@ export type ListTokensRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'n
10
10
  export type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
11
11
  export type TokenScope = 'unknown_scope' | 'read_only_metrics' | 'write_only_metrics' | 'full_access_metrics_rules' | 'read_only_logs' | 'write_only_logs' | 'full_access_logs_rules' | 'full_access_alert_manager' | 'read_only_traces' | 'write_only_traces';
12
12
  export type UsageUnit = 'unknown_unit' | 'bytes' | 'samples';
13
+ /**
14
+ * Structure for additional data relative to preconfigured alerts.
15
+ */
16
+ export interface PreconfiguredAlertData {
17
+ /**
18
+ * ID of the preconfigured rule if the alert is preconfigured.
19
+ */
20
+ preconfiguredRuleId: string;
21
+ /**
22
+ * Human readable name of the alert.
23
+ */
24
+ displayName: string;
25
+ /**
26
+ * Human readable description of the alert.
27
+ */
28
+ displayDescription: string;
29
+ }
13
30
  export interface ContactPointEmail {
14
31
  to: string;
15
32
  }
@@ -18,21 +35,50 @@ export interface GetConfigResponseRetention {
18
35
  maxDays: number;
19
36
  defaultDays: number;
20
37
  }
38
+ /**
39
+ * Structure representing an alert.
40
+ */
21
41
  export interface Alert {
22
42
  /**
23
- * Region to target. If none is passed will use default region from the
24
- * config.
43
+ * The region in which the alert is defined.
25
44
  */
26
45
  region: ScwRegion;
46
+ /**
47
+ * Indicates if the alert is preconfigured or custom.
48
+ */
27
49
  preconfigured: boolean;
50
+ /**
51
+ * Name of the alert.
52
+ */
28
53
  name: string;
54
+ /**
55
+ * Rule defining the alert condition.
56
+ */
29
57
  rule: string;
58
+ /**
59
+ * Duration for which the alert must be active before firing. The format of this duration follows the prometheus duration format.
60
+ */
30
61
  duration: string;
62
+ /**
63
+ * Indicates if the alert is enabled or disabled. Only preconfigured alerts can be disabled.
64
+ */
31
65
  enabled: boolean;
66
+ /**
67
+ * Current state of the alert. Possible states are `inactive`, `pending`, and `firing`.
68
+ */
32
69
  state?: AlertState;
70
+ /**
71
+ * Annotations for the alert, used to provide additional information about the alert.
72
+ */
33
73
  annotations: Record<string, string>;
74
+ /**
75
+ * Contains additional data for preconfigured alerts, such as the rule ID, display name, and description. Only present if the alert is preconfigured.
76
+ */
77
+ preconfiguredData?: PreconfiguredAlertData;
34
78
  }
35
- /** Contact point. */
79
+ /**
80
+ * Contact point.
81
+ */
36
82
  export interface ContactPoint {
37
83
  /**
38
84
  * Email address to send alerts to.
@@ -40,301 +86,538 @@ export interface ContactPoint {
40
86
  * One-of ('configuration'): at most one of 'email' could be set.
41
87
  */
42
88
  email?: ContactPointEmail;
43
- /** Region. */
89
+ /**
90
+ * Region.
91
+ */
44
92
  region: ScwRegion;
45
- /** Send an email notification when an alert is marked as resolved. */
93
+ /**
94
+ * Send an email notification when an alert is marked as resolved.
95
+ */
46
96
  sendResolvedNotifications: boolean;
47
97
  }
48
- /** Data source. */
98
+ /**
99
+ * Data source.
100
+ */
49
101
  export interface DataSource {
50
- /** ID of the data source. */
102
+ /**
103
+ * ID of the data source.
104
+ */
51
105
  id: string;
52
- /** ID of the Project the data source belongs to. */
106
+ /**
107
+ * ID of the Project the data source belongs to.
108
+ */
53
109
  projectId: string;
54
- /** Data source name. */
110
+ /**
111
+ * Data source name.
112
+ */
55
113
  name: string;
56
- /** Data source URL. */
114
+ /**
115
+ * Data source URL.
116
+ */
57
117
  url: string;
58
- /** Data source type. */
118
+ /**
119
+ * Data source type.
120
+ */
59
121
  type: DataSourceType;
60
- /** Data source origin. */
122
+ /**
123
+ * Data source origin.
124
+ */
61
125
  origin: DataSourceOrigin;
62
- /** Date the data source was created. */
126
+ /**
127
+ * Date the data source was created.
128
+ */
63
129
  createdAt?: Date;
64
- /** Date the data source was last updated. */
130
+ /**
131
+ * Date the data source was last updated.
132
+ */
65
133
  updatedAt?: Date;
66
- /** Indicates whether the data source is synchronized with Grafana. */
134
+ /**
135
+ * Indicates whether the data source is synchronized with Grafana.
136
+ */
67
137
  synchronizedWithGrafana: boolean;
68
- /** BETA - Duration for which the data will be retained in the data source. */
138
+ /**
139
+ * BETA - Duration for which the data will be retained in the data source.
140
+ */
69
141
  retentionDays: number;
70
- /** Region of the data source. */
142
+ /**
143
+ * Region of the data source.
144
+ */
71
145
  region: ScwRegion;
72
146
  }
73
- /** Grafana dashboard. */
147
+ /**
148
+ * Grafana dashboard.
149
+ */
74
150
  export interface GrafanaProductDashboard {
75
- /** Dashboard name. */
151
+ /**
152
+ * Dashboard name.
153
+ */
76
154
  name: string;
77
- /** Dashboard title. */
155
+ /**
156
+ * Dashboard title.
157
+ */
78
158
  title: string;
79
- /** Dashboard URL. */
159
+ /**
160
+ * Dashboard URL.
161
+ */
80
162
  url: string;
81
- /** Dashboard tags. */
163
+ /**
164
+ * Dashboard tags.
165
+ */
82
166
  tags: string[];
83
- /** Dashboard variables. */
167
+ /**
168
+ * Dashboard variables.
169
+ */
84
170
  variables: string[];
85
171
  }
86
- /** Grafana user. */
172
+ /**
173
+ * Grafana user.
174
+ */
87
175
  export interface GrafanaUser {
88
- /** ID of the Grafana user. */
176
+ /**
177
+ * ID of the Grafana user.
178
+ */
89
179
  id: number;
90
- /** Username of the Grafana user. */
180
+ /**
181
+ * Username of the Grafana user.
182
+ */
91
183
  login: string;
92
- /** Role assigned to the Grafana user. */
184
+ /**
185
+ * Role assigned to the Grafana user.
186
+ */
93
187
  role: GrafanaUserRole;
94
- /** Grafana user's password. */
188
+ /**
189
+ * Grafana user's password.
190
+ */
95
191
  password?: string;
96
192
  }
97
- /** Type of pricing plan. */
193
+ /**
194
+ * Type of pricing plan.
195
+ */
98
196
  export interface Plan {
99
- /** Name of a given pricing plan. */
197
+ /**
198
+ * Name of a given pricing plan.
199
+ */
100
200
  name: PlanName;
101
- /** Interval of time during which Scaleway's Cockpit keeps your metrics. */
201
+ /**
202
+ * Interval of time during which Scaleway's Cockpit keeps your metrics.
203
+ */
102
204
  retentionMetricsInterval?: string;
103
- /** Interval of time during which Scaleway's Cockpit keeps your logs. */
205
+ /**
206
+ * Interval of time during which Scaleway's Cockpit keeps your logs.
207
+ */
104
208
  retentionLogsInterval?: string;
105
- /** Interval of time during which Scaleway's Cockpit keeps your traces. */
209
+ /**
210
+ * Interval of time during which Scaleway's Cockpit keeps your traces.
211
+ */
106
212
  retentionTracesInterval?: string;
107
- /** Ingestion price in cents for 1 million samples. */
213
+ /**
214
+ * Ingestion price in cents for 1 million samples.
215
+ */
108
216
  sampleIngestionPrice: number;
109
- /** Ingestion price in cents for 1 GB of logs. */
217
+ /**
218
+ * Ingestion price in cents for 1 GB of logs.
219
+ */
110
220
  logsIngestionPrice: number;
111
- /** Ingestion price in cents for 1 GB of traces. */
221
+ /**
222
+ * Ingestion price in cents for 1 GB of traces.
223
+ */
112
224
  tracesIngestionPrice: number;
113
- /** Retention price in euros per month. */
225
+ /**
226
+ * Retention price in euros per month.
227
+ */
114
228
  monthlyPrice: number;
115
229
  }
116
- /** Token. */
230
+ /**
231
+ * Token.
232
+ */
117
233
  export interface Token {
118
- /** ID of the token. */
234
+ /**
235
+ * ID of the token.
236
+ */
119
237
  id: string;
120
- /** ID of the Project the token belongs to. */
238
+ /**
239
+ * ID of the Project the token belongs to.
240
+ */
121
241
  projectId: string;
122
- /** Name of the token. */
242
+ /**
243
+ * Name of the token.
244
+ */
123
245
  name: string;
124
- /** Token creation date. */
246
+ /**
247
+ * Token creation date.
248
+ */
125
249
  createdAt?: Date;
126
- /** Token last modification date. */
250
+ /**
251
+ * Token last modification date.
252
+ */
127
253
  updatedAt?: Date;
128
- /** Token permission scopes. */
254
+ /**
255
+ * Token permission scopes.
256
+ */
129
257
  scopes: TokenScope[];
130
- /** Token secret key. */
258
+ /**
259
+ * Token secret key.
260
+ */
131
261
  secretKey?: string;
132
- /** Regions where the token is located. */
262
+ /**
263
+ * Regions where the token is located.
264
+ */
133
265
  region: ScwRegion;
134
266
  }
135
- /** Data source usage. */
267
+ /**
268
+ * Data source usage.
269
+ */
136
270
  export interface Usage {
137
- /** ID of the data source. */
271
+ /**
272
+ * ID of the data source.
273
+ */
138
274
  dataSourceId?: string;
139
- /** ID of the Project the data source belongs to. */
275
+ /**
276
+ * ID of the Project the data source belongs to.
277
+ */
140
278
  projectId: string;
141
- /** Origin of the data source. */
279
+ /**
280
+ * Origin of the data source.
281
+ */
142
282
  dataSourceOrigin: DataSourceOrigin;
143
- /** Type of the data source. */
283
+ /**
284
+ * Type of the data source.
285
+ */
144
286
  dataSourceType: DataSourceType;
145
- /** Unit of the data source usage. */
287
+ /**
288
+ * Unit of the data source usage.
289
+ */
146
290
  unit: UsageUnit;
147
- /** Interval for the data source usage. */
291
+ /**
292
+ * Interval for the data source usage.
293
+ */
148
294
  interval?: string;
149
- /** Data source usage for the given interval. */
295
+ /**
296
+ * Data source usage for the given interval.
297
+ */
150
298
  quantityOverInterval: number;
151
- /** Region of the data source usage. */
299
+ /**
300
+ * Region of the data source usage.
301
+ */
152
302
  region: ScwRegion;
153
303
  }
154
- /** Alert manager information. */
304
+ /**
305
+ * Alert manager information.
306
+ */
155
307
  export interface AlertManager {
156
- /** Alert manager URL. */
308
+ /**
309
+ * Alert manager URL.
310
+ */
157
311
  alertManagerUrl?: string;
158
- /** The Alert manager is enabled. */
312
+ /**
313
+ * The Alert manager is enabled.
314
+ */
159
315
  alertManagerEnabled: boolean;
160
- /** Managed alerts are enabled. */
316
+ /**
317
+ * Managed alerts are enabled.
318
+ */
161
319
  managedAlertsEnabled: boolean;
162
- /** Regions where the Alert manager is enabled. */
320
+ /**
321
+ * Regions where the Alert manager is enabled.
322
+ */
163
323
  region: ScwRegion;
164
324
  }
165
- /** Cockpit configuration. */
325
+ /**
326
+ * Cockpit configuration.
327
+ */
166
328
  export interface GetConfigResponse {
167
- /** Custom metrics retention configuration. */
329
+ /**
330
+ * Custom metrics retention configuration.
331
+ */
168
332
  customMetricsRetention?: GetConfigResponseRetention;
169
- /** Custom logs retention configuration. */
333
+ /**
334
+ * Custom logs retention configuration.
335
+ */
170
336
  customLogsRetention?: GetConfigResponseRetention;
171
- /** Custom traces retention configuration. */
337
+ /**
338
+ * Custom traces retention configuration.
339
+ */
172
340
  customTracesRetention?: GetConfigResponseRetention;
173
- /** Scaleway metrics retention configuration. */
341
+ /**
342
+ * Scaleway metrics retention configuration.
343
+ */
174
344
  productMetricsRetention?: GetConfigResponseRetention;
175
- /** Scaleway logs retention configuration. */
345
+ /**
346
+ * Scaleway logs retention configuration.
347
+ */
176
348
  productLogsRetention?: GetConfigResponseRetention;
177
349
  }
178
- /** Create a Grafana user. */
350
+ /**
351
+ * Create a Grafana user.
352
+ */
179
353
  export type GlobalApiCreateGrafanaUserRequest = {
180
- /** ID of the Project in which to create the Grafana user. */
354
+ /**
355
+ * ID of the Project in which to create the Grafana user.
356
+ */
181
357
  projectId?: string;
182
358
  /**
183
- * Username of the Grafana user. Note that the `admin` username is not
184
- * available for creation.
359
+ * Username of the Grafana user. Note that the `admin` username is not available for creation.
185
360
  */
186
361
  login: string;
187
- /** Role assigned to the Grafana user. */
362
+ /**
363
+ * Role assigned to the Grafana user.
364
+ */
188
365
  role?: GrafanaUserRole;
189
366
  };
190
- /** Delete a Grafana user. */
367
+ /**
368
+ * Delete a Grafana user.
369
+ */
191
370
  export type GlobalApiDeleteGrafanaUserRequest = {
192
- /** ID of the Grafana user. */
371
+ /**
372
+ * ID of the Grafana user.
373
+ */
193
374
  grafanaUserId: number;
194
- /** ID of the Project to target. */
375
+ /**
376
+ * ID of the Project to target.
377
+ */
195
378
  projectId?: string;
196
379
  };
197
- /** Retrieve a pricing plan for the given Project. */
380
+ /**
381
+ * Retrieve a pricing plan for the given Project.
382
+ */
198
383
  export type GlobalApiGetCurrentPlanRequest = {
199
- /** ID of the Project. */
384
+ /**
385
+ * ID of the Project.
386
+ */
200
387
  projectId?: string;
201
388
  };
202
- /** Retrieve a specific dashboard. */
389
+ /**
390
+ * Retrieve a specific dashboard.
391
+ */
203
392
  export type GlobalApiGetGrafanaProductDashboardRequest = {
204
- /** Name of the dashboard. */
393
+ /**
394
+ * Name of the dashboard.
395
+ */
205
396
  dashboardName: string;
206
- /** ID of the Project the dashboard belongs to. */
397
+ /**
398
+ * ID of the Project the dashboard belongs to.
399
+ */
207
400
  projectId?: string;
208
401
  };
209
- /** Request a Grafana. */
402
+ /**
403
+ * Request a Grafana.
404
+ */
210
405
  export type GlobalApiGetGrafanaRequest = {
211
- /** ID of the Project. */
406
+ /**
407
+ * ID of the Project.
408
+ */
212
409
  projectId?: string;
213
410
  };
214
- /** Retrieve a list of available product dashboards. */
411
+ /**
412
+ * Retrieve a list of available product dashboards.
413
+ */
215
414
  export type GlobalApiListGrafanaProductDashboardsRequest = {
216
- /** ID of the Project to target. */
415
+ /**
416
+ * ID of the Project to target.
417
+ */
217
418
  projectId?: string;
218
- /** Page number. */
419
+ /**
420
+ * Page number.
421
+ */
219
422
  page?: number;
220
- /** Page size. */
423
+ /**
424
+ * Page size.
425
+ */
221
426
  pageSize?: number;
222
- /** Tags to filter for. */
427
+ /**
428
+ * Tags to filter for.
429
+ */
223
430
  tags?: string[];
224
431
  };
225
- /** List all Grafana users. */
432
+ /**
433
+ * List all Grafana users.
434
+ */
226
435
  export type GlobalApiListGrafanaUsersRequest = {
227
- /** Page number. */
436
+ /**
437
+ * Page number.
438
+ */
228
439
  page?: number;
229
- /** Page size. */
440
+ /**
441
+ * Page size.
442
+ */
230
443
  pageSize?: number;
231
- /** Order of the Grafana users. */
444
+ /**
445
+ * Order of the Grafana users.
446
+ */
232
447
  orderBy?: ListGrafanaUsersRequestOrderBy;
233
- /** ID of the Project to target. */
448
+ /**
449
+ * ID of the Project to target.
450
+ */
234
451
  projectId?: string;
235
452
  };
236
- /** Retrieve a list of available pricing plans. */
453
+ /**
454
+ * Retrieve a list of available pricing plans.
455
+ */
237
456
  export type GlobalApiListPlansRequest = {
238
- /** Page number. */
457
+ /**
458
+ * Page number.
459
+ */
239
460
  page?: number;
240
- /** Page size. */
461
+ /**
462
+ * Page size.
463
+ */
241
464
  pageSize?: number;
242
465
  orderBy?: ListPlansRequestOrderBy;
243
466
  };
244
- /** Reset a Grafana user's password. */
467
+ /**
468
+ * Reset a Grafana user's password.
469
+ */
245
470
  export type GlobalApiResetGrafanaUserPasswordRequest = {
246
- /** ID of the Grafana user. */
471
+ /**
472
+ * ID of the Grafana user.
473
+ */
247
474
  grafanaUserId: number;
248
- /** ID of the Project to target. */
475
+ /**
476
+ * ID of the Project to target.
477
+ */
249
478
  projectId?: string;
250
479
  };
251
- /** Select a specific pricing plan. */
480
+ /**
481
+ * Select a specific pricing plan.
482
+ */
252
483
  export type GlobalApiSelectPlanRequest = {
253
- /** ID of the Project. */
484
+ /**
485
+ * ID of the Project.
486
+ */
254
487
  projectId?: string;
255
- /** Name of the pricing plan. */
488
+ /**
489
+ * Name of the pricing plan.
490
+ */
256
491
  planName?: PlanName;
257
492
  };
258
493
  /**
259
- * Trigger the synchronization of all data sources created in the relevant
260
- * regions.
494
+ * Trigger the synchronization of all data sources created in the relevant regions.
261
495
  */
262
496
  export type GlobalApiSyncGrafanaDataSourcesRequest = {
263
- /** ID of the Project to target. */
497
+ /**
498
+ * ID of the Project to target.
499
+ */
264
500
  projectId?: string;
265
501
  };
266
- /** Grafana user. */
502
+ /**
503
+ * Grafana user.
504
+ */
267
505
  export interface Grafana {
268
- /** URL to access your Cockpit's Grafana. */
506
+ /**
507
+ * URL to access your Cockpit's Grafana.
508
+ */
269
509
  grafanaUrl: string;
270
510
  }
271
- /** Retrieve a list of alerts matching the request. */
511
+ /**
512
+ * Retrieve a list of alerts matching the request.
513
+ */
272
514
  export interface ListAlertsResponse {
273
- /** Total count of alerts matching the request. */
515
+ /**
516
+ * Total count of alerts matching the request.
517
+ */
274
518
  totalCount: number;
275
- /** List of alerts matching the applied filters. */
519
+ /**
520
+ * List of alerts matching the applied filters.
521
+ */
276
522
  alerts: Alert[];
277
523
  }
278
- /** Response returned when listing contact points. */
524
+ /**
525
+ * Response returned when listing contact points.
526
+ */
279
527
  export interface ListContactPointsResponse {
280
- /** Total count of contact points associated with the default receiver. */
528
+ /**
529
+ * Total count of contact points associated with the default receiver.
530
+ */
281
531
  totalCount: number;
282
- /** List of contact points associated with the default receiver. */
532
+ /**
533
+ * List of contact points associated with the default receiver.
534
+ */
283
535
  contactPoints: ContactPoint[];
284
536
  /**
285
- * Indicates whether the Alert manager has other receivers than the default
286
- * one.
537
+ * Indicates whether the Alert manager has other receivers than the default one.
287
538
  */
288
539
  hasAdditionalReceivers: boolean;
289
540
  /**
290
- * Indicates whether there are unmanaged contact points on the default
291
- * receiver.
541
+ * Indicates whether there are unmanaged contact points on the default receiver.
292
542
  */
293
543
  hasAdditionalContactPoints: boolean;
294
544
  }
295
- /** Response returned when listing data sources. */
545
+ /**
546
+ * Response returned when listing data sources.
547
+ */
296
548
  export interface ListDataSourcesResponse {
297
- /** Total count of data sources matching the request. */
549
+ /**
550
+ * Total count of data sources matching the request.
551
+ */
298
552
  totalCount: number;
299
- /** Data sources matching the request within the pagination. */
553
+ /**
554
+ * Data sources matching the request within the pagination.
555
+ */
300
556
  dataSources: DataSource[];
301
557
  }
302
- /** Output returned when listing dashboards. */
558
+ /**
559
+ * Output returned when listing dashboards.
560
+ */
303
561
  export interface ListGrafanaProductDashboardsResponse {
304
- /** Total count of Grafana dashboards. */
562
+ /**
563
+ * Total count of Grafana dashboards.
564
+ */
305
565
  totalCount: number;
306
- /** Grafana dashboards information. */
566
+ /**
567
+ * Grafana dashboards information.
568
+ */
307
569
  dashboards: GrafanaProductDashboard[];
308
570
  }
309
- /** Ouptut returned when listing Grafana users. */
571
+ /**
572
+ * Ouptut returned when listing Grafana users.
573
+ */
310
574
  export interface ListGrafanaUsersResponse {
311
- /** Total count of Grafana users. */
575
+ /**
576
+ * Total count of Grafana users.
577
+ */
312
578
  totalCount: number;
313
- /** Grafana users information. */
579
+ /**
580
+ * Grafana users information.
581
+ */
314
582
  grafanaUsers: GrafanaUser[];
315
583
  }
316
- /** Output returned when listing pricing plans. */
584
+ /**
585
+ * Output returned when listing pricing plans.
586
+ */
317
587
  export interface ListPlansResponse {
318
- /** Total count of available pricing plans. */
588
+ /**
589
+ * Total count of available pricing plans.
590
+ */
319
591
  totalCount: number;
320
- /** Plan types information. */
592
+ /**
593
+ * Plan types information.
594
+ */
321
595
  plans: Plan[];
322
596
  }
323
- /** Response returned when listing tokens. */
597
+ /**
598
+ * Response returned when listing tokens.
599
+ */
324
600
  export interface ListTokensResponse {
325
- /** Total count of tokens matching the request. */
601
+ /**
602
+ * Total count of tokens matching the request.
603
+ */
326
604
  totalCount: number;
327
- /** Tokens matching the request within the pagination. */
605
+ /**
606
+ * Tokens matching the request within the pagination.
607
+ */
328
608
  tokens: Token[];
329
609
  }
330
- /** Create a contact point. */
610
+ /**
611
+ * Create a contact point.
612
+ */
331
613
  export type RegionalApiCreateContactPointRequest = {
332
614
  /**
333
- * Region to target. If none is passed will use default region from the
334
- * config.
615
+ * Region to target. If none is passed will use default region from the config.
335
616
  */
336
617
  region?: ScwRegion;
337
- /** ID of the Project to create the contact point in. */
618
+ /**
619
+ * ID of the Project to create the contact point in.
620
+ */
338
621
  projectId?: string;
339
622
  /**
340
623
  * Email address of the contact point to create.
@@ -342,47 +625,68 @@ export type RegionalApiCreateContactPointRequest = {
342
625
  * One-of ('configuration'): at most one of 'email' could be set.
343
626
  */
344
627
  email?: ContactPointEmail;
345
- /** Send an email notification when an alert is marked as resolved. */
628
+ /**
629
+ * Send an email notification when an alert is marked as resolved.
630
+ */
346
631
  sendResolvedNotifications?: boolean;
347
632
  };
348
- /** Create a data source. */
633
+ /**
634
+ * Create a data source.
635
+ */
349
636
  export type RegionalApiCreateDataSourceRequest = {
350
637
  /**
351
- * Region to target. If none is passed will use default region from the
352
- * config.
638
+ * Region to target. If none is passed will use default region from the config.
353
639
  */
354
640
  region?: ScwRegion;
355
- /** ID of the Project the data source belongs to. */
641
+ /**
642
+ * ID of the Project the data source belongs to.
643
+ */
356
644
  projectId?: string;
357
- /** Data source name. */
645
+ /**
646
+ * Data source name.
647
+ */
358
648
  name: string;
359
- /** Data source type. */
649
+ /**
650
+ * Data source type.
651
+ */
360
652
  type?: DataSourceType;
361
- /** Default values are 30 days for metrics, 7 days for logs and traces. */
653
+ /**
654
+ * Default values are 30 days for metrics, 7 days for logs and traces.
655
+ */
362
656
  retentionDays?: number;
363
657
  };
364
- /** Create a token. */
658
+ /**
659
+ * Create a token.
660
+ */
365
661
  export type RegionalApiCreateTokenRequest = {
366
662
  /**
367
- * Region to target. If none is passed will use default region from the
368
- * config.
663
+ * Region to target. If none is passed will use default region from the config.
369
664
  */
370
665
  region?: ScwRegion;
371
- /** ID of the Project the token belongs to. */
666
+ /**
667
+ * ID of the Project the token belongs to.
668
+ */
372
669
  projectId?: string;
373
- /** Name of the token. */
670
+ /**
671
+ * Name of the token.
672
+ */
374
673
  name: string;
375
- /** Token permission scopes. */
674
+ /**
675
+ * Token permission scopes.
676
+ */
376
677
  tokenScopes?: TokenScope[];
377
678
  };
378
- /** Delete a contact point. */
679
+ /**
680
+ * Delete a contact point.
681
+ */
379
682
  export type RegionalApiDeleteContactPointRequest = {
380
683
  /**
381
- * Region to target. If none is passed will use default region from the
382
- * config.
684
+ * Region to target. If none is passed will use default region from the config.
383
685
  */
384
686
  region?: ScwRegion;
385
- /** ID of the Project containing the contact point to delete. */
687
+ /**
688
+ * ID of the Project containing the contact point to delete.
689
+ */
386
690
  projectId?: string;
387
691
  /**
388
692
  * Email address of the contact point to delete.
@@ -391,219 +695,288 @@ export type RegionalApiDeleteContactPointRequest = {
391
695
  */
392
696
  email?: ContactPointEmail;
393
697
  };
394
- /** Delete a data source. */
698
+ /**
699
+ * Delete a data source.
700
+ */
395
701
  export type RegionalApiDeleteDataSourceRequest = {
396
702
  /**
397
- * Region to target. If none is passed will use default region from the
398
- * config.
703
+ * Region to target. If none is passed will use default region from the config.
399
704
  */
400
705
  region?: ScwRegion;
401
- /** ID of the data source to delete. */
706
+ /**
707
+ * ID of the data source to delete.
708
+ */
402
709
  dataSourceId: string;
403
710
  };
404
- /** Delete a token. */
711
+ /**
712
+ * Delete a token.
713
+ */
405
714
  export type RegionalApiDeleteTokenRequest = {
406
715
  /**
407
- * Region to target. If none is passed will use default region from the
408
- * config.
716
+ * Region to target. If none is passed will use default region from the config.
409
717
  */
410
718
  region?: ScwRegion;
411
- /** ID of the token to delete. */
719
+ /**
720
+ * ID of the token to delete.
721
+ */
412
722
  tokenId: string;
413
723
  };
414
- /** Disable the Alert manager. */
724
+ /**
725
+ * Disable the Alert manager.
726
+ */
415
727
  export type RegionalApiDisableAlertManagerRequest = {
416
728
  /**
417
- * Region to target. If none is passed will use default region from the
418
- * config.
729
+ * Region to target. If none is passed will use default region from the config.
419
730
  */
420
731
  region?: ScwRegion;
421
- /** ID of the Project to disable the Alert manager in. */
732
+ /**
733
+ * ID of the Project to disable the Alert manager in.
734
+ */
422
735
  projectId?: string;
423
736
  };
424
- /** Disable the sending of managed alerts. */
737
+ export type RegionalApiDisableAlertRulesRequest = {
738
+ /**
739
+ * Region to target. If none is passed will use default region from the config.
740
+ */
741
+ region?: ScwRegion;
742
+ projectId?: string;
743
+ ruleIds?: string[];
744
+ };
745
+ /**
746
+ * Disable the sending of managed alerts.
747
+ */
425
748
  export type RegionalApiDisableManagedAlertsRequest = {
426
749
  /**
427
- * Region to target. If none is passed will use default region from the
428
- * config.
750
+ * Region to target. If none is passed will use default region from the config.
429
751
  */
430
752
  region?: ScwRegion;
431
- /** ID of the Project. */
753
+ /**
754
+ * ID of the Project.
755
+ */
432
756
  projectId?: string;
433
757
  };
434
- /** Enable the Alert manager. */
758
+ /**
759
+ * Enable the Alert manager.
760
+ */
435
761
  export type RegionalApiEnableAlertManagerRequest = {
436
762
  /**
437
- * Region to target. If none is passed will use default region from the
438
- * config.
763
+ * Region to target. If none is passed will use default region from the config.
439
764
  */
440
765
  region?: ScwRegion;
441
- /** ID of the Project to enable the Alert manager in. */
766
+ /**
767
+ * ID of the Project to enable the Alert manager in.
768
+ */
442
769
  projectId?: string;
443
770
  };
444
- /** Enable the sending of managed alerts. */
771
+ export type RegionalApiEnableAlertRulesRequest = {
772
+ /**
773
+ * Region to target. If none is passed will use default region from the config.
774
+ */
775
+ region?: ScwRegion;
776
+ projectId?: string;
777
+ ruleIds?: string[];
778
+ };
779
+ /**
780
+ * Enable the sending of managed alerts.
781
+ */
445
782
  export type RegionalApiEnableManagedAlertsRequest = {
446
783
  /**
447
- * Region to target. If none is passed will use default region from the
448
- * config.
784
+ * Region to target. If none is passed will use default region from the config.
449
785
  */
450
786
  region?: ScwRegion;
451
- /** ID of the Project. */
787
+ /**
788
+ * ID of the Project.
789
+ */
452
790
  projectId?: string;
453
791
  };
454
- /** Get the Alert manager. */
792
+ /**
793
+ * Get the Alert manager.
794
+ */
455
795
  export type RegionalApiGetAlertManagerRequest = {
456
796
  /**
457
- * Region to target. If none is passed will use default region from the
458
- * config.
797
+ * Region to target. If none is passed will use default region from the config.
459
798
  */
460
799
  region?: ScwRegion;
461
- /** Project ID of the requested Alert manager. */
800
+ /**
801
+ * Project ID of the requested Alert manager.
802
+ */
462
803
  projectId?: string;
463
804
  };
464
- /** Get Cockpit configuration. */
805
+ /**
806
+ * Get Cockpit configuration.
807
+ */
465
808
  export type RegionalApiGetConfigRequest = {
466
809
  /**
467
- * Region to target. If none is passed will use default region from the
468
- * config.
810
+ * Region to target. If none is passed will use default region from the config.
469
811
  */
470
812
  region?: ScwRegion;
471
813
  };
472
- /** Retrieve a data source. */
814
+ /**
815
+ * Retrieve a data source.
816
+ */
473
817
  export type RegionalApiGetDataSourceRequest = {
474
818
  /**
475
- * Region to target. If none is passed will use default region from the
476
- * config.
819
+ * Region to target. If none is passed will use default region from the config.
477
820
  */
478
821
  region?: ScwRegion;
479
- /** ID of the relevant data source. */
822
+ /**
823
+ * ID of the relevant data source.
824
+ */
480
825
  dataSourceId: string;
481
826
  };
482
- /** Get a token. */
827
+ /**
828
+ * Get a token.
829
+ */
483
830
  export type RegionalApiGetTokenRequest = {
484
831
  /**
485
- * Region to target. If none is passed will use default region from the
486
- * config.
832
+ * Region to target. If none is passed will use default region from the config.
487
833
  */
488
834
  region?: ScwRegion;
489
- /** Token ID. */
835
+ /**
836
+ * Token ID.
837
+ */
490
838
  tokenId: string;
491
839
  };
492
840
  export type RegionalApiGetUsageOverviewRequest = {
493
841
  /**
494
- * Region to target. If none is passed will use default region from the
495
- * config.
842
+ * Region to target. If none is passed will use default region from the config.
496
843
  */
497
844
  region?: ScwRegion;
498
845
  projectId?: string;
499
846
  interval?: string;
500
847
  };
501
- /** Retrieve a list of alerts. */
848
+ /**
849
+ * Retrieve a list of alerts.
850
+ */
502
851
  export type RegionalApiListAlertsRequest = {
503
852
  /**
504
- * Region to target. If none is passed will use default region from the
505
- * config.
853
+ * Region to target. If none is passed will use default region from the config.
506
854
  */
507
855
  region?: ScwRegion;
508
- /** Project ID to filter for, only alerts from this Project will be returned. */
856
+ /**
857
+ * Project ID to filter for, only alerts from this Project will be returned.
858
+ */
509
859
  projectId?: string;
510
860
  /**
511
- * True returns only enabled alerts. False returns only disabled alerts. If
512
- * omitted, no alert filtering is applied. Other filters may still apply.
861
+ * True returns only enabled alerts. False returns only disabled alerts. If omitted, no alert filtering is applied. Other filters may still apply.
513
862
  */
514
863
  isEnabled?: boolean;
515
864
  /**
516
- * True returns only preconfigured alerts. False returns only custom alerts.
517
- * If omitted, no filtering is applied on alert types. Other filters may still
518
- * apply.
865
+ * True returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply.
519
866
  */
520
867
  isPreconfigured?: boolean;
521
868
  /**
522
- * Valid values to filter on are `disabled`, `enabled`, `pending` and
523
- * `firing`. If omitted, no filtering is applied on alert states. Other
524
- * filters may still apply.
869
+ * Valid values to filter on are `inactive`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
525
870
  */
526
871
  state?: AlertState;
527
872
  };
528
- /** List contact points. */
873
+ /**
874
+ * List contact points.
875
+ */
529
876
  export type RegionalApiListContactPointsRequest = {
530
877
  /**
531
- * Region to target. If none is passed will use default region from the
532
- * config.
878
+ * Region to target. If none is passed will use default region from the config.
533
879
  */
534
880
  region?: ScwRegion;
535
- /** Page number to return, from the paginated results. */
881
+ /**
882
+ * Page number to return, from the paginated results.
883
+ */
536
884
  page?: number;
537
- /** Total count of contact points to return per page. */
885
+ /**
886
+ * Total count of contact points to return per page.
887
+ */
538
888
  pageSize?: number;
539
- /** ID of the Project containing the contact points to list. */
889
+ /**
890
+ * ID of the Project containing the contact points to list.
891
+ */
540
892
  projectId?: string;
541
893
  };
542
- /** List data sources. */
894
+ /**
895
+ * List data sources.
896
+ */
543
897
  export type RegionalApiListDataSourcesRequest = {
544
898
  /**
545
- * Region to target. If none is passed will use default region from the
546
- * config.
899
+ * Region to target. If none is passed will use default region from the config.
547
900
  */
548
901
  region?: ScwRegion;
549
- /** Page number to return, from the paginated results. */
902
+ /**
903
+ * Page number to return, from the paginated results.
904
+ */
550
905
  page?: number;
551
- /** Number of data sources to return per page. */
906
+ /**
907
+ * Number of data sources to return per page.
908
+ */
552
909
  pageSize?: number;
553
- /** Sort order for data sources in the response. */
910
+ /**
911
+ * Sort order for data sources in the response.
912
+ */
554
913
  orderBy?: ListDataSourcesRequestOrderBy;
555
914
  /**
556
- * Project ID to filter for, only data sources from this Project will be
557
- * returned.
915
+ * Project ID to filter for, only data sources from this Project will be returned.
558
916
  */
559
917
  projectId?: string;
560
918
  /**
561
- * Origin to filter for, only data sources with matching origin will be
562
- * returned.
919
+ * Origin to filter for, only data sources with matching origin will be returned.
563
920
  */
564
921
  origin?: DataSourceOrigin;
565
922
  /**
566
- * Types to filter for, only data sources with matching types will be
567
- * returned.
923
+ * Types to filter for, only data sources with matching types will be returned.
568
924
  */
569
925
  types?: DataSourceType[];
570
926
  };
571
- /** List tokens. */
927
+ /**
928
+ * List tokens.
929
+ */
572
930
  export type RegionalApiListTokensRequest = {
573
931
  /**
574
- * Region to target. If none is passed will use default region from the
575
- * config.
932
+ * Region to target. If none is passed will use default region from the config.
576
933
  */
577
934
  region?: ScwRegion;
578
- /** Page number to return, from the paginated results. */
935
+ /**
936
+ * Page number to return, from the paginated results.
937
+ */
579
938
  page?: number;
580
- /** Number of tokens to return per page. */
939
+ /**
940
+ * Number of tokens to return per page.
941
+ */
581
942
  pageSize?: number;
582
- /** Order in which to return results. */
943
+ /**
944
+ * Order in which to return results.
945
+ */
583
946
  orderBy?: ListTokensRequestOrderBy;
584
- /** ID of the Project the tokens belong to. */
947
+ /**
948
+ * ID of the Project the tokens belong to.
949
+ */
585
950
  projectId?: string;
586
- /** Token scopes to filter for. */
951
+ /**
952
+ * Token scopes to filter for.
953
+ */
587
954
  tokenScopes?: TokenScope[];
588
955
  };
589
- /** Request to trigger a test alert. */
956
+ /**
957
+ * Request to trigger a test alert.
958
+ */
590
959
  export type RegionalApiTriggerTestAlertRequest = {
591
960
  /**
592
- * Region to target. If none is passed will use default region from the
593
- * config.
961
+ * Region to target. If none is passed will use default region from the config.
594
962
  */
595
963
  region?: ScwRegion;
596
- /** ID of the Project. */
964
+ /**
965
+ * ID of the Project.
966
+ */
597
967
  projectId?: string;
598
968
  };
599
- /** Update a contact point. */
969
+ /**
970
+ * Update a contact point.
971
+ */
600
972
  export type RegionalApiUpdateContactPointRequest = {
601
973
  /**
602
- * Region to target. If none is passed will use default region from the
603
- * config.
974
+ * Region to target. If none is passed will use default region from the config.
604
975
  */
605
976
  region?: ScwRegion;
606
- /** ID of the Project containing the contact point to update. */
977
+ /**
978
+ * ID of the Project containing the contact point to update.
979
+ */
607
980
  projectId?: string;
608
981
  /**
609
982
  * Email address of the contact point to update.
@@ -611,21 +984,30 @@ export type RegionalApiUpdateContactPointRequest = {
611
984
  * One-of ('configuration'): at most one of 'email' could be set.
612
985
  */
613
986
  email?: ContactPointEmail;
614
- /** Enable or disable notifications when alert is resolved. */
987
+ /**
988
+ * Enable or disable notifications when alert is resolved.
989
+ */
615
990
  sendResolvedNotifications?: boolean;
616
991
  };
617
- /** Update a data source name. */
992
+ /**
993
+ * Update a data source name.
994
+ */
618
995
  export type RegionalApiUpdateDataSourceRequest = {
619
996
  /**
620
- * Region to target. If none is passed will use default region from the
621
- * config.
997
+ * Region to target. If none is passed will use default region from the config.
622
998
  */
623
999
  region?: ScwRegion;
624
- /** ID of the data source to update. */
1000
+ /**
1001
+ * ID of the data source to update.
1002
+ */
625
1003
  dataSourceId: string;
626
- /** Updated name of the data source. */
1004
+ /**
1005
+ * Updated name of the data source.
1006
+ */
627
1007
  name?: string;
628
- /** BETA - Duration for which the data will be retained in the data source. */
1008
+ /**
1009
+ * BETA - Duration for which the data will be retained in the data source.
1010
+ */
629
1011
  retentionDays?: number;
630
1012
  };
631
1013
  export interface UsageOverview {