@distilled.cloud/ovh 0.0.0 → 1.0.0-rc.9

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 (192) hide show
  1. package/LICENSE +201 -0
  2. package/lib/credentials.d.ts +38 -0
  3. package/lib/credentials.d.ts.map +1 -0
  4. package/lib/credentials.js +54 -0
  5. package/lib/credentials.js.map +1 -0
  6. package/lib/errors.d.ts +36 -0
  7. package/lib/errors.d.ts.map +1 -0
  8. package/lib/errors.js +26 -0
  9. package/lib/errors.js.map +1 -0
  10. package/lib/index.d.ts +22 -0
  11. package/lib/index.d.ts.map +1 -0
  12. package/lib/index.js +22 -0
  13. package/lib/index.js.map +1 -0
  14. package/lib/pagination.d.ts +8 -0
  15. package/lib/pagination.d.ts.map +1 -0
  16. package/lib/pagination.js +8 -0
  17. package/lib/pagination.js.map +1 -0
  18. package/lib/protocol.d.ts +18 -0
  19. package/lib/protocol.d.ts.map +1 -0
  20. package/lib/protocol.js +60 -0
  21. package/lib/protocol.js.map +1 -0
  22. package/lib/retry.d.ts +32 -0
  23. package/lib/retry.d.ts.map +1 -0
  24. package/lib/retry.js +32 -0
  25. package/lib/retry.js.map +1 -0
  26. package/lib/services/baremetal.d.ts +3551 -0
  27. package/lib/services/baremetal.d.ts.map +1 -0
  28. package/lib/services/baremetal.js +4200 -0
  29. package/lib/services/baremetal.js.map +1 -0
  30. package/lib/services/cloud.d.ts +26011 -0
  31. package/lib/services/cloud.d.ts.map +1 -0
  32. package/lib/services/cloud.js +31119 -0
  33. package/lib/services/cloud.js.map +1 -0
  34. package/lib/services/cloud_v2.d.ts +5642 -0
  35. package/lib/services/cloud_v2.d.ts.map +1 -0
  36. package/lib/services/cloud_v2.js +5760 -0
  37. package/lib/services/cloud_v2.js.map +1 -0
  38. package/lib/services/dedicatedceph.d.ts +747 -0
  39. package/lib/services/dedicatedceph.d.ts.map +1 -0
  40. package/lib/services/dedicatedceph.js +962 -0
  41. package/lib/services/dedicatedceph.js.map +1 -0
  42. package/lib/services/dedicatednasha.d.ts +755 -0
  43. package/lib/services/dedicatednasha.d.ts.map +1 -0
  44. package/lib/services/dedicatednasha.js +967 -0
  45. package/lib/services/dedicatednasha.js.map +1 -0
  46. package/lib/services/domain.d.ts +2995 -0
  47. package/lib/services/domain.d.ts.map +1 -0
  48. package/lib/services/domain.js +3080 -0
  49. package/lib/services/domain.js.map +1 -0
  50. package/lib/services/emaildomain.d.ts +1913 -0
  51. package/lib/services/emaildomain.d.ts.map +1 -0
  52. package/lib/services/emaildomain.js +2550 -0
  53. package/lib/services/emaildomain.js.map +1 -0
  54. package/lib/services/emailmxplan.d.ts +1012 -0
  55. package/lib/services/emailmxplan.d.ts.map +1 -0
  56. package/lib/services/emailmxplan.js +1155 -0
  57. package/lib/services/emailmxplan.js.map +1 -0
  58. package/lib/services/emailpro.d.ts +1287 -0
  59. package/lib/services/emailpro.d.ts.map +1 -0
  60. package/lib/services/emailpro.js +1471 -0
  61. package/lib/services/emailpro.js.map +1 -0
  62. package/lib/services/hostingprivatedatabase.d.ts +1402 -0
  63. package/lib/services/hostingprivatedatabase.d.ts.map +1 -0
  64. package/lib/services/hostingprivatedatabase.js +1833 -0
  65. package/lib/services/hostingprivatedatabase.js.map +1 -0
  66. package/lib/services/iam.d.ts +829 -0
  67. package/lib/services/iam.d.ts.map +1 -0
  68. package/lib/services/iam.js +793 -0
  69. package/lib/services/iam.js.map +1 -0
  70. package/lib/services/index.d.ts +31 -0
  71. package/lib/services/index.d.ts.map +1 -0
  72. package/lib/services/index.js +32 -0
  73. package/lib/services/index.js.map +1 -0
  74. package/lib/services/ip.d.ts +1417 -0
  75. package/lib/services/ip.d.ts.map +1 -0
  76. package/lib/services/ip.js +1691 -0
  77. package/lib/services/ip.js.map +1 -0
  78. package/lib/services/iploadbalancing.d.ts +3059 -0
  79. package/lib/services/iploadbalancing.d.ts.map +1 -0
  80. package/lib/services/iploadbalancing.js +3554 -0
  81. package/lib/services/iploadbalancing.js.map +1 -0
  82. package/lib/services/ldp.d.ts +2492 -0
  83. package/lib/services/ldp.d.ts.map +1 -0
  84. package/lib/services/ldp.js +3072 -0
  85. package/lib/services/ldp.js.map +1 -0
  86. package/lib/services/me.d.ts +7511 -0
  87. package/lib/services/me.d.ts.map +1 -0
  88. package/lib/services/me.js +8878 -0
  89. package/lib/services/me.js.map +1 -0
  90. package/lib/services/overthebox.d.ts +981 -0
  91. package/lib/services/overthebox.d.ts.map +1 -0
  92. package/lib/services/overthebox.js +1122 -0
  93. package/lib/services/overthebox.js.map +1 -0
  94. package/lib/services/ovhcloudconnect.d.ts +1123 -0
  95. package/lib/services/ovhcloudconnect.d.ts.map +1 -0
  96. package/lib/services/ovhcloudconnect.js +1353 -0
  97. package/lib/services/ovhcloudconnect.js.map +1 -0
  98. package/lib/services/packxdsl.d.ts +1583 -0
  99. package/lib/services/packxdsl.d.ts.map +1 -0
  100. package/lib/services/packxdsl.js +1791 -0
  101. package/lib/services/packxdsl.js.map +1 -0
  102. package/lib/services/sms.d.ts +2602 -0
  103. package/lib/services/sms.d.ts.map +1 -0
  104. package/lib/services/sms.js +2995 -0
  105. package/lib/services/sms.js.map +1 -0
  106. package/lib/services/sslgateway.d.ts +493 -0
  107. package/lib/services/sslgateway.d.ts.map +1 -0
  108. package/lib/services/sslgateway.js +569 -0
  109. package/lib/services/sslgateway.js.map +1 -0
  110. package/lib/services/storagenetapp.d.ts +859 -0
  111. package/lib/services/storagenetapp.d.ts.map +1 -0
  112. package/lib/services/storagenetapp.js +1022 -0
  113. package/lib/services/storagenetapp.js.map +1 -0
  114. package/lib/services/support.d.ts +233 -0
  115. package/lib/services/support.d.ts.map +1 -0
  116. package/lib/services/support.js +237 -0
  117. package/lib/services/support.js.map +1 -0
  118. package/lib/services/telephony.d.ts +10825 -0
  119. package/lib/services/telephony.d.ts.map +1 -0
  120. package/lib/services/telephony.js +14894 -0
  121. package/lib/services/telephony.js.map +1 -0
  122. package/lib/services/vmwareclouddirectorbackup.d.ts +784 -0
  123. package/lib/services/vmwareclouddirectorbackup.d.ts.map +1 -0
  124. package/lib/services/vmwareclouddirectorbackup.js +842 -0
  125. package/lib/services/vmwareclouddirectorbackup.js.map +1 -0
  126. package/lib/services/vmwareclouddirectororganization.d.ts +784 -0
  127. package/lib/services/vmwareclouddirectororganization.d.ts.map +1 -0
  128. package/lib/services/vmwareclouddirectororganization.js +842 -0
  129. package/lib/services/vmwareclouddirectororganization.js.map +1 -0
  130. package/lib/services/vps.d.ts +1579 -0
  131. package/lib/services/vps.d.ts.map +1 -0
  132. package/lib/services/vps.js +1914 -0
  133. package/lib/services/vps.js.map +1 -0
  134. package/lib/services/vrack.d.ts +1204 -0
  135. package/lib/services/vrack.d.ts.map +1 -0
  136. package/lib/services/vrack.js +1627 -0
  137. package/lib/services/vrack.js.map +1 -0
  138. package/lib/services/vrackservices.d.ts +394 -0
  139. package/lib/services/vrackservices.d.ts.map +1 -0
  140. package/lib/services/vrackservices.js +355 -0
  141. package/lib/services/vrackservices.js.map +1 -0
  142. package/lib/services/webhosting.d.ts +3986 -0
  143. package/lib/services/webhosting.d.ts.map +1 -0
  144. package/lib/services/webhosting.js +4527 -0
  145. package/lib/services/webhosting.js.map +1 -0
  146. package/lib/services/xdsl.d.ts +3433 -0
  147. package/lib/services/xdsl.d.ts.map +1 -0
  148. package/lib/services/xdsl.js +3682 -0
  149. package/lib/services/xdsl.js.map +1 -0
  150. package/lib/traits.d.ts +11 -0
  151. package/lib/traits.d.ts.map +1 -0
  152. package/lib/traits.js +11 -0
  153. package/lib/traits.js.map +1 -0
  154. package/package.json +77 -6
  155. package/src/credentials.ts +77 -0
  156. package/src/errors.ts +50 -0
  157. package/src/index.ts +21 -0
  158. package/src/pagination.ts +7 -0
  159. package/src/protocol.ts +86 -0
  160. package/src/retry.ts +54 -0
  161. package/src/services/baremetal.ts +10954 -0
  162. package/src/services/cloud.ts +75508 -0
  163. package/src/services/cloud_v2.ts +14751 -0
  164. package/src/services/dedicatedceph.ts +2233 -0
  165. package/src/services/dedicatednasha.ts +2269 -0
  166. package/src/services/domain.ts +7998 -0
  167. package/src/services/emaildomain.ts +5751 -0
  168. package/src/services/emailmxplan.ts +2764 -0
  169. package/src/services/emailpro.ts +3519 -0
  170. package/src/services/hostingprivatedatabase.ts +4218 -0
  171. package/src/services/iam.ts +2060 -0
  172. package/src/services/index.ts +31 -0
  173. package/src/services/ip.ts +4462 -0
  174. package/src/services/iploadbalancing.ts +8422 -0
  175. package/src/services/ldp.ts +7274 -0
  176. package/src/services/me.ts +21720 -0
  177. package/src/services/overthebox.ts +2693 -0
  178. package/src/services/ovhcloudconnect.ts +3226 -0
  179. package/src/services/packxdsl.ts +4623 -0
  180. package/src/services/sms.ts +7255 -0
  181. package/src/services/sslgateway.ts +1408 -0
  182. package/src/services/storagenetapp.ts +2433 -0
  183. package/src/services/support.ts +598 -0
  184. package/src/services/telephony.ts +32941 -0
  185. package/src/services/vmwareclouddirectorbackup.ts +2171 -0
  186. package/src/services/vmwareclouddirectororganization.ts +2171 -0
  187. package/src/services/vps.ts +5134 -0
  188. package/src/services/vrack.ts +3730 -0
  189. package/src/services/vrackservices.ts +939 -0
  190. package/src/services/webhosting.ts +11290 -0
  191. package/src/services/xdsl.ts +9278 -0
  192. package/src/traits.ts +44 -0
@@ -0,0 +1,2693 @@
1
+ // AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-ovh). Do not edit.
2
+ import * as S from "@distilled.cloud/core/schema";
3
+ import * as API from "@distilled.cloud/core/api";
4
+ import * as T from "../traits.ts";
5
+ import {
6
+ OvhProtocol,
7
+ type OvhOpError,
8
+ type OvhOpContext,
9
+ } from "../protocol.ts";
10
+ import { UnknownOvhError } from "../errors.ts";
11
+ import * as Retry from "../retry.ts";
12
+
13
+ export type { OvhOpError, OvhOpContext };
14
+
15
+ export interface AuthorizeOverTheBoxRemoteAccessRequest {
16
+ /** The internal name of your overTheBox offer */
17
+ serviceName: string;
18
+ /** The id of the remote access */
19
+ remoteAccessId: string;
20
+ }
21
+ export const AuthorizeOverTheBoxRemoteAccessRequest = /*@__PURE__*/ S.suspend(
22
+ () =>
23
+ S.Struct({
24
+ serviceName: S.String.pipe(T.Label()),
25
+ remoteAccessId: S.String.pipe(T.Label()),
26
+ }).pipe(
27
+ T.Http({
28
+ method: "POST",
29
+ uri: "/overTheBox/{serviceName}/remoteAccesses/{remoteAccessId}/authorize",
30
+ code: 200,
31
+ }),
32
+ ),
33
+ ).annotate({
34
+ identifier: "AuthorizeOverTheBoxRemoteAccessRequest",
35
+ }) as any as S.Schema<AuthorizeOverTheBoxRemoteAccessRequest>;
36
+
37
+ export interface AuthorizeOverTheBoxRemoteAccessResponse {}
38
+ export const AuthorizeOverTheBoxRemoteAccessResponse = /*@__PURE__*/ S.suspend(
39
+ () => S.Struct({}),
40
+ ).annotate({
41
+ identifier: "AuthorizeOverTheBoxRemoteAccessResponse",
42
+ }) as any as S.Schema<AuthorizeOverTheBoxRemoteAccessResponse>;
43
+
44
+ export interface CancelOverTheBoxResiliationRequest {
45
+ /** The internal name of your overTheBox offer */
46
+ serviceName: string;
47
+ }
48
+ export const CancelOverTheBoxResiliationRequest = /*@__PURE__*/ S.suspend(() =>
49
+ S.Struct({
50
+ serviceName: S.String.pipe(T.Label()),
51
+ }).pipe(
52
+ T.Http({
53
+ method: "POST",
54
+ uri: "/overTheBox/{serviceName}/cancelResiliation",
55
+ code: 200,
56
+ }),
57
+ ),
58
+ ).annotate({
59
+ identifier: "CancelOverTheBoxResiliationRequest",
60
+ }) as any as S.Schema<CancelOverTheBoxResiliationRequest>;
61
+
62
+ export interface CancelOverTheBoxResiliationResponse {}
63
+ export const CancelOverTheBoxResiliationResponse = /*@__PURE__*/ S.suspend(() =>
64
+ S.Struct({}),
65
+ ).annotate({
66
+ identifier: "CancelOverTheBoxResiliationResponse",
67
+ }) as any as S.Schema<CancelOverTheBoxResiliationResponse>;
68
+
69
+ export interface CreateOverTheBoxChangeContactRequest {
70
+ /** The internal name of your overTheBox offer */
71
+ serviceName: string;
72
+ /** The contact to set as admin contact */
73
+ contactAdmin?: string;
74
+ /** The contact to set as billing contact */
75
+ contactBilling?: string;
76
+ /** The contact to set as tech contact */
77
+ contactTech?: string;
78
+ }
79
+ export const CreateOverTheBoxChangeContactRequest = /*@__PURE__*/ S.suspend(
80
+ () =>
81
+ S.Struct({
82
+ serviceName: S.String.pipe(T.Label()),
83
+ contactAdmin: S.optional(S.String),
84
+ contactBilling: S.optional(S.String),
85
+ contactTech: S.optional(S.String),
86
+ }).pipe(
87
+ T.Http({
88
+ method: "POST",
89
+ uri: "/overTheBox/{serviceName}/changeContact",
90
+ code: 200,
91
+ }),
92
+ ),
93
+ ).annotate({
94
+ identifier: "CreateOverTheBoxChangeContactRequest",
95
+ }) as any as S.Schema<CreateOverTheBoxChangeContactRequest>;
96
+
97
+ export type CreateOverTheBoxChangeContactResponseBodyList = Array<number>;
98
+ export const CreateOverTheBoxChangeContactResponseBodyList =
99
+ /*@__PURE__*/ S.Array(
100
+ S.Number,
101
+ ) as any as S.Schema<CreateOverTheBoxChangeContactResponseBodyList>;
102
+
103
+ export type CreateOverTheBoxChangeContactResponse =
104
+ CreateOverTheBoxChangeContactResponseBodyList;
105
+ export const CreateOverTheBoxChangeContactResponse = /*@__PURE__*/ S.suspend(
106
+ () => CreateOverTheBoxChangeContactResponseBodyList.pipe(T.RawResponseRoot()),
107
+ ).annotate({
108
+ identifier: "CreateOverTheBoxChangeContactResponse",
109
+ }) as any as S.Schema<CreateOverTheBoxChangeContactResponse>;
110
+
111
+ export interface CreateOverTheBoxDeviceRequest {}
112
+ export const CreateOverTheBoxDeviceRequest = /*@__PURE__*/ S.suspend(() =>
113
+ S.Struct({}).pipe(
114
+ T.Http({ method: "POST", uri: "/overTheBox/devices", code: 200 }),
115
+ ),
116
+ ).annotate({
117
+ identifier: "CreateOverTheBoxDeviceRequest",
118
+ }) as any as S.Schema<CreateOverTheBoxDeviceRequest>;
119
+
120
+ /** A device for registration */
121
+ export interface OverTheBoxDeviceForRegistration {
122
+ /** Whether or not this device is actived */
123
+ activated?: boolean;
124
+ deviceId?: string;
125
+ /** The last time this device was seen on the provisionning servers */
126
+ lastSeen?: string;
127
+ }
128
+ export const OverTheBoxDeviceForRegistration = /*@__PURE__*/ S.suspend(() =>
129
+ S.Struct({
130
+ activated: S.optional(S.Boolean),
131
+ deviceId: S.optional(S.String),
132
+ lastSeen: S.optional(S.String),
133
+ }),
134
+ ).annotate({
135
+ identifier: "OverTheBoxDeviceForRegistration",
136
+ }) as any as S.Schema<OverTheBoxDeviceForRegistration>;
137
+
138
+ export type CreateOverTheBoxDeviceResponseBodyList =
139
+ Array<OverTheBoxDeviceForRegistration>;
140
+ export const CreateOverTheBoxDeviceResponseBodyList = /*@__PURE__*/ S.Array(
141
+ OverTheBoxDeviceForRegistration,
142
+ ) as any as S.Schema<CreateOverTheBoxDeviceResponseBodyList>;
143
+
144
+ export type CreateOverTheBoxDeviceResponse =
145
+ CreateOverTheBoxDeviceResponseBodyList;
146
+ export const CreateOverTheBoxDeviceResponse = /*@__PURE__*/ S.suspend(() =>
147
+ CreateOverTheBoxDeviceResponseBodyList.pipe(T.RawResponseRoot()),
148
+ ).annotate({
149
+ identifier: "CreateOverTheBoxDeviceResponse",
150
+ }) as any as S.Schema<CreateOverTheBoxDeviceResponse>;
151
+
152
+ export interface CreateOverTheBoxDeviceActionRequest {
153
+ /** The internal name of your overTheBox offer */
154
+ serviceName: string;
155
+ /** Name of the action */
156
+ name: string;
157
+ }
158
+ export const CreateOverTheBoxDeviceActionRequest = /*@__PURE__*/ S.suspend(() =>
159
+ S.Struct({
160
+ serviceName: S.String.pipe(T.Label()),
161
+ name: S.String,
162
+ }).pipe(
163
+ T.Http({
164
+ method: "POST",
165
+ uri: "/overTheBox/{serviceName}/device/actions",
166
+ code: 200,
167
+ }),
168
+ ),
169
+ ).annotate({
170
+ identifier: "CreateOverTheBoxDeviceActionRequest",
171
+ }) as any as S.Schema<CreateOverTheBoxDeviceActionRequest>;
172
+
173
+ /** Status of a task. */
174
+ export type OverTheBoxActionStatusEnum = "doing" | "done" | "error" | "todo";
175
+ export const OverTheBoxActionStatusEnum = /*@__PURE__*/ S.String;
176
+
177
+ /** Device action */
178
+ export interface OverTheBoxDeviceAction {
179
+ /** The id of the action */
180
+ actionId?: string;
181
+ /** Date of creation of the action */
182
+ createdAt?: string;
183
+ /** The details of the action */
184
+ details?: string;
185
+ /** The name of the action */
186
+ name?: string;
187
+ /** The status of the action */
188
+ status?: OverTheBoxActionStatusEnum;
189
+ /** Date of execution of the action */
190
+ todoDate?: string;
191
+ /** Last time the action was updated */
192
+ updatedAt?: string;
193
+ }
194
+ export const OverTheBoxDeviceAction = /*@__PURE__*/ S.suspend(() =>
195
+ S.Struct({
196
+ actionId: S.optional(S.String),
197
+ createdAt: S.optional(S.String),
198
+ details: S.optional(S.String),
199
+ name: S.optional(S.String),
200
+ status: S.optional(OverTheBoxActionStatusEnum),
201
+ todoDate: S.optional(S.String),
202
+ updatedAt: S.optional(S.String),
203
+ }),
204
+ ).annotate({
205
+ identifier: "OverTheBoxDeviceAction",
206
+ }) as any as S.Schema<OverTheBoxDeviceAction>;
207
+
208
+ export interface CreateOverTheBoxDeviceBackupRequest {
209
+ /** The internal name of your overTheBox offer */
210
+ serviceName: string;
211
+ }
212
+ export const CreateOverTheBoxDeviceBackupRequest = /*@__PURE__*/ S.suspend(() =>
213
+ S.Struct({
214
+ serviceName: S.String.pipe(T.Label()),
215
+ }).pipe(
216
+ T.Http({
217
+ method: "POST",
218
+ uri: "/overTheBox/{serviceName}/device/backup",
219
+ code: 200,
220
+ }),
221
+ ),
222
+ ).annotate({
223
+ identifier: "CreateOverTheBoxDeviceBackupRequest",
224
+ }) as any as S.Schema<CreateOverTheBoxDeviceBackupRequest>;
225
+
226
+ export interface CreateOverTheBoxDeviceLogRequest {
227
+ /** The internal name of your overTheBox offer */
228
+ serviceName: string;
229
+ }
230
+ export const CreateOverTheBoxDeviceLogRequest = /*@__PURE__*/ S.suspend(() =>
231
+ S.Struct({
232
+ serviceName: S.String.pipe(T.Label()),
233
+ }).pipe(
234
+ T.Http({
235
+ method: "POST",
236
+ uri: "/overTheBox/{serviceName}/device/logs",
237
+ code: 200,
238
+ }),
239
+ ),
240
+ ).annotate({
241
+ identifier: "CreateOverTheBoxDeviceLogRequest",
242
+ }) as any as S.Schema<CreateOverTheBoxDeviceLogRequest>;
243
+
244
+ /** Temporary url informations */
245
+ export interface OverTheBoxTemporaryLogsLink {
246
+ /** Temporary url expiration date */
247
+ expirationDate?: string;
248
+ /** Temporary url */
249
+ url?: string;
250
+ }
251
+ export const OverTheBoxTemporaryLogsLink = /*@__PURE__*/ S.suspend(() =>
252
+ S.Struct({
253
+ expirationDate: S.optional(S.String),
254
+ url: S.optional(S.String),
255
+ }),
256
+ ).annotate({
257
+ identifier: "OverTheBoxTemporaryLogsLink",
258
+ }) as any as S.Schema<OverTheBoxTemporaryLogsLink>;
259
+
260
+ export interface CreateOverTheBoxLinkDeviceRequest {
261
+ /** The internal name of your overTheBox offer */
262
+ serviceName: string;
263
+ /** The id of the device */
264
+ deviceId: string;
265
+ }
266
+ export const CreateOverTheBoxLinkDeviceRequest = /*@__PURE__*/ S.suspend(() =>
267
+ S.Struct({
268
+ serviceName: S.String.pipe(T.Label()),
269
+ deviceId: S.String,
270
+ }).pipe(
271
+ T.Http({
272
+ method: "POST",
273
+ uri: "/overTheBox/{serviceName}/linkDevice",
274
+ code: 200,
275
+ }),
276
+ ),
277
+ ).annotate({
278
+ identifier: "CreateOverTheBoxLinkDeviceRequest",
279
+ }) as any as S.Schema<CreateOverTheBoxLinkDeviceRequest>;
280
+
281
+ export interface CreateOverTheBoxLinkDeviceResponse {}
282
+ export const CreateOverTheBoxLinkDeviceResponse = /*@__PURE__*/ S.suspend(() =>
283
+ S.Struct({}),
284
+ ).annotate({
285
+ identifier: "CreateOverTheBoxLinkDeviceResponse",
286
+ }) as any as S.Schema<CreateOverTheBoxLinkDeviceResponse>;
287
+
288
+ export interface CreateOverTheBoxLinkHardwareRequest {
289
+ /** The internal name of your overTheBox offer */
290
+ serviceName: string;
291
+ /** The internal name of your hardware */
292
+ hardwareName: string;
293
+ }
294
+ export const CreateOverTheBoxLinkHardwareRequest = /*@__PURE__*/ S.suspend(() =>
295
+ S.Struct({
296
+ serviceName: S.String.pipe(T.Label()),
297
+ hardwareName: S.String,
298
+ }).pipe(
299
+ T.Http({
300
+ method: "POST",
301
+ uri: "/overTheBox/{serviceName}/linkHardware",
302
+ code: 200,
303
+ }),
304
+ ),
305
+ ).annotate({
306
+ identifier: "CreateOverTheBoxLinkHardwareRequest",
307
+ }) as any as S.Schema<CreateOverTheBoxLinkHardwareRequest>;
308
+
309
+ export interface CreateOverTheBoxLinkHardwareResponse {}
310
+ export const CreateOverTheBoxLinkHardwareResponse = /*@__PURE__*/ S.suspend(
311
+ () => S.Struct({}),
312
+ ).annotate({
313
+ identifier: "CreateOverTheBoxLinkHardwareResponse",
314
+ }) as any as S.Schema<CreateOverTheBoxLinkHardwareResponse>;
315
+
316
+ export interface CreateOverTheBoxMigrationChangeOfferRequest {
317
+ /** The internal name of your overTheBox offer */
318
+ serviceName: string;
319
+ /** Name of the hardware */
320
+ hardwareName?: string;
321
+ /** Offer name to migrate to */
322
+ offer: string;
323
+ /** In case of hardware and if a shipping custom address is desired */
324
+ shippingContactID?: string;
325
+ }
326
+ export const CreateOverTheBoxMigrationChangeOfferRequest =
327
+ /*@__PURE__*/ S.suspend(() =>
328
+ S.Struct({
329
+ serviceName: S.String.pipe(T.Label()),
330
+ hardwareName: S.optional(S.String),
331
+ offer: S.String,
332
+ shippingContactID: S.optional(S.String),
333
+ }).pipe(
334
+ T.Http({
335
+ method: "POST",
336
+ uri: "/overTheBox/{serviceName}/migration/changeOffers",
337
+ code: 200,
338
+ }),
339
+ ),
340
+ ).annotate({
341
+ identifier: "CreateOverTheBoxMigrationChangeOfferRequest",
342
+ }) as any as S.Schema<CreateOverTheBoxMigrationChangeOfferRequest>;
343
+
344
+ /** Migration order */
345
+ export interface OverTheBoxOrderMigration {
346
+ /** Id of the migration order */
347
+ orderId?: string;
348
+ /** URL of the migration order */
349
+ orderUrl?: string;
350
+ }
351
+ export const OverTheBoxOrderMigration = /*@__PURE__*/ S.suspend(() =>
352
+ S.Struct({
353
+ orderId: S.optional(S.String),
354
+ orderUrl: S.optional(S.String),
355
+ }),
356
+ ).annotate({
357
+ identifier: "OverTheBoxOrderMigration",
358
+ }) as any as S.Schema<OverTheBoxOrderMigration>;
359
+
360
+ export interface CreateOverTheBoxRemoteAccessRequest {
361
+ /** The internal name of your overTheBox offer */
362
+ serviceName: string;
363
+ /** IP block from which the remote access will be allowed (the default value is the IP from which the call is made) */
364
+ allowedIp?: string;
365
+ /** The expirationDate of the remote access (default 1 day) */
366
+ expirationDate?: string;
367
+ /** The port that the device will expose */
368
+ exposedPort: number;
369
+ /** The remote user public key authorized on the device (for SSH purpose) */
370
+ publicKey?: string;
371
+ }
372
+ export const CreateOverTheBoxRemoteAccessRequest = /*@__PURE__*/ S.suspend(() =>
373
+ S.Struct({
374
+ serviceName: S.String.pipe(T.Label()),
375
+ allowedIp: S.optional(S.String),
376
+ expirationDate: S.optional(S.String),
377
+ exposedPort: S.Number,
378
+ publicKey: S.optional(S.String),
379
+ }).pipe(
380
+ T.Http({
381
+ method: "POST",
382
+ uri: "/overTheBox/{serviceName}/remoteAccesses",
383
+ code: 200,
384
+ }),
385
+ ),
386
+ ).annotate({
387
+ identifier: "CreateOverTheBoxRemoteAccessRequest",
388
+ }) as any as S.Schema<CreateOverTheBoxRemoteAccessRequest>;
389
+
390
+ /** All the infos needed to connect yourself to your OTB */
391
+ export interface OverTheBoxRemoteAccessConnectionInfos {
392
+ /** IP to connect to when accessing the device remotely */
393
+ ip?: string | null;
394
+ /** Port to connect to when accessing the device remotely */
395
+ port?: number | null;
396
+ }
397
+ export const OverTheBoxRemoteAccessConnectionInfos = /*@__PURE__*/ S.suspend(
398
+ () =>
399
+ S.Struct({
400
+ ip: S.optional(S.NullOr(S.String)),
401
+ port: S.optional(S.NullOr(S.Number)),
402
+ }),
403
+ ).annotate({
404
+ identifier: "OverTheBoxRemoteAccessConnectionInfos",
405
+ }) as any as S.Schema<OverTheBoxRemoteAccessConnectionInfos>;
406
+
407
+ /** Infos about the remote user */
408
+ export interface OverTheBoxRemoteAccessUserInfos {
409
+ /** IP from which the remote access will be allowed */
410
+ ip?: string;
411
+ /** The public key authorized on the device (for SSH purpose) */
412
+ publicKey?: string | null;
413
+ /** The user that will access the device remotely */
414
+ user?: string;
415
+ }
416
+ export const OverTheBoxRemoteAccessUserInfos = /*@__PURE__*/ S.suspend(() =>
417
+ S.Struct({
418
+ ip: S.optional(S.String),
419
+ publicKey: S.optional(S.NullOr(S.String)),
420
+ user: S.optional(S.String),
421
+ }),
422
+ ).annotate({
423
+ identifier: "OverTheBoxRemoteAccessUserInfos",
424
+ }) as any as S.Schema<OverTheBoxRemoteAccessUserInfos>;
425
+
426
+ /** Status of the remote access. */
427
+ export type OverTheBoxRemoteAccessStatusEnum =
428
+ | "active"
429
+ | "creating"
430
+ | "deleted"
431
+ | "deleting"
432
+ | "pendingValidation"
433
+ | "recreating"
434
+ | "toDelete"
435
+ | "toRecreate";
436
+ export const OverTheBoxRemoteAccessStatusEnum = /*@__PURE__*/ S.String;
437
+
438
+ /** If authorized, a remote access will expose a port, allowing an access to the device remotely */
439
+ export interface OverTheBoxRemoteAccess {
440
+ /** If the remote access was accepted by the remote user */
441
+ accepted?: boolean;
442
+ /** The date of the remote access demand */
443
+ askDate?: string;
444
+ /** The user that authorized the remote access */
445
+ authorizedBy?: string | null;
446
+ /** All the infos needed to connect yourself to your OTB */
447
+ connectionInfos?: OverTheBoxRemoteAccessConnectionInfos;
448
+ /** When the remote access was deleted */
449
+ deletedAt?: string | null;
450
+ /** Info about the docker version */
451
+ dockerVersion?: string;
452
+ /** When the remote access will be automatically deleted */
453
+ expirationDate?: string;
454
+ /** The device's port which will be exposed */
455
+ exposedPort?: number;
456
+ /** The id of the remote access */
457
+ remoteAccessId?: string;
458
+ /** Infos about the remote user */
459
+ remoteUserInfos?: OverTheBoxRemoteAccessUserInfos;
460
+ /** Status of the remote access */
461
+ status?: OverTheBoxRemoteAccessStatusEnum;
462
+ }
463
+ export const OverTheBoxRemoteAccess = /*@__PURE__*/ S.suspend(() =>
464
+ S.Struct({
465
+ accepted: S.optional(S.Boolean),
466
+ askDate: S.optional(S.String),
467
+ authorizedBy: S.optional(S.NullOr(S.String)),
468
+ connectionInfos: S.optional(OverTheBoxRemoteAccessConnectionInfos),
469
+ deletedAt: S.optional(S.NullOr(S.String)),
470
+ dockerVersion: S.optional(S.String),
471
+ expirationDate: S.optional(S.String),
472
+ exposedPort: S.optional(S.Number),
473
+ remoteAccessId: S.optional(S.String),
474
+ remoteUserInfos: S.optional(OverTheBoxRemoteAccessUserInfos),
475
+ status: S.optional(OverTheBoxRemoteAccessStatusEnum),
476
+ }),
477
+ ).annotate({
478
+ identifier: "OverTheBoxRemoteAccess",
479
+ }) as any as S.Schema<OverTheBoxRemoteAccess>;
480
+
481
+ export interface DeleteOverTheBoxRequest {
482
+ /** The internal name of your overTheBox offer */
483
+ serviceName: string;
484
+ }
485
+ export const DeleteOverTheBoxRequest = /*@__PURE__*/ S.suspend(() =>
486
+ S.Struct({
487
+ serviceName: S.String.pipe(T.Label()),
488
+ }).pipe(
489
+ T.Http({ method: "DELETE", uri: "/overTheBox/{serviceName}", code: 200 }),
490
+ ),
491
+ ).annotate({
492
+ identifier: "DeleteOverTheBoxRequest",
493
+ }) as any as S.Schema<DeleteOverTheBoxRequest>;
494
+
495
+ export interface DeleteOverTheBoxResponse {}
496
+ export const DeleteOverTheBoxResponse = /*@__PURE__*/ S.suspend(() =>
497
+ S.Struct({}),
498
+ ).annotate({
499
+ identifier: "DeleteOverTheBoxResponse",
500
+ }) as any as S.Schema<DeleteOverTheBoxResponse>;
501
+
502
+ export interface DeleteOverTheBoxBackupRequest {
503
+ /** The internal name of your overTheBox offer */
504
+ serviceName: string;
505
+ /** The id of the backup */
506
+ backupId: string;
507
+ }
508
+ export const DeleteOverTheBoxBackupRequest = /*@__PURE__*/ S.suspend(() =>
509
+ S.Struct({
510
+ serviceName: S.String.pipe(T.Label()),
511
+ backupId: S.String.pipe(T.Label()),
512
+ }).pipe(
513
+ T.Http({
514
+ method: "DELETE",
515
+ uri: "/overTheBox/{serviceName}/backups/{backupId}",
516
+ code: 200,
517
+ }),
518
+ ),
519
+ ).annotate({
520
+ identifier: "DeleteOverTheBoxBackupRequest",
521
+ }) as any as S.Schema<DeleteOverTheBoxBackupRequest>;
522
+
523
+ export interface DeleteOverTheBoxBackupResponse {}
524
+ export const DeleteOverTheBoxBackupResponse = /*@__PURE__*/ S.suspend(() =>
525
+ S.Struct({}),
526
+ ).annotate({
527
+ identifier: "DeleteOverTheBoxBackupResponse",
528
+ }) as any as S.Schema<DeleteOverTheBoxBackupResponse>;
529
+
530
+ export interface DeleteOverTheBoxDeviceRequest {
531
+ /** The internal name of your overTheBox offer */
532
+ serviceName: string;
533
+ }
534
+ export const DeleteOverTheBoxDeviceRequest = /*@__PURE__*/ S.suspend(() =>
535
+ S.Struct({
536
+ serviceName: S.String.pipe(T.Label()),
537
+ }).pipe(
538
+ T.Http({
539
+ method: "DELETE",
540
+ uri: "/overTheBox/{serviceName}/device",
541
+ code: 200,
542
+ }),
543
+ ),
544
+ ).annotate({
545
+ identifier: "DeleteOverTheBoxDeviceRequest",
546
+ }) as any as S.Schema<DeleteOverTheBoxDeviceRequest>;
547
+
548
+ export interface DeleteOverTheBoxDeviceResponse {}
549
+ export const DeleteOverTheBoxDeviceResponse = /*@__PURE__*/ S.suspend(() =>
550
+ S.Struct({}),
551
+ ).annotate({
552
+ identifier: "DeleteOverTheBoxDeviceResponse",
553
+ }) as any as S.Schema<DeleteOverTheBoxDeviceResponse>;
554
+
555
+ export interface DeleteOverTheBoxRemoteAccessRequest {
556
+ /** The internal name of your overTheBox offer */
557
+ serviceName: string;
558
+ /** The id of the remote access */
559
+ remoteAccessId: string;
560
+ }
561
+ export const DeleteOverTheBoxRemoteAccessRequest = /*@__PURE__*/ S.suspend(() =>
562
+ S.Struct({
563
+ serviceName: S.String.pipe(T.Label()),
564
+ remoteAccessId: S.String.pipe(T.Label()),
565
+ }).pipe(
566
+ T.Http({
567
+ method: "DELETE",
568
+ uri: "/overTheBox/{serviceName}/remoteAccesses/{remoteAccessId}",
569
+ code: 200,
570
+ }),
571
+ ),
572
+ ).annotate({
573
+ identifier: "DeleteOverTheBoxRemoteAccessRequest",
574
+ }) as any as S.Schema<DeleteOverTheBoxRemoteAccessRequest>;
575
+
576
+ export interface DeleteOverTheBoxRemoteAccessResponse {}
577
+ export const DeleteOverTheBoxRemoteAccessResponse = /*@__PURE__*/ S.suspend(
578
+ () => S.Struct({}),
579
+ ).annotate({
580
+ identifier: "DeleteOverTheBoxRemoteAccessResponse",
581
+ }) as any as S.Schema<DeleteOverTheBoxRemoteAccessResponse>;
582
+
583
+ export interface GetOverTheBoxRequest {
584
+ /** The internal name of your overTheBox offer */
585
+ serviceName: string;
586
+ }
587
+ export const GetOverTheBoxRequest = /*@__PURE__*/ S.suspend(() =>
588
+ S.Struct({
589
+ serviceName: S.String.pipe(T.Label()),
590
+ }).pipe(
591
+ T.Http({ method: "GET", uri: "/overTheBox/{serviceName}", code: 200 }),
592
+ ),
593
+ ).annotate({
594
+ identifier: "GetOverTheBoxRequest",
595
+ }) as any as S.Schema<GetOverTheBoxRequest>;
596
+
597
+ /** Status of the service */
598
+ export type OverTheBoxAvailableStatusEnum = "disabled" | "enabled";
599
+ export const OverTheBoxAvailableStatusEnum = /*@__PURE__*/ S.String;
600
+
601
+ /** Configuration mode of the service */
602
+ export type OverTheBoxServiceConfigurationModeEnum = "autoconfigure" | "local";
603
+ export const OverTheBoxServiceConfigurationModeEnum = /*@__PURE__*/ S.String;
604
+
605
+ /** Parameters required to query metrics from OpenTSDB */
606
+ export interface OverTheBoxGraphEndpoint {
607
+ /** The OpenTSDB host */
608
+ host?: string;
609
+ /** A read-only token */
610
+ readToken?: string;
611
+ /** The read-only token ID */
612
+ readTokenID?: string;
613
+ }
614
+ export const OverTheBoxGraphEndpoint = /*@__PURE__*/ S.suspend(() =>
615
+ S.Struct({
616
+ host: S.optional(S.String),
617
+ readToken: S.optional(S.String),
618
+ readTokenID: S.optional(S.String),
619
+ }),
620
+ ).annotate({
621
+ identifier: "OverTheBoxGraphEndpoint",
622
+ }) as any as S.Schema<OverTheBoxGraphEndpoint>;
623
+
624
+ /** Resource tags. Tags that were internally computed are prefixed with ovh: */
625
+ export type IamResourceMetadataTagsMap = { [key: string]: string | undefined };
626
+ export const IamResourceMetadataTagsMap = /*@__PURE__*/ S.Record(
627
+ S.String,
628
+ S.String,
629
+ ) as any as S.Schema<IamResourceMetadataTagsMap>;
630
+
631
+ /** IAM resource metadata embedded in services models */
632
+ export interface IamResourceMetadata {
633
+ /** Resource display name */
634
+ displayName?: string | null;
635
+ /** Unique identifier of the resource */
636
+ id?: string;
637
+ /** Resource tags. Tags that were internally computed are prefixed with ovh: */
638
+ tags?: IamResourceMetadataTagsMap | null;
639
+ /** Unique resource name used in policies */
640
+ urn?: string;
641
+ }
642
+ export const IamResourceMetadata = /*@__PURE__*/ S.suspend(() =>
643
+ S.Struct({
644
+ displayName: S.optional(S.NullOr(S.String)),
645
+ id: S.optional(S.String),
646
+ tags: S.optional(S.NullOr(IamResourceMetadataTagsMap)),
647
+ urn: S.optional(S.String),
648
+ }),
649
+ ).annotate({
650
+ identifier: "IamResourceMetadata",
651
+ }) as any as S.Schema<IamResourceMetadata>;
652
+
653
+ /** Status of the service. */
654
+ export type OverTheBoxServiceStatusEnum =
655
+ | "active"
656
+ | "creating"
657
+ | "deleted"
658
+ | "suspended"
659
+ | "toCreate"
660
+ | "toDelete";
661
+ export const OverTheBoxServiceStatusEnum = /*@__PURE__*/ S.String;
662
+
663
+ /** Tunnel mode of the service. */
664
+ export type OverTheBoxTunnelModeEnum =
665
+ | "glorytun"
666
+ | "glorytun_hybrid"
667
+ | "glorytun_mud";
668
+ export const OverTheBoxTunnelModeEnum = /*@__PURE__*/ S.String;
669
+
670
+ /** Service */
671
+ export interface OverTheBoxServiceWithIAM {
672
+ /** If the socks proxy is enabled */
673
+ SOCKSProxyEnabled?: boolean;
674
+ /** The status of the autoMTU */
675
+ autoMTU?: OverTheBoxAvailableStatusEnum;
676
+ /** Enable device auto upgrade */
677
+ autoUpgrade?: boolean;
678
+ /** The service maximum bandwidth in bits */
679
+ bandwidth?: number;
680
+ /** Configuration mode of the service */
681
+ configurationMode?: OverTheBoxServiceConfigurationModeEnum;
682
+ /** Editable field for customer */
683
+ customerDescription?: string | null;
684
+ /** Parameters needed to fetch metrics */
685
+ graphEndpoint?: OverTheBoxGraphEndpoint | null;
686
+ /** IAM resource metadata */
687
+ iam?: IamResourceMetadata | null;
688
+ /** Indicates if IPv6 is enabled */
689
+ ipv6Enabled?: boolean;
690
+ /** The service offer */
691
+ offer?: string;
692
+ /** The service pretty offer name */
693
+ prettyOfferName?: string;
694
+ /** Release channel of the service */
695
+ releaseChannel?: string;
696
+ /** The name of the service */
697
+ serviceName?: string;
698
+ /** The status of the service */
699
+ status?: OverTheBoxServiceStatusEnum;
700
+ /** The tunnel mode of the service */
701
+ tunnelMode?: OverTheBoxTunnelModeEnum;
702
+ }
703
+ export const OverTheBoxServiceWithIAM = /*@__PURE__*/ S.suspend(() =>
704
+ S.Struct({
705
+ SOCKSProxyEnabled: S.optional(S.Boolean),
706
+ autoMTU: S.optional(OverTheBoxAvailableStatusEnum),
707
+ autoUpgrade: S.optional(S.Boolean),
708
+ bandwidth: S.optional(S.Number),
709
+ configurationMode: S.optional(OverTheBoxServiceConfigurationModeEnum),
710
+ customerDescription: S.optional(S.NullOr(S.String)),
711
+ graphEndpoint: S.optional(S.NullOr(OverTheBoxGraphEndpoint)),
712
+ iam: S.optional(S.NullOr(IamResourceMetadata)),
713
+ ipv6Enabled: S.optional(S.Boolean),
714
+ offer: S.optional(S.String),
715
+ prettyOfferName: S.optional(S.String),
716
+ releaseChannel: S.optional(S.String),
717
+ serviceName: S.optional(S.String),
718
+ status: S.optional(OverTheBoxServiceStatusEnum),
719
+ tunnelMode: S.optional(OverTheBoxTunnelModeEnum),
720
+ }),
721
+ ).annotate({
722
+ identifier: "OverTheBoxServiceWithIAM",
723
+ }) as any as S.Schema<OverTheBoxServiceWithIAM>;
724
+
725
+ export interface GetOverTheBoxBackupRequest {
726
+ /** The internal name of your overTheBox offer */
727
+ serviceName: string;
728
+ /** The id of the backup */
729
+ backupId: string;
730
+ }
731
+ export const GetOverTheBoxBackupRequest = /*@__PURE__*/ S.suspend(() =>
732
+ S.Struct({
733
+ serviceName: S.String.pipe(T.Label()),
734
+ backupId: S.String.pipe(T.Label()),
735
+ }).pipe(
736
+ T.Http({
737
+ method: "GET",
738
+ uri: "/overTheBox/{serviceName}/backups/{backupId}",
739
+ code: 200,
740
+ }),
741
+ ),
742
+ ).annotate({
743
+ identifier: "GetOverTheBoxBackupRequest",
744
+ }) as any as S.Schema<GetOverTheBoxBackupRequest>;
745
+
746
+ /** Backup */
747
+ export interface OverTheBoxBackup {
748
+ /** The id of the backup */
749
+ backupId?: string;
750
+ /** Date of the creation of the backup */
751
+ createdAt?: string;
752
+ /** The id of the device action that triggered the backup */
753
+ deviceActionId?: string | null;
754
+ }
755
+ export const OverTheBoxBackup = /*@__PURE__*/ S.suspend(() =>
756
+ S.Struct({
757
+ backupId: S.optional(S.String),
758
+ createdAt: S.optional(S.String),
759
+ deviceActionId: S.optional(S.NullOr(S.String)),
760
+ }),
761
+ ).annotate({
762
+ identifier: "OverTheBoxBackup",
763
+ }) as any as S.Schema<OverTheBoxBackup>;
764
+
765
+ export interface GetOverTheBoxDeviceRequest {
766
+ /** The internal name of your overTheBox offer */
767
+ serviceName: string;
768
+ }
769
+ export const GetOverTheBoxDeviceRequest = /*@__PURE__*/ S.suspend(() =>
770
+ S.Struct({
771
+ serviceName: S.String.pipe(T.Label()),
772
+ }).pipe(
773
+ T.Http({
774
+ method: "GET",
775
+ uri: "/overTheBox/{serviceName}/device",
776
+ code: 200,
777
+ }),
778
+ ),
779
+ ).annotate({
780
+ identifier: "GetOverTheBoxDeviceRequest",
781
+ }) as any as S.Schema<GetOverTheBoxDeviceRequest>;
782
+
783
+ /** The DNS servers of this interface */
784
+ export type OverTheBoxDeviceInterfaceDnsServersList = Array<string>;
785
+ export const OverTheBoxDeviceInterfaceDnsServersList = /*@__PURE__*/ S.Array(
786
+ S.String,
787
+ ) as any as S.Schema<OverTheBoxDeviceInterfaceDnsServersList>;
788
+
789
+ /** Status of a MPTCP Interface. */
790
+ export type OverTheBoxMultipathStatusEnum =
791
+ | "backup"
792
+ | "handover"
793
+ | "master"
794
+ | "off"
795
+ | "on";
796
+ export const OverTheBoxMultipathStatusEnum = /*@__PURE__*/ S.String;
797
+
798
+ /** Infos about a network interface */
799
+ export interface OverTheBoxDeviceInterface {
800
+ /** Device of the interface */
801
+ device?: string | null;
802
+ /** The DNS servers of this interface */
803
+ dnsServers?: OverTheBoxDeviceInterfaceDnsServersList | null;
804
+ /** Gateway of the interface */
805
+ gateway?: string | null;
806
+ /** IP of the interface */
807
+ ip?: string | null;
808
+ /** Status of MPTCP on this interface */
809
+ multipathStatus?: OverTheBoxMultipathStatusEnum;
810
+ /** Name of the interface */
811
+ name?: string;
812
+ /** Netmask of the interface */
813
+ netmask?: string | null;
814
+ /** Public IP of the interface */
815
+ publicIp?: string | null;
816
+ }
817
+ export const OverTheBoxDeviceInterface = /*@__PURE__*/ S.suspend(() =>
818
+ S.Struct({
819
+ device: S.optional(S.NullOr(S.String)),
820
+ dnsServers: S.optional(S.NullOr(OverTheBoxDeviceInterfaceDnsServersList)),
821
+ gateway: S.optional(S.NullOr(S.String)),
822
+ ip: S.optional(S.NullOr(S.String)),
823
+ multipathStatus: S.optional(OverTheBoxMultipathStatusEnum),
824
+ name: S.optional(S.String),
825
+ netmask: S.optional(S.NullOr(S.String)),
826
+ publicIp: S.optional(S.NullOr(S.String)),
827
+ }),
828
+ ).annotate({
829
+ identifier: "OverTheBoxDeviceInterface",
830
+ }) as any as S.Schema<OverTheBoxDeviceInterface>;
831
+
832
+ /** Network interfaces of the device */
833
+ export type OverTheBoxDeviceNetworkInterfacesList =
834
+ Array<OverTheBoxDeviceInterface>;
835
+ export const OverTheBoxDeviceNetworkInterfacesList = /*@__PURE__*/ S.Array(
836
+ OverTheBoxDeviceInterface,
837
+ ) as any as S.Schema<OverTheBoxDeviceNetworkInterfacesList>;
838
+
839
+ /** Infos about a device system */
840
+ export interface OverTheBoxDeviceSystem {
841
+ /** Device CPU */
842
+ cpu?: string | null;
843
+ /** Device hostname */
844
+ hostname?: string | null;
845
+ /** Device linux kernel version */
846
+ kernel?: string | null;
847
+ /** Device mac address (first interface mac) */
848
+ mac?: string | null;
849
+ /** Device model */
850
+ model?: string | null;
851
+ /** Name of the device board */
852
+ name?: string | null;
853
+ /** OVH offer name of the device board */
854
+ offerName?: string | null;
855
+ /** OVH name of the device board */
856
+ ovhName?: string | null;
857
+ }
858
+ export const OverTheBoxDeviceSystem = /*@__PURE__*/ S.suspend(() =>
859
+ S.Struct({
860
+ cpu: S.optional(S.NullOr(S.String)),
861
+ hostname: S.optional(S.NullOr(S.String)),
862
+ kernel: S.optional(S.NullOr(S.String)),
863
+ mac: S.optional(S.NullOr(S.String)),
864
+ model: S.optional(S.NullOr(S.String)),
865
+ name: S.optional(S.NullOr(S.String)),
866
+ offerName: S.optional(S.NullOr(S.String)),
867
+ ovhName: S.optional(S.NullOr(S.String)),
868
+ }),
869
+ ).annotate({
870
+ identifier: "OverTheBoxDeviceSystem",
871
+ }) as any as S.Schema<OverTheBoxDeviceSystem>;
872
+
873
+ /** Device */
874
+ export interface OverTheBoxDevice {
875
+ /** Whether or not this device is associated to a service */
876
+ activated?: boolean;
877
+ /** Whether or not an upate is available for this device */
878
+ availableUpdate?: boolean;
879
+ /** The id of the device */
880
+ deviceId?: string;
881
+ /** Last time the device has been seen on the provisionning servers */
882
+ lastSeen?: string;
883
+ /** Network interfaces of the device */
884
+ networkInterfaces?: OverTheBoxDeviceNetworkInterfacesList;
885
+ /** The public IP of the device */
886
+ publicIp?: string;
887
+ /** Device system information */
888
+ system?: OverTheBoxDeviceSystem | null;
889
+ /** System version of the device */
890
+ systemVersion?: string;
891
+ /** Version of the device */
892
+ version?: string;
893
+ }
894
+ export const OverTheBoxDevice = /*@__PURE__*/ S.suspend(() =>
895
+ S.Struct({
896
+ activated: S.optional(S.Boolean),
897
+ availableUpdate: S.optional(S.Boolean),
898
+ deviceId: S.optional(S.String),
899
+ lastSeen: S.optional(S.String),
900
+ networkInterfaces: S.optional(OverTheBoxDeviceNetworkInterfacesList),
901
+ publicIp: S.optional(S.String),
902
+ system: S.optional(S.NullOr(OverTheBoxDeviceSystem)),
903
+ systemVersion: S.optional(S.String),
904
+ version: S.optional(S.String),
905
+ }),
906
+ ).annotate({
907
+ identifier: "OverTheBoxDevice",
908
+ }) as any as S.Schema<OverTheBoxDevice>;
909
+
910
+ export interface GetOverTheBoxDeviceActionRequest {
911
+ /** The internal name of your overTheBox offer */
912
+ serviceName: string;
913
+ /** The id of the action */
914
+ actionId: string;
915
+ }
916
+ export const GetOverTheBoxDeviceActionRequest = /*@__PURE__*/ S.suspend(() =>
917
+ S.Struct({
918
+ serviceName: S.String.pipe(T.Label()),
919
+ actionId: S.String.pipe(T.Label()),
920
+ }).pipe(
921
+ T.Http({
922
+ method: "GET",
923
+ uri: "/overTheBox/{serviceName}/device/actions/{actionId}",
924
+ code: 200,
925
+ }),
926
+ ),
927
+ ).annotate({
928
+ identifier: "GetOverTheBoxDeviceActionRequest",
929
+ }) as any as S.Schema<GetOverTheBoxDeviceActionRequest>;
930
+
931
+ export interface GetOverTheBoxDeviceHardwareRequest {
932
+ /** The internal name of your overTheBox offer */
933
+ serviceName: string;
934
+ }
935
+ export const GetOverTheBoxDeviceHardwareRequest = /*@__PURE__*/ S.suspend(() =>
936
+ S.Struct({
937
+ serviceName: S.String.pipe(T.Label()),
938
+ }).pipe(
939
+ T.Http({
940
+ method: "GET",
941
+ uri: "/overTheBox/{serviceName}/device/hardware",
942
+ code: 200,
943
+ }),
944
+ ),
945
+ ).annotate({
946
+ identifier: "GetOverTheBoxDeviceHardwareRequest",
947
+ }) as any as S.Schema<GetOverTheBoxDeviceHardwareRequest>;
948
+
949
+ /** Hardware properties */
950
+ export interface OverTheBoxHardware {
951
+ /** True if hardware can be linked to a service without deviceID */
952
+ canBeLinkedToService?: boolean;
953
+ /** Hardware MAC address */
954
+ mac?: string | null;
955
+ /** Hardware model */
956
+ model?: string;
957
+ /** Hardware name */
958
+ name?: string;
959
+ /** The hardware pretty model name */
960
+ prettyModelName?: string;
961
+ /** Hardware serial */
962
+ serial?: string;
963
+ }
964
+ export const OverTheBoxHardware = /*@__PURE__*/ S.suspend(() =>
965
+ S.Struct({
966
+ canBeLinkedToService: S.optional(S.Boolean),
967
+ mac: S.optional(S.NullOr(S.String)),
968
+ model: S.optional(S.String),
969
+ name: S.optional(S.String),
970
+ prettyModelName: S.optional(S.String),
971
+ serial: S.optional(S.String),
972
+ }),
973
+ ).annotate({
974
+ identifier: "OverTheBoxHardware",
975
+ }) as any as S.Schema<OverTheBoxHardware>;
976
+
977
+ export interface GetOverTheBoxHardwareRequest {
978
+ /** The internal name of your hardware */
979
+ hardwareName: string;
980
+ }
981
+ export const GetOverTheBoxHardwareRequest = /*@__PURE__*/ S.suspend(() =>
982
+ S.Struct({
983
+ hardwareName: S.String.pipe(T.Label()),
984
+ }).pipe(
985
+ T.Http({
986
+ method: "GET",
987
+ uri: "/overTheBox/hardware/{hardwareName}",
988
+ code: 200,
989
+ }),
990
+ ),
991
+ ).annotate({
992
+ identifier: "GetOverTheBoxHardwareRequest",
993
+ }) as any as S.Schema<GetOverTheBoxHardwareRequest>;
994
+
995
+ /** Hardware properties */
996
+ export interface OverTheBoxHardwareWithIAM {
997
+ /** True if hardware can be linked to a service without deviceID */
998
+ canBeLinkedToService?: boolean;
999
+ /** IAM resource metadata */
1000
+ iam?: IamResourceMetadata | null;
1001
+ /** Hardware MAC address */
1002
+ mac?: string | null;
1003
+ /** Hardware model */
1004
+ model?: string;
1005
+ /** Hardware name */
1006
+ name?: string;
1007
+ /** The hardware pretty model name */
1008
+ prettyModelName?: string;
1009
+ /** Hardware serial */
1010
+ serial?: string;
1011
+ }
1012
+ export const OverTheBoxHardwareWithIAM = /*@__PURE__*/ S.suspend(() =>
1013
+ S.Struct({
1014
+ canBeLinkedToService: S.optional(S.Boolean),
1015
+ iam: S.optional(S.NullOr(IamResourceMetadata)),
1016
+ mac: S.optional(S.NullOr(S.String)),
1017
+ model: S.optional(S.String),
1018
+ name: S.optional(S.String),
1019
+ prettyModelName: S.optional(S.String),
1020
+ serial: S.optional(S.String),
1021
+ }),
1022
+ ).annotate({
1023
+ identifier: "OverTheBoxHardwareWithIAM",
1024
+ }) as any as S.Schema<OverTheBoxHardwareWithIAM>;
1025
+
1026
+ export interface GetOverTheBoxIpsRequest {
1027
+ /** The internal name of your overTheBox offer */
1028
+ serviceName: string;
1029
+ /** Ip */
1030
+ ip: string;
1031
+ }
1032
+ export const GetOverTheBoxIpsRequest = /*@__PURE__*/ S.suspend(() =>
1033
+ S.Struct({
1034
+ serviceName: S.String.pipe(T.Label()),
1035
+ ip: S.String.pipe(T.Label()),
1036
+ }).pipe(
1037
+ T.Http({
1038
+ method: "GET",
1039
+ uri: "/overTheBox/{serviceName}/ips/{ip}",
1040
+ code: 200,
1041
+ }),
1042
+ ),
1043
+ ).annotate({
1044
+ identifier: "GetOverTheBoxIpsRequest",
1045
+ }) as any as S.Schema<GetOverTheBoxIpsRequest>;
1046
+
1047
+ /** IP geolocation */
1048
+ export type OtbServiceIpGeolocationEnum = "fr";
1049
+ export const OtbServiceIpGeolocationEnum = /*@__PURE__*/ S.String;
1050
+
1051
+ /** IP status */
1052
+ export type OtbServiceIpStatusEnum =
1053
+ | "active"
1054
+ | "free"
1055
+ | "pendingRelease"
1056
+ | "released"
1057
+ | "reserved";
1058
+ export const OtbServiceIpStatusEnum = /*@__PURE__*/ S.String;
1059
+
1060
+ /** IP version */
1061
+ export type OtbServiceIpVersionEnum = "v4" | "v6";
1062
+ export const OtbServiceIpVersionEnum = /*@__PURE__*/ S.String;
1063
+
1064
+ /** Service IP details */
1065
+ export interface OtbServiceIp {
1066
+ /** IP geolocation */
1067
+ geolocation?: OtbServiceIpGeolocationEnum;
1068
+ /** IP address */
1069
+ ip?: string;
1070
+ /** IP cidr prefix */
1071
+ range?: number;
1072
+ /** IP status */
1073
+ status?: OtbServiceIpStatusEnum;
1074
+ /** IP version */
1075
+ version?: OtbServiceIpVersionEnum;
1076
+ }
1077
+ export const OtbServiceIp = /*@__PURE__*/ S.suspend(() =>
1078
+ S.Struct({
1079
+ geolocation: S.optional(OtbServiceIpGeolocationEnum),
1080
+ ip: S.optional(S.String),
1081
+ range: S.optional(S.Number),
1082
+ status: S.optional(OtbServiceIpStatusEnum),
1083
+ version: S.optional(OtbServiceIpVersionEnum),
1084
+ }),
1085
+ ).annotate({ identifier: "OtbServiceIp" }) as any as S.Schema<OtbServiceIp>;
1086
+
1087
+ export interface GetOverTheBoxRemoteAccessRequest {
1088
+ /** The internal name of your overTheBox offer */
1089
+ serviceName: string;
1090
+ /** The id of the remote access */
1091
+ remoteAccessId: string;
1092
+ }
1093
+ export const GetOverTheBoxRemoteAccessRequest = /*@__PURE__*/ S.suspend(() =>
1094
+ S.Struct({
1095
+ serviceName: S.String.pipe(T.Label()),
1096
+ remoteAccessId: S.String.pipe(T.Label()),
1097
+ }).pipe(
1098
+ T.Http({
1099
+ method: "GET",
1100
+ uri: "/overTheBox/{serviceName}/remoteAccesses/{remoteAccessId}",
1101
+ code: 200,
1102
+ }),
1103
+ ),
1104
+ ).annotate({
1105
+ identifier: "GetOverTheBoxRemoteAccessRequest",
1106
+ }) as any as S.Schema<GetOverTheBoxRemoteAccessRequest>;
1107
+
1108
+ export interface GetOverTheBoxServiceInfosRequest {
1109
+ /** The internal name of your overTheBox offer */
1110
+ serviceName: string;
1111
+ }
1112
+ export const GetOverTheBoxServiceInfosRequest = /*@__PURE__*/ S.suspend(() =>
1113
+ S.Struct({
1114
+ serviceName: S.String.pipe(T.Label()),
1115
+ }).pipe(
1116
+ T.Http({
1117
+ method: "GET",
1118
+ uri: "/overTheBox/{serviceName}/serviceInfos",
1119
+ code: 200,
1120
+ }),
1121
+ ),
1122
+ ).annotate({
1123
+ identifier: "GetOverTheBoxServiceInfosRequest",
1124
+ }) as any as S.Schema<GetOverTheBoxServiceInfosRequest>;
1125
+
1126
+ /** All the possible renew period of your service in month */
1127
+ export type ServicesServicePossibleRenewPeriodList = Array<number>;
1128
+ export const ServicesServicePossibleRenewPeriodList = /*@__PURE__*/ S.Array(
1129
+ S.Number,
1130
+ ) as any as S.Schema<ServicesServicePossibleRenewPeriodList>;
1131
+
1132
+ /** Map a possible renew for a specific service */
1133
+ export interface ServiceRenewType {
1134
+ /** The service is automatically renewed */
1135
+ automatic?: boolean;
1136
+ /** The service will be deleted at expiration */
1137
+ deleteAtExpiration?: boolean;
1138
+ /** The service forced to be renewed */
1139
+ forced?: boolean;
1140
+ /** The service needs to be manually renewed and paid */
1141
+ manualPayment?: boolean | null;
1142
+ /** period of renew in month */
1143
+ period?: number | null;
1144
+ }
1145
+ export const ServiceRenewType = /*@__PURE__*/ S.suspend(() =>
1146
+ S.Struct({
1147
+ automatic: S.optional(S.Boolean),
1148
+ deleteAtExpiration: S.optional(S.Boolean),
1149
+ forced: S.optional(S.Boolean),
1150
+ manualPayment: S.optional(S.NullOr(S.Boolean)),
1151
+ period: S.optional(S.NullOr(S.Number)),
1152
+ }),
1153
+ ).annotate({
1154
+ identifier: "ServiceRenewType",
1155
+ }) as any as S.Schema<ServiceRenewType>;
1156
+
1157
+ /** Detailed renewal type of a service */
1158
+ export type ServiceRenewalTypeEnum =
1159
+ | "automaticForcedProduct"
1160
+ | "automaticV2012"
1161
+ | "automaticV2014"
1162
+ | "automaticV2016"
1163
+ | "automaticV2024"
1164
+ | "manual"
1165
+ | "oneShot"
1166
+ | "option";
1167
+ export const ServiceRenewalTypeEnum = /*@__PURE__*/ S.String;
1168
+
1169
+ export type ServiceStateEnum =
1170
+ | "autorenewInProgress"
1171
+ | "expired"
1172
+ | "inCreation"
1173
+ | "ok"
1174
+ | "pendingDebt"
1175
+ | "unPaid";
1176
+ export const ServiceStateEnum = /*@__PURE__*/ S.String;
1177
+
1178
+ /** Details about a Service */
1179
+ export interface ServicesService {
1180
+ /** Indicates that the service can be set up to be deleted at expiration */
1181
+ canDeleteAtExpiration?: boolean;
1182
+ contactAdmin?: string;
1183
+ contactBilling?: string;
1184
+ contactTech?: string;
1185
+ creation?: string;
1186
+ domain?: string;
1187
+ engagedUpTo?: string | null;
1188
+ expiration?: string;
1189
+ /** All the possible renew period of your service in month */
1190
+ possibleRenewPeriod?: ServicesServicePossibleRenewPeriodList | null;
1191
+ /** Way of handling the renew */
1192
+ renew?: ServiceRenewType | null;
1193
+ renewalType?: ServiceRenewalTypeEnum;
1194
+ serviceId?: number;
1195
+ status?: ServiceStateEnum;
1196
+ }
1197
+ export const ServicesService = /*@__PURE__*/ S.suspend(() =>
1198
+ S.Struct({
1199
+ canDeleteAtExpiration: S.optional(S.Boolean),
1200
+ contactAdmin: S.optional(S.String),
1201
+ contactBilling: S.optional(S.String),
1202
+ contactTech: S.optional(S.String),
1203
+ creation: S.optional(S.String),
1204
+ domain: S.optional(S.String),
1205
+ engagedUpTo: S.optional(S.NullOr(S.String)),
1206
+ expiration: S.optional(S.String),
1207
+ possibleRenewPeriod: S.optional(
1208
+ S.NullOr(ServicesServicePossibleRenewPeriodList),
1209
+ ),
1210
+ renew: S.optional(S.NullOr(ServiceRenewType)),
1211
+ renewalType: S.optional(ServiceRenewalTypeEnum),
1212
+ serviceId: S.optional(S.Number),
1213
+ status: S.optional(ServiceStateEnum),
1214
+ }),
1215
+ ).annotate({
1216
+ identifier: "ServicesService",
1217
+ }) as any as S.Schema<ServicesService>;
1218
+
1219
+ export interface GetOverTheBoxTaskRequest {
1220
+ /** The internal name of your overTheBox offer */
1221
+ serviceName: string;
1222
+ /** The id of the task */
1223
+ taskId: string;
1224
+ }
1225
+ export const GetOverTheBoxTaskRequest = /*@__PURE__*/ S.suspend(() =>
1226
+ S.Struct({
1227
+ serviceName: S.String.pipe(T.Label()),
1228
+ taskId: S.String.pipe(T.Label()),
1229
+ }).pipe(
1230
+ T.Http({
1231
+ method: "GET",
1232
+ uri: "/overTheBox/{serviceName}/tasks/{taskId}",
1233
+ code: 200,
1234
+ }),
1235
+ ),
1236
+ ).annotate({
1237
+ identifier: "GetOverTheBoxTaskRequest",
1238
+ }) as any as S.Schema<GetOverTheBoxTaskRequest>;
1239
+
1240
+ /** Status of a task. */
1241
+ export type OverTheBoxTaskStatusEnum = "doing" | "done" | "error" | "todo";
1242
+ export const OverTheBoxTaskStatusEnum = /*@__PURE__*/ S.String;
1243
+
1244
+ /** Task */
1245
+ export interface OverTheBoxTask {
1246
+ /** The name of the task */
1247
+ name?: string;
1248
+ /** The status of the task */
1249
+ status?: OverTheBoxTaskStatusEnum;
1250
+ /** The id of the task */
1251
+ taskId?: string;
1252
+ }
1253
+ export const OverTheBoxTask = /*@__PURE__*/ S.suspend(() =>
1254
+ S.Struct({
1255
+ name: S.optional(S.String),
1256
+ status: S.optional(OverTheBoxTaskStatusEnum),
1257
+ taskId: S.optional(S.String),
1258
+ }),
1259
+ ).annotate({ identifier: "OverTheBoxTask" }) as any as S.Schema<OverTheBoxTask>;
1260
+
1261
+ /** Resource tag filter */
1262
+ export interface IamResourceTagFilterInput {}
1263
+ export const IamResourceTagFilterInput = /*@__PURE__*/ S.suspend(() =>
1264
+ S.Struct({}),
1265
+ ).annotate({
1266
+ identifier: "IamResourceTagFilterInput",
1267
+ }) as any as S.Schema<IamResourceTagFilterInput>;
1268
+
1269
+ export type ListOverTheBoxRequestIamTagsValueList =
1270
+ Array<IamResourceTagFilterInput>;
1271
+ export const ListOverTheBoxRequestIamTagsValueList = /*@__PURE__*/ S.Array(
1272
+ IamResourceTagFilterInput,
1273
+ ) as any as S.Schema<ListOverTheBoxRequestIamTagsValueList>;
1274
+
1275
+ export type ListOverTheBoxRequestIamTagsMap = {
1276
+ [key: string]: ListOverTheBoxRequestIamTagsValueList | undefined;
1277
+ };
1278
+ export const ListOverTheBoxRequestIamTagsMap = /*@__PURE__*/ S.Record(
1279
+ S.String,
1280
+ ListOverTheBoxRequestIamTagsValueList,
1281
+ ) as any as S.Schema<ListOverTheBoxRequestIamTagsMap>;
1282
+
1283
+ export interface ListOverTheBoxRequest {
1284
+ /** Filter resources on IAM tags */
1285
+ iamTags?: ListOverTheBoxRequestIamTagsMap;
1286
+ }
1287
+ export const ListOverTheBoxRequest = /*@__PURE__*/ S.suspend(() =>
1288
+ S.Struct({
1289
+ iamTags: S.optional(ListOverTheBoxRequestIamTagsMap.pipe(T.Query())),
1290
+ }).pipe(T.Http({ method: "GET", uri: "/overTheBox", code: 200 })),
1291
+ ).annotate({
1292
+ identifier: "ListOverTheBoxRequest",
1293
+ }) as any as S.Schema<ListOverTheBoxRequest>;
1294
+
1295
+ export type ListOverTheBoxResponseBodyList = Array<string>;
1296
+ export const ListOverTheBoxResponseBodyList = /*@__PURE__*/ S.Array(
1297
+ S.String,
1298
+ ) as any as S.Schema<ListOverTheBoxResponseBodyList>;
1299
+
1300
+ export type ListOverTheBoxResponse = ListOverTheBoxResponseBodyList;
1301
+ export const ListOverTheBoxResponse = /*@__PURE__*/ S.suspend(() =>
1302
+ ListOverTheBoxResponseBodyList.pipe(T.RawResponseRoot()),
1303
+ ).annotate({
1304
+ identifier: "ListOverTheBoxResponse",
1305
+ }) as any as S.Schema<ListOverTheBoxResponse>;
1306
+
1307
+ export interface ListOverTheBoxAvailableOffersRequest {}
1308
+ export const ListOverTheBoxAvailableOffersRequest = /*@__PURE__*/ S.suspend(
1309
+ () =>
1310
+ S.Struct({}).pipe(
1311
+ T.Http({ method: "GET", uri: "/overTheBox/availableOffers", code: 200 }),
1312
+ ),
1313
+ ).annotate({
1314
+ identifier: "ListOverTheBoxAvailableOffersRequest",
1315
+ }) as any as S.Schema<ListOverTheBoxAvailableOffersRequest>;
1316
+
1317
+ /** Enum of Offers */
1318
+ export type PriceOverTheBoxOfferEnum = "business.v1" | "plus.v1" | "starter.v1";
1319
+ export const PriceOverTheBoxOfferEnum = /*@__PURE__*/ S.String;
1320
+
1321
+ export type ListOverTheBoxAvailableOffersResponseBodyList =
1322
+ Array<PriceOverTheBoxOfferEnum>;
1323
+ export const ListOverTheBoxAvailableOffersResponseBodyList =
1324
+ /*@__PURE__*/ S.Array(
1325
+ PriceOverTheBoxOfferEnum,
1326
+ ) as any as S.Schema<ListOverTheBoxAvailableOffersResponseBodyList>;
1327
+
1328
+ export type ListOverTheBoxAvailableOffersResponse =
1329
+ ListOverTheBoxAvailableOffersResponseBodyList;
1330
+ export const ListOverTheBoxAvailableOffersResponse = /*@__PURE__*/ S.suspend(
1331
+ () => ListOverTheBoxAvailableOffersResponseBodyList.pipe(T.RawResponseRoot()),
1332
+ ).annotate({
1333
+ identifier: "ListOverTheBoxAvailableOffersResponse",
1334
+ }) as any as S.Schema<ListOverTheBoxAvailableOffersResponse>;
1335
+
1336
+ export interface ListOverTheBoxAvailableReleaseChannelsRequest {
1337
+ /** The internal name of your overTheBox offer */
1338
+ serviceName: string;
1339
+ }
1340
+ export const ListOverTheBoxAvailableReleaseChannelsRequest =
1341
+ /*@__PURE__*/ S.suspend(() =>
1342
+ S.Struct({
1343
+ serviceName: S.String.pipe(T.Label()),
1344
+ }).pipe(
1345
+ T.Http({
1346
+ method: "GET",
1347
+ uri: "/overTheBox/{serviceName}/availableReleaseChannels",
1348
+ code: 200,
1349
+ }),
1350
+ ),
1351
+ ).annotate({
1352
+ identifier: "ListOverTheBoxAvailableReleaseChannelsRequest",
1353
+ }) as any as S.Schema<ListOverTheBoxAvailableReleaseChannelsRequest>;
1354
+
1355
+ export type ListOverTheBoxAvailableReleaseChannelsResponseBodyList =
1356
+ Array<string>;
1357
+ export const ListOverTheBoxAvailableReleaseChannelsResponseBodyList =
1358
+ /*@__PURE__*/ S.Array(
1359
+ S.String,
1360
+ ) as any as S.Schema<ListOverTheBoxAvailableReleaseChannelsResponseBodyList>;
1361
+
1362
+ export type ListOverTheBoxAvailableReleaseChannelsResponse =
1363
+ ListOverTheBoxAvailableReleaseChannelsResponseBodyList;
1364
+ export const ListOverTheBoxAvailableReleaseChannelsResponse =
1365
+ /*@__PURE__*/ S.suspend(() =>
1366
+ ListOverTheBoxAvailableReleaseChannelsResponseBodyList.pipe(
1367
+ T.RawResponseRoot(),
1368
+ ),
1369
+ ).annotate({
1370
+ identifier: "ListOverTheBoxAvailableReleaseChannelsResponse",
1371
+ }) as any as S.Schema<ListOverTheBoxAvailableReleaseChannelsResponse>;
1372
+
1373
+ export interface ListOverTheBoxBackupsRequest {
1374
+ /** The internal name of your overTheBox offer */
1375
+ serviceName: string;
1376
+ }
1377
+ export const ListOverTheBoxBackupsRequest = /*@__PURE__*/ S.suspend(() =>
1378
+ S.Struct({
1379
+ serviceName: S.String.pipe(T.Label()),
1380
+ }).pipe(
1381
+ T.Http({
1382
+ method: "GET",
1383
+ uri: "/overTheBox/{serviceName}/backups",
1384
+ code: 200,
1385
+ }),
1386
+ ),
1387
+ ).annotate({
1388
+ identifier: "ListOverTheBoxBackupsRequest",
1389
+ }) as any as S.Schema<ListOverTheBoxBackupsRequest>;
1390
+
1391
+ export type ListOverTheBoxBackupsResponseBodyList = Array<string>;
1392
+ export const ListOverTheBoxBackupsResponseBodyList = /*@__PURE__*/ S.Array(
1393
+ S.String,
1394
+ ) as any as S.Schema<ListOverTheBoxBackupsResponseBodyList>;
1395
+
1396
+ export type ListOverTheBoxBackupsResponse =
1397
+ ListOverTheBoxBackupsResponseBodyList;
1398
+ export const ListOverTheBoxBackupsResponse = /*@__PURE__*/ S.suspend(() =>
1399
+ ListOverTheBoxBackupsResponseBodyList.pipe(T.RawResponseRoot()),
1400
+ ).annotate({
1401
+ identifier: "ListOverTheBoxBackupsResponse",
1402
+ }) as any as S.Schema<ListOverTheBoxBackupsResponse>;
1403
+
1404
+ export interface ListOverTheBoxDeviceActionsRequest {
1405
+ /** The internal name of your overTheBox offer */
1406
+ serviceName: string;
1407
+ /** Filter the value of name property (=) */
1408
+ name?: string;
1409
+ /** Filter the value of status property (=) */
1410
+ status?: OverTheBoxActionStatusEnum | (string & {});
1411
+ }
1412
+ export const ListOverTheBoxDeviceActionsRequest = /*@__PURE__*/ S.suspend(() =>
1413
+ S.Struct({
1414
+ serviceName: S.String.pipe(T.Label()),
1415
+ name: S.optional(S.String.pipe(T.Query())),
1416
+ status: S.optional(OverTheBoxActionStatusEnum.pipe(T.Query())),
1417
+ }).pipe(
1418
+ T.Http({
1419
+ method: "GET",
1420
+ uri: "/overTheBox/{serviceName}/device/actions",
1421
+ code: 200,
1422
+ }),
1423
+ ),
1424
+ ).annotate({
1425
+ identifier: "ListOverTheBoxDeviceActionsRequest",
1426
+ }) as any as S.Schema<ListOverTheBoxDeviceActionsRequest>;
1427
+
1428
+ export type ListOverTheBoxDeviceActionsResponseBodyList = Array<string>;
1429
+ export const ListOverTheBoxDeviceActionsResponseBodyList =
1430
+ /*@__PURE__*/ S.Array(
1431
+ S.String,
1432
+ ) as any as S.Schema<ListOverTheBoxDeviceActionsResponseBodyList>;
1433
+
1434
+ export type ListOverTheBoxDeviceActionsResponse =
1435
+ ListOverTheBoxDeviceActionsResponseBodyList;
1436
+ export const ListOverTheBoxDeviceActionsResponse = /*@__PURE__*/ S.suspend(() =>
1437
+ ListOverTheBoxDeviceActionsResponseBodyList.pipe(T.RawResponseRoot()),
1438
+ ).annotate({
1439
+ identifier: "ListOverTheBoxDeviceActionsResponse",
1440
+ }) as any as S.Schema<ListOverTheBoxDeviceActionsResponse>;
1441
+
1442
+ export interface ListOverTheBoxDeviceAvailableActionsRequest {
1443
+ /** The internal name of your overTheBox offer */
1444
+ serviceName: string;
1445
+ }
1446
+ export const ListOverTheBoxDeviceAvailableActionsRequest =
1447
+ /*@__PURE__*/ S.suspend(() =>
1448
+ S.Struct({
1449
+ serviceName: S.String.pipe(T.Label()),
1450
+ }).pipe(
1451
+ T.Http({
1452
+ method: "GET",
1453
+ uri: "/overTheBox/{serviceName}/device/availableActions",
1454
+ code: 200,
1455
+ }),
1456
+ ),
1457
+ ).annotate({
1458
+ identifier: "ListOverTheBoxDeviceAvailableActionsRequest",
1459
+ }) as any as S.Schema<ListOverTheBoxDeviceAvailableActionsRequest>;
1460
+
1461
+ /** Device action */
1462
+ export interface OverTheBoxAvailableDeviceAction {
1463
+ /** Description of the action */
1464
+ description?: string;
1465
+ /** Name of the action */
1466
+ name?: string;
1467
+ }
1468
+ export const OverTheBoxAvailableDeviceAction = /*@__PURE__*/ S.suspend(() =>
1469
+ S.Struct({
1470
+ description: S.optional(S.String),
1471
+ name: S.optional(S.String),
1472
+ }),
1473
+ ).annotate({
1474
+ identifier: "OverTheBoxAvailableDeviceAction",
1475
+ }) as any as S.Schema<OverTheBoxAvailableDeviceAction>;
1476
+
1477
+ export type ListOverTheBoxDeviceAvailableActionsResponseBodyList =
1478
+ Array<OverTheBoxAvailableDeviceAction>;
1479
+ export const ListOverTheBoxDeviceAvailableActionsResponseBodyList =
1480
+ /*@__PURE__*/ S.Array(
1481
+ OverTheBoxAvailableDeviceAction,
1482
+ ) as any as S.Schema<ListOverTheBoxDeviceAvailableActionsResponseBodyList>;
1483
+
1484
+ export type ListOverTheBoxDeviceAvailableActionsResponse =
1485
+ ListOverTheBoxDeviceAvailableActionsResponseBodyList;
1486
+ export const ListOverTheBoxDeviceAvailableActionsResponse =
1487
+ /*@__PURE__*/ S.suspend(() =>
1488
+ ListOverTheBoxDeviceAvailableActionsResponseBodyList.pipe(
1489
+ T.RawResponseRoot(),
1490
+ ),
1491
+ ).annotate({
1492
+ identifier: "ListOverTheBoxDeviceAvailableActionsResponse",
1493
+ }) as any as S.Schema<ListOverTheBoxDeviceAvailableActionsResponse>;
1494
+
1495
+ export type ListOverTheBoxHardwareRequestIamTagsValueList =
1496
+ Array<IamResourceTagFilterInput>;
1497
+ export const ListOverTheBoxHardwareRequestIamTagsValueList =
1498
+ /*@__PURE__*/ S.Array(
1499
+ IamResourceTagFilterInput,
1500
+ ) as any as S.Schema<ListOverTheBoxHardwareRequestIamTagsValueList>;
1501
+
1502
+ export type ListOverTheBoxHardwareRequestIamTagsMap = {
1503
+ [key: string]: ListOverTheBoxHardwareRequestIamTagsValueList | undefined;
1504
+ };
1505
+ export const ListOverTheBoxHardwareRequestIamTagsMap = /*@__PURE__*/ S.Record(
1506
+ S.String,
1507
+ ListOverTheBoxHardwareRequestIamTagsValueList,
1508
+ ) as any as S.Schema<ListOverTheBoxHardwareRequestIamTagsMap>;
1509
+
1510
+ export interface ListOverTheBoxHardwareRequest {
1511
+ /** Filter resources on IAM tags */
1512
+ iamTags?: ListOverTheBoxHardwareRequestIamTagsMap;
1513
+ }
1514
+ export const ListOverTheBoxHardwareRequest = /*@__PURE__*/ S.suspend(() =>
1515
+ S.Struct({
1516
+ iamTags: S.optional(
1517
+ ListOverTheBoxHardwareRequestIamTagsMap.pipe(T.Query()),
1518
+ ),
1519
+ }).pipe(T.Http({ method: "GET", uri: "/overTheBox/hardware", code: 200 })),
1520
+ ).annotate({
1521
+ identifier: "ListOverTheBoxHardwareRequest",
1522
+ }) as any as S.Schema<ListOverTheBoxHardwareRequest>;
1523
+
1524
+ export type ListOverTheBoxHardwareResponseBodyList = Array<string>;
1525
+ export const ListOverTheBoxHardwareResponseBodyList = /*@__PURE__*/ S.Array(
1526
+ S.String,
1527
+ ) as any as S.Schema<ListOverTheBoxHardwareResponseBodyList>;
1528
+
1529
+ export type ListOverTheBoxHardwareResponse =
1530
+ ListOverTheBoxHardwareResponseBodyList;
1531
+ export const ListOverTheBoxHardwareResponse = /*@__PURE__*/ S.suspend(() =>
1532
+ ListOverTheBoxHardwareResponseBodyList.pipe(T.RawResponseRoot()),
1533
+ ).annotate({
1534
+ identifier: "ListOverTheBoxHardwareResponse",
1535
+ }) as any as S.Schema<ListOverTheBoxHardwareResponse>;
1536
+
1537
+ export interface ListOverTheBoxHardwareAvailableRequest {}
1538
+ export const ListOverTheBoxHardwareAvailableRequest = /*@__PURE__*/ S.suspend(
1539
+ () =>
1540
+ S.Struct({}).pipe(
1541
+ T.Http({
1542
+ method: "GET",
1543
+ uri: "/overTheBox/hardware/available",
1544
+ code: 200,
1545
+ }),
1546
+ ),
1547
+ ).annotate({
1548
+ identifier: "ListOverTheBoxHardwareAvailableRequest",
1549
+ }) as any as S.Schema<ListOverTheBoxHardwareAvailableRequest>;
1550
+
1551
+ export type ListOverTheBoxHardwareAvailableResponseBodyList = Array<string>;
1552
+ export const ListOverTheBoxHardwareAvailableResponseBodyList =
1553
+ /*@__PURE__*/ S.Array(
1554
+ S.String,
1555
+ ) as any as S.Schema<ListOverTheBoxHardwareAvailableResponseBodyList>;
1556
+
1557
+ export type ListOverTheBoxHardwareAvailableResponse =
1558
+ ListOverTheBoxHardwareAvailableResponseBodyList;
1559
+ export const ListOverTheBoxHardwareAvailableResponse = /*@__PURE__*/ S.suspend(
1560
+ () =>
1561
+ ListOverTheBoxHardwareAvailableResponseBodyList.pipe(T.RawResponseRoot()),
1562
+ ).annotate({
1563
+ identifier: "ListOverTheBoxHardwareAvailableResponse",
1564
+ }) as any as S.Schema<ListOverTheBoxHardwareAvailableResponse>;
1565
+
1566
+ export interface ListOverTheBoxIpsRequest {
1567
+ /** The internal name of your overTheBox offer */
1568
+ serviceName: string;
1569
+ }
1570
+ export const ListOverTheBoxIpsRequest = /*@__PURE__*/ S.suspend(() =>
1571
+ S.Struct({
1572
+ serviceName: S.String.pipe(T.Label()),
1573
+ }).pipe(
1574
+ T.Http({ method: "GET", uri: "/overTheBox/{serviceName}/ips", code: 200 }),
1575
+ ),
1576
+ ).annotate({
1577
+ identifier: "ListOverTheBoxIpsRequest",
1578
+ }) as any as S.Schema<ListOverTheBoxIpsRequest>;
1579
+
1580
+ export type ListOverTheBoxIpsResponseBodyList = Array<string>;
1581
+ export const ListOverTheBoxIpsResponseBodyList = /*@__PURE__*/ S.Array(
1582
+ S.String,
1583
+ ) as any as S.Schema<ListOverTheBoxIpsResponseBodyList>;
1584
+
1585
+ export type ListOverTheBoxIpsResponse = ListOverTheBoxIpsResponseBodyList;
1586
+ export const ListOverTheBoxIpsResponse = /*@__PURE__*/ S.suspend(() =>
1587
+ ListOverTheBoxIpsResponseBodyList.pipe(T.RawResponseRoot()),
1588
+ ).annotate({
1589
+ identifier: "ListOverTheBoxIpsResponse",
1590
+ }) as any as S.Schema<ListOverTheBoxIpsResponse>;
1591
+
1592
+ export interface ListOverTheBoxMigrationOffersRequest {
1593
+ /** The internal name of your overTheBox offer */
1594
+ serviceName: string;
1595
+ }
1596
+ export const ListOverTheBoxMigrationOffersRequest = /*@__PURE__*/ S.suspend(
1597
+ () =>
1598
+ S.Struct({
1599
+ serviceName: S.String.pipe(T.Label()),
1600
+ }).pipe(
1601
+ T.Http({
1602
+ method: "GET",
1603
+ uri: "/overTheBox/{serviceName}/migration/offers",
1604
+ code: 200,
1605
+ }),
1606
+ ),
1607
+ ).annotate({
1608
+ identifier: "ListOverTheBoxMigrationOffersRequest",
1609
+ }) as any as S.Schema<ListOverTheBoxMigrationOffersRequest>;
1610
+
1611
+ export type OrderCurrencyCodeEnum =
1612
+ | "AUD"
1613
+ | "CAD"
1614
+ | "CZK"
1615
+ | "EUR"
1616
+ | "GBP"
1617
+ | "INR"
1618
+ | "LTL"
1619
+ | "MAD"
1620
+ | "N/A"
1621
+ | "PLN"
1622
+ | "SGD"
1623
+ | "TND"
1624
+ | "USD"
1625
+ | "XOF"
1626
+ | "points";
1627
+ export const OrderCurrencyCodeEnum = /*@__PURE__*/ S.String;
1628
+
1629
+ /** Price with it's currency and textual representation */
1630
+ export interface OrderPrice {
1631
+ currencyCode?: OrderCurrencyCodeEnum;
1632
+ text?: string;
1633
+ value?: number;
1634
+ }
1635
+ export const OrderPrice = /*@__PURE__*/ S.suspend(() =>
1636
+ S.Struct({
1637
+ currencyCode: S.optional(OrderCurrencyCodeEnum),
1638
+ text: S.optional(S.String),
1639
+ value: S.optional(S.Number),
1640
+ }),
1641
+ ).annotate({ identifier: "OrderPrice" }) as any as S.Schema<OrderPrice>;
1642
+
1643
+ /** Details of available hardwares */
1644
+ export interface OverTheBoxHardwareDetails {
1645
+ /** Pretty hardware model name */
1646
+ hardwareDisplayName?: string | null;
1647
+ /** Name of the hardware */
1648
+ hardwareName?: string | null;
1649
+ /** Hardware purchase price */
1650
+ hardwarePrice?: OrderPrice | null;
1651
+ }
1652
+ export const OverTheBoxHardwareDetails = /*@__PURE__*/ S.suspend(() =>
1653
+ S.Struct({
1654
+ hardwareDisplayName: S.optional(S.NullOr(S.String)),
1655
+ hardwareName: S.optional(S.NullOr(S.String)),
1656
+ hardwarePrice: S.optional(S.NullOr(OrderPrice)),
1657
+ }),
1658
+ ).annotate({
1659
+ identifier: "OverTheBoxHardwareDetails",
1660
+ }) as any as S.Schema<OverTheBoxHardwareDetails>;
1661
+
1662
+ /** Details of available hardwares */
1663
+ export type OverTheBoxAvailableMigrationOfferHardwaresList =
1664
+ Array<OverTheBoxHardwareDetails>;
1665
+ export const OverTheBoxAvailableMigrationOfferHardwaresList =
1666
+ /*@__PURE__*/ S.Array(
1667
+ OverTheBoxHardwareDetails,
1668
+ ) as any as S.Schema<OverTheBoxAvailableMigrationOfferHardwaresList>;
1669
+
1670
+ /** Migration offer */
1671
+ export interface OverTheBoxAvailableMigrationOffer {
1672
+ /** Monthly price of the current offer */
1673
+ currentOfferPrice?: OrderPrice;
1674
+ /** Description of the offer */
1675
+ description?: string;
1676
+ /** Number of months of engagement */
1677
+ engagementMonths?: number;
1678
+ /** Specify if a hardware is available */
1679
+ hardwareAvailable?: boolean;
1680
+ /** Name of the hardware */
1681
+ hardwareName?: string | null;
1682
+ /** Hardware purchase price */
1683
+ hardwarePrice?: OrderPrice | null;
1684
+ /** Details of available hardwares */
1685
+ hardwares?: OverTheBoxAvailableMigrationOfferHardwaresList;
1686
+ /** Name of the offer */
1687
+ offer?: string;
1688
+ /** Monthly price of the new offer */
1689
+ price?: OrderPrice;
1690
+ }
1691
+ export const OverTheBoxAvailableMigrationOffer = /*@__PURE__*/ S.suspend(() =>
1692
+ S.Struct({
1693
+ currentOfferPrice: S.optional(OrderPrice),
1694
+ description: S.optional(S.String),
1695
+ engagementMonths: S.optional(S.Number),
1696
+ hardwareAvailable: S.optional(S.Boolean),
1697
+ hardwareName: S.optional(S.NullOr(S.String)),
1698
+ hardwarePrice: S.optional(S.NullOr(OrderPrice)),
1699
+ hardwares: S.optional(OverTheBoxAvailableMigrationOfferHardwaresList),
1700
+ offer: S.optional(S.String),
1701
+ price: S.optional(OrderPrice),
1702
+ }),
1703
+ ).annotate({
1704
+ identifier: "OverTheBoxAvailableMigrationOffer",
1705
+ }) as any as S.Schema<OverTheBoxAvailableMigrationOffer>;
1706
+
1707
+ export type ListOverTheBoxMigrationOffersResponseBodyList =
1708
+ Array<OverTheBoxAvailableMigrationOffer>;
1709
+ export const ListOverTheBoxMigrationOffersResponseBodyList =
1710
+ /*@__PURE__*/ S.Array(
1711
+ OverTheBoxAvailableMigrationOffer,
1712
+ ) as any as S.Schema<ListOverTheBoxMigrationOffersResponseBodyList>;
1713
+
1714
+ export type ListOverTheBoxMigrationOffersResponse =
1715
+ ListOverTheBoxMigrationOffersResponseBodyList;
1716
+ export const ListOverTheBoxMigrationOffersResponse = /*@__PURE__*/ S.suspend(
1717
+ () => ListOverTheBoxMigrationOffersResponseBodyList.pipe(T.RawResponseRoot()),
1718
+ ).annotate({
1719
+ identifier: "ListOverTheBoxMigrationOffersResponse",
1720
+ }) as any as S.Schema<ListOverTheBoxMigrationOffersResponse>;
1721
+
1722
+ export interface ListOverTheBoxRemoteAccessesRequest {
1723
+ /** The internal name of your overTheBox offer */
1724
+ serviceName: string;
1725
+ }
1726
+ export const ListOverTheBoxRemoteAccessesRequest = /*@__PURE__*/ S.suspend(() =>
1727
+ S.Struct({
1728
+ serviceName: S.String.pipe(T.Label()),
1729
+ }).pipe(
1730
+ T.Http({
1731
+ method: "GET",
1732
+ uri: "/overTheBox/{serviceName}/remoteAccesses",
1733
+ code: 200,
1734
+ }),
1735
+ ),
1736
+ ).annotate({
1737
+ identifier: "ListOverTheBoxRemoteAccessesRequest",
1738
+ }) as any as S.Schema<ListOverTheBoxRemoteAccessesRequest>;
1739
+
1740
+ export type ListOverTheBoxRemoteAccessesResponseBodyList = Array<string>;
1741
+ export const ListOverTheBoxRemoteAccessesResponseBodyList =
1742
+ /*@__PURE__*/ S.Array(
1743
+ S.String,
1744
+ ) as any as S.Schema<ListOverTheBoxRemoteAccessesResponseBodyList>;
1745
+
1746
+ export type ListOverTheBoxRemoteAccessesResponse =
1747
+ ListOverTheBoxRemoteAccessesResponseBodyList;
1748
+ export const ListOverTheBoxRemoteAccessesResponse = /*@__PURE__*/ S.suspend(
1749
+ () => ListOverTheBoxRemoteAccessesResponseBodyList.pipe(T.RawResponseRoot()),
1750
+ ).annotate({
1751
+ identifier: "ListOverTheBoxRemoteAccessesResponse",
1752
+ }) as any as S.Schema<ListOverTheBoxRemoteAccessesResponse>;
1753
+
1754
+ /** Serie Name */
1755
+ export type OtbDeviceStatisticsTypeEnum = "load" | "memory_free" | "traffic";
1756
+ export const OtbDeviceStatisticsTypeEnum = /*@__PURE__*/ S.String;
1757
+
1758
+ /** Statistics Period */
1759
+ export type OtbDeviceStatisticsPeriodEnum =
1760
+ | "daily"
1761
+ | "hourly"
1762
+ | "monthly"
1763
+ | "weekly";
1764
+ export const OtbDeviceStatisticsPeriodEnum = /*@__PURE__*/ S.String;
1765
+
1766
+ export interface ListOverTheBoxStatisticsRequest {
1767
+ /** The internal name of your overTheBox offer */
1768
+ serviceName: string;
1769
+ /** Type of metrics you want to retrieve */
1770
+ metricsType: OtbDeviceStatisticsTypeEnum | (string & {});
1771
+ /** Period (default is daily) */
1772
+ period?: OtbDeviceStatisticsPeriodEnum | (string & {});
1773
+ }
1774
+ export const ListOverTheBoxStatisticsRequest = /*@__PURE__*/ S.suspend(() =>
1775
+ S.Struct({
1776
+ serviceName: S.String.pipe(T.Label()),
1777
+ metricsType: OtbDeviceStatisticsTypeEnum.pipe(T.Query()),
1778
+ period: S.optional(OtbDeviceStatisticsPeriodEnum.pipe(T.Query())),
1779
+ }).pipe(
1780
+ T.Http({
1781
+ method: "GET",
1782
+ uri: "/overTheBox/{serviceName}/statistics",
1783
+ code: 200,
1784
+ }),
1785
+ ),
1786
+ ).annotate({
1787
+ identifier: "ListOverTheBoxStatisticsRequest",
1788
+ }) as any as S.Schema<ListOverTheBoxStatisticsRequest>;
1789
+
1790
+ /** Statistics Datapoint */
1791
+ export interface OtbDeviceStatisticsPoint {
1792
+ /** Timestamp */
1793
+ timestamp?: number;
1794
+ /** Datapoint value */
1795
+ value?: number | null;
1796
+ }
1797
+ export const OtbDeviceStatisticsPoint = /*@__PURE__*/ S.suspend(() =>
1798
+ S.Struct({
1799
+ timestamp: S.optional(S.Number),
1800
+ value: S.optional(S.NullOr(S.Number)),
1801
+ }),
1802
+ ).annotate({
1803
+ identifier: "OtbDeviceStatisticsPoint",
1804
+ }) as any as S.Schema<OtbDeviceStatisticsPoint>;
1805
+
1806
+ /** List of point */
1807
+ export type OtbDeviceStatisticsPointsList = Array<OtbDeviceStatisticsPoint>;
1808
+ export const OtbDeviceStatisticsPointsList = /*@__PURE__*/ S.Array(
1809
+ OtbDeviceStatisticsPoint,
1810
+ ) as any as S.Schema<OtbDeviceStatisticsPointsList>;
1811
+
1812
+ /** Tags for the metrics */
1813
+ export interface OtbDeviceStatisticsTag {
1814
+ /** Name of tag */
1815
+ name?: string;
1816
+ /** Value of tag */
1817
+ value?: string | null;
1818
+ }
1819
+ export const OtbDeviceStatisticsTag = /*@__PURE__*/ S.suspend(() =>
1820
+ S.Struct({
1821
+ name: S.optional(S.String),
1822
+ value: S.optional(S.NullOr(S.String)),
1823
+ }),
1824
+ ).annotate({
1825
+ identifier: "OtbDeviceStatisticsTag",
1826
+ }) as any as S.Schema<OtbDeviceStatisticsTag>;
1827
+
1828
+ /** List of tags */
1829
+ export type OtbDeviceStatisticsTagsList = Array<OtbDeviceStatisticsTag>;
1830
+ export const OtbDeviceStatisticsTagsList = /*@__PURE__*/ S.Array(
1831
+ OtbDeviceStatisticsTag,
1832
+ ) as any as S.Schema<OtbDeviceStatisticsTagsList>;
1833
+
1834
+ /** Serie Unit */
1835
+ export type OtbDeviceStatisticsUnitEnum = "bps" | "byte" | "n/a";
1836
+ export const OtbDeviceStatisticsUnitEnum = /*@__PURE__*/ S.String;
1837
+
1838
+ /** Device Statistics Datapoints */
1839
+ export interface OtbDeviceStatistics {
1840
+ /** Name of the serie */
1841
+ name?: string;
1842
+ /** List of point */
1843
+ points?: OtbDeviceStatisticsPointsList;
1844
+ /** List of tags */
1845
+ tags?: OtbDeviceStatisticsTagsList;
1846
+ /** Unit of the serie */
1847
+ unit?: OtbDeviceStatisticsUnitEnum;
1848
+ }
1849
+ export const OtbDeviceStatistics = /*@__PURE__*/ S.suspend(() =>
1850
+ S.Struct({
1851
+ name: S.optional(S.String),
1852
+ points: S.optional(OtbDeviceStatisticsPointsList),
1853
+ tags: S.optional(OtbDeviceStatisticsTagsList),
1854
+ unit: S.optional(OtbDeviceStatisticsUnitEnum),
1855
+ }),
1856
+ ).annotate({
1857
+ identifier: "OtbDeviceStatistics",
1858
+ }) as any as S.Schema<OtbDeviceStatistics>;
1859
+
1860
+ export type ListOverTheBoxStatisticsResponseBodyList =
1861
+ Array<OtbDeviceStatistics>;
1862
+ export const ListOverTheBoxStatisticsResponseBodyList = /*@__PURE__*/ S.Array(
1863
+ OtbDeviceStatistics,
1864
+ ) as any as S.Schema<ListOverTheBoxStatisticsResponseBodyList>;
1865
+
1866
+ export type ListOverTheBoxStatisticsResponse =
1867
+ ListOverTheBoxStatisticsResponseBodyList;
1868
+ export const ListOverTheBoxStatisticsResponse = /*@__PURE__*/ S.suspend(() =>
1869
+ ListOverTheBoxStatisticsResponseBodyList.pipe(T.RawResponseRoot()),
1870
+ ).annotate({
1871
+ identifier: "ListOverTheBoxStatisticsResponse",
1872
+ }) as any as S.Schema<ListOverTheBoxStatisticsResponse>;
1873
+
1874
+ export interface ListOverTheBoxTasksRequest {
1875
+ /** The internal name of your overTheBox offer */
1876
+ serviceName: string;
1877
+ /** Filter the value of name property (=) */
1878
+ name?: string;
1879
+ /** Filter the value of status property (=) */
1880
+ status?: OverTheBoxTaskStatusEnum | (string & {});
1881
+ }
1882
+ export const ListOverTheBoxTasksRequest = /*@__PURE__*/ S.suspend(() =>
1883
+ S.Struct({
1884
+ serviceName: S.String.pipe(T.Label()),
1885
+ name: S.optional(S.String.pipe(T.Query())),
1886
+ status: S.optional(OverTheBoxTaskStatusEnum.pipe(T.Query())),
1887
+ }).pipe(
1888
+ T.Http({
1889
+ method: "GET",
1890
+ uri: "/overTheBox/{serviceName}/tasks",
1891
+ code: 200,
1892
+ }),
1893
+ ),
1894
+ ).annotate({
1895
+ identifier: "ListOverTheBoxTasksRequest",
1896
+ }) as any as S.Schema<ListOverTheBoxTasksRequest>;
1897
+
1898
+ export type ListOverTheBoxTasksResponseBodyList = Array<string>;
1899
+ export const ListOverTheBoxTasksResponseBodyList = /*@__PURE__*/ S.Array(
1900
+ S.String,
1901
+ ) as any as S.Schema<ListOverTheBoxTasksResponseBodyList>;
1902
+
1903
+ export type ListOverTheBoxTasksResponse = ListOverTheBoxTasksResponseBodyList;
1904
+ export const ListOverTheBoxTasksResponse = /*@__PURE__*/ S.suspend(() =>
1905
+ ListOverTheBoxTasksResponseBodyList.pipe(T.RawResponseRoot()),
1906
+ ).annotate({
1907
+ identifier: "ListOverTheBoxTasksResponse",
1908
+ }) as any as S.Schema<ListOverTheBoxTasksResponse>;
1909
+
1910
+ export interface PutOverTheBoxRequest {
1911
+ /** The internal name of your overTheBox offer */
1912
+ serviceName: string;
1913
+ /** Enable device auto upgrade */
1914
+ autoUpgrade?: boolean;
1915
+ /** Editable field for customer */
1916
+ customerDescription?: string | null;
1917
+ /** Release channel of the service */
1918
+ releaseChannel?: string;
1919
+ }
1920
+ export const PutOverTheBoxRequest = /*@__PURE__*/ S.suspend(() =>
1921
+ S.Struct({
1922
+ serviceName: S.String.pipe(T.Label()),
1923
+ autoUpgrade: S.optional(S.Boolean),
1924
+ customerDescription: S.optional(S.NullOr(S.String)),
1925
+ releaseChannel: S.optional(S.String),
1926
+ }).pipe(
1927
+ T.Http({ method: "PUT", uri: "/overTheBox/{serviceName}", code: 200 }),
1928
+ ),
1929
+ ).annotate({
1930
+ identifier: "PutOverTheBoxRequest",
1931
+ }) as any as S.Schema<PutOverTheBoxRequest>;
1932
+
1933
+ export interface PutOverTheBoxResponse {}
1934
+ export const PutOverTheBoxResponse = /*@__PURE__*/ S.suspend(() =>
1935
+ S.Struct({}),
1936
+ ).annotate({
1937
+ identifier: "PutOverTheBoxResponse",
1938
+ }) as any as S.Schema<PutOverTheBoxResponse>;
1939
+
1940
+ export interface PutOverTheBoxAutoMTURequest {
1941
+ /** The internal name of your overTheBox offer */
1942
+ serviceName: string;
1943
+ /** Enable or disable autoMTU */
1944
+ mtuAuto: OverTheBoxAvailableStatusEnum | (string & {});
1945
+ }
1946
+ export const PutOverTheBoxAutoMTURequest = /*@__PURE__*/ S.suspend(() =>
1947
+ S.Struct({
1948
+ serviceName: S.String.pipe(T.Label()),
1949
+ mtuAuto: OverTheBoxAvailableStatusEnum,
1950
+ }).pipe(
1951
+ T.Http({
1952
+ method: "PUT",
1953
+ uri: "/overTheBox/{serviceName}/autoMTU",
1954
+ code: 200,
1955
+ }),
1956
+ ),
1957
+ ).annotate({
1958
+ identifier: "PutOverTheBoxAutoMTURequest",
1959
+ }) as any as S.Schema<PutOverTheBoxAutoMTURequest>;
1960
+
1961
+ export interface PutOverTheBoxAutoMTUResponse {}
1962
+ export const PutOverTheBoxAutoMTUResponse = /*@__PURE__*/ S.suspend(() =>
1963
+ S.Struct({}),
1964
+ ).annotate({
1965
+ identifier: "PutOverTheBoxAutoMTUResponse",
1966
+ }) as any as S.Schema<PutOverTheBoxAutoMTUResponse>;
1967
+
1968
+ export interface PutOverTheBoxIpv6Request {
1969
+ /** The internal name of your overTheBox offer */
1970
+ serviceName: string;
1971
+ /** Enabled/disabled IPv6 */
1972
+ enabled: boolean;
1973
+ }
1974
+ export const PutOverTheBoxIpv6Request = /*@__PURE__*/ S.suspend(() =>
1975
+ S.Struct({
1976
+ serviceName: S.String.pipe(T.Label()),
1977
+ enabled: S.Boolean,
1978
+ }).pipe(
1979
+ T.Http({ method: "PUT", uri: "/overTheBox/{serviceName}/ipv6", code: 200 }),
1980
+ ),
1981
+ ).annotate({
1982
+ identifier: "PutOverTheBoxIpv6Request",
1983
+ }) as any as S.Schema<PutOverTheBoxIpv6Request>;
1984
+
1985
+ export interface PutOverTheBoxServiceInfosRequest {
1986
+ /** The internal name of your overTheBox offer */
1987
+ serviceName: string;
1988
+ /** Way of handling the renew */
1989
+ renew?: ServiceRenewType | null;
1990
+ }
1991
+ export const PutOverTheBoxServiceInfosRequest = /*@__PURE__*/ S.suspend(() =>
1992
+ S.Struct({
1993
+ serviceName: S.String.pipe(T.Label()),
1994
+ renew: S.optional(S.NullOr(ServiceRenewType)),
1995
+ }).pipe(
1996
+ T.Http({
1997
+ method: "PUT",
1998
+ uri: "/overTheBox/{serviceName}/serviceInfos",
1999
+ code: 200,
2000
+ }),
2001
+ ),
2002
+ ).annotate({
2003
+ identifier: "PutOverTheBoxServiceInfosRequest",
2004
+ }) as any as S.Schema<PutOverTheBoxServiceInfosRequest>;
2005
+
2006
+ export interface PutOverTheBoxServiceInfosResponse {}
2007
+ export const PutOverTheBoxServiceInfosResponse = /*@__PURE__*/ S.suspend(() =>
2008
+ S.Struct({}),
2009
+ ).annotate({
2010
+ identifier: "PutOverTheBoxServiceInfosResponse",
2011
+ }) as any as S.Schema<PutOverTheBoxServiceInfosResponse>;
2012
+
2013
+ export interface RestoreOverTheBoxDeviceBackupRequest {
2014
+ /** The internal name of your overTheBox offer */
2015
+ serviceName: string;
2016
+ /** The id of the backup to restore */
2017
+ backupId: string;
2018
+ }
2019
+ export const RestoreOverTheBoxDeviceBackupRequest = /*@__PURE__*/ S.suspend(
2020
+ () =>
2021
+ S.Struct({
2022
+ serviceName: S.String.pipe(T.Label()),
2023
+ backupId: S.String,
2024
+ }).pipe(
2025
+ T.Http({
2026
+ method: "POST",
2027
+ uri: "/overTheBox/{serviceName}/device/restoreBackup",
2028
+ code: 200,
2029
+ }),
2030
+ ),
2031
+ ).annotate({
2032
+ identifier: "RestoreOverTheBoxDeviceBackupRequest",
2033
+ }) as any as S.Schema<RestoreOverTheBoxDeviceBackupRequest>;
2034
+
2035
+ export type RestoreOverTheBoxDeviceBackupResponseBodyList =
2036
+ Array<OverTheBoxDeviceAction>;
2037
+ export const RestoreOverTheBoxDeviceBackupResponseBodyList =
2038
+ /*@__PURE__*/ S.Array(
2039
+ OverTheBoxDeviceAction,
2040
+ ) as any as S.Schema<RestoreOverTheBoxDeviceBackupResponseBodyList>;
2041
+
2042
+ export type RestoreOverTheBoxDeviceBackupResponse =
2043
+ RestoreOverTheBoxDeviceBackupResponseBodyList;
2044
+ export const RestoreOverTheBoxDeviceBackupResponse = /*@__PURE__*/ S.suspend(
2045
+ () => RestoreOverTheBoxDeviceBackupResponseBodyList.pipe(T.RawResponseRoot()),
2046
+ ).annotate({
2047
+ identifier: "RestoreOverTheBoxDeviceBackupResponse",
2048
+ }) as any as S.Schema<RestoreOverTheBoxDeviceBackupResponse>;
2049
+
2050
+ export type AuthorizeOverTheBoxRemoteAccessError = OvhOpError;
2051
+ /** Authorize the remote access */
2052
+ export const authorizeOverTheBoxRemoteAccess: API.OperationMethod<
2053
+ AuthorizeOverTheBoxRemoteAccessRequest,
2054
+ AuthorizeOverTheBoxRemoteAccessResponse,
2055
+ AuthorizeOverTheBoxRemoteAccessError,
2056
+ OvhOpContext
2057
+ > = /*@__PURE__*/ API.make(() => ({
2058
+ input: AuthorizeOverTheBoxRemoteAccessRequest,
2059
+ output: AuthorizeOverTheBoxRemoteAccessResponse,
2060
+ errors: [UnknownOvhError],
2061
+ protocol: OvhProtocol,
2062
+ retry: Retry.Retry,
2063
+ }));
2064
+
2065
+ export type CancelOverTheBoxResiliationError = OvhOpError;
2066
+ /** Cancel the resiliation of the Service */
2067
+ export const cancelOverTheBoxResiliation: API.OperationMethod<
2068
+ CancelOverTheBoxResiliationRequest,
2069
+ CancelOverTheBoxResiliationResponse,
2070
+ CancelOverTheBoxResiliationError,
2071
+ OvhOpContext
2072
+ > = /*@__PURE__*/ API.make(() => ({
2073
+ input: CancelOverTheBoxResiliationRequest,
2074
+ output: CancelOverTheBoxResiliationResponse,
2075
+ errors: [UnknownOvhError],
2076
+ protocol: OvhProtocol,
2077
+ retry: Retry.Retry,
2078
+ }));
2079
+
2080
+ export type CreateOverTheBoxChangeContactError = OvhOpError;
2081
+ /** Launch a contact change procedure */
2082
+ export const createOverTheBoxChangeContact: API.OperationMethod<
2083
+ CreateOverTheBoxChangeContactRequest,
2084
+ CreateOverTheBoxChangeContactResponse,
2085
+ CreateOverTheBoxChangeContactError,
2086
+ OvhOpContext
2087
+ > = /*@__PURE__*/ API.make(() => ({
2088
+ input: CreateOverTheBoxChangeContactRequest,
2089
+ output: CreateOverTheBoxChangeContactResponse,
2090
+ errors: [UnknownOvhError],
2091
+ protocol: OvhProtocol,
2092
+ retry: Retry.Retry,
2093
+ }));
2094
+
2095
+ export type CreateOverTheBoxDeviceError = OvhOpError;
2096
+ /** Get the list of devices connected from the same IP address */
2097
+ export const createOverTheBoxDevice: API.OperationMethod<
2098
+ CreateOverTheBoxDeviceRequest,
2099
+ CreateOverTheBoxDeviceResponse,
2100
+ CreateOverTheBoxDeviceError,
2101
+ OvhOpContext
2102
+ > = /*@__PURE__*/ API.make(() => ({
2103
+ input: CreateOverTheBoxDeviceRequest,
2104
+ output: CreateOverTheBoxDeviceResponse,
2105
+ errors: [UnknownOvhError],
2106
+ protocol: OvhProtocol,
2107
+ retry: Retry.Retry,
2108
+ }));
2109
+
2110
+ export type CreateOverTheBoxDeviceActionError = OvhOpError;
2111
+ /** Create a device action on the device */
2112
+ export const createOverTheBoxDeviceAction: API.OperationMethod<
2113
+ CreateOverTheBoxDeviceActionRequest,
2114
+ OverTheBoxDeviceAction,
2115
+ CreateOverTheBoxDeviceActionError,
2116
+ OvhOpContext
2117
+ > = /*@__PURE__*/ API.make(() => ({
2118
+ input: CreateOverTheBoxDeviceActionRequest,
2119
+ output: OverTheBoxDeviceAction,
2120
+ errors: [UnknownOvhError],
2121
+ protocol: OvhProtocol,
2122
+ retry: Retry.Retry,
2123
+ }));
2124
+
2125
+ export type CreateOverTheBoxDeviceBackupError = OvhOpError;
2126
+ /** Create an action to generate a backup */
2127
+ export const createOverTheBoxDeviceBackup: API.OperationMethod<
2128
+ CreateOverTheBoxDeviceBackupRequest,
2129
+ OverTheBoxDeviceAction,
2130
+ CreateOverTheBoxDeviceBackupError,
2131
+ OvhOpContext
2132
+ > = /*@__PURE__*/ API.make(() => ({
2133
+ input: CreateOverTheBoxDeviceBackupRequest,
2134
+ output: OverTheBoxDeviceAction,
2135
+ errors: [UnknownOvhError],
2136
+ protocol: OvhProtocol,
2137
+ retry: Retry.Retry,
2138
+ }));
2139
+
2140
+ export type CreateOverTheBoxDeviceLogError = OvhOpError;
2141
+ /** Generate a temporary url to retrieve device logs */
2142
+ export const createOverTheBoxDeviceLog: API.OperationMethod<
2143
+ CreateOverTheBoxDeviceLogRequest,
2144
+ OverTheBoxTemporaryLogsLink,
2145
+ CreateOverTheBoxDeviceLogError,
2146
+ OvhOpContext
2147
+ > = /*@__PURE__*/ API.make(() => ({
2148
+ input: CreateOverTheBoxDeviceLogRequest,
2149
+ output: OverTheBoxTemporaryLogsLink,
2150
+ errors: [UnknownOvhError],
2151
+ protocol: OvhProtocol,
2152
+ retry: Retry.Retry,
2153
+ }));
2154
+
2155
+ export type CreateOverTheBoxLinkDeviceError = OvhOpError;
2156
+ /** Link a device to this service */
2157
+ export const createOverTheBoxLinkDevice: API.OperationMethod<
2158
+ CreateOverTheBoxLinkDeviceRequest,
2159
+ CreateOverTheBoxLinkDeviceResponse,
2160
+ CreateOverTheBoxLinkDeviceError,
2161
+ OvhOpContext
2162
+ > = /*@__PURE__*/ API.make(() => ({
2163
+ input: CreateOverTheBoxLinkDeviceRequest,
2164
+ output: CreateOverTheBoxLinkDeviceResponse,
2165
+ errors: [UnknownOvhError],
2166
+ protocol: OvhProtocol,
2167
+ retry: Retry.Retry,
2168
+ }));
2169
+
2170
+ export type CreateOverTheBoxLinkHardwareError = OvhOpError;
2171
+ /** Link an available hardware to this service */
2172
+ export const createOverTheBoxLinkHardware: API.OperationMethod<
2173
+ CreateOverTheBoxLinkHardwareRequest,
2174
+ CreateOverTheBoxLinkHardwareResponse,
2175
+ CreateOverTheBoxLinkHardwareError,
2176
+ OvhOpContext
2177
+ > = /*@__PURE__*/ API.make(() => ({
2178
+ input: CreateOverTheBoxLinkHardwareRequest,
2179
+ output: CreateOverTheBoxLinkHardwareResponse,
2180
+ errors: [UnknownOvhError],
2181
+ protocol: OvhProtocol,
2182
+ retry: Retry.Retry,
2183
+ }));
2184
+
2185
+ export type CreateOverTheBoxMigrationChangeOfferError = OvhOpError;
2186
+ /** Migrate to the selected overTheBox offer */
2187
+ export const createOverTheBoxMigrationChangeOffer: API.OperationMethod<
2188
+ CreateOverTheBoxMigrationChangeOfferRequest,
2189
+ OverTheBoxOrderMigration,
2190
+ CreateOverTheBoxMigrationChangeOfferError,
2191
+ OvhOpContext
2192
+ > = /*@__PURE__*/ API.make(() => ({
2193
+ input: CreateOverTheBoxMigrationChangeOfferRequest,
2194
+ output: OverTheBoxOrderMigration,
2195
+ errors: [UnknownOvhError],
2196
+ protocol: OvhProtocol,
2197
+ retry: Retry.Retry,
2198
+ }));
2199
+
2200
+ export type CreateOverTheBoxRemoteAccessError = OvhOpError;
2201
+ /** Create a new remote access for the service */
2202
+ export const createOverTheBoxRemoteAccess: API.OperationMethod<
2203
+ CreateOverTheBoxRemoteAccessRequest,
2204
+ OverTheBoxRemoteAccess,
2205
+ CreateOverTheBoxRemoteAccessError,
2206
+ OvhOpContext
2207
+ > = /*@__PURE__*/ API.make(() => ({
2208
+ input: CreateOverTheBoxRemoteAccessRequest,
2209
+ output: OverTheBoxRemoteAccess,
2210
+ errors: [UnknownOvhError],
2211
+ protocol: OvhProtocol,
2212
+ retry: Retry.Retry,
2213
+ }));
2214
+
2215
+ export type DeleteOverTheBoxError = OvhOpError;
2216
+ /** Resiliate a service */
2217
+ export const deleteOverTheBox: API.OperationMethod<
2218
+ DeleteOverTheBoxRequest,
2219
+ DeleteOverTheBoxResponse,
2220
+ DeleteOverTheBoxError,
2221
+ OvhOpContext
2222
+ > = /*@__PURE__*/ API.make(() => ({
2223
+ input: DeleteOverTheBoxRequest,
2224
+ output: DeleteOverTheBoxResponse,
2225
+ errors: [UnknownOvhError],
2226
+ protocol: OvhProtocol,
2227
+ retry: Retry.Retry,
2228
+ }));
2229
+
2230
+ export type DeleteOverTheBoxBackupError = OvhOpError;
2231
+ /** Delete a backup */
2232
+ export const deleteOverTheBoxBackup: API.OperationMethod<
2233
+ DeleteOverTheBoxBackupRequest,
2234
+ DeleteOverTheBoxBackupResponse,
2235
+ DeleteOverTheBoxBackupError,
2236
+ OvhOpContext
2237
+ > = /*@__PURE__*/ API.make(() => ({
2238
+ input: DeleteOverTheBoxBackupRequest,
2239
+ output: DeleteOverTheBoxBackupResponse,
2240
+ errors: [UnknownOvhError],
2241
+ protocol: OvhProtocol,
2242
+ retry: Retry.Retry,
2243
+ }));
2244
+
2245
+ export type DeleteOverTheBoxDeviceError = OvhOpError;
2246
+ /** Unlink a device from a service */
2247
+ export const deleteOverTheBoxDevice: API.OperationMethod<
2248
+ DeleteOverTheBoxDeviceRequest,
2249
+ DeleteOverTheBoxDeviceResponse,
2250
+ DeleteOverTheBoxDeviceError,
2251
+ OvhOpContext
2252
+ > = /*@__PURE__*/ API.make(() => ({
2253
+ input: DeleteOverTheBoxDeviceRequest,
2254
+ output: DeleteOverTheBoxDeviceResponse,
2255
+ errors: [UnknownOvhError],
2256
+ protocol: OvhProtocol,
2257
+ retry: Retry.Retry,
2258
+ }));
2259
+
2260
+ export type DeleteOverTheBoxRemoteAccessError = OvhOpError;
2261
+ /** Delete a remote access */
2262
+ export const deleteOverTheBoxRemoteAccess: API.OperationMethod<
2263
+ DeleteOverTheBoxRemoteAccessRequest,
2264
+ DeleteOverTheBoxRemoteAccessResponse,
2265
+ DeleteOverTheBoxRemoteAccessError,
2266
+ OvhOpContext
2267
+ > = /*@__PURE__*/ API.make(() => ({
2268
+ input: DeleteOverTheBoxRemoteAccessRequest,
2269
+ output: DeleteOverTheBoxRemoteAccessResponse,
2270
+ errors: [UnknownOvhError],
2271
+ protocol: OvhProtocol,
2272
+ retry: Retry.Retry,
2273
+ }));
2274
+
2275
+ export type GetOverTheBoxError = OvhOpError;
2276
+ /** Get this object properties */
2277
+ export const getOverTheBox: API.OperationMethod<
2278
+ GetOverTheBoxRequest,
2279
+ OverTheBoxServiceWithIAM,
2280
+ GetOverTheBoxError,
2281
+ OvhOpContext
2282
+ > = /*@__PURE__*/ API.make(() => ({
2283
+ input: GetOverTheBoxRequest,
2284
+ output: OverTheBoxServiceWithIAM,
2285
+ errors: [UnknownOvhError],
2286
+ protocol: OvhProtocol,
2287
+ retry: Retry.Retry,
2288
+ }));
2289
+
2290
+ export type GetOverTheBoxBackupError = OvhOpError;
2291
+ /** Get this object properties */
2292
+ export const getOverTheBoxBackup: API.OperationMethod<
2293
+ GetOverTheBoxBackupRequest,
2294
+ OverTheBoxBackup,
2295
+ GetOverTheBoxBackupError,
2296
+ OvhOpContext
2297
+ > = /*@__PURE__*/ API.make(() => ({
2298
+ input: GetOverTheBoxBackupRequest,
2299
+ output: OverTheBoxBackup,
2300
+ errors: [UnknownOvhError],
2301
+ protocol: OvhProtocol,
2302
+ retry: Retry.Retry,
2303
+ }));
2304
+
2305
+ export type GetOverTheBoxDeviceError = OvhOpError;
2306
+ /** Get this object properties */
2307
+ export const getOverTheBoxDevice: API.OperationMethod<
2308
+ GetOverTheBoxDeviceRequest,
2309
+ OverTheBoxDevice,
2310
+ GetOverTheBoxDeviceError,
2311
+ OvhOpContext
2312
+ > = /*@__PURE__*/ API.make(() => ({
2313
+ input: GetOverTheBoxDeviceRequest,
2314
+ output: OverTheBoxDevice,
2315
+ errors: [UnknownOvhError],
2316
+ protocol: OvhProtocol,
2317
+ retry: Retry.Retry,
2318
+ }));
2319
+
2320
+ export type GetOverTheBoxDeviceActionError = OvhOpError;
2321
+ /** Get this object properties */
2322
+ export const getOverTheBoxDeviceAction: API.OperationMethod<
2323
+ GetOverTheBoxDeviceActionRequest,
2324
+ OverTheBoxDeviceAction,
2325
+ GetOverTheBoxDeviceActionError,
2326
+ OvhOpContext
2327
+ > = /*@__PURE__*/ API.make(() => ({
2328
+ input: GetOverTheBoxDeviceActionRequest,
2329
+ output: OverTheBoxDeviceAction,
2330
+ errors: [UnknownOvhError],
2331
+ protocol: OvhProtocol,
2332
+ retry: Retry.Retry,
2333
+ }));
2334
+
2335
+ export type GetOverTheBoxDeviceHardwareError = OvhOpError;
2336
+ /** Get this object properties */
2337
+ export const getOverTheBoxDeviceHardware: API.OperationMethod<
2338
+ GetOverTheBoxDeviceHardwareRequest,
2339
+ OverTheBoxHardware,
2340
+ GetOverTheBoxDeviceHardwareError,
2341
+ OvhOpContext
2342
+ > = /*@__PURE__*/ API.make(() => ({
2343
+ input: GetOverTheBoxDeviceHardwareRequest,
2344
+ output: OverTheBoxHardware,
2345
+ errors: [UnknownOvhError],
2346
+ protocol: OvhProtocol,
2347
+ retry: Retry.Retry,
2348
+ }));
2349
+
2350
+ export type GetOverTheBoxHardwareError = OvhOpError;
2351
+ /** Get this object properties */
2352
+ export const getOverTheBoxHardware: API.OperationMethod<
2353
+ GetOverTheBoxHardwareRequest,
2354
+ OverTheBoxHardwareWithIAM,
2355
+ GetOverTheBoxHardwareError,
2356
+ OvhOpContext
2357
+ > = /*@__PURE__*/ API.make(() => ({
2358
+ input: GetOverTheBoxHardwareRequest,
2359
+ output: OverTheBoxHardwareWithIAM,
2360
+ errors: [UnknownOvhError],
2361
+ protocol: OvhProtocol,
2362
+ retry: Retry.Retry,
2363
+ }));
2364
+
2365
+ export type GetOverTheBoxIpsError = OvhOpError;
2366
+ /** Get details IP assigned to an OverTheBox service */
2367
+ export const getOverTheBoxIps: API.OperationMethod<
2368
+ GetOverTheBoxIpsRequest,
2369
+ OtbServiceIp,
2370
+ GetOverTheBoxIpsError,
2371
+ OvhOpContext
2372
+ > = /*@__PURE__*/ API.make(() => ({
2373
+ input: GetOverTheBoxIpsRequest,
2374
+ output: OtbServiceIp,
2375
+ errors: [UnknownOvhError],
2376
+ protocol: OvhProtocol,
2377
+ retry: Retry.Retry,
2378
+ }));
2379
+
2380
+ export type GetOverTheBoxRemoteAccessError = OvhOpError;
2381
+ /** Get this object properties */
2382
+ export const getOverTheBoxRemoteAccess: API.OperationMethod<
2383
+ GetOverTheBoxRemoteAccessRequest,
2384
+ OverTheBoxRemoteAccess,
2385
+ GetOverTheBoxRemoteAccessError,
2386
+ OvhOpContext
2387
+ > = /*@__PURE__*/ API.make(() => ({
2388
+ input: GetOverTheBoxRemoteAccessRequest,
2389
+ output: OverTheBoxRemoteAccess,
2390
+ errors: [UnknownOvhError],
2391
+ protocol: OvhProtocol,
2392
+ retry: Retry.Retry,
2393
+ }));
2394
+
2395
+ export type GetOverTheBoxServiceInfosError = OvhOpError;
2396
+ /** Get service information */
2397
+ export const getOverTheBoxServiceInfos: API.OperationMethod<
2398
+ GetOverTheBoxServiceInfosRequest,
2399
+ ServicesService,
2400
+ GetOverTheBoxServiceInfosError,
2401
+ OvhOpContext
2402
+ > = /*@__PURE__*/ API.make(() => ({
2403
+ input: GetOverTheBoxServiceInfosRequest,
2404
+ output: ServicesService,
2405
+ errors: [UnknownOvhError],
2406
+ protocol: OvhProtocol,
2407
+ retry: Retry.Retry,
2408
+ }));
2409
+
2410
+ export type GetOverTheBoxTaskError = OvhOpError;
2411
+ /** Get this object properties */
2412
+ export const getOverTheBoxTask: API.OperationMethod<
2413
+ GetOverTheBoxTaskRequest,
2414
+ OverTheBoxTask,
2415
+ GetOverTheBoxTaskError,
2416
+ OvhOpContext
2417
+ > = /*@__PURE__*/ API.make(() => ({
2418
+ input: GetOverTheBoxTaskRequest,
2419
+ output: OverTheBoxTask,
2420
+ errors: [UnknownOvhError],
2421
+ protocol: OvhProtocol,
2422
+ retry: Retry.Retry,
2423
+ }));
2424
+
2425
+ export type ListOverTheBoxError = OvhOpError;
2426
+ /** List available services */
2427
+ export const listOverTheBox: API.OperationMethod<
2428
+ ListOverTheBoxRequest,
2429
+ ListOverTheBoxResponse,
2430
+ ListOverTheBoxError,
2431
+ OvhOpContext
2432
+ > = /*@__PURE__*/ API.make(() => ({
2433
+ input: ListOverTheBoxRequest,
2434
+ output: ListOverTheBoxResponse,
2435
+ errors: [UnknownOvhError],
2436
+ protocol: OvhProtocol,
2437
+ retry: Retry.Retry,
2438
+ }));
2439
+
2440
+ export type ListOverTheBoxAvailableOffersError = OvhOpError;
2441
+ /** List the available offers for the new call */
2442
+ export const listOverTheBoxAvailableOffers: API.OperationMethod<
2443
+ ListOverTheBoxAvailableOffersRequest,
2444
+ ListOverTheBoxAvailableOffersResponse,
2445
+ ListOverTheBoxAvailableOffersError,
2446
+ OvhOpContext
2447
+ > = /*@__PURE__*/ API.make(() => ({
2448
+ input: ListOverTheBoxAvailableOffersRequest,
2449
+ output: ListOverTheBoxAvailableOffersResponse,
2450
+ errors: [UnknownOvhError],
2451
+ protocol: OvhProtocol,
2452
+ retry: Retry.Retry,
2453
+ }));
2454
+
2455
+ export type ListOverTheBoxAvailableReleaseChannelsError = OvhOpError;
2456
+ /** List available release channels for this service */
2457
+ export const listOverTheBoxAvailableReleaseChannels: API.OperationMethod<
2458
+ ListOverTheBoxAvailableReleaseChannelsRequest,
2459
+ ListOverTheBoxAvailableReleaseChannelsResponse,
2460
+ ListOverTheBoxAvailableReleaseChannelsError,
2461
+ OvhOpContext
2462
+ > = /*@__PURE__*/ API.make(() => ({
2463
+ input: ListOverTheBoxAvailableReleaseChannelsRequest,
2464
+ output: ListOverTheBoxAvailableReleaseChannelsResponse,
2465
+ errors: [UnknownOvhError],
2466
+ protocol: OvhProtocol,
2467
+ retry: Retry.Retry,
2468
+ }));
2469
+
2470
+ export type ListOverTheBoxBackupsError = OvhOpError;
2471
+ /** List of backups for this service */
2472
+ export const listOverTheBoxBackups: API.OperationMethod<
2473
+ ListOverTheBoxBackupsRequest,
2474
+ ListOverTheBoxBackupsResponse,
2475
+ ListOverTheBoxBackupsError,
2476
+ OvhOpContext
2477
+ > = /*@__PURE__*/ API.make(() => ({
2478
+ input: ListOverTheBoxBackupsRequest,
2479
+ output: ListOverTheBoxBackupsResponse,
2480
+ errors: [UnknownOvhError],
2481
+ protocol: OvhProtocol,
2482
+ retry: Retry.Retry,
2483
+ }));
2484
+
2485
+ export type ListOverTheBoxDeviceActionsError = OvhOpError;
2486
+ /** List of actions scheduled for this device */
2487
+ export const listOverTheBoxDeviceActions: API.OperationMethod<
2488
+ ListOverTheBoxDeviceActionsRequest,
2489
+ ListOverTheBoxDeviceActionsResponse,
2490
+ ListOverTheBoxDeviceActionsError,
2491
+ OvhOpContext
2492
+ > = /*@__PURE__*/ API.make(() => ({
2493
+ input: ListOverTheBoxDeviceActionsRequest,
2494
+ output: ListOverTheBoxDeviceActionsResponse,
2495
+ errors: [UnknownOvhError],
2496
+ protocol: OvhProtocol,
2497
+ retry: Retry.Retry,
2498
+ }));
2499
+
2500
+ export type ListOverTheBoxDeviceAvailableActionsError = OvhOpError;
2501
+ /** List the available device actions */
2502
+ export const listOverTheBoxDeviceAvailableActions: API.OperationMethod<
2503
+ ListOverTheBoxDeviceAvailableActionsRequest,
2504
+ ListOverTheBoxDeviceAvailableActionsResponse,
2505
+ ListOverTheBoxDeviceAvailableActionsError,
2506
+ OvhOpContext
2507
+ > = /*@__PURE__*/ API.make(() => ({
2508
+ input: ListOverTheBoxDeviceAvailableActionsRequest,
2509
+ output: ListOverTheBoxDeviceAvailableActionsResponse,
2510
+ errors: [UnknownOvhError],
2511
+ protocol: OvhProtocol,
2512
+ retry: Retry.Retry,
2513
+ }));
2514
+
2515
+ export type ListOverTheBoxHardwareError = OvhOpError;
2516
+ /** List available services */
2517
+ export const listOverTheBoxHardware: API.OperationMethod<
2518
+ ListOverTheBoxHardwareRequest,
2519
+ ListOverTheBoxHardwareResponse,
2520
+ ListOverTheBoxHardwareError,
2521
+ OvhOpContext
2522
+ > = /*@__PURE__*/ API.make(() => ({
2523
+ input: ListOverTheBoxHardwareRequest,
2524
+ output: ListOverTheBoxHardwareResponse,
2525
+ errors: [UnknownOvhError],
2526
+ protocol: OvhProtocol,
2527
+ retry: Retry.Retry,
2528
+ }));
2529
+
2530
+ export type ListOverTheBoxHardwareAvailableError = OvhOpError;
2531
+ /** List hardware that can be linked to a service */
2532
+ export const listOverTheBoxHardwareAvailable: API.OperationMethod<
2533
+ ListOverTheBoxHardwareAvailableRequest,
2534
+ ListOverTheBoxHardwareAvailableResponse,
2535
+ ListOverTheBoxHardwareAvailableError,
2536
+ OvhOpContext
2537
+ > = /*@__PURE__*/ API.make(() => ({
2538
+ input: ListOverTheBoxHardwareAvailableRequest,
2539
+ output: ListOverTheBoxHardwareAvailableResponse,
2540
+ errors: [UnknownOvhError],
2541
+ protocol: OvhProtocol,
2542
+ retry: Retry.Retry,
2543
+ }));
2544
+
2545
+ export type ListOverTheBoxIpsError = OvhOpError;
2546
+ /** List IP assigned to an OverTheBox service */
2547
+ export const listOverTheBoxIps: API.OperationMethod<
2548
+ ListOverTheBoxIpsRequest,
2549
+ ListOverTheBoxIpsResponse,
2550
+ ListOverTheBoxIpsError,
2551
+ OvhOpContext
2552
+ > = /*@__PURE__*/ API.make(() => ({
2553
+ input: ListOverTheBoxIpsRequest,
2554
+ output: ListOverTheBoxIpsResponse,
2555
+ errors: [UnknownOvhError],
2556
+ protocol: OvhProtocol,
2557
+ retry: Retry.Retry,
2558
+ }));
2559
+
2560
+ export type ListOverTheBoxMigrationOffersError = OvhOpError;
2561
+ /** List all available offers one can migrate to */
2562
+ export const listOverTheBoxMigrationOffers: API.OperationMethod<
2563
+ ListOverTheBoxMigrationOffersRequest,
2564
+ ListOverTheBoxMigrationOffersResponse,
2565
+ ListOverTheBoxMigrationOffersError,
2566
+ OvhOpContext
2567
+ > = /*@__PURE__*/ API.make(() => ({
2568
+ input: ListOverTheBoxMigrationOffersRequest,
2569
+ output: ListOverTheBoxMigrationOffersResponse,
2570
+ errors: [UnknownOvhError],
2571
+ protocol: OvhProtocol,
2572
+ retry: Retry.Retry,
2573
+ }));
2574
+
2575
+ export type ListOverTheBoxRemoteAccessesError = OvhOpError;
2576
+ /** List of remote accesses for the service */
2577
+ export const listOverTheBoxRemoteAccesses: API.OperationMethod<
2578
+ ListOverTheBoxRemoteAccessesRequest,
2579
+ ListOverTheBoxRemoteAccessesResponse,
2580
+ ListOverTheBoxRemoteAccessesError,
2581
+ OvhOpContext
2582
+ > = /*@__PURE__*/ API.make(() => ({
2583
+ input: ListOverTheBoxRemoteAccessesRequest,
2584
+ output: ListOverTheBoxRemoteAccessesResponse,
2585
+ errors: [UnknownOvhError],
2586
+ protocol: OvhProtocol,
2587
+ retry: Retry.Retry,
2588
+ }));
2589
+
2590
+ export type ListOverTheBoxStatisticsError = OvhOpError;
2591
+ /** Get statistics for an OTB device */
2592
+ export const listOverTheBoxStatistics: API.OperationMethod<
2593
+ ListOverTheBoxStatisticsRequest,
2594
+ ListOverTheBoxStatisticsResponse,
2595
+ ListOverTheBoxStatisticsError,
2596
+ OvhOpContext
2597
+ > = /*@__PURE__*/ API.make(() => ({
2598
+ input: ListOverTheBoxStatisticsRequest,
2599
+ output: ListOverTheBoxStatisticsResponse,
2600
+ errors: [UnknownOvhError],
2601
+ protocol: OvhProtocol,
2602
+ retry: Retry.Retry,
2603
+ }));
2604
+
2605
+ export type ListOverTheBoxTasksError = OvhOpError;
2606
+ /** List of tasks scheduled for this service */
2607
+ export const listOverTheBoxTasks: API.OperationMethod<
2608
+ ListOverTheBoxTasksRequest,
2609
+ ListOverTheBoxTasksResponse,
2610
+ ListOverTheBoxTasksError,
2611
+ OvhOpContext
2612
+ > = /*@__PURE__*/ API.make(() => ({
2613
+ input: ListOverTheBoxTasksRequest,
2614
+ output: ListOverTheBoxTasksResponse,
2615
+ errors: [UnknownOvhError],
2616
+ protocol: OvhProtocol,
2617
+ retry: Retry.Retry,
2618
+ }));
2619
+
2620
+ export type PutOverTheBoxError = OvhOpError;
2621
+ /** Alter this object properties */
2622
+ export const putOverTheBox: API.OperationMethod<
2623
+ PutOverTheBoxRequest,
2624
+ PutOverTheBoxResponse,
2625
+ PutOverTheBoxError,
2626
+ OvhOpContext
2627
+ > = /*@__PURE__*/ API.make(() => ({
2628
+ input: PutOverTheBoxRequest,
2629
+ output: PutOverTheBoxResponse,
2630
+ errors: [UnknownOvhError],
2631
+ protocol: OvhProtocol,
2632
+ retry: Retry.Retry,
2633
+ }));
2634
+
2635
+ export type PutOverTheBoxAutoMTUError = OvhOpError;
2636
+ /** Change the value of autoMTU */
2637
+ export const putOverTheBoxAutoMTU: API.OperationMethod<
2638
+ PutOverTheBoxAutoMTURequest,
2639
+ PutOverTheBoxAutoMTUResponse,
2640
+ PutOverTheBoxAutoMTUError,
2641
+ OvhOpContext
2642
+ > = /*@__PURE__*/ API.make(() => ({
2643
+ input: PutOverTheBoxAutoMTURequest,
2644
+ output: PutOverTheBoxAutoMTUResponse,
2645
+ errors: [UnknownOvhError],
2646
+ protocol: OvhProtocol,
2647
+ retry: Retry.Retry,
2648
+ }));
2649
+
2650
+ export type PutOverTheBoxIpv6Error = OvhOpError;
2651
+ /** Change the status of IPv6 on this service */
2652
+ export const putOverTheBoxIpv6: API.OperationMethod<
2653
+ PutOverTheBoxIpv6Request,
2654
+ OverTheBoxTask,
2655
+ PutOverTheBoxIpv6Error,
2656
+ OvhOpContext
2657
+ > = /*@__PURE__*/ API.make(() => ({
2658
+ input: PutOverTheBoxIpv6Request,
2659
+ output: OverTheBoxTask,
2660
+ errors: [UnknownOvhError],
2661
+ protocol: OvhProtocol,
2662
+ retry: Retry.Retry,
2663
+ }));
2664
+
2665
+ export type PutOverTheBoxServiceInfosError = OvhOpError;
2666
+ /** Update service information */
2667
+ export const putOverTheBoxServiceInfos: API.OperationMethod<
2668
+ PutOverTheBoxServiceInfosRequest,
2669
+ PutOverTheBoxServiceInfosResponse,
2670
+ PutOverTheBoxServiceInfosError,
2671
+ OvhOpContext
2672
+ > = /*@__PURE__*/ API.make(() => ({
2673
+ input: PutOverTheBoxServiceInfosRequest,
2674
+ output: PutOverTheBoxServiceInfosResponse,
2675
+ errors: [UnknownOvhError],
2676
+ protocol: OvhProtocol,
2677
+ retry: Retry.Retry,
2678
+ }));
2679
+
2680
+ export type RestoreOverTheBoxDeviceBackupError = OvhOpError;
2681
+ /** Create a group of actions to restore a given backup */
2682
+ export const restoreOverTheBoxDeviceBackup: API.OperationMethod<
2683
+ RestoreOverTheBoxDeviceBackupRequest,
2684
+ RestoreOverTheBoxDeviceBackupResponse,
2685
+ RestoreOverTheBoxDeviceBackupError,
2686
+ OvhOpContext
2687
+ > = /*@__PURE__*/ API.make(() => ({
2688
+ input: RestoreOverTheBoxDeviceBackupRequest,
2689
+ output: RestoreOverTheBoxDeviceBackupResponse,
2690
+ errors: [UnknownOvhError],
2691
+ protocol: OvhProtocol,
2692
+ retry: Retry.Retry,
2693
+ }));