@serve.zone/dcrouter-apiclient 32.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/dist_ts_apiclient/classes.apitoken.d.ts +41 -0
  2. package/dist_ts_apiclient/classes.apitoken.js +115 -0
  3. package/dist_ts_apiclient/classes.certificate.d.ts +57 -0
  4. package/dist_ts_apiclient/classes.certificate.js +69 -0
  5. package/dist_ts_apiclient/classes.config.d.ts +7 -0
  6. package/dist_ts_apiclient/classes.config.js +11 -0
  7. package/dist_ts_apiclient/classes.dcrouterapiclient.d.ts +54 -0
  8. package/dist_ts_apiclient/classes.dcrouterapiclient.js +97 -0
  9. package/dist_ts_apiclient/classes.email.d.ts +30 -0
  10. package/dist_ts_apiclient/classes.email.js +52 -0
  11. package/dist_ts_apiclient/classes.gatewayclient.d.ts +28 -0
  12. package/dist_ts_apiclient/classes.gatewayclient.js +52 -0
  13. package/dist_ts_apiclient/classes.logs.d.ts +28 -0
  14. package/dist_ts_apiclient/classes.logs.js +69 -0
  15. package/dist_ts_apiclient/classes.radius.d.ts +59 -0
  16. package/dist_ts_apiclient/classes.radius.js +95 -0
  17. package/dist_ts_apiclient/classes.remoteingress.d.ts +66 -0
  18. package/dist_ts_apiclient/classes.remoteingress.js +164 -0
  19. package/dist_ts_apiclient/classes.route.d.ts +39 -0
  20. package/dist_ts_apiclient/classes.route.js +125 -0
  21. package/dist_ts_apiclient/classes.stats.d.ts +47 -0
  22. package/dist_ts_apiclient/classes.stats.js +38 -0
  23. package/dist_ts_apiclient/classes.testing.d.ts +65 -0
  24. package/dist_ts_apiclient/classes.testing.js +120 -0
  25. package/dist_ts_apiclient/index.d.ts +12 -0
  26. package/dist_ts_apiclient/index.js +16 -0
  27. package/dist_ts_apiclient/plugins.d.ts +4 -0
  28. package/dist_ts_apiclient/plugins.js +6 -0
  29. package/dist_ts_interfaces/data/acme-config.d.ts +23 -0
  30. package/dist_ts_interfaces/data/acme-config.js +2 -0
  31. package/dist_ts_interfaces/data/auth.d.ts +8 -0
  32. package/dist_ts_interfaces/data/auth.js +2 -0
  33. package/dist_ts_interfaces/data/config-events.d.ts +34 -0
  34. package/dist_ts_interfaces/data/config-events.js +8 -0
  35. package/dist_ts_interfaces/data/dns-authority.d.ts +98 -0
  36. package/dist_ts_interfaces/data/dns-authority.js +26 -0
  37. package/dist_ts_interfaces/data/dns-provider.d.ts +136 -0
  38. package/dist_ts_interfaces/data/dns-provider.js +41 -0
  39. package/dist_ts_interfaces/data/dns-record.d.ts +48 -0
  40. package/dist_ts_interfaces/data/dns-record.js +2 -0
  41. package/dist_ts_interfaces/data/domain.d.ts +35 -0
  42. package/dist_ts_interfaces/data/domain.js +2 -0
  43. package/dist_ts_interfaces/data/email-domain.d.ts +177 -0
  44. package/dist_ts_interfaces/data/email-domain.js +2 -0
  45. package/dist_ts_interfaces/data/email-settings.d.ts +68 -0
  46. package/dist_ts_interfaces/data/email-settings.js +2 -0
  47. package/dist_ts_interfaces/data/index.d.ts +18 -0
  48. package/dist_ts_interfaces/data/index.js +19 -0
  49. package/dist_ts_interfaces/data/remoteingress.d.ts +181 -0
  50. package/dist_ts_interfaces/data/remoteingress.js +15 -0
  51. package/dist_ts_interfaces/data/route-management.d.ts +270 -0
  52. package/dist_ts_interfaces/data/route-management.js +130 -0
  53. package/dist_ts_interfaces/data/security-policy.d.ts +32 -0
  54. package/dist_ts_interfaces/data/security-policy.js +2 -0
  55. package/dist_ts_interfaces/data/smtp-account.d.ts +50 -0
  56. package/dist_ts_interfaces/data/smtp-account.js +9 -0
  57. package/dist_ts_interfaces/data/stats.d.ts +283 -0
  58. package/dist_ts_interfaces/data/stats.js +2 -0
  59. package/dist_ts_interfaces/data/target-profile.d.ts +30 -0
  60. package/dist_ts_interfaces/data/target-profile.js +2 -0
  61. package/dist_ts_interfaces/data/testing.d.ts +191 -0
  62. package/dist_ts_interfaces/data/testing.js +20 -0
  63. package/dist_ts_interfaces/data/vpn.d.ts +65 -0
  64. package/dist_ts_interfaces/data/vpn.js +2 -0
  65. package/dist_ts_interfaces/data/workhoster.d.ts +63 -0
  66. package/dist_ts_interfaces/data/workhoster.js +2 -0
  67. package/dist_ts_interfaces/index.d.ts +5 -0
  68. package/dist_ts_interfaces/index.js +8 -0
  69. package/dist_ts_interfaces/plugins.d.ts +2 -0
  70. package/dist_ts_interfaces/plugins.js +4 -0
  71. package/dist_ts_interfaces/requests/acme-config.d.ts +42 -0
  72. package/dist_ts_interfaces/requests/acme-config.js +2 -0
  73. package/dist_ts_interfaces/requests/admin.d.ts +69 -0
  74. package/dist_ts_interfaces/requests/admin.js +3 -0
  75. package/dist_ts_interfaces/requests/api-tokens.d.ts +85 -0
  76. package/dist_ts_interfaces/requests/api-tokens.js +2 -0
  77. package/dist_ts_interfaces/requests/certificate.d.ts +87 -0
  78. package/dist_ts_interfaces/requests/certificate.js +5 -0
  79. package/dist_ts_interfaces/requests/combined.stats.d.ts +29 -0
  80. package/dist_ts_interfaces/requests/combined.stats.js +2 -0
  81. package/dist_ts_interfaces/requests/config-events.d.ts +35 -0
  82. package/dist_ts_interfaces/requests/config-events.js +4 -0
  83. package/dist_ts_interfaces/requests/config.d.ts +93 -0
  84. package/dist_ts_interfaces/requests/config.js +3 -0
  85. package/dist_ts_interfaces/requests/dns-authority.d.ts +80 -0
  86. package/dist_ts_interfaces/requests/dns-authority.js +3 -0
  87. package/dist_ts_interfaces/requests/dns-providers.d.ts +117 -0
  88. package/dist_ts_interfaces/requests/dns-providers.js +2 -0
  89. package/dist_ts_interfaces/requests/dns-records.d.ts +89 -0
  90. package/dist_ts_interfaces/requests/dns-records.js +2 -0
  91. package/dist_ts_interfaces/requests/domains.d.ts +142 -0
  92. package/dist_ts_interfaces/requests/domains.js +2 -0
  93. package/dist_ts_interfaces/requests/email-domains.d.ts +154 -0
  94. package/dist_ts_interfaces/requests/email-domains.js +2 -0
  95. package/dist_ts_interfaces/requests/email-ops.d.ts +211 -0
  96. package/dist_ts_interfaces/requests/email-ops.js +3 -0
  97. package/dist_ts_interfaces/requests/email-settings.d.ts +26 -0
  98. package/dist_ts_interfaces/requests/email-settings.js +2 -0
  99. package/dist_ts_interfaces/requests/index.d.ts +29 -0
  100. package/dist_ts_interfaces/requests/index.js +30 -0
  101. package/dist_ts_interfaces/requests/logs.d.ts +43 -0
  102. package/dist_ts_interfaces/requests/logs.js +4 -0
  103. package/dist_ts_interfaces/requests/network-targets.d.ts +102 -0
  104. package/dist_ts_interfaces/requests/network-targets.js +2 -0
  105. package/dist_ts_interfaces/requests/radius.d.ts +280 -0
  106. package/dist_ts_interfaces/requests/radius.js +3 -0
  107. package/dist_ts_interfaces/requests/realtime.d.ts +38 -0
  108. package/dist_ts_interfaces/requests/realtime.js +12 -0
  109. package/dist_ts_interfaces/requests/remoteingress.d.ts +162 -0
  110. package/dist_ts_interfaces/requests/remoteingress.js +3 -0
  111. package/dist_ts_interfaces/requests/route-management.d.ts +147 -0
  112. package/dist_ts_interfaces/requests/route-management.js +2 -0
  113. package/dist_ts_interfaces/requests/security-policy.d.ts +105 -0
  114. package/dist_ts_interfaces/requests/security-policy.js +2 -0
  115. package/dist_ts_interfaces/requests/smtp-accounts.d.ts +125 -0
  116. package/dist_ts_interfaces/requests/smtp-accounts.js +2 -0
  117. package/dist_ts_interfaces/requests/source-profiles.d.ts +102 -0
  118. package/dist_ts_interfaces/requests/source-profiles.js +2 -0
  119. package/dist_ts_interfaces/requests/stats.d.ts +196 -0
  120. package/dist_ts_interfaces/requests/stats.js +4 -0
  121. package/dist_ts_interfaces/requests/target-profiles.d.ts +105 -0
  122. package/dist_ts_interfaces/requests/target-profiles.js +2 -0
  123. package/dist_ts_interfaces/requests/testing.d.ts +169 -0
  124. package/dist_ts_interfaces/requests/testing.js +2 -0
  125. package/dist_ts_interfaces/requests/users.d.ts +53 -0
  126. package/dist_ts_interfaces/requests/users.js +3 -0
  127. package/dist_ts_interfaces/requests/vpn.d.ts +188 -0
  128. package/dist_ts_interfaces/requests/vpn.js +3 -0
  129. package/dist_ts_interfaces/requests/workhoster.d.ts +79 -0
  130. package/dist_ts_interfaces/requests/workhoster.js +2 -0
  131. package/license +21 -0
  132. package/package.json +67 -0
  133. package/readme.md +218 -0
  134. package/ts_apiclient/classes.apitoken.ts +157 -0
  135. package/ts_apiclient/classes.certificate.ts +124 -0
  136. package/ts_apiclient/classes.config.ts +17 -0
  137. package/ts_apiclient/classes.dcrouterapiclient.ts +138 -0
  138. package/ts_apiclient/classes.email.ts +77 -0
  139. package/ts_apiclient/classes.gatewayclient.ts +110 -0
  140. package/ts_apiclient/classes.logs.ts +91 -0
  141. package/ts_apiclient/classes.radius.ts +180 -0
  142. package/ts_apiclient/classes.remoteingress.ts +217 -0
  143. package/ts_apiclient/classes.route.ts +166 -0
  144. package/ts_apiclient/classes.stats.ts +111 -0
  145. package/ts_apiclient/classes.testing.ts +152 -0
  146. package/ts_apiclient/index.ts +17 -0
  147. package/ts_apiclient/plugins.ts +10 -0
  148. package/ts_apiclient/readme.md +218 -0
  149. package/ts_interfaces/data/acme-config.ts +23 -0
  150. package/ts_interfaces/data/auth.ts +8 -0
  151. package/ts_interfaces/data/config-events.ts +38 -0
  152. package/ts_interfaces/data/dns-authority.ts +106 -0
  153. package/ts_interfaces/data/dns-provider.ts +174 -0
  154. package/ts_interfaces/data/dns-record.ts +50 -0
  155. package/ts_interfaces/data/domain.ts +36 -0
  156. package/ts_interfaces/data/email-domain.ts +206 -0
  157. package/ts_interfaces/data/email-settings.ts +75 -0
  158. package/ts_interfaces/data/index.ts +18 -0
  159. package/ts_interfaces/data/remoteingress.ts +204 -0
  160. package/ts_interfaces/data/route-management.ts +436 -0
  161. package/ts_interfaces/data/security-policy.ts +37 -0
  162. package/ts_interfaces/data/smtp-account.ts +63 -0
  163. package/ts_interfaces/data/stats.ts +305 -0
  164. package/ts_interfaces/data/target-profile.ts +31 -0
  165. package/ts_interfaces/data/testing.ts +184 -0
  166. package/ts_interfaces/data/vpn.ts +68 -0
  167. package/ts_interfaces/data/workhoster.ts +72 -0
  168. package/ts_interfaces/index.ts +9 -0
  169. package/ts_interfaces/plugins.ts +6 -0
  170. package/ts_interfaces/readme.md +194 -0
  171. package/ts_interfaces/requests/acme-config.ts +54 -0
  172. package/ts_interfaces/requests/admin.ts +96 -0
  173. package/ts_interfaces/requests/api-tokens.ts +109 -0
  174. package/ts_interfaces/requests/certificate.ts +106 -0
  175. package/ts_interfaces/requests/combined.stats.ts +30 -0
  176. package/ts_interfaces/requests/config-events.ts +45 -0
  177. package/ts_interfaces/requests/config.ts +94 -0
  178. package/ts_interfaces/requests/dns-authority.ts +104 -0
  179. package/ts_interfaces/requests/dns-providers.ts +154 -0
  180. package/ts_interfaces/requests/dns-records.ts +113 -0
  181. package/ts_interfaces/requests/domains.ts +178 -0
  182. package/ts_interfaces/requests/email-domains.ts +193 -0
  183. package/ts_interfaces/requests/email-ops.ts +266 -0
  184. package/ts_interfaces/requests/email-settings.ts +34 -0
  185. package/ts_interfaces/requests/index.ts +29 -0
  186. package/ts_interfaces/requests/logs.ts +58 -0
  187. package/ts_interfaces/requests/network-targets.ts +127 -0
  188. package/ts_interfaces/requests/radius.ts +341 -0
  189. package/ts_interfaces/requests/realtime.ts +59 -0
  190. package/ts_interfaces/requests/remoteingress.ts +202 -0
  191. package/ts_interfaces/requests/route-management.ts +194 -0
  192. package/ts_interfaces/requests/security-policy.ts +144 -0
  193. package/ts_interfaces/requests/smtp-accounts.ts +163 -0
  194. package/ts_interfaces/requests/source-profiles.ts +127 -0
  195. package/ts_interfaces/requests/stats.ts +207 -0
  196. package/ts_interfaces/requests/target-profiles.ts +130 -0
  197. package/ts_interfaces/requests/testing.ts +186 -0
  198. package/ts_interfaces/requests/users.ts +66 -0
  199. package/ts_interfaces/requests/vpn.ts +238 -0
  200. package/ts_interfaces/requests/workhoster.ts +100 -0
