@scaleway/sdk 2.72.0 → 2.73.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 (146) 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/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -3,25 +3,21 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
3
3
  import type { ListEventsRequest, ListEventsResponse, ListProductsRequest, ListProductsResponse } from './types.gen';
4
4
  /**
5
5
  * Audit Trail API.
6
- *
7
- * This API allows you to ensure accountability and security by recording events
8
- * and changes performed within your Scaleway Organization.
6
+
7
+ This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
9
8
  */
10
9
  export declare class API extends ParentAPI {
11
10
  /** Lists the available regions of the API. */
12
11
  static readonly LOCALITIES: ScwRegion[];
13
12
  /**
14
- * List events. Retrieve the list of Audit Trail events for a Scaleway
15
- * Organization and/or Project. You must specify the `organization_id` and
16
- * optionally, the `project_id`.
13
+ * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
17
14
  *
18
15
  * @param request - The request {@link ListEventsRequest}
19
16
  * @returns A Promise of ListEventsResponse
20
17
  */
21
18
  listEvents: (request?: Readonly<ListEventsRequest>) => Promise<ListEventsResponse>;
22
19
  /**
23
- * Retrieve the list of Scaleway resources for which you have Audit Trail
24
- * events.
20
+ * Retrieve the list of Scaleway resources for which you have Audit Trail events.
25
21
  *
26
22
  * @param request - The request {@link ListProductsRequest}
27
23
  * @returns A Promise of ListProductsResponse
@@ -7,9 +7,7 @@ class API extends API$1 {
7
7
  /** Lists the available regions of the API. */
8
8
  static LOCALITIES = ["fr-par", "nl-ams"];
9
9
  /**
10
- * List events. Retrieve the list of Audit Trail events for a Scaleway
11
- * Organization and/or Project. You must specify the `organization_id` and
12
- * optionally, the `project_id`.
10
+ * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
13
11
  *
14
12
  * @param request - The request {@link ListEventsRequest}
15
13
  * @returns A Promise of ListEventsResponse
@@ -42,8 +40,7 @@ class API extends API$1 {
42
40
  unmarshalListEventsResponse
43
41
  );
44
42
  /**
45
- * Retrieve the list of Scaleway resources for which you have Audit Trail
46
- * events.
43
+ * Retrieve the list of Scaleway resources for which you have Audit Trail events.
47
44
  *
48
45
  * @param request - The request {@link ListProductsRequest}
49
46
  * @returns A Promise of ListProductsResponse
@@ -34,77 +34,54 @@ export interface Resource {
34
34
  /**
35
35
  * @deprecated
36
36
  *
37
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
38
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
39
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
40
- * 'keyManagerKeyInfo' could be set.
37
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
41
38
  */
42
39
  secmSecretInfo?: SecretManagerSecretInfo;
43
40
  /**
44
41
  * @deprecated
45
42
  *
46
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
47
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
48
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
49
- * 'keyManagerKeyInfo' could be set.
43
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
50
44
  */
51
45
  secmSecretVersionInfo?: SecretManagerSecretVersionInfo;
52
46
  /**
53
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
54
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
55
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
56
- * 'keyManagerKeyInfo' could be set.
47
+ *
48
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
57
49
  */
58
50
  kubeClusterInfo?: KubernetesClusterInfo;
59
51
  /**
60
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
61
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
62
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
63
- * 'keyManagerKeyInfo' could be set.
52
+ *
53
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
64
54
  */
65
55
  kubePoolInfo?: KubernetesPoolInfo;
66
56
  /**
67
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
68
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
69
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
70
- * 'keyManagerKeyInfo' could be set.
57
+ *
58
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
71
59
  */
72
60
  kubeNodeInfo?: KubernetesNodeInfo;
73
61
  /**
74
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
75
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
76
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
77
- * 'keyManagerKeyInfo' could be set.
62
+ *
63
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
78
64
  */
79
65
  kubeAclInfo?: KubernetesACLInfo;
80
66
  /**
81
67
  * @deprecated
82
68
  *
83
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
84
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
85
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
86
- * 'keyManagerKeyInfo' could be set.
69
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
87
70
  */
88
71
  keymKeyInfo?: KeyManagerKeyInfo;
89
72
  /**
90
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
91
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
92
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
93
- * 'keyManagerKeyInfo' could be set.
73
+ *
74
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
94
75
  */
95
76
  secretManagerSecretInfo?: SecretManagerSecretInfo;
96
77
  /**
97
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
98
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
99
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
100
- * 'keyManagerKeyInfo' could be set.
78
+ *
79
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
101
80
  */
102
81
  secretManagerVersionInfo?: SecretManagerSecretVersionInfo;
103
82
  /**
104
- * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo',
105
- * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo',
106
- * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo',
107
- * 'keyManagerKeyInfo' could be set.
83
+ *
84
+ * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
108
85
  */
109
86
  keyManagerKeyInfo?: KeyManagerKeyInfo;
110
87
  }
