@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,207 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ import * as statsInterfaces from '../data/stats.js';
4
+
5
+ // Server Statistics
6
+ export interface IReq_GetServerStatistics extends plugins.typedrequestInterfaces.implementsTR<
7
+ plugins.typedrequestInterfaces.ITypedRequest,
8
+ IReq_GetServerStatistics
9
+ > {
10
+ method: 'getServerStatistics';
11
+ request: {
12
+ identity?: authInterfaces.IIdentity;
13
+ apiToken?: string;
14
+ includeHistory?: boolean;
15
+ timeRange?: '1h' | '6h' | '24h' | '7d' | '30d';
16
+ };
17
+ response: {
18
+ stats: statsInterfaces.IServerStats;
19
+ history?: Array<{
20
+ timestamp: number;
21
+ value: number;
22
+ }>;
23
+ };
24
+ }
25
+
26
+ // Email Statistics
27
+ export interface IReq_GetEmailStatistics extends plugins.typedrequestInterfaces.implementsTR<
28
+ plugins.typedrequestInterfaces.ITypedRequest,
29
+ IReq_GetEmailStatistics
30
+ > {
31
+ method: 'getEmailStatistics';
32
+ request: {
33
+ identity?: authInterfaces.IIdentity;
34
+ apiToken?: string;
35
+ timeRange?: '1h' | '6h' | '24h' | '7d' | '30d';
36
+ domain?: string;
37
+ includeDetails?: boolean;
38
+ };
39
+ response: {
40
+ stats: statsInterfaces.IEmailStats;
41
+ domainBreakdown?: {
42
+ [domain: string]: statsInterfaces.IEmailStats;
43
+ };
44
+ };
45
+ }
46
+
47
+ // DNS Statistics
48
+ export interface IReq_GetDnsStatistics extends plugins.typedrequestInterfaces.implementsTR<
49
+ plugins.typedrequestInterfaces.ITypedRequest,
50
+ IReq_GetDnsStatistics
51
+ > {
52
+ method: 'getDnsStatistics';
53
+ request: {
54
+ identity?: authInterfaces.IIdentity;
55
+ apiToken?: string;
56
+ timeRange?: '1h' | '6h' | '24h' | '7d' | '30d';
57
+ domain?: string;
58
+ includeQueryTypes?: boolean;
59
+ };
60
+ response: {
61
+ stats: statsInterfaces.IDnsStats;
62
+ domainBreakdown?: {
63
+ [domain: string]: statsInterfaces.IDnsStats;
64
+ };
65
+ };
66
+ }
67
+
68
+ // Rate Limit Status
69
+ export interface IReq_GetRateLimitStatus extends plugins.typedrequestInterfaces.implementsTR<
70
+ plugins.typedrequestInterfaces.ITypedRequest,
71
+ IReq_GetRateLimitStatus
72
+ > {
73
+ method: 'getRateLimitStatus';
74
+ request: {
75
+ identity?: authInterfaces.IIdentity;
76
+ apiToken?: string;
77
+ domain?: string;
78
+ ip?: string;
79
+ includeBlocked?: boolean;
80
+ };
81
+ response: {
82
+ limits: statsInterfaces.IRateLimitInfo[];
83
+ globalLimit?: {
84
+ current: number;
85
+ limit: number;
86
+ remaining: number;
87
+ };
88
+ };
89
+ }
90
+
91
+ // Security Metrics
92
+ export interface IReq_GetSecurityMetrics extends plugins.typedrequestInterfaces.implementsTR<
93
+ plugins.typedrequestInterfaces.ITypedRequest,
94
+ IReq_GetSecurityMetrics
95
+ > {
96
+ method: 'getSecurityMetrics';
97
+ request: {
98
+ identity?: authInterfaces.IIdentity;
99
+ apiToken?: string;
100
+ timeRange?: '1h' | '6h' | '24h' | '7d' | '30d';
101
+ includeDetails?: boolean;
102
+ };
103
+ response: {
104
+ metrics: statsInterfaces.ISecurityMetrics;
105
+ trends?: {
106
+ spam: Array<{ timestamp: number; value: number }>;
107
+ malware: Array<{ timestamp: number; value: number }>;
108
+ phishing: Array<{ timestamp: number; value: number }>;
109
+ };
110
+ };
111
+ }
112
+
113
+ // Active Connections
114
+ export interface IReq_GetActiveConnections extends plugins.typedrequestInterfaces.implementsTR<
115
+ plugins.typedrequestInterfaces.ITypedRequest,
116
+ IReq_GetActiveConnections
117
+ > {
118
+ method: 'getActiveConnections';
119
+ request: {
120
+ identity?: authInterfaces.IIdentity;
121
+ apiToken?: string;
122
+ protocol?: 'smtp' | 'smtps' | 'http' | 'https';
123
+ state?: string;
124
+ limit?: number;
125
+ cursor?: string;
126
+ };
127
+ response: {
128
+ connections: statsInterfaces.IConnectionInfo[];
129
+ summary: {
130
+ total: number;
131
+ byProtocol: {
132
+ [protocol: string]: number;
133
+ };
134
+ byState: {
135
+ [state: string]: number;
136
+ };
137
+ };
138
+ pagination: {
139
+ limit: number;
140
+ hasMore: boolean;
141
+ nextCursor?: string;
142
+ };
143
+ };
144
+ }
145
+
146
+ // Queue Status
147
+ export interface IReq_GetQueueStatus extends plugins.typedrequestInterfaces.implementsTR<
148
+ plugins.typedrequestInterfaces.ITypedRequest,
149
+ IReq_GetQueueStatus
150
+ > {
151
+ method: 'getQueueStatus';
152
+ request: {
153
+ identity?: authInterfaces.IIdentity;
154
+ apiToken?: string;
155
+ queueName?: string;
156
+ };
157
+ response: {
158
+ queues: statsInterfaces.IQueueStatus[];
159
+ totalItems: number;
160
+ };
161
+ }
162
+
163
+ // Health Check
164
+ export interface IReq_GetHealthStatus extends plugins.typedrequestInterfaces.implementsTR<
165
+ plugins.typedrequestInterfaces.ITypedRequest,
166
+ IReq_GetHealthStatus
167
+ > {
168
+ method: 'getHealthStatus';
169
+ request: {
170
+ identity?: authInterfaces.IIdentity;
171
+ apiToken?: string;
172
+ detailed?: boolean;
173
+ };
174
+ response: {
175
+ health: statsInterfaces.IHealthStatus;
176
+ };
177
+ }
178
+
179
+ // Network Stats (raw SmartProxy network data)
180
+ export interface IReq_GetNetworkStats extends plugins.typedrequestInterfaces.implementsTR<
181
+ plugins.typedrequestInterfaces.ITypedRequest,
182
+ IReq_GetNetworkStats
183
+ > {
184
+ method: 'getNetworkStats';
185
+ request: {
186
+ identity?: authInterfaces.IIdentity;
187
+ apiToken?: string;
188
+ };
189
+ response: {
190
+ connectionsByIP: Array<{ ip: string; count: number }>;
191
+ throughputRate: { bytesInPerSecond: number; bytesOutPerSecond: number };
192
+ topIPs: Array<{ ip: string; count: number }>;
193
+ totalDataTransferred: { bytesIn: number; bytesOut: number };
194
+ throughputHistory: Array<{ timestamp: number; in: number; out: number }>;
195
+ frontendConnectionHistory: statsInterfaces.IProtocolConnectionHistoryPoint[];
196
+ backendConnectionHistory: statsInterfaces.IProtocolConnectionHistoryPoint[];
197
+ throughputByIP: Array<{ ip: string; in: number; out: number }>;
198
+ requestsPerSecond: number;
199
+ requestsTotal: number;
200
+ backends?: statsInterfaces.IBackendInfo[];
201
+ topIPsByBandwidth: Array<{ ip: string; count: number; bwIn: number; bwOut: number }>;
202
+ topASNs: statsInterfaces.IAsnActivity[];
203
+ domainActivity: statsInterfaces.IDomainActivity[];
204
+ frontendProtocols?: statsInterfaces.IProtocolDistribution | null;
205
+ backendProtocols?: statsInterfaces.IProtocolDistribution | null;
206
+ };
207
+ }
@@ -0,0 +1,130 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type * as authInterfaces from '../data/auth.js';
3
+ import type { ITargetProfile, ITargetProfileTarget } from '../data/target-profile.js';
4
+
5
+ // ============================================================================
6
+ // Target Profile Endpoints (target-side: what can be accessed)
7
+ // ============================================================================
8
+
9
+ /**
10
+ * Get all target profiles.
11
+ */
12
+ export interface IReq_GetTargetProfiles extends plugins.typedrequestInterfaces.implementsTR<
13
+ plugins.typedrequestInterfaces.ITypedRequest,
14
+ IReq_GetTargetProfiles
15
+ > {
16
+ method: 'getTargetProfiles';
17
+ request: {
18
+ identity?: authInterfaces.IIdentity;
19
+ apiToken?: string;
20
+ };
21
+ response: {
22
+ profiles: ITargetProfile[];
23
+ };
24
+ }
25
+
26
+ /**
27
+ * Get a single target profile by ID.
28
+ */
29
+ export interface IReq_GetTargetProfile extends plugins.typedrequestInterfaces.implementsTR<
30
+ plugins.typedrequestInterfaces.ITypedRequest,
31
+ IReq_GetTargetProfile
32
+ > {
33
+ method: 'getTargetProfile';
34
+ request: {
35
+ identity?: authInterfaces.IIdentity;
36
+ apiToken?: string;
37
+ id: string;
38
+ };
39
+ response: {
40
+ profile: ITargetProfile | null;
41
+ };
42
+ }
43
+
44
+ /**
45
+ * Create a new target profile.
46
+ */
47
+ export interface IReq_CreateTargetProfile extends plugins.typedrequestInterfaces.implementsTR<
48
+ plugins.typedrequestInterfaces.ITypedRequest,
49
+ IReq_CreateTargetProfile
50
+ > {
51
+ method: 'createTargetProfile';
52
+ request: {
53
+ identity?: authInterfaces.IIdentity;
54
+ apiToken?: string;
55
+ name: string;
56
+ description?: string;
57
+ domains?: string[];
58
+ targets?: ITargetProfileTarget[];
59
+ routeRefs?: string[];
60
+ allowRoutesByClientSourceIp?: boolean;
61
+ };
62
+ response: {
63
+ success: boolean;
64
+ id?: string;
65
+ message?: string;
66
+ };
67
+ }
68
+
69
+ /**
70
+ * Update a target profile.
71
+ */
72
+ export interface IReq_UpdateTargetProfile extends plugins.typedrequestInterfaces.implementsTR<
73
+ plugins.typedrequestInterfaces.ITypedRequest,
74
+ IReq_UpdateTargetProfile
75
+ > {
76
+ method: 'updateTargetProfile';
77
+ request: {
78
+ identity?: authInterfaces.IIdentity;
79
+ apiToken?: string;
80
+ id: string;
81
+ name?: string;
82
+ description?: string;
83
+ domains?: string[];
84
+ targets?: ITargetProfileTarget[];
85
+ routeRefs?: string[];
86
+ allowRoutesByClientSourceIp?: boolean;
87
+ };
88
+ response: {
89
+ success: boolean;
90
+ message?: string;
91
+ };
92
+ }
93
+
94
+ /**
95
+ * Delete a target profile.
96
+ */
97
+ export interface IReq_DeleteTargetProfile extends plugins.typedrequestInterfaces.implementsTR<
98
+ plugins.typedrequestInterfaces.ITypedRequest,
99
+ IReq_DeleteTargetProfile
100
+ > {
101
+ method: 'deleteTargetProfile';
102
+ request: {
103
+ identity?: authInterfaces.IIdentity;
104
+ apiToken?: string;
105
+ id: string;
106
+ force?: boolean;
107
+ };
108
+ response: {
109
+ success: boolean;
110
+ message?: string;
111
+ };
112
+ }
113
+
114
+ /**
115
+ * Get which VPN clients reference a target profile.
116
+ */
117
+ export interface IReq_GetTargetProfileUsage extends plugins.typedrequestInterfaces.implementsTR<
118
+ plugins.typedrequestInterfaces.ITypedRequest,
119
+ IReq_GetTargetProfileUsage
120
+ > {
121
+ method: 'getTargetProfileUsage';
122
+ request: {
123
+ identity?: authInterfaces.IIdentity;
124
+ apiToken?: string;
125
+ id: string;
126
+ };
127
+ response: {
128
+ clients: Array<{ clientId: string; description?: string }>;
129
+ };
130
+ }
@@ -0,0 +1,186 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type * as data from '../data/testing.js';
3
+
4
+ export interface IReq_CreateTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<
5
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateTestingRegistration
6
+ > {
7
+ method: 'createTestingRegistration';
8
+ request: data.ITestingAdminAuth & data.ITestingMutationRequest & { displayName: string; credentialExpiresAt: number };
9
+ response: data.TTestingResult<data.ITestingRegistrationCredential>;
10
+ }
11
+
12
+ export interface IReq_GetTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<
13
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingRegistration
14
+ > {
15
+ method: 'getTestingRegistration';
16
+ request: data.ITestingMachineAuth;
17
+ response: data.TTestingResult<data.ITestingRegistration>;
18
+ }
19
+
20
+ export interface IReq_ListTestingRegistrations extends plugins.typedrequestInterfaces.implementsTR<
21
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingRegistrations
22
+ > {
23
+ method: 'listTestingRegistrations';
24
+ request: data.ITestingAdminAuth & data.ITestingPageRequest & { state?: data.ITestingRegistration['state'] };
25
+ response: data.TTestingResult<data.ITestingPage<data.ITestingRegistration>>;
26
+ }
27
+
28
+ export interface IReq_RotateTestingRegistrationCredential extends plugins.typedrequestInterfaces.implementsTR<
29
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_RotateTestingRegistrationCredential
30
+ > {
31
+ method: 'rotateTestingRegistrationCredential';
32
+ request: data.ITestingAdminAuth & {
33
+ registrationId: string; expectedGeneration: number; credentialExpiresAt: number;
34
+ };
35
+ response: data.TTestingResult<data.ITestingRegistrationCredential>;
36
+ }
37
+
38
+ export interface IReq_RevokeTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<
39
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_RevokeTestingRegistration
40
+ > {
41
+ method: 'revokeTestingRegistration';
42
+ request: data.ITestingAdminAuth & { registrationId: string; expectedRevision: number; reason: string };
43
+ response: data.TTestingResult<data.ITestingRegistration>;
44
+ }
45
+
46
+ export interface IReq_PutTestingZone extends plugins.typedrequestInterfaces.implementsTR<
47
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_PutTestingZone
48
+ > {
49
+ method: 'putTestingZone';
50
+ /** domainId identifies the zone; null revision permits creation only. */
51
+ request: data.ITestingAdminAuth & { policy: data.ITestingZonePolicy; expectedRevision: number | null };
52
+ response: data.TTestingResult<data.ITestingZone>;
53
+ }
54
+
55
+ export interface IReq_ListTestingZones extends plugins.typedrequestInterfaces.implementsTR<
56
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingZones
57
+ > {
58
+ method: 'listTestingZones';
59
+ request: data.ITestingReadAuth & data.ITestingPageRequest;
60
+ response: data.TTestingResult<data.ITestingPage<data.ITestingZone>>;
61
+ }
62
+
63
+ export interface IReq_RequestTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<
64
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_RequestTestingDomainGrant
65
+ > {
66
+ method: 'requestTestingDomainGrant';
67
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & { zoneId: string; hostname: string };
68
+ response: data.TTestingResult<data.ITestingDomainGrant>;
69
+ }
70
+
71
+ export interface IReq_ListTestingDomainGrants extends plugins.typedrequestInterfaces.implementsTR<
72
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingDomainGrants
73
+ > {
74
+ method: 'listTestingDomainGrants';
75
+ request: data.ITestingReadAuth & data.ITestingPageRequest & { state?: data.TTestingGrantState };
76
+ response: data.TTestingResult<data.ITestingPage<data.ITestingDomainGrant>>;
77
+ }
78
+
79
+ export interface IReq_GetTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<
80
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingDomainGrant
81
+ > {
82
+ method: 'getTestingDomainGrant';
83
+ request: data.ITestingReadAuth & { grantId: string };
84
+ response: data.TTestingResult<data.ITestingDomainGrant>;
85
+ }
86
+
87
+ export interface IReq_ReviewTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<
88
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ReviewTestingDomainGrant
89
+ > {
90
+ method: 'reviewTestingDomainGrant';
91
+ request: data.ITestingAdminAuth & {
92
+ grantId: string; expectedRevision: number; action: 'approve' | 'deny' | 'reopen' | 'revoke'; reason: string;
93
+ };
94
+ response: data.TTestingResult<data.ITestingDomainGrant>;
95
+ }
96
+
97
+ export interface IReq_RequestTestingCertificate extends plugins.typedrequestInterfaces.implementsTR<
98
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_RequestTestingCertificate
99
+ > {
100
+ method: 'requestTestingCertificate';
101
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & { grantId: string };
102
+ response: data.TTestingResult<data.TTestingCertificateJob>;
103
+ }
104
+
105
+ export interface IReq_GetTestingCertificateJob extends plugins.typedrequestInterfaces.implementsTR<
106
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingCertificateJob
107
+ > {
108
+ method: 'getTestingCertificateJob';
109
+ request: data.ITestingMachineAuth & { jobId: string };
110
+ response: data.TTestingResult<data.TTestingCertificateJob>;
111
+ }
112
+
113
+ export interface IReq_DownloadTestingCertificate extends plugins.typedrequestInterfaces.implementsTR<
114
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_DownloadTestingCertificate
115
+ > {
116
+ method: 'downloadTestingCertificate';
117
+ request: data.ITestingMachineAuth & { jobId: string };
118
+ response: data.TTestingResult<data.ITestingCertificateDownload>;
119
+ }
120
+
121
+ export interface IReq_ListTestingDnsRecords extends plugins.typedrequestInterfaces.implementsTR<
122
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingDnsRecords
123
+ > {
124
+ method: 'listTestingDnsRecords';
125
+ request: data.ITestingMachineAuth & data.ITestingPageRequest & { grantId: string };
126
+ response: data.TTestingResult<data.ITestingPage<data.ITestingDnsRecord>>;
127
+ }
128
+
129
+ export interface IReq_UpsertTestingDnsRecord extends plugins.typedrequestInterfaces.implementsTR<
130
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_UpsertTestingDnsRecord
131
+ > {
132
+ method: 'upsertTestingDnsRecord';
133
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
134
+ grantId: string; clientRecordKey: string; expectedRevision: number | null;
135
+ type: data.TTestingDnsRecordType; value: string; ttl: number;
136
+ };
137
+ response: data.TTestingResult<data.TTestingDnsMutation>;
138
+ }
139
+
140
+ export interface IReq_DeleteTestingDnsRecord extends plugins.typedrequestInterfaces.implementsTR<
141
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteTestingDnsRecord
142
+ > {
143
+ method: 'deleteTestingDnsRecord';
144
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
145
+ grantId: string; clientRecordKey: string; expectedRevision: number;
146
+ };
147
+ response: data.TTestingResult<data.TTestingDnsMutation>;
148
+ }
149
+
150
+ export interface IReq_GetTestingDnsMutation extends plugins.typedrequestInterfaces.implementsTR<
151
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingDnsMutation
152
+ > {
153
+ method: 'getTestingDnsMutation';
154
+ request: data.ITestingMachineAuth & { mutationId: string };
155
+ response: data.TTestingResult<data.TTestingDnsMutation>;
156
+ }
157
+
158
+ export interface IReq_ListTestingOperationRecoveries extends plugins.typedrequestInterfaces.implementsTR<
159
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingOperationRecoveries
160
+ > {
161
+ method: 'listTestingOperationRecoveries';
162
+ request: data.ITestingAdminAuth & data.ITestingPageRequest & {
163
+ kind: data.TTestingOperationKind;
164
+ state?: 'indeterminate' | 'abandoned_unverified' | 'running' | 'retry_wait';
165
+ };
166
+ response: data.TTestingResult<data.ITestingPage<data.ITestingOperationRecovery>>;
167
+ }
168
+
169
+ export interface IReq_GetTestingOperationRecovery extends plugins.typedrequestInterfaces.implementsTR<
170
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingOperationRecovery
171
+ > {
172
+ method: 'getTestingOperationRecovery';
173
+ request: data.ITestingAdminAuth & { kind: data.TTestingOperationKind; operationId: string };
174
+ response: data.TTestingResult<data.ITestingOperationRecovery>;
175
+ }
176
+
177
+ export interface IReq_RecoverTestingOperation extends plugins.typedrequestInterfaces.implementsTR<
178
+ plugins.typedrequestInterfaces.ITypedRequest, IReq_RecoverTestingOperation
179
+ > {
180
+ method: 'recoverTestingOperation';
181
+ request: data.ITestingAdminAuth & data.ITestingMutationRequest & {
182
+ kind: data.TTestingOperationKind; operationId: string; expectedRevision: number;
183
+ action: data.TTestingRecoveryAction; reason: string;
184
+ };
185
+ response: data.TTestingResult<data.ITestingOperationRecovery>;
186
+ }
@@ -0,0 +1,66 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ import type { IAdminUserProjection } from './admin.js';
4
+
5
+ export type TUserManagementRole = 'admin' | 'user';
6
+
7
+ /**
8
+ * List all OpsServer users (admin-only).
9
+ * Deliberately omits password/secret fields from the response.
10
+ */
11
+ export interface IReq_ListUsers extends plugins.typedrequestInterfaces.implementsTR<
12
+ plugins.typedrequestInterfaces.ITypedRequest,
13
+ IReq_ListUsers
14
+ > {
15
+ method: 'listUsers';
16
+ request: {
17
+ identity?: authInterfaces.IIdentity;
18
+ apiToken?: string;
19
+ };
20
+ response: {
21
+ users: IAdminUserProjection[];
22
+ };
23
+ }
24
+
25
+ /**
26
+ * Create a persisted OpsServer user account (admin-only).
27
+ */
28
+ export interface IReq_CreateUser extends plugins.typedrequestInterfaces.implementsTR<
29
+ plugins.typedrequestInterfaces.ITypedRequest,
30
+ IReq_CreateUser
31
+ > {
32
+ method: 'createUser';
33
+ request: {
34
+ identity?: authInterfaces.IIdentity;
35
+ apiToken?: string;
36
+ email: string;
37
+ name?: string;
38
+ role: TUserManagementRole;
39
+ password: string;
40
+ enableIdpGlobalAuth?: boolean;
41
+ };
42
+ response: {
43
+ success: boolean;
44
+ user?: IAdminUserProjection;
45
+ message?: string;
46
+ };
47
+ }
48
+
49
+ /**
50
+ * Delete a persisted OpsServer user account (admin-only).
51
+ */
52
+ export interface IReq_DeleteUser extends plugins.typedrequestInterfaces.implementsTR<
53
+ plugins.typedrequestInterfaces.ITypedRequest,
54
+ IReq_DeleteUser
55
+ > {
56
+ method: 'deleteUser';
57
+ request: {
58
+ identity?: authInterfaces.IIdentity;
59
+ apiToken?: string;
60
+ id: string;
61
+ };
62
+ response: {
63
+ success: boolean;
64
+ message?: string;
65
+ };
66
+ }