@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,169 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type * as data from '../data/testing.js';
3
+ export interface IReq_CreateTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateTestingRegistration> {
4
+ method: 'createTestingRegistration';
5
+ request: data.ITestingAdminAuth & data.ITestingMutationRequest & {
6
+ displayName: string;
7
+ credentialExpiresAt: number;
8
+ };
9
+ response: data.TTestingResult<data.ITestingRegistrationCredential>;
10
+ }
11
+ export interface IReq_GetTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingRegistration> {
12
+ method: 'getTestingRegistration';
13
+ request: data.ITestingMachineAuth;
14
+ response: data.TTestingResult<data.ITestingRegistration>;
15
+ }
16
+ export interface IReq_ListTestingRegistrations extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingRegistrations> {
17
+ method: 'listTestingRegistrations';
18
+ request: data.ITestingAdminAuth & data.ITestingPageRequest & {
19
+ state?: data.ITestingRegistration['state'];
20
+ };
21
+ response: data.TTestingResult<data.ITestingPage<data.ITestingRegistration>>;
22
+ }
23
+ export interface IReq_RotateTestingRegistrationCredential extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RotateTestingRegistrationCredential> {
24
+ method: 'rotateTestingRegistrationCredential';
25
+ request: data.ITestingAdminAuth & {
26
+ registrationId: string;
27
+ expectedGeneration: number;
28
+ credentialExpiresAt: number;
29
+ };
30
+ response: data.TTestingResult<data.ITestingRegistrationCredential>;
31
+ }
32
+ export interface IReq_RevokeTestingRegistration extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RevokeTestingRegistration> {
33
+ method: 'revokeTestingRegistration';
34
+ request: data.ITestingAdminAuth & {
35
+ registrationId: string;
36
+ expectedRevision: number;
37
+ reason: string;
38
+ };
39
+ response: data.TTestingResult<data.ITestingRegistration>;
40
+ }
41
+ export interface IReq_PutTestingZone extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_PutTestingZone> {
42
+ method: 'putTestingZone';
43
+ /** domainId identifies the zone; null revision permits creation only. */
44
+ request: data.ITestingAdminAuth & {
45
+ policy: data.ITestingZonePolicy;
46
+ expectedRevision: number | null;
47
+ };
48
+ response: data.TTestingResult<data.ITestingZone>;
49
+ }
50
+ export interface IReq_ListTestingZones extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingZones> {
51
+ method: 'listTestingZones';
52
+ request: data.ITestingReadAuth & data.ITestingPageRequest;
53
+ response: data.TTestingResult<data.ITestingPage<data.ITestingZone>>;
54
+ }
55
+ export interface IReq_RequestTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RequestTestingDomainGrant> {
56
+ method: 'requestTestingDomainGrant';
57
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
58
+ zoneId: string;
59
+ hostname: string;
60
+ };
61
+ response: data.TTestingResult<data.ITestingDomainGrant>;
62
+ }
63
+ export interface IReq_ListTestingDomainGrants extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingDomainGrants> {
64
+ method: 'listTestingDomainGrants';
65
+ request: data.ITestingReadAuth & data.ITestingPageRequest & {
66
+ state?: data.TTestingGrantState;
67
+ };
68
+ response: data.TTestingResult<data.ITestingPage<data.ITestingDomainGrant>>;
69
+ }
70
+ export interface IReq_GetTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingDomainGrant> {
71
+ method: 'getTestingDomainGrant';
72
+ request: data.ITestingReadAuth & {
73
+ grantId: string;
74
+ };
75
+ response: data.TTestingResult<data.ITestingDomainGrant>;
76
+ }
77
+ export interface IReq_ReviewTestingDomainGrant extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ReviewTestingDomainGrant> {
78
+ method: 'reviewTestingDomainGrant';
79
+ request: data.ITestingAdminAuth & {
80
+ grantId: string;
81
+ expectedRevision: number;
82
+ action: 'approve' | 'deny' | 'reopen' | 'revoke';
83
+ reason: string;
84
+ };
85
+ response: data.TTestingResult<data.ITestingDomainGrant>;
86
+ }
87
+ export interface IReq_RequestTestingCertificate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RequestTestingCertificate> {
88
+ method: 'requestTestingCertificate';
89
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
90
+ grantId: string;
91
+ };
92
+ response: data.TTestingResult<data.TTestingCertificateJob>;
93
+ }
94
+ export interface IReq_GetTestingCertificateJob extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingCertificateJob> {
95
+ method: 'getTestingCertificateJob';
96
+ request: data.ITestingMachineAuth & {
97
+ jobId: string;
98
+ };
99
+ response: data.TTestingResult<data.TTestingCertificateJob>;
100
+ }
101
+ export interface IReq_DownloadTestingCertificate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DownloadTestingCertificate> {
102
+ method: 'downloadTestingCertificate';
103
+ request: data.ITestingMachineAuth & {
104
+ jobId: string;
105
+ };
106
+ response: data.TTestingResult<data.ITestingCertificateDownload>;
107
+ }
108
+ export interface IReq_ListTestingDnsRecords extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingDnsRecords> {
109
+ method: 'listTestingDnsRecords';
110
+ request: data.ITestingMachineAuth & data.ITestingPageRequest & {
111
+ grantId: string;
112
+ };
113
+ response: data.TTestingResult<data.ITestingPage<data.ITestingDnsRecord>>;
114
+ }
115
+ export interface IReq_UpsertTestingDnsRecord extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpsertTestingDnsRecord> {
116
+ method: 'upsertTestingDnsRecord';
117
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
118
+ grantId: string;
119
+ clientRecordKey: string;
120
+ expectedRevision: number | null;
121
+ type: data.TTestingDnsRecordType;
122
+ value: string;
123
+ ttl: number;
124
+ };
125
+ response: data.TTestingResult<data.TTestingDnsMutation>;
126
+ }
127
+ export interface IReq_DeleteTestingDnsRecord extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteTestingDnsRecord> {
128
+ method: 'deleteTestingDnsRecord';
129
+ request: data.ITestingMachineAuth & data.ITestingMutationRequest & {
130
+ grantId: string;
131
+ clientRecordKey: string;
132
+ expectedRevision: number;
133
+ };
134
+ response: data.TTestingResult<data.TTestingDnsMutation>;
135
+ }
136
+ export interface IReq_GetTestingDnsMutation extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingDnsMutation> {
137
+ method: 'getTestingDnsMutation';
138
+ request: data.ITestingMachineAuth & {
139
+ mutationId: string;
140
+ };
141
+ response: data.TTestingResult<data.TTestingDnsMutation>;
142
+ }
143
+ export interface IReq_ListTestingOperationRecoveries extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListTestingOperationRecoveries> {
144
+ method: 'listTestingOperationRecoveries';
145
+ request: data.ITestingAdminAuth & data.ITestingPageRequest & {
146
+ kind: data.TTestingOperationKind;
147
+ state?: 'indeterminate' | 'abandoned_unverified' | 'running' | 'retry_wait';
148
+ };
149
+ response: data.TTestingResult<data.ITestingPage<data.ITestingOperationRecovery>>;
150
+ }
151
+ export interface IReq_GetTestingOperationRecovery extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetTestingOperationRecovery> {
152
+ method: 'getTestingOperationRecovery';
153
+ request: data.ITestingAdminAuth & {
154
+ kind: data.TTestingOperationKind;
155
+ operationId: string;
156
+ };
157
+ response: data.TTestingResult<data.ITestingOperationRecovery>;
158
+ }
159
+ export interface IReq_RecoverTestingOperation extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RecoverTestingOperation> {
160
+ method: 'recoverTestingOperation';
161
+ request: data.ITestingAdminAuth & data.ITestingMutationRequest & {
162
+ kind: data.TTestingOperationKind;
163
+ operationId: string;
164
+ expectedRevision: number;
165
+ action: data.TTestingRecoveryAction;
166
+ reason: string;
167
+ };
168
+ response: data.TTestingResult<data.ITestingOperationRecovery>;
169
+ }
@@ -0,0 +1,2 @@
1
+ import * as plugins from '../plugins.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdGluZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX2ludGVyZmFjZXMvcmVxdWVzdHMvdGVzdGluZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQyJ9
@@ -0,0 +1,53 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ import type { IAdminUserProjection } from './admin.js';
4
+ export type TUserManagementRole = 'admin' | 'user';
5
+ /**
6
+ * List all OpsServer users (admin-only).
7
+ * Deliberately omits password/secret fields from the response.
8
+ */
9
+ export interface IReq_ListUsers extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListUsers> {
10
+ method: 'listUsers';
11
+ request: {
12
+ identity?: authInterfaces.IIdentity;
13
+ apiToken?: string;
14
+ };
15
+ response: {
16
+ users: IAdminUserProjection[];
17
+ };
18
+ }
19
+ /**
20
+ * Create a persisted OpsServer user account (admin-only).
21
+ */
22
+ export interface IReq_CreateUser extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateUser> {
23
+ method: 'createUser';
24
+ request: {
25
+ identity?: authInterfaces.IIdentity;
26
+ apiToken?: string;
27
+ email: string;
28
+ name?: string;
29
+ role: TUserManagementRole;
30
+ password: string;
31
+ enableIdpGlobalAuth?: boolean;
32
+ };
33
+ response: {
34
+ success: boolean;
35
+ user?: IAdminUserProjection;
36
+ message?: string;
37
+ };
38
+ }
39
+ /**
40
+ * Delete a persisted OpsServer user account (admin-only).
41
+ */
42
+ export interface IReq_DeleteUser extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteUser> {
43
+ method: 'deleteUser';
44
+ request: {
45
+ identity?: authInterfaces.IIdentity;
46
+ apiToken?: string;
47
+ id: string;
48
+ };
49
+ response: {
50
+ success: boolean;
51
+ message?: string;
52
+ };
53
+ }
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19pbnRlcmZhY2VzL3JlcXVlc3RzL3VzZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxjQUFjLE1BQU0saUJBQWlCLENBQUMifQ==
@@ -0,0 +1,188 @@
1
+ import * as plugins from '../plugins.js';
2
+ import * as authInterfaces from '../data/auth.js';
3
+ import type { IVpnClient, IVpnServerStatus, IVpnClientTelemetry, IVpnConnectedClient } from '../data/vpn.js';
4
+ /**
5
+ * Get all registered VPN clients.
6
+ */
7
+ export interface IReq_GetVpnClients extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetVpnClients> {
8
+ method: 'getVpnClients';
9
+ request: {
10
+ identity?: authInterfaces.IIdentity;
11
+ apiToken?: string;
12
+ };
13
+ response: {
14
+ clients: IVpnClient[];
15
+ };
16
+ }
17
+ /**
18
+ * Get VPN server status.
19
+ */
20
+ export interface IReq_GetVpnStatus extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetVpnStatus> {
21
+ method: 'getVpnStatus';
22
+ request: {
23
+ identity?: authInterfaces.IIdentity;
24
+ apiToken?: string;
25
+ };
26
+ response: {
27
+ status: IVpnServerStatus;
28
+ };
29
+ }
30
+ /**
31
+ * Create a new VPN client. Returns the config bundle (secrets only shown once).
32
+ */
33
+ export interface IReq_CreateVpnClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateVpnClient> {
34
+ method: 'createVpnClient';
35
+ request: {
36
+ identity?: authInterfaces.IIdentity;
37
+ apiToken?: string;
38
+ clientId: string;
39
+ targetProfileIds?: string[];
40
+ description?: string;
41
+ destinationAllowList?: string[];
42
+ destinationBlockList?: string[];
43
+ useHostIp?: boolean;
44
+ useDhcp?: boolean;
45
+ staticIp?: string;
46
+ forceVlan?: boolean;
47
+ vlanId?: number;
48
+ };
49
+ response: {
50
+ success: boolean;
51
+ client?: IVpnClient;
52
+ /** WireGuard .conf file content (only returned at creation) */
53
+ wireguardConfig?: string;
54
+ message?: string;
55
+ };
56
+ }
57
+ /**
58
+ * Update a VPN client's metadata (description, tags) without rotating keys.
59
+ */
60
+ export interface IReq_UpdateVpnClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateVpnClient> {
61
+ method: 'updateVpnClient';
62
+ request: {
63
+ identity?: authInterfaces.IIdentity;
64
+ apiToken?: string;
65
+ clientId: string;
66
+ description?: string;
67
+ targetProfileIds?: string[];
68
+ destinationAllowList?: string[];
69
+ destinationBlockList?: string[];
70
+ useHostIp?: boolean;
71
+ useDhcp?: boolean;
72
+ staticIp?: string;
73
+ forceVlan?: boolean;
74
+ vlanId?: number;
75
+ };
76
+ response: {
77
+ success: boolean;
78
+ message?: string;
79
+ };
80
+ }
81
+ /**
82
+ * Get currently connected VPN clients.
83
+ */
84
+ export interface IReq_GetVpnConnectedClients extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetVpnConnectedClients> {
85
+ method: 'getVpnConnectedClients';
86
+ request: {
87
+ identity?: authInterfaces.IIdentity;
88
+ apiToken?: string;
89
+ };
90
+ response: {
91
+ connectedClients: IVpnConnectedClient[];
92
+ };
93
+ }
94
+ /**
95
+ * Delete a VPN client.
96
+ */
97
+ export interface IReq_DeleteVpnClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteVpnClient> {
98
+ method: 'deleteVpnClient';
99
+ request: {
100
+ identity?: authInterfaces.IIdentity;
101
+ apiToken?: string;
102
+ clientId: string;
103
+ };
104
+ response: {
105
+ success: boolean;
106
+ message?: string;
107
+ };
108
+ }
109
+ /**
110
+ * Enable a VPN client.
111
+ */
112
+ export interface IReq_EnableVpnClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_EnableVpnClient> {
113
+ method: 'enableVpnClient';
114
+ request: {
115
+ identity?: authInterfaces.IIdentity;
116
+ apiToken?: string;
117
+ clientId: string;
118
+ };
119
+ response: {
120
+ success: boolean;
121
+ message?: string;
122
+ };
123
+ }
124
+ /**
125
+ * Disable a VPN client.
126
+ */
127
+ export interface IReq_DisableVpnClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DisableVpnClient> {
128
+ method: 'disableVpnClient';
129
+ request: {
130
+ identity?: authInterfaces.IIdentity;
131
+ apiToken?: string;
132
+ clientId: string;
133
+ };
134
+ response: {
135
+ success: boolean;
136
+ message?: string;
137
+ };
138
+ }
139
+ /**
140
+ * Rotate a VPN client's keys. Returns the new config bundle.
141
+ */
142
+ export interface IReq_RotateVpnClientKey extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RotateVpnClientKey> {
143
+ method: 'rotateVpnClientKey';
144
+ request: {
145
+ identity?: authInterfaces.IIdentity;
146
+ apiToken?: string;
147
+ clientId: string;
148
+ };
149
+ response: {
150
+ success: boolean;
151
+ /** WireGuard .conf file content with new keys */
152
+ wireguardConfig?: string;
153
+ message?: string;
154
+ };
155
+ }
156
+ /**
157
+ * Export a VPN client config.
158
+ */
159
+ export interface IReq_ExportVpnClientConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ExportVpnClientConfig> {
160
+ method: 'exportVpnClientConfig';
161
+ request: {
162
+ identity?: authInterfaces.IIdentity;
163
+ apiToken?: string;
164
+ clientId: string;
165
+ format: 'smartvpn' | 'wireguard';
166
+ };
167
+ response: {
168
+ success: boolean;
169
+ config?: string;
170
+ message?: string;
171
+ };
172
+ }
173
+ /**
174
+ * Get telemetry for a specific VPN client.
175
+ */
176
+ export interface IReq_GetVpnClientTelemetry extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetVpnClientTelemetry> {
177
+ method: 'getVpnClientTelemetry';
178
+ request: {
179
+ identity?: authInterfaces.IIdentity;
180
+ apiToken?: string;
181
+ clientId: string;
182
+ };
183
+ response: {
184
+ success: boolean;
185
+ telemetry?: IVpnClientTelemetry;
186
+ message?: string;
187
+ };
188
+ }
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidnBuLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfaW50ZXJmYWNlcy9yZXF1ZXN0cy92cG4udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUM7QUFDekMsT0FBTyxLQUFLLGNBQWMsTUFBTSxpQkFBaUIsQ0FBQyJ9
@@ -0,0 +1,79 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type * as authInterfaces from '../data/auth.js';
3
+ import type { IGatewayClient } from '../data/workhoster.js';
4
+ export interface IReq_ListGatewayClients extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ListGatewayClients> {
5
+ method: 'listGatewayClients';
6
+ request: {
7
+ identity?: authInterfaces.IIdentity;
8
+ apiToken?: string;
9
+ };
10
+ response: {
11
+ gatewayClients: IGatewayClient[];
12
+ };
13
+ }
14
+ export interface IReq_CreateGatewayClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateGatewayClient> {
15
+ method: 'createGatewayClient';
16
+ request: {
17
+ identity?: authInterfaces.IIdentity;
18
+ apiToken?: string;
19
+ id?: string;
20
+ type: IGatewayClient['type'];
21
+ name: string;
22
+ description?: string;
23
+ hostnamePatterns?: string[];
24
+ allowedRouteTargets?: IGatewayClient['allowedRouteTargets'];
25
+ capabilities?: IGatewayClient['capabilities'];
26
+ };
27
+ response: {
28
+ success: boolean;
29
+ gatewayClient?: IGatewayClient;
30
+ message?: string;
31
+ };
32
+ }
33
+ export interface IReq_UpdateGatewayClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_UpdateGatewayClient> {
34
+ method: 'updateGatewayClient';
35
+ request: {
36
+ identity?: authInterfaces.IIdentity;
37
+ apiToken?: string;
38
+ id: string;
39
+ name?: string;
40
+ description?: string;
41
+ hostnamePatterns?: string[];
42
+ allowedRouteTargets?: IGatewayClient['allowedRouteTargets'];
43
+ capabilities?: IGatewayClient['capabilities'];
44
+ enabled?: boolean;
45
+ };
46
+ response: {
47
+ success: boolean;
48
+ gatewayClient?: IGatewayClient;
49
+ message?: string;
50
+ };
51
+ }
52
+ export interface IReq_DeleteGatewayClient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_DeleteGatewayClient> {
53
+ method: 'deleteGatewayClient';
54
+ request: {
55
+ identity?: authInterfaces.IIdentity;
56
+ apiToken?: string;
57
+ id: string;
58
+ };
59
+ response: {
60
+ success: boolean;
61
+ message?: string;
62
+ };
63
+ }
64
+ export interface IReq_CreateGatewayClientToken extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CreateGatewayClientToken> {
65
+ method: 'createGatewayClientToken';
66
+ request: {
67
+ identity?: authInterfaces.IIdentity;
68
+ apiToken?: string;
69
+ gatewayClientId: string;
70
+ name?: string;
71
+ expiresInDays?: number | null;
72
+ };
73
+ response: {
74
+ success: boolean;
75
+ tokenId?: string;
76
+ tokenValue?: string;
77
+ message?: string;
78
+ };
79
+ }
@@ -0,0 +1,2 @@
1
+ import * as plugins from '../plugins.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid29ya2hvc3Rlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX2ludGVyZmFjZXMvcmVxdWVzdHMvd29ya2hvc3Rlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQyJ9
package/license ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Task Venture Capital GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json ADDED
@@ -0,0 +1,67 @@
1
+ {
2
+ "author": "Task Venture Capital GmbH",
3
+ "license": "MIT",
4
+ "keywords": [
5
+ "mail service",
6
+ "SMS",
7
+ "letter delivery",
8
+ "AI services",
9
+ "SMTP server",
10
+ "mail parsing",
11
+ "DKIM",
12
+ "mail router",
13
+ "letterXpress",
14
+ "OpenAI",
15
+ "Anthropic AI",
16
+ "DKIM signing",
17
+ "mail forwarding",
18
+ "SMTP TLS",
19
+ "domain management",
20
+ "email templating",
21
+ "rule management",
22
+ "SMTP STARTTLS",
23
+ "DNS management",
24
+ "RADIUS",
25
+ "AAA",
26
+ "network authentication",
27
+ "VLAN assignment",
28
+ "MAC authentication"
29
+ ],
30
+ "name": "@serve.zone/dcrouter-apiclient",
31
+ "version": "32.3.0",
32
+ "type": "module",
33
+ "description": "Object-oriented TypeScript client and shared TypedRequest contracts for the dcrouter OpsServer API.",
34
+ "main": "./dist_ts_apiclient/index.js",
35
+ "types": "./dist_ts_apiclient/index.d.ts",
36
+ "exports": {
37
+ ".": {
38
+ "types": "./dist_ts_apiclient/index.d.ts",
39
+ "import": "./dist_ts_apiclient/index.js"
40
+ },
41
+ "./interfaces": {
42
+ "types": "./dist_ts_interfaces/index.d.ts",
43
+ "import": "./dist_ts_interfaces/index.js"
44
+ }
45
+ },
46
+ "dependencies": {
47
+ "@api.global/typedrequest": "8.0.4",
48
+ "@api.global/typedrequest-interfaces": "7.1.0",
49
+ "@api.global/typedsocket": "8.0.3",
50
+ "@push.rocks/smartchallenge": "^1.1.0",
51
+ "@push.rocks/smartmta": "^9.5.0",
52
+ "@push.rocks/smartnetwork": "^4.10.1",
53
+ "@push.rocks/smartproxy": "^27.21.0",
54
+ "@serve.zone/interfaces": "^32.0.0"
55
+ },
56
+ "engines": {
57
+ "node": ">=22"
58
+ },
59
+ "files": [
60
+ "ts_apiclient",
61
+ "dist_ts_apiclient",
62
+ "ts_interfaces",
63
+ "dist_ts_interfaces",
64
+ "readme.md",
65
+ "license"
66
+ ]
67
+ }