@@ -113,106 +90,157 @@ export interface ProductService {
113
90
  methods: string[];
114
91
  }
115
92
  export interface Event {
116
- /** ID of the event. */
93
+ /**
94
+ * ID of the event.
95
+ */
117
96
  id: string;
118
- /** Timestamp of the event. */
97
+ /**
98
+ * Timestamp of the event.
99
+ */
119
100
  recordedAt?: Date;
120
- /** Locality of the resource attached to the event. */
101
+ /**
102
+ * Locality of the resource attached to the event.
103
+ */
121
104
  locality: string;
122
- /** User or IAM application at the origin of the event. */
105
+ /**
106
+ * User or IAM application at the origin of the event.
107
+ */
123
108
  principal?: EventPrincipal;
124
- /** Organization ID containing the event. */
109
+ /**
110
+ * Organization ID containing the event.
111
+ */
125
112
  organizationId: string;
126
- /** (Optional) Project of the resource attached to the event. */
113
+ /**
114
+ * (Optional) Project of the resource attached to the event.
115
+ */
127
116
  projectId?: string;
128
- /** IP address at the origin of the event. */
117
+ /**
118
+ * IP address at the origin of the event.
119
+ */
129
120
  sourceIp: string;
130
- /** User Agent at the origin of the event. */
121
+ /**
122
+ * User Agent at the origin of the event.
123
+ */
131
124
  userAgent?: string;
132
- /** Product name of the resource attached to the event. */
125
+ /**
126
+ * Product name of the resource attached to the event.
127
+ */
133
128
  productName: string;
134
- /** API name called to trigger the event. */
129
+ /**
130
+ * API name called to trigger the event.
131
+ */
135
132
  serviceName: string;
136
- /** API method called to trigger the event. */
133
+ /**
134
+ * API method called to trigger the event.
135
+ */
137
136
  methodName: string;
138
- /** @deprecated Resource attached to the event. */
137
+ /**
138
+ * @deprecated Resource attached to the event.
139
+ */
139
140
  resource?: Resource;
140
- /** Resources attached to the event. */
141
+ /**
142
+ * Resources attached to the event.
143
+ */
141
144
  resources: Resource[];
142
- /** Unique identifier of the request at the origin of the event. */
145
+ /**
146
+ * Unique identifier of the request at the origin of the event.
147
+ */
143
148
  requestId: string;
144
- /** Request at the origin of the event. */
149
+ /**
150
+ * Request at the origin of the event.
151
+ */
145
152
  requestBody?: Record<string, unknown>;
146
- /** HTTP status code resulting of the API call. */
153
+ /**
154
+ * HTTP status code resulting of the API call.
155
+ */
147
156
  statusCode: number;
148
157
  }
149
158
  export interface Product {
150
- /** Product title. */
159
+ /**
160
+ * Product title.
161
+ */
151
162
  title: string;
152
- /** Product name. */
163
+ /**
164
+ * Product name.
165
+ */
153
166
  name: string;
154
167
  /**
155
- * Specifies the API versions of the products integrated with Audit Trail.
156
- * Each version defines the methods logged by Audit Trail.
168
+ * Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail.
157
169
  */
158
170
  services: ProductService[];
159
171
  }