@@ -0,0 +1,280 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ /**
4
+ * Get all RADIUS clients (NAS devices)
5
+ */
6
+ export interface IReq_GetRadiusClients extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRadiusClients> {
7
+ method: 'getRadiusClients';
8
+ request: {
9
+ identity?: authInterfaces.IIdentity;
10
+ apiToken?: string;
11
+ };
12
+ response: {
13
+ clients: Array<{
14
+ name: string;
15
+ ipRange: string;
16
+ description?: string;
17
+ enabled: boolean;
18
+ }>;
19
+ };
20
+ }
21
+ /**
22
+ * Add or update a RADIUS client
23
+ */
24
+ export interface IReq_SetRadiusClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_SetRadiusClient> {
25
+ method: 'setRadiusClient';
26
+ request: {
27
+ identity?: authInterfaces.IIdentity;
28
+ apiToken?: string;
29
+ client: {
30
+ name: string;
31
+ ipRange: string;
32
+ secret: string;
33
+ description?: string;
34
+ enabled: boolean;
35
+ };
36
+ };
37
+ response: {
38
+ success: boolean;
39
+ message?: string;
40
+ };
41
+ }
42
+ /**
43
+ * Remove a RADIUS client
44
+ */
45
+ export interface IReq_RemoveRadiusClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RemoveRadiusClient> {
46
+ method: 'removeRadiusClient';
47
+ request: {
48
+ identity?: authInterfaces.IIdentity;
49
+ apiToken?: string;
50
+ name: string;
51
+ };
52
+ response: {
53
+ success: boolean;
54
+ message?: string;
55
+ };
56
+ }
57
+ /**
58
+ * Get all MAC-to-VLAN mappings
59
+ */
60
+ export interface IReq_GetVlanMappings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetVlanMappings> {
61
+ method: 'getVlanMappings';
62
+ request: {
63
+ identity?: authInterfaces.IIdentity;
64
+ apiToken?: string;
65
+ };
66
+ response: {
67
+ mappings: Array<{
68
+ mac: string;
69
+ vlan: number;
70
+ description?: string;
71
+ enabled: boolean;
72
+ createdAt: number;
73
+ updatedAt: number;
74
+ }>;
75
+ config: {
76
+ defaultVlan: number;
77
+ allowUnknownMacs: boolean;
78
+ };
79
+ };
80
+ }
81
+ /**
82
+ * Add or update a VLAN mapping
83
+ */
84
+ export interface IReq_SetVlanMapping extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_SetVlanMapping> {
85
+ method: 'setVlanMapping';
86
+ request: {
87
+ identity?: authInterfaces.IIdentity;
88
+ apiToken?: string;
89
+ mapping: {
90
+ mac: string;
91
+ vlan: number;
92
+ description?: string;
93
+ enabled: boolean;
94
+ };
95
+ };
96
+ response: {
97
+ success: boolean;
98
+ mapping?: {
99
+ mac: string;
100
+ vlan: number;
101
+ description?: string;
102
+ enabled: boolean;
103
+ createdAt: number;
104
+ updatedAt: number;
105
+ };
106
+ message?: string;
107
+ };
108
+ }
109
+ /**
110
+ * Remove a VLAN mapping
111
+ */
112
+ export interface IReq_RemoveVlanMapping extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RemoveVlanMapping> {
113
+ method: 'removeVlanMapping';
114
+ request: {
115
+ identity?: authInterfaces.IIdentity;
116
+ apiToken?: string;
117
+ mac: string;
118
+ };
119
+ response: {
120
+ success: boolean;
121
+ message?: string;
122
+ };
123
+ }
124
+ /**
125
+ * Update VLAN configuration
126
+ */
127
+ export interface IReq_UpdateVlanConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateVlanConfig> {
128
+ method: 'updateVlanConfig';
129
+ request: {
130
+ identity?: authInterfaces.IIdentity;
131
+ apiToken?: string;
132
+ defaultVlan?: number;
133
+ allowUnknownMacs?: boolean;
134
+ };
135
+ response: {
136
+ success: boolean;
137
+ config: {
138
+ defaultVlan: number;
139
+ allowUnknownMacs: boolean;
140
+ };
141
+ };
142
+ }
143
+ /**
144
+ * Test VLAN assignment for a MAC address
145
+ */
146
+ export interface IReq_TestVlanAssignment extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_TestVlanAssignment> {
147
+ method: 'testVlanAssignment';
148
+ request: {
149
+ identity?: authInterfaces.IIdentity;
150
+ apiToken?: string;
151
+ mac: string;
152
+ };
153
+ response: {
154
+ assigned: boolean;
155
+ vlan: number;
156
+ isDefault: boolean;
157
+ matchedRule?: {
158
+ mac: string;
159
+ vlan: number;
160
+ description?: string;
161
+ };
162
+ };
163
+ }
164
+ /**
165
+ * Get active RADIUS sessions
166
+ */
167
+ export interface IReq_GetRadiusSessions extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRadiusSessions> {
168
+ method: 'getRadiusSessions';
169
+ request: {
170
+ identity?: authInterfaces.IIdentity;
171
+ apiToken?: string;
172
+ filter?: {
173
+ username?: string;
174
+ nasIpAddress?: string;
175
+ vlanId?: number;
176
+ };
177
+ };
178
+ response: {
179
+ sessions: Array<{
180
+ sessionId: string;
181
+ username: string;
182
+ macAddress?: string;
183
+ nasIpAddress: string;
184
+ nasIdentifier?: string;
185
+ vlanId?: number;
186
+ framedIpAddress?: string;
187
+ startTime: number;
188
+ lastUpdateTime: number;
189
+ status: 'active' | 'stopped' | 'terminated';
190
+ inputOctets: number;
191
+ outputOctets: number;
192
+ sessionTime: number;
193
+ }>;
194
+ totalCount: number;
195
+ };
196
+ }
197
+ /**
198
+ * Disconnect a RADIUS session
199
+ */
200
+ export interface IReq_DisconnectRadiusSession extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DisconnectRadiusSession> {
201
+ method: 'disconnectRadiusSession';
202
+ request: {
203
+ identity?: authInterfaces.IIdentity;
204
+ apiToken?: string;
205
+ sessionId: string;
206
+ reason?: string;
207
+ };
208
+ response: {
209
+ success: boolean;
210
+ message?: string;
211
+ };
212
+ }
213
+ /**
214
+ * Get accounting summary/report
215
+ */
216
+ export interface IReq_GetRadiusAccountingSummary extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRadiusAccountingSummary> {
217
+ method: 'getRadiusAccountingSummary';
218
+ request: {
219
+ identity?: authInterfaces.IIdentity;
220
+ apiToken?: string;
221
+ startTime: number;
222
+ endTime: number;
223
+ };
224
+ response: {
225
+ summary: {
226
+ periodStart: number;
227
+ periodEnd: number;
228
+ totalSessions: number;
229
+ activeSessions: number;
230
+ totalInputBytes: number;
231
+ totalOutputBytes: number;
232
+ totalSessionTime: number;
233
+ averageSessionDuration: number;
234
+ uniqueUsers: number;
235
+ sessionsByVlan: Record<number, number>;
236
+ topUsersByTraffic: Array<{
237
+ username: string;
238
+ totalBytes: number;
239
+ }>;
240
+ };
241
+ };
242
+ }
243
+ /**
244
+ * Get RADIUS server statistics
245
+ */
246
+ export interface IReq_GetRadiusStatistics extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRadiusStatistics> {
247
+ method: 'getRadiusStatistics';
248
+ request: {
249
+ identity?: authInterfaces.IIdentity;
250
+ apiToken?: string;
251
+ };
252
+ response: {
253
+ stats: {
254
+ running: boolean;
255
+ uptime: number;
256
+ authRequests: number;
257
+ authAccepts: number;
258
+ authRejects: number;
259
+ accountingRequests: number;
260
+ activeSessions: number;
261
+ vlanMappings: number;
262
+ clients: number;
263
+ };
264
+ vlanStats: {
265
+ totalMappings: number;
266
+ enabledMappings: number;
267
+ exactMatches: number;
268
+ ouiPatterns: number;
269
+ wildcardPatterns: number;
270
+ };
271
+ accountingStats: {
272
+ activeSessions: number;
273
+ totalSessionsStarted: number;
274
+ totalSessionsStopped: number;
275
+ totalInputBytes: number;
276
+ totalOutputBytes: number;
277
+ interimUpdatesReceived: number;
278
+ };
279
+ };
280
+ }
@@ -0,0 +1,3 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmFkaXVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfaW50ZXJmYWNlcy9yZXF1ZXN0cy9yYWRpdXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUM7QUFDekMsT0FBTyxLQUFLLGNBQWMsTUFBTSxpQkFBaUIsQ0FBQyJ9
@@ -0,0 +1,38 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type { IIdentity } from '../data/auth.js';
3
+ export declare const opsRealtimeResources: readonly ["emailDomains", "emailQueue", "smtpAttempts", "dns", "routes", "edges", "certificates", "configEvents"];
4
+ export type TOpsRealtimeResource = (typeof opsRealtimeResources)[number];
5
+ export type IOpsRealtimeRevisionMap = Record<TOpsRealtimeResource, number>;
6
+ export interface IOpsRealtimeInvalidation {
7
+ resource: TOpsRealtimeResource;
8
+ revision: number;
9
+ changedIds?: string[];
10
+ reason?: string;
11
+ timestamp: number;
12
+ }
13
+ /**
14
+ * Authenticates the current WebSocket peer and returns anything newer than the
15
+ * client's last accepted revision. The tag is assigned by the server only.
16
+ */
17
+ export interface IReq_SubscribeOpsRealtime extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_SubscribeOpsRealtime> {
18
+ method: 'subscribeOpsRealtime';
19
+ request: {
20
+ identity: IIdentity;
21
+ knownServerEpoch?: string;
22
+ knownRevisions?: Partial<IOpsRealtimeRevisionMap>;
23
+ };
24
+ response: {
25
+ serverEpoch: string;
26
+ revisions: IOpsRealtimeRevisionMap;
27
+ invalidations: IOpsRealtimeInvalidation[];
28
+ };
29
+ }
30
+ /** Server-to-browser notification. Resource data remains behind authenticated reads. */
31
+ export interface IReq_PushOpsRealtimeInvalidation extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_PushOpsRealtimeInvalidation> {
32
+ method: 'pushOpsRealtimeInvalidation';
33
+ request: {
34
+ serverEpoch: string;
35
+ invalidations: IOpsRealtimeInvalidation[];
36
+ };
37
+ response: Record<string, never>;
38
+ }
@@ -0,0 +1,12 @@
1
+ import * as plugins from '../plugins.js';
2
+ export const opsRealtimeResources = [
3
+ 'emailDomains',
4
+ 'emailQueue',
5
+ 'smtpAttempts',
6
+ 'dns',
7
+ 'routes',
8
+ 'edges',
9
+ 'certificates',
10
+ 'configEvents',
11
+ ];
12
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVhbHRpbWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19pbnRlcmZhY2VzL3JlcXVlc3RzL3JlYWx0aW1lLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBR3pDLE1BQU0sQ0FBQyxNQUFNLG9CQUFvQixHQUFHO0lBQ2xDLGNBQWM7SUFDZCxZQUFZO0lBQ1osY0FBYztJQUNkLEtBQUs7SUFDTCxRQUFRO0lBQ1IsT0FBTztJQUNQLGNBQWM7SUFDZCxjQUFjO0NBQ04sQ0FBQyJ9
@@ -0,0 +1,162 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ import type { IRemoteIngress, IRemoteIngressEgressPolicyConfig, IRemoteIngressHubSettings, IRemoteIngressPerformanceConfig, IRemoteIngressStatus } from '../data/remoteingress.js';
4
+ /**
5
+ * Create a new remote ingress edge registration.
6
+ */
7
+ export interface IReq_CreateRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateRemoteIngress> {
8
+ method: 'createRemoteIngress';
9
+ request: {
10
+ identity?: authInterfaces.IIdentity;
11
+ apiToken?: string;
12
+ name: string;
13
+ listenPorts?: number[];
14
+ autoDerivePorts?: boolean;
15
+ performance?: IRemoteIngressPerformanceConfig;
16
+ egress?: IRemoteIngressEgressPolicyConfig;
17
+ tags?: string[];
18
+ publicIp?: string;
19
+ publicIpV6?: string;
20
+ mailHostname?: string;
21
+ };
22
+ response: {
23
+ success: boolean;
24
+ edge: IRemoteIngress;
25
+ /** Failure reason (e.g. rejected publicIp) when success is false. */
26
+ message?: string;
27
+ };
28
+ }
29
+ /**
30
+ * Delete a remote ingress edge registration.
31
+ */
32
+ export interface IReq_DeleteRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteRemoteIngress> {
33
+ method: 'deleteRemoteIngress';
34
+ request: {
35
+ identity?: authInterfaces.IIdentity;
36
+ apiToken?: string;
37
+ id: string;
38
+ };
39
+ response: {
40
+ success: boolean;
41
+ message?: string;
42
+ };
43
+ }
44
+ /**
45
+ * Update a remote ingress edge registration.
46
+ */
47
+ export interface IReq_UpdateRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateRemoteIngress> {
48
+ method: 'updateRemoteIngress';
49
+ request: {
50
+ identity?: authInterfaces.IIdentity;
51
+ apiToken?: string;
52
+ id: string;
53
+ name?: string;
54
+ listenPorts?: number[];
55
+ autoDerivePorts?: boolean;
56
+ enabled?: boolean;
57
+ performance?: IRemoteIngressPerformanceConfig;
58
+ egress?: IRemoteIngressEgressPolicyConfig;
59
+ tags?: string[];
60
+ /** null clears the stored value. */
61
+ publicIp?: string | null;
62
+ publicIpV6?: string | null;
63
+ mailHostname?: string | null;
64
+ };
65
+ response: {
66
+ success: boolean;
67
+ edge: IRemoteIngress;
68
+ /** Failure reason (e.g. rejected publicIp) when success is false. */
69
+ message?: string;
70
+ };
71
+ }
72
+ /**
73
+ * Regenerate the secret for a remote ingress edge.
74
+ */
75
+ export interface IReq_RegenerateRemoteIngressSecret extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RegenerateRemoteIngressSecret> {
76
+ method: 'regenerateRemoteIngressSecret';
77
+ request: {
78
+ identity?: authInterfaces.IIdentity;
79
+ apiToken?: string;
80
+ id: string;
81
+ };
82
+ response: {
83
+ success: boolean;
84
+ secret: string;
85
+ };
86
+ }
87
+ /**
88
+ * Get all remote ingress edge registrations.
89
+ */
90
+ export interface IReq_GetRemoteIngresses extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRemoteIngresses> {
91
+ method: 'getRemoteIngresses';
92
+ request: {
93
+ identity?: authInterfaces.IIdentity;
94
+ apiToken?: string;
95
+ };
96
+ response: {
97
+ edges: IRemoteIngress[];
98
+ };
99
+ }
100
+ /**
101
+ * Get runtime status of all remote ingress edges.
102
+ */
103
+ export interface IReq_GetRemoteIngressStatus extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRemoteIngressStatus> {
104
+ method: 'getRemoteIngressStatus';
105
+ request: {
106
+ identity?: authInterfaces.IIdentity;
107
+ apiToken?: string;
108
+ };
109
+ response: {
110
+ statuses: IRemoteIngressStatus[];
111
+ };
112
+ }
113
+ /**
114
+ * Get a connection token for a remote ingress edge.
115
+ * The token is a single opaque base64url string that encodes hubHost, hubPort, edgeId, and secret.
116
+ */
117
+ export interface IReq_GetRemoteIngressConnectionToken extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRemoteIngressConnectionToken> {
118
+ method: 'getRemoteIngressConnectionToken';
119
+ request: {
120
+ identity?: authInterfaces.IIdentity;
121
+ apiToken?: string;
122
+ edgeId: string;
123
+ hubHost?: string;
124
+ };
125
+ response: {
126
+ success: boolean;
127
+ token?: string;
128
+ message?: string;
129
+ };
130
+ }
131
+ /**
132
+ * Get hub-level RemoteIngress settings.
133
+ */
134
+ export interface IReq_GetRemoteIngressHubSettings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRemoteIngressHubSettings> {
135
+ method: 'getRemoteIngressHubSettings';
136
+ request: {
137
+ identity?: authInterfaces.IIdentity;
138
+ apiToken?: string;
139
+ };
140
+ response: {
141
+ settings: IRemoteIngressHubSettings;
142
+ };
143
+ }
144
+ /**
145
+ * Update hub-level RemoteIngress settings.
146
+ */
147
+ export interface IReq_UpdateRemoteIngressHubSettings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateRemoteIngressHubSettings> {
148
+ method: 'updateRemoteIngressHubSettings';
149
+ request: {
150
+ identity?: authInterfaces.IIdentity;
151
+ apiToken?: string;
152
+ enabled?: boolean;
153
+ tunnelPort?: number;
154
+ hubDomain?: string | null;
155
+ performance?: IRemoteIngressPerformanceConfig | null;
156
+ };
157
+ response: {
158
+ success: boolean;
159
+ settings?: IRemoteIngressHubSettings;
160
+ message?: string;
161
+ };
162
+ }
@@ -0,0 +1,3 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVtb3RlaW5ncmVzcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX2ludGVyZmFjZXMvcmVxdWVzdHMvcmVtb3RlaW5ncmVzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUN6QyxPQUFPLEtBQUssY0FBYyxNQUFNLGlCQUFpQixDQUFDIn0=
@@ -0,0 +1,147 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type * as authInterfaces from '../data/auth.js';
3
+ import type { IHttpRedirectInfo, ILetsEncryptHttp01ForwardConfig, IMergedRoute, IRouteWarning, IRouteMetadata } from '../data/route-management.js';
4
+ import type { IDcRouterRouteConfig } from '../data/remoteingress.js';
5
+ /**
6
+ * Get all routes with warnings.
7
+ */
8
+ export interface IReq_GetMergedRoutes extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetMergedRoutes> {
9
+ method: 'getMergedRoutes';
10
+ request: {
11
+ identity?: authInterfaces.IIdentity;
12
+ apiToken?: string;
13
+ };
14
+ response: {
15
+ routes: IMergedRoute[];
16
+ warnings: IRouteWarning[];
17
+ };
18
+ }
19
+ /**
20
+ * Get derived HTTP-to-HTTPS redirects.
21
+ */
22
+ export interface IReq_GetHttpRedirects extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetHttpRedirects> {
23
+ method: 'getHttpRedirects';
24
+ request: {
25
+ identity?: authInterfaces.IIdentity;
26
+ apiToken?: string;
27
+ };
28
+ response: {
29
+ redirects: IHttpRedirectInfo[];
30
+ };
31
+ }
32
+ /**
33
+ * Create a new route.
34
+ */
35
+ export interface IReq_CreateRoute extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateRoute> {
36
+ method: 'createRoute';
37
+ request: {
38
+ identity?: authInterfaces.IIdentity;
39
+ apiToken?: string;
40
+ route: IDcRouterRouteConfig;
41
+ enabled?: boolean;
42
+ metadata?: IRouteMetadata;
43
+ };
44
+ response: {
45
+ success: boolean;
46
+ routeId?: string;
47
+ message?: string;
48
+ };
49
+ }
50
+ /**
51
+ * Update a route.
52
+ */
53
+ export interface IReq_UpdateRoute extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateRoute> {
54
+ method: 'updateRoute';
55
+ request: {
56
+ identity?: authInterfaces.IIdentity;
57
+ apiToken?: string;
58
+ id: string;
59
+ route?: Partial<IDcRouterRouteConfig>;
60
+ enabled?: boolean;
61
+ metadata?: Partial<IRouteMetadata>;
62
+ };
63
+ response: {
64
+ success: boolean;
65
+ message?: string;
66
+ };
67
+ }
68
+ /**
69
+ * Delete a route.
70
+ */
71
+ export interface IReq_DeleteRoute extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteRoute> {
72
+ method: 'deleteRoute';
73
+ request: {
74
+ identity?: authInterfaces.IIdentity;
75
+ apiToken?: string;
76
+ id: string;
77
+ };
78
+ response: {
79
+ success: boolean;
80
+ message?: string;
81
+ };
82
+ }
83
+ /**
84
+ * Toggle a route on/off by id.
85
+ */
86
+ export interface IReq_ToggleRoute extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ToggleRoute> {
87
+ method: 'toggleRoute';
88
+ request: {
89
+ identity?: authInterfaces.IIdentity;
90
+ apiToken?: string;
91
+ id: string;
92
+ enabled: boolean;
93
+ };
94
+ response: {
95
+ success: boolean;
96
+ message?: string;
97
+ };
98
+ }
99
+ /**
100
+ * Create a server-managed Let's Encrypt HTTP-01 forward.
101
+ */
102
+ export interface IReq_CreateLetsEncryptHttp01Forward extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateLetsEncryptHttp01Forward> {
103
+ method: 'createLetsEncryptHttp01Forward';
104
+ request: {
105
+ identity?: authInterfaces.IIdentity;
106
+ apiToken?: string;
107
+ config: ILetsEncryptHttp01ForwardConfig;
108
+ enabled?: boolean;
109
+ };
110
+ response: {
111
+ success: boolean;
112
+ routeId?: string;
113
+ message?: string;
114
+ };
115
+ }
116
+ /**
117
+ * Update a server-managed Let's Encrypt HTTP-01 forward.
118
+ */
119
+ export interface IReq_UpdateLetsEncryptHttp01Forward extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateLetsEncryptHttp01Forward> {
120
+ method: 'updateLetsEncryptHttp01Forward';
121
+ request: {
122
+ identity?: authInterfaces.IIdentity;
123
+ apiToken?: string;
124
+ id: string;
125
+ config: ILetsEncryptHttp01ForwardConfig;
126
+ enabled?: boolean;
127
+ };
128
+ response: {
129
+ success: boolean;
130
+ message?: string;
131
+ };
132
+ }
133
+ /**
134
+ * Delete a server-managed Let's Encrypt HTTP-01 forward.
135
+ */
136
+ export interface IReq_DeleteLetsEncryptHttp01Forward extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteLetsEncryptHttp01Forward> {
137
+ method: 'deleteLetsEncryptHttp01Forward';
138
+ request: {
139
+ identity?: authInterfaces.IIdentity;
140
+ apiToken?: string;
141
+ id: string;
142
+ };
143
+ response: {
144
+ success: boolean;
145
+ message?: string;
146
+ };
147
+ }
@@ -0,0 +1,2 @@
1
+ import * as plugins from '../plugins.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGUtbWFuYWdlbWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX2ludGVyZmFjZXMvcmVxdWVzdHMvcm91dGUtbWFuYWdlbWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQyJ9