@homeflare/distilled-unifi-network 0.2.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/LICENSE +201 -0
- package/README.md +125 -0
- package/dist/credentials.d.ts +24 -0
- package/dist/credentials.d.ts.map +1 -0
- package/dist/credentials.js +78 -0
- package/dist/credentials.js.map +1 -0
- package/dist/errors.d.ts +74 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +49 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +33 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +33 -0
- package/dist/index.js.map +1 -0
- package/dist/protocol.d.ts +18 -0
- package/dist/protocol.d.ts.map +1 -0
- package/dist/protocol.js +59 -0
- package/dist/protocol.js.map +1 -0
- package/dist/retry.d.ts +57 -0
- package/dist/retry.d.ts.map +1 -0
- package/dist/retry.js +50 -0
- package/dist/retry.js.map +1 -0
- package/dist/services/access_control_acl_rules.d.ts +222 -0
- package/dist/services/access_control_acl_rules.d.ts.map +1 -0
- package/dist/services/access_control_acl_rules.js +225 -0
- package/dist/services/access_control_acl_rules.js.map +1 -0
- package/dist/services/application_info.d.ts +15 -0
- package/dist/services/application_info.d.ts.map +1 -0
- package/dist/services/application_info.js +22 -0
- package/dist/services/application_info.js.map +1 -0
- package/dist/services/clients.d.ts +108 -0
- package/dist/services/clients.d.ts.map +1 -0
- package/dist/services/clients.js +122 -0
- package/dist/services/clients.js.map +1 -0
- package/dist/services/dns_policies.d.ts +143 -0
- package/dist/services/dns_policies.d.ts.map +1 -0
- package/dist/services/dns_policies.js +171 -0
- package/dist/services/dns_policies.js.map +1 -0
- package/dist/services/firewall.d.ts +473 -0
- package/dist/services/firewall.d.ts.map +1 -0
- package/dist/services/firewall.js +521 -0
- package/dist/services/firewall.js.map +1 -0
- package/dist/services/hotspot.d.ts +107 -0
- package/dist/services/hotspot.d.ts.map +1 -0
- package/dist/services/hotspot.js +145 -0
- package/dist/services/hotspot.js.map +1 -0
- package/dist/services/index.d.ts +14 -0
- package/dist/services/index.d.ts.map +1 -0
- package/dist/services/index.js +15 -0
- package/dist/services/index.js.map +1 -0
- package/dist/services/networks.d.ts +251 -0
- package/dist/services/networks.d.ts.map +1 -0
- package/dist/services/networks.js +256 -0
- package/dist/services/networks.js.map +1 -0
- package/dist/services/sites.d.ts +31 -0
- package/dist/services/sites.d.ts.map +1 -0
- package/dist/services/sites.js +38 -0
- package/dist/services/sites.js.map +1 -0
- package/dist/services/supporting_resources.d.ts +238 -0
- package/dist/services/supporting_resources.d.ts.map +1 -0
- package/dist/services/supporting_resources.js +298 -0
- package/dist/services/supporting_resources.js.map +1 -0
- package/dist/services/switching.d.ts +168 -0
- package/dist/services/switching.d.ts.map +1 -0
- package/dist/services/switching.js +226 -0
- package/dist/services/switching.js.map +1 -0
- package/dist/services/traffic_matching_lists.d.ts +75 -0
- package/dist/services/traffic_matching_lists.d.ts.map +1 -0
- package/dist/services/traffic_matching_lists.js +126 -0
- package/dist/services/traffic_matching_lists.js.map +1 -0
- package/dist/services/unifi_devices.d.ts +280 -0
- package/dist/services/unifi_devices.d.ts.map +1 -0
- package/dist/services/unifi_devices.js +338 -0
- package/dist/services/unifi_devices.js.map +1 -0
- package/dist/services/wifi_broadcasts.d.ts +378 -0
- package/dist/services/wifi_broadcasts.d.ts.map +1 -0
- package/dist/services/wifi_broadcasts.js +396 -0
- package/dist/services/wifi_broadcasts.js.map +1 -0
- package/dist/traits.d.ts +11 -0
- package/dist/traits.d.ts.map +1 -0
- package/dist/traits.js +12 -0
- package/dist/traits.js.map +1 -0
- package/package.json +75 -0
- package/src/credentials.ts +112 -0
- package/src/errors.ts +103 -0
- package/src/index.ts +36 -0
- package/src/protocol.ts +86 -0
- package/src/retry.ts +83 -0
- package/src/services/access_control_acl_rules.ts +537 -0
- package/src/services/application_info.ts +44 -0
- package/src/services/clients.ts +272 -0
- package/src/services/dns_policies.ts +363 -0
- package/src/services/firewall.ts +1492 -0
- package/src/services/hotspot.ts +305 -0
- package/src/services/index.ts +14 -0
- package/src/services/networks.ts +613 -0
- package/src/services/sites.ts +81 -0
- package/src/services/supporting_resources.ts +650 -0
- package/src/services/switching.ts +496 -0
- package/src/services/traffic_matching_lists.ts +248 -0
- package/src/services/unifi_devices.ts +795 -0
- package/src/services/wifi_broadcasts.ts +992 -0
- package/src/traits.ts +45 -0
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-unifi-network/specs/openapi.json). Do not edit.
|
|
2
|
+
import * as S from "@distilled.cloud/core/schema";
|
|
3
|
+
import * as API from "@distilled.cloud/core/api";
|
|
4
|
+
import * as T from "../traits.ts";
|
|
5
|
+
import {
|
|
6
|
+
UnifiNetworkProtocol,
|
|
7
|
+
type UnifiNetworkOpError,
|
|
8
|
+
type UnifiNetworkOpContext,
|
|
9
|
+
} from "../protocol.ts";
|
|
10
|
+
import { UnknownUnifiNetworkError } from "../errors.ts";
|
|
11
|
+
import * as Retry from "../retry.ts";
|
|
12
|
+
|
|
13
|
+
export type { UnifiNetworkOpError, UnifiNetworkOpContext };
|
|
14
|
+
|
|
15
|
+
export interface CreateTrafficMatchingListRequest {
|
|
16
|
+
siteId: string;
|
|
17
|
+
name: string;
|
|
18
|
+
type: string;
|
|
19
|
+
/** Shape varies by variant — widened by scripts/convert.ts; see README. */
|
|
20
|
+
items?: unknown;
|
|
21
|
+
}
|
|
22
|
+
export const CreateTrafficMatchingListRequest = /*@__PURE__*/ S.suspend(() =>
|
|
23
|
+
S.Struct({
|
|
24
|
+
siteId: S.String.pipe(T.Label()),
|
|
25
|
+
name: S.String,
|
|
26
|
+
type: S.String,
|
|
27
|
+
items: S.optional(S.Unknown),
|
|
28
|
+
}).pipe(
|
|
29
|
+
T.Http({
|
|
30
|
+
method: "POST",
|
|
31
|
+
uri: "/v1/sites/{siteId}/traffic-matching-lists",
|
|
32
|
+
code: 200,
|
|
33
|
+
}),
|
|
34
|
+
),
|
|
35
|
+
).annotate({
|
|
36
|
+
identifier: "CreateTrafficMatchingListRequest",
|
|
37
|
+
}) as any as S.Schema<CreateTrafficMatchingListRequest>;
|
|
38
|
+
|
|
39
|
+
export interface TrafficMatchingList {
|
|
40
|
+
id: string;
|
|
41
|
+
name: string;
|
|
42
|
+
type: string;
|
|
43
|
+
/** Shape varies by variant — widened by scripts/convert.ts; see README. */
|
|
44
|
+
items?: unknown;
|
|
45
|
+
}
|
|
46
|
+
export const TrafficMatchingList = /*@__PURE__*/ S.suspend(() =>
|
|
47
|
+
S.Struct({
|
|
48
|
+
id: S.String,
|
|
49
|
+
name: S.String,
|
|
50
|
+
type: S.String,
|
|
51
|
+
items: S.optional(S.Unknown),
|
|
52
|
+
}),
|
|
53
|
+
).annotate({
|
|
54
|
+
identifier: "TrafficMatchingList",
|
|
55
|
+
}) as any as S.Schema<TrafficMatchingList>;
|
|
56
|
+
|
|
57
|
+
export interface DeleteTrafficMatchingListRequest {
|
|
58
|
+
siteId: string;
|
|
59
|
+
trafficMatchingListId: string;
|
|
60
|
+
}
|
|
61
|
+
export const DeleteTrafficMatchingListRequest = /*@__PURE__*/ S.suspend(() =>
|
|
62
|
+
S.Struct({
|
|
63
|
+
siteId: S.String.pipe(T.Label()),
|
|
64
|
+
trafficMatchingListId: S.String.pipe(T.Label()),
|
|
65
|
+
}).pipe(
|
|
66
|
+
T.Http({
|
|
67
|
+
method: "DELETE",
|
|
68
|
+
uri: "/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}",
|
|
69
|
+
code: 200,
|
|
70
|
+
}),
|
|
71
|
+
),
|
|
72
|
+
).annotate({
|
|
73
|
+
identifier: "DeleteTrafficMatchingListRequest",
|
|
74
|
+
}) as any as S.Schema<DeleteTrafficMatchingListRequest>;
|
|
75
|
+
|
|
76
|
+
export interface DeleteTrafficMatchingListResponse {}
|
|
77
|
+
export const DeleteTrafficMatchingListResponse = /*@__PURE__*/ S.suspend(() =>
|
|
78
|
+
S.Struct({}),
|
|
79
|
+
).annotate({
|
|
80
|
+
identifier: "DeleteTrafficMatchingListResponse",
|
|
81
|
+
}) as any as S.Schema<DeleteTrafficMatchingListResponse>;
|
|
82
|
+
|
|
83
|
+
export interface GetTrafficMatchingListRequest {
|
|
84
|
+
siteId: string;
|
|
85
|
+
trafficMatchingListId: string;
|
|
86
|
+
}
|
|
87
|
+
export const GetTrafficMatchingListRequest = /*@__PURE__*/ S.suspend(() =>
|
|
88
|
+
S.Struct({
|
|
89
|
+
siteId: S.String.pipe(T.Label()),
|
|
90
|
+
trafficMatchingListId: S.String.pipe(T.Label()),
|
|
91
|
+
}).pipe(
|
|
92
|
+
T.Http({
|
|
93
|
+
method: "GET",
|
|
94
|
+
uri: "/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}",
|
|
95
|
+
code: 200,
|
|
96
|
+
}),
|
|
97
|
+
),
|
|
98
|
+
).annotate({
|
|
99
|
+
identifier: "GetTrafficMatchingListRequest",
|
|
100
|
+
}) as any as S.Schema<GetTrafficMatchingListRequest>;
|
|
101
|
+
|
|
102
|
+
export interface GetTrafficMatchingListsRequest {
|
|
103
|
+
siteId: string;
|
|
104
|
+
offset?: number;
|
|
105
|
+
limit?: number;
|
|
106
|
+
filter?: string;
|
|
107
|
+
}
|
|
108
|
+
export const GetTrafficMatchingListsRequest = /*@__PURE__*/ S.suspend(() =>
|
|
109
|
+
S.Struct({
|
|
110
|
+
siteId: S.String.pipe(T.Label()),
|
|
111
|
+
offset: S.optional(S.Number.pipe(T.Query())),
|
|
112
|
+
limit: S.optional(S.Number.pipe(T.Query())),
|
|
113
|
+
filter: S.optional(S.String.pipe(T.Query())),
|
|
114
|
+
}).pipe(
|
|
115
|
+
T.Http({
|
|
116
|
+
method: "GET",
|
|
117
|
+
uri: "/v1/sites/{siteId}/traffic-matching-lists",
|
|
118
|
+
code: 200,
|
|
119
|
+
}),
|
|
120
|
+
),
|
|
121
|
+
).annotate({
|
|
122
|
+
identifier: "GetTrafficMatchingListsRequest",
|
|
123
|
+
}) as any as S.Schema<GetTrafficMatchingListsRequest>;
|
|
124
|
+
|
|
125
|
+
export type TrafficMatchingListsPageDataList = Array<TrafficMatchingList>;
|
|
126
|
+
export const TrafficMatchingListsPageDataList = /*@__PURE__*/ S.Array(
|
|
127
|
+
TrafficMatchingList,
|
|
128
|
+
) as any as S.Schema<TrafficMatchingListsPageDataList>;
|
|
129
|
+
|
|
130
|
+
export interface TrafficMatchingListsPage {
|
|
131
|
+
count: number;
|
|
132
|
+
data: TrafficMatchingListsPageDataList;
|
|
133
|
+
limit: number;
|
|
134
|
+
offset: number;
|
|
135
|
+
totalCount: number;
|
|
136
|
+
}
|
|
137
|
+
export const TrafficMatchingListsPage = /*@__PURE__*/ S.suspend(() =>
|
|
138
|
+
S.Struct({
|
|
139
|
+
count: S.Number,
|
|
140
|
+
data: TrafficMatchingListsPageDataList,
|
|
141
|
+
limit: S.Number,
|
|
142
|
+
offset: S.Number,
|
|
143
|
+
totalCount: S.Number,
|
|
144
|
+
}),
|
|
145
|
+
).annotate({
|
|
146
|
+
identifier: "TrafficMatchingListsPage",
|
|
147
|
+
}) as any as S.Schema<TrafficMatchingListsPage>;
|
|
148
|
+
|
|
149
|
+
export interface UpdateTrafficMatchingListRequest {
|
|
150
|
+
siteId: string;
|
|
151
|
+
trafficMatchingListId: string;
|
|
152
|
+
name: string;
|
|
153
|
+
type: string;
|
|
154
|
+
/** Shape varies by variant — widened by scripts/convert.ts; see README. */
|
|
155
|
+
items?: unknown;
|
|
156
|
+
}
|
|
157
|
+
export const UpdateTrafficMatchingListRequest = /*@__PURE__*/ S.suspend(() =>
|
|
158
|
+
S.Struct({
|
|
159
|
+
siteId: S.String.pipe(T.Label()),
|
|
160
|
+
trafficMatchingListId: S.String.pipe(T.Label()),
|
|
161
|
+
name: S.String,
|
|
162
|
+
type: S.String,
|
|
163
|
+
items: S.optional(S.Unknown),
|
|
164
|
+
}).pipe(
|
|
165
|
+
T.Http({
|
|
166
|
+
method: "PUT",
|
|
167
|
+
uri: "/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}",
|
|
168
|
+
code: 200,
|
|
169
|
+
}),
|
|
170
|
+
),
|
|
171
|
+
).annotate({
|
|
172
|
+
identifier: "UpdateTrafficMatchingListRequest",
|
|
173
|
+
}) as any as S.Schema<UpdateTrafficMatchingListRequest>;
|
|
174
|
+
|
|
175
|
+
export type CreateTrafficMatchingListError = UnifiNetworkOpError;
|
|
176
|
+
/** Create Traffic Matching List Create a new traffic matching list on a site. */
|
|
177
|
+
export const createTrafficMatchingList: API.OperationMethod<
|
|
178
|
+
CreateTrafficMatchingListRequest,
|
|
179
|
+
TrafficMatchingList,
|
|
180
|
+
CreateTrafficMatchingListError,
|
|
181
|
+
UnifiNetworkOpContext
|
|
182
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
183
|
+
input: CreateTrafficMatchingListRequest,
|
|
184
|
+
output: TrafficMatchingList,
|
|
185
|
+
errors: [UnknownUnifiNetworkError],
|
|
186
|
+
protocol: UnifiNetworkProtocol,
|
|
187
|
+
retry: Retry.Retry,
|
|
188
|
+
}));
|
|
189
|
+
|
|
190
|
+
export type DeleteTrafficMatchingListError = UnifiNetworkOpError;
|
|
191
|
+
/** Delete Traffic Matching List Delete an exist traffic matching list on a site. */
|
|
192
|
+
export const deleteTrafficMatchingList: API.OperationMethod<
|
|
193
|
+
DeleteTrafficMatchingListRequest,
|
|
194
|
+
DeleteTrafficMatchingListResponse,
|
|
195
|
+
DeleteTrafficMatchingListError,
|
|
196
|
+
UnifiNetworkOpContext
|
|
197
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
198
|
+
input: DeleteTrafficMatchingListRequest,
|
|
199
|
+
output: DeleteTrafficMatchingListResponse,
|
|
200
|
+
errors: [UnknownUnifiNetworkError],
|
|
201
|
+
protocol: UnifiNetworkProtocol,
|
|
202
|
+
retry: Retry.Retry,
|
|
203
|
+
}));
|
|
204
|
+
|
|
205
|
+
export type GetTrafficMatchingListError = UnifiNetworkOpError;
|
|
206
|
+
/** Get Traffic Matching List Get an exist traffic matching list on a site. */
|
|
207
|
+
export const getTrafficMatchingList: API.OperationMethod<
|
|
208
|
+
GetTrafficMatchingListRequest,
|
|
209
|
+
TrafficMatchingList,
|
|
210
|
+
GetTrafficMatchingListError,
|
|
211
|
+
UnifiNetworkOpContext
|
|
212
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
213
|
+
input: GetTrafficMatchingListRequest,
|
|
214
|
+
output: TrafficMatchingList,
|
|
215
|
+
errors: [UnknownUnifiNetworkError],
|
|
216
|
+
protocol: UnifiNetworkProtocol,
|
|
217
|
+
retry: Retry.Retry,
|
|
218
|
+
}));
|
|
219
|
+
|
|
220
|
+
export type GetTrafficMatchingListsError = UnifiNetworkOpError;
|
|
221
|
+
/** List Traffic Matching Lists Retrieve all traffic matching lists on a site. <details> <summary>Filterable properties (click to expand)</summary> </details> */
|
|
222
|
+
export const getTrafficMatchingLists: API.OperationMethod<
|
|
223
|
+
GetTrafficMatchingListsRequest,
|
|
224
|
+
TrafficMatchingListsPage,
|
|
225
|
+
GetTrafficMatchingListsError,
|
|
226
|
+
UnifiNetworkOpContext
|
|
227
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
228
|
+
input: GetTrafficMatchingListsRequest,
|
|
229
|
+
output: TrafficMatchingListsPage,
|
|
230
|
+
errors: [UnknownUnifiNetworkError],
|
|
231
|
+
protocol: UnifiNetworkProtocol,
|
|
232
|
+
retry: Retry.Retry,
|
|
233
|
+
}));
|
|
234
|
+
|
|
235
|
+
export type UpdateTrafficMatchingListError = UnifiNetworkOpError;
|
|
236
|
+
/** Update Traffic Matching List Update an exist traffic matching list on a site. */
|
|
237
|
+
export const updateTrafficMatchingList: API.OperationMethod<
|
|
238
|
+
UpdateTrafficMatchingListRequest,
|
|
239
|
+
TrafficMatchingList,
|
|
240
|
+
UpdateTrafficMatchingListError,
|
|
241
|
+
UnifiNetworkOpContext
|
|
242
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
243
|
+
input: UpdateTrafficMatchingListRequest,
|
|
244
|
+
output: TrafficMatchingList,
|
|
245
|
+
errors: [UnknownUnifiNetworkError],
|
|
246
|
+
protocol: UnifiNetworkProtocol,
|
|
247
|
+
retry: Retry.Retry,
|
|
248
|
+
}));
|