160
172
  export type ListEventsRequest = {
161
173
  /**
162
- * Region to target. If none is passed will use default region from the
163
- * config.
174
+ * Region to target. If none is passed will use default region from the config.
164
175
  */
165
176
  region?: ScwRegion;
166
- /** (Optional) ID of the Project containing the Audit Trail events. */
177
+ /**
178
+ * (Optional) ID of the Project containing the Audit Trail events.
179
+ */
167
180
  projectId?: string;
168
- /** ID of the Organization containing the Audit Trail events. */
181
+ /**
182
+ * ID of the Organization containing the Audit Trail events.
183
+ */
169
184
  organizationId?: string;
170
- /** (Optional) Returns a paginated list of Scaleway resources' features. */
185
+ /**
186
+ * (Optional) Returns a paginated list of Scaleway resources' features.
187
+ */
171
188
  resourceType?: ResourceType;
172
- /** (Optional) Name of the method of the API call performed. */
189
+ /**
190
+ * (Optional) Name of the method of the API call performed.
191
+ */
173
192
  methodName?: string;
174
193
  /**
175
- * (Optional) HTTP status code of the request. Returns either `200` if the
176
- * request was successful or `403` if the permission was denied.
194
+ * (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied.
177
195
  */
178
196
  status?: number;
179
197
  /**
180
- * (Optional) The `recorded_after` parameter defines the earliest timestamp
181
- * from which Audit Trail events are retrieved. Returns `one hour ago` by
182
- * default.
198
+ * (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default.
183
199
  */
184
200
  recordedAfter?: Date;
185
201
  /**
186
- * (Optional) The `recorded_before` parameter defines the latest timestamp up
187
- * to which Audit Trail events are retrieved. Returns `now` by default.
202
+ * (Optional) The `recorded_before` parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns `now` by default.
188
203
  */
189
204
  recordedBefore?: Date;
190
205
  orderBy?: ListEventsRequestOrderBy;
191
206
  pageSize?: number;
192
207
  pageToken?: string;
193
- /** (Optional) Name of the Scaleway resource in a hyphenated format. */
208
+ /**
209
+ * (Optional) Name of the Scaleway resource in a hyphenated format.
210
+ */
194
211
  productName?: string;
195
- /** (Optional) Name of the service of the API call performed. */
212
+ /**
213
+ * (Optional) Name of the service of the API call performed.
214
+ */
196
215
  serviceName?: string;
197
216
  };
198
217
  export interface ListEventsResponse {
199
- /** Single page of events matching the requested criteria. */
218
+ /**
219
+ * Single page of events matching the requested criteria.
220
+ */
200
221
  events: Event[];
201
- /** Page token to use in following calls to keep listing. */
222
+ /**
223
+ * Page token to use in following calls to keep listing.
224
+ */
202
225
  nextPageToken?: string;
203
226
  }
204
227
  export type ListProductsRequest = {
205
228
  /**
206
- * Region to target. If none is passed will use default region from the
207
- * config.
229
+ * Region to target. If none is passed will use default region from the config.
208
230
  */
209
231
  region?: ScwRegion;
210
- /** ID of the Organization containing the Audit Trail events. */
232
+ /**
233
+ * ID of the Organization containing the Audit Trail events.
234
+ */
211
235
  organizationId?: string;
212
236
  };
213
237
  export interface ListProductsResponse {
214
- /** List of all products integrated with Audit Trail. */
238
+ /**
239
+ * List of all products integrated with Audit Trail.
240
+ */
215
241
  products: Product[];
216
- /** Number of integrated products. */
242
+ /**
243
+ * Number of integrated products.
244
+ */
217
245
  totalCount: number;
218
246
  }
@@ -43,16 +43,14 @@ class API extends api.API {
43
43
  marshalling_gen.unmarshalListServersResponse
44
44
  );
45
45
  /**
46
- * List Elastic Metal servers for an Organization. List Elastic Metal servers
47
- * for a specific Organization.
46
+ * List Elastic Metal servers for an Organization. List Elastic Metal servers for a specific Organization.
48
47
  *
49
48
  * @param request - The request {@link ListServersRequest}
50
49
  * @returns A Promise of ListServersResponse
51
50
  */
52
51
  listServers = (request = {}) => resourcePaginator.enrichForPagination("servers", this.pageOfListServers, request);
