@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.
- package/dist_ts_apiclient/classes.apitoken.d.ts +41 -0
- package/dist_ts_apiclient/classes.apitoken.js +115 -0
- package/dist_ts_apiclient/classes.certificate.d.ts +57 -0
- package/dist_ts_apiclient/classes.certificate.js +69 -0
- package/dist_ts_apiclient/classes.config.d.ts +7 -0
- package/dist_ts_apiclient/classes.config.js +11 -0
- package/dist_ts_apiclient/classes.dcrouterapiclient.d.ts +54 -0
- package/dist_ts_apiclient/classes.dcrouterapiclient.js +97 -0
- package/dist_ts_apiclient/classes.email.d.ts +30 -0
- package/dist_ts_apiclient/classes.email.js +52 -0
- package/dist_ts_apiclient/classes.gatewayclient.d.ts +28 -0
- package/dist_ts_apiclient/classes.gatewayclient.js +52 -0
- package/dist_ts_apiclient/classes.logs.d.ts +28 -0
- package/dist_ts_apiclient/classes.logs.js +69 -0
- package/dist_ts_apiclient/classes.radius.d.ts +59 -0
- package/dist_ts_apiclient/classes.radius.js +95 -0
- package/dist_ts_apiclient/classes.remoteingress.d.ts +66 -0
- package/dist_ts_apiclient/classes.remoteingress.js +164 -0
- package/dist_ts_apiclient/classes.route.d.ts +39 -0
- package/dist_ts_apiclient/classes.route.js +125 -0
- package/dist_ts_apiclient/classes.stats.d.ts +47 -0
- package/dist_ts_apiclient/classes.stats.js +38 -0
- package/dist_ts_apiclient/classes.testing.d.ts +65 -0
- package/dist_ts_apiclient/classes.testing.js +120 -0
- package/dist_ts_apiclient/index.d.ts +12 -0
- package/dist_ts_apiclient/index.js +16 -0
- package/dist_ts_apiclient/plugins.d.ts +4 -0
- package/dist_ts_apiclient/plugins.js +6 -0
- package/dist_ts_interfaces/data/acme-config.d.ts +23 -0
- package/dist_ts_interfaces/data/acme-config.js +2 -0
- package/dist_ts_interfaces/data/auth.d.ts +8 -0
- package/dist_ts_interfaces/data/auth.js +2 -0
- package/dist_ts_interfaces/data/config-events.d.ts +34 -0
- package/dist_ts_interfaces/data/config-events.js +8 -0
- package/dist_ts_interfaces/data/dns-authority.d.ts +98 -0
- package/dist_ts_interfaces/data/dns-authority.js +26 -0
- package/dist_ts_interfaces/data/dns-provider.d.ts +136 -0
- package/dist_ts_interfaces/data/dns-provider.js +41 -0
- package/dist_ts_interfaces/data/dns-record.d.ts +48 -0
- package/dist_ts_interfaces/data/dns-record.js +2 -0
- package/dist_ts_interfaces/data/domain.d.ts +35 -0
- package/dist_ts_interfaces/data/domain.js +2 -0
- package/dist_ts_interfaces/data/email-domain.d.ts +177 -0
- package/dist_ts_interfaces/data/email-domain.js +2 -0
- package/dist_ts_interfaces/data/email-settings.d.ts +68 -0
- package/dist_ts_interfaces/data/email-settings.js +2 -0
- package/dist_ts_interfaces/data/index.d.ts +18 -0
- package/dist_ts_interfaces/data/index.js +19 -0
- package/dist_ts_interfaces/data/remoteingress.d.ts +181 -0
- package/dist_ts_interfaces/data/remoteingress.js +15 -0
- package/dist_ts_interfaces/data/route-management.d.ts +270 -0
- package/dist_ts_interfaces/data/route-management.js +130 -0
- package/dist_ts_interfaces/data/security-policy.d.ts +32 -0
- package/dist_ts_interfaces/data/security-policy.js +2 -0
- package/dist_ts_interfaces/data/smtp-account.d.ts +50 -0
- package/dist_ts_interfaces/data/smtp-account.js +9 -0
- package/dist_ts_interfaces/data/stats.d.ts +283 -0
- package/dist_ts_interfaces/data/stats.js +2 -0
- package/dist_ts_interfaces/data/target-profile.d.ts +30 -0
- package/dist_ts_interfaces/data/target-profile.js +2 -0
- package/dist_ts_interfaces/data/testing.d.ts +191 -0
- package/dist_ts_interfaces/data/testing.js +20 -0
- package/dist_ts_interfaces/data/vpn.d.ts +65 -0
- package/dist_ts_interfaces/data/vpn.js +2 -0
- package/dist_ts_interfaces/data/workhoster.d.ts +63 -0
- package/dist_ts_interfaces/data/workhoster.js +2 -0
- package/dist_ts_interfaces/index.d.ts +5 -0
- package/dist_ts_interfaces/index.js +8 -0
- package/dist_ts_interfaces/plugins.d.ts +2 -0
- package/dist_ts_interfaces/plugins.js +4 -0
- package/dist_ts_interfaces/requests/acme-config.d.ts +42 -0
- package/dist_ts_interfaces/requests/acme-config.js +2 -0
- package/dist_ts_interfaces/requests/admin.d.ts +69 -0
- package/dist_ts_interfaces/requests/admin.js +3 -0
- package/dist_ts_interfaces/requests/api-tokens.d.ts +85 -0
- package/dist_ts_interfaces/requests/api-tokens.js +2 -0
- package/dist_ts_interfaces/requests/certificate.d.ts +87 -0
- package/dist_ts_interfaces/requests/certificate.js +5 -0
- package/dist_ts_interfaces/requests/combined.stats.d.ts +29 -0
- package/dist_ts_interfaces/requests/combined.stats.js +2 -0
- package/dist_ts_interfaces/requests/config-events.d.ts +35 -0
- package/dist_ts_interfaces/requests/config-events.js +4 -0
- package/dist_ts_interfaces/requests/config.d.ts +93 -0
- package/dist_ts_interfaces/requests/config.js +3 -0
- package/dist_ts_interfaces/requests/dns-authority.d.ts +80 -0
- package/dist_ts_interfaces/requests/dns-authority.js +3 -0
- package/dist_ts_interfaces/requests/dns-providers.d.ts +117 -0
- package/dist_ts_interfaces/requests/dns-providers.js +2 -0
- package/dist_ts_interfaces/requests/dns-records.d.ts +89 -0
- package/dist_ts_interfaces/requests/dns-records.js +2 -0
- package/dist_ts_interfaces/requests/domains.d.ts +142 -0
- package/dist_ts_interfaces/requests/domains.js +2 -0
- package/dist_ts_interfaces/requests/email-domains.d.ts +154 -0
- package/dist_ts_interfaces/requests/email-domains.js +2 -0
- package/dist_ts_interfaces/requests/email-ops.d.ts +211 -0
- package/dist_ts_interfaces/requests/email-ops.js +3 -0
- package/dist_ts_interfaces/requests/email-settings.d.ts +26 -0
- package/dist_ts_interfaces/requests/email-settings.js +2 -0
- package/dist_ts_interfaces/requests/index.d.ts +29 -0
- package/dist_ts_interfaces/requests/index.js +30 -0
- package/dist_ts_interfaces/requests/logs.d.ts +43 -0
- package/dist_ts_interfaces/requests/logs.js +4 -0
- package/dist_ts_interfaces/requests/network-targets.d.ts +102 -0
- package/dist_ts_interfaces/requests/network-targets.js +2 -0
- package/dist_ts_interfaces/requests/radius.d.ts +280 -0
- package/dist_ts_interfaces/requests/radius.js +3 -0
- package/dist_ts_interfaces/requests/realtime.d.ts +38 -0
- package/dist_ts_interfaces/requests/realtime.js +12 -0
- package/dist_ts_interfaces/requests/remoteingress.d.ts +162 -0
- package/dist_ts_interfaces/requests/remoteingress.js +3 -0
- package/dist_ts_interfaces/requests/route-management.d.ts +147 -0
- package/dist_ts_interfaces/requests/route-management.js +2 -0
- package/dist_ts_interfaces/requests/security-policy.d.ts +105 -0
- package/dist_ts_interfaces/requests/security-policy.js +2 -0
- package/dist_ts_interfaces/requests/smtp-accounts.d.ts +125 -0
- package/dist_ts_interfaces/requests/smtp-accounts.js +2 -0
- package/dist_ts_interfaces/requests/source-profiles.d.ts +102 -0
- package/dist_ts_interfaces/requests/source-profiles.js +2 -0
- package/dist_ts_interfaces/requests/stats.d.ts +196 -0
- package/dist_ts_interfaces/requests/stats.js +4 -0
- package/dist_ts_interfaces/requests/target-profiles.d.ts +105 -0
- package/dist_ts_interfaces/requests/target-profiles.js +2 -0
- package/dist_ts_interfaces/requests/testing.d.ts +169 -0
- package/dist_ts_interfaces/requests/testing.js +2 -0
- package/dist_ts_interfaces/requests/users.d.ts +53 -0
- package/dist_ts_interfaces/requests/users.js +3 -0
- package/dist_ts_interfaces/requests/vpn.d.ts +188 -0
- package/dist_ts_interfaces/requests/vpn.js +3 -0
- package/dist_ts_interfaces/requests/workhoster.d.ts +79 -0
- package/dist_ts_interfaces/requests/workhoster.js +2 -0
- package/license +21 -0
- package/package.json +67 -0
- package/readme.md +218 -0
- package/ts_apiclient/classes.apitoken.ts +157 -0
- package/ts_apiclient/classes.certificate.ts +124 -0
- package/ts_apiclient/classes.config.ts +17 -0
- package/ts_apiclient/classes.dcrouterapiclient.ts +138 -0
- package/ts_apiclient/classes.email.ts +77 -0
- package/ts_apiclient/classes.gatewayclient.ts +110 -0
- package/ts_apiclient/classes.logs.ts +91 -0
- package/ts_apiclient/classes.radius.ts +180 -0
- package/ts_apiclient/classes.remoteingress.ts +217 -0
- package/ts_apiclient/classes.route.ts +166 -0
- package/ts_apiclient/classes.stats.ts +111 -0
- package/ts_apiclient/classes.testing.ts +152 -0
- package/ts_apiclient/index.ts +17 -0
- package/ts_apiclient/plugins.ts +10 -0
- package/ts_apiclient/readme.md +218 -0
- package/ts_interfaces/data/acme-config.ts +23 -0
- package/ts_interfaces/data/auth.ts +8 -0
- package/ts_interfaces/data/config-events.ts +38 -0
- package/ts_interfaces/data/dns-authority.ts +106 -0
- package/ts_interfaces/data/dns-provider.ts +174 -0
- package/ts_interfaces/data/dns-record.ts +50 -0
- package/ts_interfaces/data/domain.ts +36 -0
- package/ts_interfaces/data/email-domain.ts +206 -0
- package/ts_interfaces/data/email-settings.ts +75 -0
- package/ts_interfaces/data/index.ts +18 -0
- package/ts_interfaces/data/remoteingress.ts +204 -0
- package/ts_interfaces/data/route-management.ts +436 -0
- package/ts_interfaces/data/security-policy.ts +37 -0
- package/ts_interfaces/data/smtp-account.ts +63 -0
- package/ts_interfaces/data/stats.ts +305 -0
- package/ts_interfaces/data/target-profile.ts +31 -0
- package/ts_interfaces/data/testing.ts +184 -0
- package/ts_interfaces/data/vpn.ts +68 -0
- package/ts_interfaces/data/workhoster.ts +72 -0
- package/ts_interfaces/index.ts +9 -0
- package/ts_interfaces/plugins.ts +6 -0
- package/ts_interfaces/readme.md +194 -0
- package/ts_interfaces/requests/acme-config.ts +54 -0
- package/ts_interfaces/requests/admin.ts +96 -0
- package/ts_interfaces/requests/api-tokens.ts +109 -0
- package/ts_interfaces/requests/certificate.ts +106 -0
- package/ts_interfaces/requests/combined.stats.ts +30 -0
- package/ts_interfaces/requests/config-events.ts +45 -0
- package/ts_interfaces/requests/config.ts +94 -0
- package/ts_interfaces/requests/dns-authority.ts +104 -0
- package/ts_interfaces/requests/dns-providers.ts +154 -0
- package/ts_interfaces/requests/dns-records.ts +113 -0
- package/ts_interfaces/requests/domains.ts +178 -0
- package/ts_interfaces/requests/email-domains.ts +193 -0
- package/ts_interfaces/requests/email-ops.ts +266 -0
- package/ts_interfaces/requests/email-settings.ts +34 -0
- package/ts_interfaces/requests/index.ts +29 -0
- package/ts_interfaces/requests/logs.ts +58 -0
- package/ts_interfaces/requests/network-targets.ts +127 -0
- package/ts_interfaces/requests/radius.ts +341 -0
- package/ts_interfaces/requests/realtime.ts +59 -0
- package/ts_interfaces/requests/remoteingress.ts +202 -0
- package/ts_interfaces/requests/route-management.ts +194 -0
- package/ts_interfaces/requests/security-policy.ts +144 -0
- package/ts_interfaces/requests/smtp-accounts.ts +163 -0
- package/ts_interfaces/requests/source-profiles.ts +127 -0
- package/ts_interfaces/requests/stats.ts +207 -0
- package/ts_interfaces/requests/target-profiles.ts +130 -0
- package/ts_interfaces/requests/testing.ts +186 -0
- package/ts_interfaces/requests/users.ts +66 -0
- package/ts_interfaces/requests/vpn.ts +238 -0
- package/ts_interfaces/requests/workhoster.ts +100 -0
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import * as authInterfaces from '../data/auth.js';
|
|
3
|
+
export type TEmailStatus = 'delivered' | 'bounced' | 'rejected' | 'deferred' | 'pending' | 'accepted' | 'flagged';
|
|
4
|
+
export type TEmailDirection = 'inbound' | 'outbound';
|
|
5
|
+
export interface IEmail {
|
|
6
|
+
id: string;
|
|
7
|
+
direction: TEmailDirection;
|
|
8
|
+
status: TEmailStatus;
|
|
9
|
+
from: string;
|
|
10
|
+
to: string;
|
|
11
|
+
subject: string;
|
|
12
|
+
timestamp: string;
|
|
13
|
+
messageId: string;
|
|
14
|
+
size: string;
|
|
15
|
+
}
|
|
16
|
+
export type TEmailLogTrafficWindow = '24h' | '7d' | '14d' | '30d';
|
|
17
|
+
export interface IEmailLogTrafficPoint {
|
|
18
|
+
timestamp: number;
|
|
19
|
+
value: number;
|
|
20
|
+
}
|
|
21
|
+
export interface IEmailLogTraffic {
|
|
22
|
+
window: TEmailLogTrafficWindow;
|
|
23
|
+
label: string;
|
|
24
|
+
durationMs: number;
|
|
25
|
+
windowStart: number;
|
|
26
|
+
windowEnd: number;
|
|
27
|
+
bucketSizeMs: number;
|
|
28
|
+
sent: IEmailLogTrafficPoint[];
|
|
29
|
+
received: IEmailLogTrafficPoint[];
|
|
30
|
+
failed: IEmailLogTrafficPoint[];
|
|
31
|
+
}
|
|
32
|
+
export interface IEmailSecurityFinding {
|
|
33
|
+
id: string;
|
|
34
|
+
timestamp: string;
|
|
35
|
+
from: string;
|
|
36
|
+
to: string;
|
|
37
|
+
subject: string;
|
|
38
|
+
disposition: 'flagged' | 'rejected';
|
|
39
|
+
failures: string[];
|
|
40
|
+
failureSummary: string;
|
|
41
|
+
}
|
|
42
|
+
export interface ISmtpLogEntry {
|
|
43
|
+
timestamp: string;
|
|
44
|
+
direction: 'client' | 'server' | 'system';
|
|
45
|
+
command: string;
|
|
46
|
+
responseCode?: number;
|
|
47
|
+
}
|
|
48
|
+
export type TSmtpDeliveryPhase = 'connect' | 'greeting' | 'ehlo' | 'starttls' | 'tls_handshake' | 'post_tls_ehlo' | 'auth' | 'mail_from' | 'rcpt_to' | 'data_command' | 'message_body' | 'final_response' | 'rset' | 'quit' | 'unknown';
|
|
49
|
+
export interface ISmtpTranscriptEntry {
|
|
50
|
+
timestampMs: number;
|
|
51
|
+
phase: TSmtpDeliveryPhase;
|
|
52
|
+
direction: 'client' | 'server' | 'system';
|
|
53
|
+
text: string;
|
|
54
|
+
responseCode?: number;
|
|
55
|
+
}
|
|
56
|
+
export interface IOutboundAuthenticationCheck {
|
|
57
|
+
state: 'pending' | 'completed' | 'indeterminate' | 'not-evaluated';
|
|
58
|
+
overall: 'pass' | 'fail' | 'indeterminate';
|
|
59
|
+
checkedAt: string;
|
|
60
|
+
signedMessageSha256?: string;
|
|
61
|
+
error?: string;
|
|
62
|
+
identity?: {
|
|
63
|
+
sourceIp: string;
|
|
64
|
+
addressFamily: 'ipv4' | 'ipv6';
|
|
65
|
+
heloDomain: string;
|
|
66
|
+
receiverHostname: string;
|
|
67
|
+
envelopeFrom: string;
|
|
68
|
+
dkimDomain?: string;
|
|
69
|
+
dkimSelector?: string;
|
|
70
|
+
};
|
|
71
|
+
dkim?: Array<{
|
|
72
|
+
is_valid: boolean;
|
|
73
|
+
domain: string | null;
|
|
74
|
+
selector: string | null;
|
|
75
|
+
status: string;
|
|
76
|
+
details: string | null;
|
|
77
|
+
}>;
|
|
78
|
+
spf?: {
|
|
79
|
+
result: string;
|
|
80
|
+
domain: string;
|
|
81
|
+
ip: string;
|
|
82
|
+
explanation: string | null;
|
|
83
|
+
} | null;
|
|
84
|
+
dmarc?: {
|
|
85
|
+
passed: boolean;
|
|
86
|
+
policy: string;
|
|
87
|
+
domain: string;
|
|
88
|
+
dkim_result: string;
|
|
89
|
+
spf_result: string;
|
|
90
|
+
action: string;
|
|
91
|
+
details: string | null;
|
|
92
|
+
} | null;
|
|
93
|
+
}
|
|
94
|
+
export interface ISmtpTransactionAttempt {
|
|
95
|
+
id: string;
|
|
96
|
+
queueItemId: string;
|
|
97
|
+
queueAttempt: number;
|
|
98
|
+
targetHost: string;
|
|
99
|
+
targetPort: number;
|
|
100
|
+
recipientDomain?: string;
|
|
101
|
+
recipients: string[];
|
|
102
|
+
startedAt: string;
|
|
103
|
+
completedAt: string;
|
|
104
|
+
durationMs: number;
|
|
105
|
+
outcome: 'succeeded' | 'failed';
|
|
106
|
+
retryable: boolean;
|
|
107
|
+
errorType?: string;
|
|
108
|
+
smtpCode?: number;
|
|
109
|
+
recipientResults?: Array<{
|
|
110
|
+
recipient: string;
|
|
111
|
+
accepted: boolean;
|
|
112
|
+
responseCode: number;
|
|
113
|
+
}>;
|
|
114
|
+
failurePhase?: TSmtpDeliveryPhase;
|
|
115
|
+
error?: string;
|
|
116
|
+
outboundAuthentication?: IOutboundAuthenticationCheck;
|
|
117
|
+
transcript: ISmtpTranscriptEntry[];
|
|
118
|
+
}
|
|
119
|
+
export interface IConnectionInfo {
|
|
120
|
+
sourceIp: string;
|
|
121
|
+
sourceHostname: string;
|
|
122
|
+
destinationIp: string;
|
|
123
|
+
destinationPort: number;
|
|
124
|
+
tlsVersion: string;
|
|
125
|
+
tlsCipher: string;
|
|
126
|
+
authenticated: boolean;
|
|
127
|
+
authMethod: string;
|
|
128
|
+
authUser: string;
|
|
129
|
+
}
|
|
130
|
+
export interface IAuthenticationResults {
|
|
131
|
+
spf: 'pass' | 'fail' | 'softfail' | 'neutral' | 'none';
|
|
132
|
+
spfDomain: string;
|
|
133
|
+
dkim: 'pass' | 'fail' | 'none';
|
|
134
|
+
dkimDomain: string;
|
|
135
|
+
dmarc: 'pass' | 'fail' | 'none';
|
|
136
|
+
dmarcPolicy: string;
|
|
137
|
+
}
|
|
138
|
+
export interface IEmailDetail extends IEmail {
|
|
139
|
+
smtpTransactions?: ISmtpTransactionAttempt[];
|
|
140
|
+
/** Epoch ms of the next scheduled delivery attempt (pending/deferred only). */
|
|
141
|
+
nextAttemptAt?: number;
|
|
142
|
+
/** 1-based number of the next scheduled delivery attempt. */
|
|
143
|
+
nextAttemptNumber?: number;
|
|
144
|
+
toList: string[];
|
|
145
|
+
cc?: string[];
|
|
146
|
+
smtpLog: ISmtpLogEntry[];
|
|
147
|
+
connectionInfo: IConnectionInfo;
|
|
148
|
+
authenticationResults: IAuthenticationResults;
|
|
149
|
+
outboundAuthentication?: IOutboundAuthenticationCheck;
|
|
150
|
+
rejectionReason?: string;
|
|
151
|
+
bounceMessage?: string;
|
|
152
|
+
headers: Record<string, string>;
|
|
153
|
+
body: string;
|
|
154
|
+
}
|
|
155
|
+
export interface IReq_GetAllEmails extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetAllEmails> {
|
|
156
|
+
method: 'getAllEmails';
|
|
157
|
+
request: {
|
|
158
|
+
identity?: authInterfaces.IIdentity;
|
|
159
|
+
apiToken?: string;
|
|
160
|
+
/** Restrict the listing to one direction. Absent = both. */
|
|
161
|
+
direction?: TEmailDirection;
|
|
162
|
+
/** Maximum number of entries to return (default 200). */
|
|
163
|
+
limit?: number;
|
|
164
|
+
/** Literal search across sender, recipients, subject, and message ID. */
|
|
165
|
+
search?: string;
|
|
166
|
+
/** Inclusive accepted-at lower bound in epoch milliseconds. Requires `to`. */
|
|
167
|
+
from?: number;
|
|
168
|
+
/** Inclusive accepted-at upper bound in epoch milliseconds. Requires `from`. */
|
|
169
|
+
to?: number;
|
|
170
|
+
};
|
|
171
|
+
response: {
|
|
172
|
+
emails: IEmail[];
|
|
173
|
+
traffic: IEmailLogTraffic;
|
|
174
|
+
};
|
|
175
|
+
}
|
|
176
|
+
export interface IReq_GetEmailSecurityFindings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetEmailSecurityFindings> {
|
|
177
|
+
method: 'getEmailSecurityFindings';
|
|
178
|
+
request: {
|
|
179
|
+
identity?: authInterfaces.IIdentity;
|
|
180
|
+
apiToken?: string;
|
|
181
|
+
/** Maximum number of findings to return (default/max 200). */
|
|
182
|
+
limit?: number;
|
|
183
|
+
};
|
|
184
|
+
response: {
|
|
185
|
+
findings: IEmailSecurityFinding[];
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
export interface IReq_GetEmailDetail extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetEmailDetail> {
|
|
189
|
+
method: 'getEmailDetail';
|
|
190
|
+
request: {
|
|
191
|
+
identity?: authInterfaces.IIdentity;
|
|
192
|
+
apiToken?: string;
|
|
193
|
+
emailId: string;
|
|
194
|
+
};
|
|
195
|
+
response: {
|
|
196
|
+
email: IEmailDetail | null;
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
export interface IReq_ResendEmail extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ResendEmail> {
|
|
200
|
+
method: 'resendEmail';
|
|
201
|
+
request: {
|
|
202
|
+
identity?: authInterfaces.IIdentity;
|
|
203
|
+
apiToken?: string;
|
|
204
|
+
emailId: string;
|
|
205
|
+
};
|
|
206
|
+
response: {
|
|
207
|
+
success: boolean;
|
|
208
|
+
newQueueId?: string;
|
|
209
|
+
error?: string;
|
|
210
|
+
};
|
|
211
|
+
}
|
|
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1haWwtb3BzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfaW50ZXJmYWNlcy9yZXF1ZXN0cy9lbWFpbC1vcHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUM7QUFDekMsT0FBTyxLQUFLLGNBQWMsTUFBTSxpQkFBaUIsQ0FBQyJ9
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import type * as authInterfaces from '../data/auth.js';
|
|
3
|
+
import type { IEmailServerSettings, TEmailServerSettingsUpdate } from '../data/email-settings.js';
|
|
4
|
+
export interface IReq_GetEmailServerSettings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetEmailServerSettings> {
|
|
5
|
+
method: 'getEmailServerSettings';
|
|
6
|
+
request: {
|
|
7
|
+
identity?: authInterfaces.IIdentity;
|
|
8
|
+
apiToken?: string;
|
|
9
|
+
};
|
|
10
|
+
response: {
|
|
11
|
+
settings: IEmailServerSettings;
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
export interface IReq_UpdateEmailServerSettings extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateEmailServerSettings> {
|
|
15
|
+
method: 'updateEmailServerSettings';
|
|
16
|
+
request: {
|
|
17
|
+
identity?: authInterfaces.IIdentity;
|
|
18
|
+
apiToken?: string;
|
|
19
|
+
settings: TEmailServerSettingsUpdate;
|
|
20
|
+
};
|
|
21
|
+
response: {
|
|
22
|
+
success: boolean;
|
|
23
|
+
settings?: IEmailServerSettings;
|
|
24
|
+
message?: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1haWwtc2V0dGluZ3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19pbnRlcmZhY2VzL3JlcXVlc3RzL2VtYWlsLXNldHRpbmdzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDIn0=
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export * from './admin.js';
|
|
2
|
+
export * from './config.js';
|
|
3
|
+
export * from './logs.js';
|
|
4
|
+
export * from './stats.js';
|
|
5
|
+
export * from './combined.stats.js';
|
|
6
|
+
export * from './radius.js';
|
|
7
|
+
export * from './email-ops.js';
|
|
8
|
+
export * from './certificate.js';
|
|
9
|
+
export * from './remoteingress.js';
|
|
10
|
+
export * from './route-management.js';
|
|
11
|
+
export * from './api-tokens.js';
|
|
12
|
+
export * from './vpn.js';
|
|
13
|
+
export * from './source-profiles.js';
|
|
14
|
+
export * from './target-profiles.js';
|
|
15
|
+
export * from './network-targets.js';
|
|
16
|
+
export * from './users.js';
|
|
17
|
+
export * from './dns-providers.js';
|
|
18
|
+
export * from './domains.js';
|
|
19
|
+
export * from './dns-authority.js';
|
|
20
|
+
export * from './dns-records.js';
|
|
21
|
+
export * from './acme-config.js';
|
|
22
|
+
export * from './email-domains.js';
|
|
23
|
+
export * from './email-settings.js';
|
|
24
|
+
export * from './smtp-accounts.js';
|
|
25
|
+
export * from './realtime.js';
|
|
26
|
+
export * from './workhoster.js';
|
|
27
|
+
export * from './security-policy.js';
|
|
28
|
+
export * from './config-events.js';
|
|
29
|
+
export * from './testing.js';
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export * from './admin.js';
|
|
2
|
+
export * from './config.js';
|
|
3
|
+
export * from './logs.js';
|
|
4
|
+
export * from './stats.js';
|
|
5
|
+
export * from './combined.stats.js';
|
|
6
|
+
export * from './radius.js';
|
|
7
|
+
export * from './email-ops.js';
|
|
8
|
+
export * from './certificate.js';
|
|
9
|
+
export * from './remoteingress.js';
|
|
10
|
+
export * from './route-management.js';
|
|
11
|
+
export * from './api-tokens.js';
|
|
12
|
+
export * from './vpn.js';
|
|
13
|
+
export * from './source-profiles.js';
|
|
14
|
+
export * from './target-profiles.js';
|
|
15
|
+
export * from './network-targets.js';
|
|
16
|
+
export * from './users.js';
|
|
17
|
+
export * from './dns-providers.js';
|
|
18
|
+
export * from './domains.js';
|
|
19
|
+
export * from './dns-authority.js';
|
|
20
|
+
export * from './dns-records.js';
|
|
21
|
+
export * from './acme-config.js';
|
|
22
|
+
export * from './email-domains.js';
|
|
23
|
+
export * from './email-settings.js';
|
|
24
|
+
export * from './smtp-accounts.js';
|
|
25
|
+
export * from './realtime.js';
|
|
26
|
+
export * from './workhoster.js';
|
|
27
|
+
export * from './security-policy.js';
|
|
28
|
+
export * from './config-events.js';
|
|
29
|
+
export * from './testing.js';
|
|
30
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19pbnRlcmZhY2VzL3JlcXVlc3RzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsV0FBVyxDQUFDO0FBQzFCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxnQkFBZ0IsQ0FBQztBQUMvQixjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGlCQUFpQixDQUFDO0FBQ2hDLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsc0JBQXNCLENBQUM7QUFDckMsY0FBYyxzQkFBc0IsQ0FBQztBQUNyQyxjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsa0JBQWtCLENBQUM7QUFDakMsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLHFCQUFxQixDQUFDO0FBQ3BDLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUMifQ==
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import * as authInterfaces from '../data/auth.js';
|
|
3
|
+
import * as statsInterfaces from '../data/stats.js';
|
|
4
|
+
export interface IReq_GetRecentLogs extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetRecentLogs> {
|
|
5
|
+
method: 'getRecentLogs';
|
|
6
|
+
request: {
|
|
7
|
+
identity?: authInterfaces.IIdentity;
|
|
8
|
+
apiToken?: string;
|
|
9
|
+
level?: 'debug' | 'info' | 'warn' | 'error';
|
|
10
|
+
category?: 'smtp' | 'dns' | 'security' | 'system' | 'email';
|
|
11
|
+
limit?: number;
|
|
12
|
+
offset?: number;
|
|
13
|
+
search?: string;
|
|
14
|
+
timeRange?: '1h' | '6h' | '24h' | '7d' | '30d';
|
|
15
|
+
};
|
|
16
|
+
response: {
|
|
17
|
+
logs: statsInterfaces.ILogEntry[];
|
|
18
|
+
total: number;
|
|
19
|
+
hasMore: boolean;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
export interface IReq_GetLogStream extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetLogStream> {
|
|
23
|
+
method: 'getLogStream';
|
|
24
|
+
request: {
|
|
25
|
+
identity?: authInterfaces.IIdentity;
|
|
26
|
+
apiToken?: string;
|
|
27
|
+
follow?: boolean;
|
|
28
|
+
filters?: {
|
|
29
|
+
level?: string[];
|
|
30
|
+
category?: string[];
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
response: {
|
|
34
|
+
logStream: plugins.typedrequestInterfaces.TVirtualStream<'receive'>;
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
export interface IReq_PushLogEntry extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_PushLogEntry> {
|
|
38
|
+
method: 'pushLogEntry';
|
|
39
|
+
request: {
|
|
40
|
+
entry: statsInterfaces.ILogEntry;
|
|
41
|
+
};
|
|
42
|
+
response: {};
|
|
43
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import * as authInterfaces from '../data/auth.js';
|
|
3
|
+
import * as statsInterfaces from '../data/stats.js';
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9ncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX2ludGVyZmFjZXMvcmVxdWVzdHMvbG9ncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUN6QyxPQUFPLEtBQUssY0FBYyxNQUFNLGlCQUFpQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxlQUFlLE1BQU0sa0JBQWtCLENBQUMifQ==
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import type * as authInterfaces from '../data/auth.js';
|
|
3
|
+
import type { INetworkTarget } from '../data/route-management.js';
|
|
4
|
+
/**
|
|
5
|
+
* Get all network targets.
|
|
6
|
+
*/
|
|
7
|
+
export interface IReq_GetNetworkTargets extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetNetworkTargets> {
|
|
8
|
+
method: 'getNetworkTargets';
|
|
9
|
+
request: {
|
|
10
|
+
identity?: authInterfaces.IIdentity;
|
|
11
|
+
apiToken?: string;
|
|
12
|
+
};
|
|
13
|
+
response: {
|
|
14
|
+
targets: INetworkTarget[];
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Get a single network target by ID.
|
|
19
|
+
*/
|
|
20
|
+
export interface IReq_GetNetworkTarget extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetNetworkTarget> {
|
|
21
|
+
method: 'getNetworkTarget';
|
|
22
|
+
request: {
|
|
23
|
+
identity?: authInterfaces.IIdentity;
|
|
24
|
+
apiToken?: string;
|
|
25
|
+
id: string;
|
|
26
|
+
};
|
|
27
|
+
response: {
|
|
28
|
+
target: INetworkTarget | null;
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Create a new network target.
|
|
33
|
+
*/
|
|
34
|
+
export interface IReq_CreateNetworkTarget extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateNetworkTarget> {
|
|
35
|
+
method: 'createNetworkTarget';
|
|
36
|
+
request: {
|
|
37
|
+
identity?: authInterfaces.IIdentity;
|
|
38
|
+
apiToken?: string;
|
|
39
|
+
name: string;
|
|
40
|
+
description?: string;
|
|
41
|
+
host: string | string[];
|
|
42
|
+
port: number;
|
|
43
|
+
};
|
|
44
|
+
response: {
|
|
45
|
+
success: boolean;
|
|
46
|
+
id?: string;
|
|
47
|
+
message?: string;
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Update a network target.
|
|
52
|
+
*/
|
|
53
|
+
export interface IReq_UpdateNetworkTarget extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateNetworkTarget> {
|
|
54
|
+
method: 'updateNetworkTarget';
|
|
55
|
+
request: {
|
|
56
|
+
identity?: authInterfaces.IIdentity;
|
|
57
|
+
apiToken?: string;
|
|
58
|
+
id: string;
|
|
59
|
+
name?: string;
|
|
60
|
+
description?: string;
|
|
61
|
+
host?: string | string[];
|
|
62
|
+
port?: number;
|
|
63
|
+
};
|
|
64
|
+
response: {
|
|
65
|
+
success: boolean;
|
|
66
|
+
affectedRouteCount?: number;
|
|
67
|
+
message?: string;
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Delete a network target.
|
|
72
|
+
*/
|
|
73
|
+
export interface IReq_DeleteNetworkTarget extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteNetworkTarget> {
|
|
74
|
+
method: 'deleteNetworkTarget';
|
|
75
|
+
request: {
|
|
76
|
+
identity?: authInterfaces.IIdentity;
|
|
77
|
+
apiToken?: string;
|
|
78
|
+
id: string;
|
|
79
|
+
force?: boolean;
|
|
80
|
+
};
|
|
81
|
+
response: {
|
|
82
|
+
success: boolean;
|
|
83
|
+
message?: string;
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Get which routes reference a network target.
|
|
88
|
+
*/
|
|
89
|
+
export interface IReq_GetNetworkTargetUsage extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetNetworkTargetUsage> {
|
|
90
|
+
method: 'getNetworkTargetUsage';
|
|
91
|
+
request: {
|
|
92
|
+
identity?: authInterfaces.IIdentity;
|
|
93
|
+
apiToken?: string;
|
|
94
|
+
id: string;
|
|
95
|
+
};
|
|
96
|
+
response: {
|
|
97
|
+
routes: Array<{
|
|
98
|
+
id: string;
|
|
99
|
+
name: string;
|
|
100
|
+
}>;
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmV0d29yay10YXJnZXRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfaW50ZXJmYWNlcy9yZXF1ZXN0cy9uZXR3b3JrLXRhcmdldHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUMifQ==
|