53
52
  /**
54
- * Get a specific Elastic Metal server. Get full details of an existing
55
- * Elastic Metal server associated with the ID.
53
+ * Get a specific Elastic Metal server. Get full details of an existing Elastic Metal server associated with the ID.
56
54
  *
57
55
  * @param request - The request {@link GetServerRequest}
58
56
  * @returns A Promise of Server
@@ -80,8 +78,7 @@ class API extends api.API {
80
78
  options
81
79
  );
82
80
  /**
83
- * Create an Elastic Metal server. Create a new Elastic Metal server. Once the
84
- * server is created, proceed with the [installation of an OS](#post-3e949e).
81
+ * Create an Elastic Metal server. Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e).
85
82
  *
86
83
  * @param request - The request {@link CreateServerRequest}
87
84
  * @returns A Promise of Server
@@ -98,9 +95,7 @@ class API extends api.API {
98
95
  marshalling_gen.unmarshalServer
99
96
  );
100
97
  /**
101
- * Update an Elastic Metal server. Update the server associated with the ID.
102
- * You can update parameters such as the server's name, tags and description.
103
- * Any parameters left null in the request body are not updated.
98
+ * Update an Elastic Metal server. Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated.
104
99
  *
105
100
  * @param request - The request {@link UpdateServerRequest}
106
101
  * @returns A Promise of Server
@@ -117,8 +112,7 @@ class API extends api.API {
117
112
  marshalling_gen.unmarshalServer
118
113
  );
119
114
  /**
120
- * Install an Elastic Metal server. Install an Operating System (OS) on the
121
- * Elastic Metal server with a specific ID.
115
+ * Install an Elastic Metal server. Install an Operating System (OS) on the Elastic Metal server with a specific ID.
122
116
  *
123
117
  * @param request - The request {@link InstallServerRequest}
124
118
  * @returns A Promise of Server
@@ -135,8 +129,7 @@ class API extends api.API {
135
129
  marshalling_gen.unmarshalServer
136
130
  );
137
131
  /**
138
- * Return server metrics. Get the ping status of the server associated with
139
- * the ID.
132
+ * Return server metrics. Get the ping status of the server associated with the ID.
140
133
  *
141
134
  * @param request - The request {@link GetServerMetricsRequest}
142
135
  * @returns A Promise of GetServerMetricsResponse
@@ -162,9 +155,7 @@ class API extends api.API {
162
155
  marshalling_gen.unmarshalServer
163
156
  );
164
157
  /**
165
- * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated
166
- * with the ID, use the `boot_type` `rescue` to reboot the server in rescue
167
- * mode.
158
+ * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode.
168
159
  *
169
160
  * @param request - The request {@link RebootServerRequest}
170
161
  * @returns A Promise of Server
@@ -198,9 +189,7 @@ class API extends api.API {
198
189
  marshalling_gen.unmarshalServer
199
190
  );
200
191
  /**
201
- * Stop an Elastic Metal server. Stop the server associated with the ID. The
202
- * server remains allocated to your account and all data remains on the local
203
- * storage of the server.
192
+ * Stop an Elastic Metal server. Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server.
204
193
  *
205
194
  * @param request - The request {@link StopServerRequest}
206
195
  * @returns A Promise of Server
@@ -230,16 +219,14 @@ class API extends api.API {
230
219
  marshalling_gen.unmarshalListServerEventsResponse
231
220
  );
232
221
  /**
233
- * List server events. List event (i.e. start/stop/reboot) associated to the
234
- * server ID.
222
+ * List server events. List event (i.e. start/stop/reboot) associated to the server ID.
235
223
  *
236
224
  * @param request - The request {@link ListServerEventsRequest}
237
225
  * @returns A Promise of ListServerEventsResponse
238
226
  */
239
227
  listServerEvents = (request) => resourcePaginator.enrichForPagination("events", this.pageOfListServerEvents, request);
240
228
  /**
241
- * Get default partitioning schema. Get the default partitioning schema for
242
- * the given offer ID and OS ID.
229
+ * Get default partitioning schema. Get the default partitioning schema for the given offer ID and OS ID.
243
230
  *
244
231
  * @param request - The request {@link GetDefaultPartitioningSchemaRequest}
245
232
  * @returns A Promise of Schema
@@ -256,9 +243,7 @@ class API extends api.API {
256
243
  marshalling_gen.unmarshalSchema
257
244
  );
258
245
  /**
259
- * Validate client partitioning schema. Validate the incoming partitioning
260
- * schema from a user before installing the server. Return default ErrorCode
261
- * if invalid.
246
+ * Validate client partitioning schema. Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.
262
247
  *
263
248
  * @param request - The request {@link ValidatePartitioningSchemaRequest}
264
249
  */
@@ -271,22 +256,14 @@ class API extends api.API {
271
256
  path: `/baremetal/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/partitioning-schemas/validate`
272
257
  });
273
258
  /**
274
- * Start BMC access. Start BMC (Baseboard Management Controller) access
275
- * associated with the ID. The BMC (Baseboard Management Controller) access is
276
- * available one hour after the installation of the server. You need first to
277
- * create an option Remote Access. You will find the ID and the price with a
278
- * call to listOffers
279
- * (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92).
280
- * Then add the option
281
- * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
282
- * After adding the BMC option, you need to Get Remote Access to get the
283
- * login/password
284
- * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do
285
- * not forget to delete the Option after use.
286
- *
287
- * @param request - The request {@link StartBMCAccessRequest}
288
- * @returns A Promise of BMCAccess
289
- */
259
+ * Start BMC access. Start BMC (Baseboard Management Controller) access associated with the ID.
260
+ The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
261
+ You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
262
+ After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.
263
+ *
264
+ * @param request - The request {@link StartBMCAccessRequest}
265
+ * @returns A Promise of BMCAccess
266
+ */
290
267
  startBMCAccess = (request) => this.client.fetch(
291
268
  {
292
269
  body: JSON.stringify(
@@ -299,9 +276,7 @@ class API extends api.API {
299
276
  marshalling_gen.unmarshalBMCAccess
300
277
  );
301
278
  /**
302
- * Get BMC access. Get the BMC (Baseboard Management Controller) access
303
- * associated with the ID, including the URL and login information needed to
304
- * connect.
279
+ * Get BMC access. Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.
305
280
  *
306
281
  * @param request - The request {@link GetBMCAccessRequest}
307
282
  * @returns A Promise of BMCAccess
@@ -314,8 +289,7 @@ class API extends api.API {
314
289
  marshalling_gen.unmarshalBMCAccess
315
290
  );
316
291
  /**
317
- * Stop BMC access. Stop BMC (Baseboard Management Controller) access
318
- * associated with the ID.
292
+ * Stop BMC access. Stop BMC (Baseboard Management Controller) access associated with the ID.
319
293
  *
320
294
  * @param request - The request {@link StopBMCAccessRequest}
321
295
  */
@@ -324,8 +298,7 @@ class API extends api.API {
324
298
  path: `/baremetal/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${marshalling.validatePathParam("serverId", request.serverId)}/bmc-access`
325
299
  });
326
300
  /**
327
- * Update IP. Configure the IP address associated with the server ID and IP
328
- * ID. You can use this method to set a reverse DNS for an IP address.
301
+ * Update IP. Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.
329
302
  *
330
303
  * @param request - The request {@link UpdateIPRequest}
331
304
  * @returns A Promise of IP
@@ -342,8 +315,7 @@ class API extends api.API {
342
315
  marshalling_gen.unmarshalIP
343
316
  );
344
317
  /**
345
- * Add server option. Add an option, such as Private Networks, to a specific
346
- * server.
318
+ * Add server option. Add an option, such as Private Networks, to a specific server.
347
319
  *
348
320
  * @param request - The request {@link AddOptionServerRequest}
349
321
  * @returns A Promise of Server
@@ -516,8 +488,7 @@ class API extends api.API {
516
488
  marshalling_gen.unmarshalListOSResponse
517
489
  );
518
490
  /**
519
- * List available OSes. List all OSes that are available for installation on
520
- * Elastic Metal servers.
491
+ * List available OSes. List all OSes that are available for installation on Elastic Metal servers.
521
492
  *
522
493
  * @param request - The request {@link ListOSRequest}
523
494
  * @returns A Promise of ListOSResponse
@@ -543,8 +514,7 @@ class PrivateNetworkAPI extends api.API {
543
514
  /**
544
515
  * Add a server to a Private Network.
545
516
  *
546
- * @param request - The request
547
- * {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
517
+ * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
548
518
  * @returns A Promise of ServerPrivateNetwork
549
519
  */
550
520
  addServerPrivateNetwork = (request) => this.client.fetch(
@@ -564,8 +534,7 @@ class PrivateNetworkAPI extends api.API {
564
534
  /**
565
535
  * Set multiple Private Networks on a server.
566
536
  *
567
- * @param request - The request
568
- * {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
537
+ * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
569
538
  * @returns A Promise of SetServerPrivateNetworksResponse
570
539
  */
571
540
  setServerPrivateNetworks = (request) => this.client.fetch(
@@ -604,8 +573,7 @@ class PrivateNetworkAPI extends api.API {
604
573
  /**
605
574
  * List the Private Networks of a server.
606
575
  *
607
- * @param request - The request
608
- * {@link PrivateNetworkApiListServerPrivateNetworksRequest}
576
+ * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
609
577
  * @returns A Promise of ListServerPrivateNetworksResponse
610
578
  */
611
579
  listServerPrivateNetworks = (request = {}) => resourcePaginator.enrichForPagination(
@@ -616,8 +584,7 @@ class PrivateNetworkAPI extends api.API {
616
584
  /**
617
585
  * Delete a Private Network.
618
586
  *
619
- * @param request - The request
620
- * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
587
+ * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
621
588
  */
622
589
  deleteServerPrivateNetwork = (request) => this.client.fetch({
623
590
  method: "DELETE",