@lobehub/sdk 1.0.20260807012700
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/README.md +70 -0
- package/dist/generated/types.gen.d.mts +1601 -0
- package/dist/generated/types.gen.mjs +0 -0
- package/dist/index.d.mts +530 -0
- package/dist/index.mjs +1600 -0
- package/package.json +30 -0
|
File without changes
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,530 @@
|
|
|
1
|
+
import { ClientOptions, DeleteApiV1AgentGroupsByIdData, DeleteApiV1AgentGroupsByIdResponses, DeleteApiV1AgentsByIdData, DeleteApiV1AgentsByIdResponses, DeleteApiV1FilesByIdData, DeleteApiV1FilesByIdResponses, DeleteApiV1KnowledgeBasesByIdData, DeleteApiV1KnowledgeBasesByIdFilesBatchData, DeleteApiV1KnowledgeBasesByIdFilesBatchResponses, DeleteApiV1KnowledgeBasesByIdResponses, DeleteApiV1MessageTranslationsByMessageIdData, DeleteApiV1MessageTranslationsByMessageIdResponses, DeleteApiV1MessagesByIdData, DeleteApiV1MessagesByIdResponses, DeleteApiV1MessagesData, DeleteApiV1MessagesResponses, DeleteApiV1PermissionsByIdData, DeleteApiV1PermissionsByIdResponses, DeleteApiV1ProvidersByIdData, DeleteApiV1ProvidersByIdResponses, DeleteApiV1RolesByIdData, DeleteApiV1RolesByIdPermissionsData, DeleteApiV1RolesByIdPermissionsResponses, DeleteApiV1RolesByIdResponses, DeleteApiV1TopicsByIdData, DeleteApiV1TopicsByIdResponses, DeleteApiV1UsersByIdData, DeleteApiV1UsersByIdResponses, DeleteApiV1UsersByIdRolesData, DeleteApiV1UsersByIdRolesResponses, GetApiV1AgentGroupsByIdData, GetApiV1AgentGroupsByIdResponses, GetApiV1AgentGroupsData, GetApiV1AgentGroupsResponses, GetApiV1AgentsByIdData, GetApiV1AgentsByIdResponses, GetApiV1AgentsData, GetApiV1AgentsResponses, GetApiV1FilesByIdChunksData, GetApiV1FilesByIdChunksResponses, GetApiV1FilesByIdData, GetApiV1FilesByIdResponses, GetApiV1FilesByIdUrlData, GetApiV1FilesByIdUrlResponses, GetApiV1FilesData, GetApiV1FilesResponses, GetApiV1HealthData, GetApiV1HealthResponses, GetApiV1KnowledgeBasesByIdData, GetApiV1KnowledgeBasesByIdFilesData, GetApiV1KnowledgeBasesByIdFilesResponses, GetApiV1KnowledgeBasesByIdResponses, GetApiV1KnowledgeBasesData, GetApiV1KnowledgeBasesResponses, GetApiV1MessageTranslationsByMessageIdData, GetApiV1MessageTranslationsByMessageIdResponses, GetApiV1MessagesByIdData, GetApiV1MessagesByIdResponses, GetApiV1MessagesCountData, GetApiV1MessagesCountResponses, GetApiV1MessagesData, GetApiV1MessagesResponses, GetApiV1ModelsByProviderIdByModelIdData, GetApiV1ModelsByProviderIdByModelIdResponses, GetApiV1ModelsData, GetApiV1ModelsResponses, GetApiV1PermissionsByIdData, GetApiV1PermissionsByIdResponses, GetApiV1PermissionsData, GetApiV1PermissionsResponses, GetApiV1ProvidersByIdData, GetApiV1ProvidersByIdResponses, GetApiV1ProvidersData, GetApiV1ProvidersResponses, GetApiV1RolesByIdData, GetApiV1RolesByIdPermissionsData, GetApiV1RolesByIdPermissionsResponses, GetApiV1RolesByIdResponses, GetApiV1RolesData, GetApiV1RolesResponses, GetApiV1TopicsByIdData, GetApiV1TopicsByIdResponses, GetApiV1TopicsData, GetApiV1TopicsResponses, GetApiV1UsersByIdData, GetApiV1UsersByIdResponses, GetApiV1UsersByIdRolesData, GetApiV1UsersByIdRolesResponses, GetApiV1UsersData, GetApiV1UsersMeData, GetApiV1UsersMeResponses, GetApiV1UsersResponses, PatchApiV1AgentGroupsByIdData, PatchApiV1AgentGroupsByIdResponses, PatchApiV1AgentsByIdData, PatchApiV1AgentsByIdResponses, PatchApiV1FilesByIdData, PatchApiV1FilesByIdResponses, PatchApiV1KnowledgeBasesByIdData, PatchApiV1KnowledgeBasesByIdResponses, PatchApiV1MessageTranslationsByMessageIdData, PatchApiV1MessageTranslationsByMessageIdResponses, PatchApiV1ModelsByProviderIdByModelIdData, PatchApiV1ModelsByProviderIdByModelIdResponses, PatchApiV1PermissionsByIdData, PatchApiV1PermissionsByIdResponses, PatchApiV1ProvidersByIdData, PatchApiV1ProvidersByIdResponses, PatchApiV1RolesByIdData, PatchApiV1RolesByIdPermissionsData, PatchApiV1RolesByIdPermissionsResponses, PatchApiV1RolesByIdResponses, PatchApiV1TopicsByIdData, PatchApiV1TopicsByIdResponses, PatchApiV1UsersByIdData, PatchApiV1UsersByIdResponses, PatchApiV1UsersByIdRolesData, PatchApiV1UsersByIdRolesResponses, PostApiV1AgentGroupsData, PostApiV1AgentGroupsResponses, PostApiV1AgentsData, PostApiV1AgentsResponses, PostApiV1FilesBatchesData, PostApiV1FilesBatchesResponses, PostApiV1FilesByIdChunksData, PostApiV1FilesByIdChunksResponses, PostApiV1FilesByIdParsesData, PostApiV1FilesByIdParsesResponses, PostApiV1FilesData, PostApiV1FilesQueriesData, PostApiV1FilesQueriesResponses, PostApiV1FilesResponses, PostApiV1KnowledgeBasesByIdFilesBatchData, PostApiV1KnowledgeBasesByIdFilesBatchResponses, PostApiV1KnowledgeBasesByIdFilesMoveData, PostApiV1KnowledgeBasesByIdFilesMoveResponses, PostApiV1KnowledgeBasesData, PostApiV1KnowledgeBasesResponses, PostApiV1MessageTranslationsByMessageIdData, PostApiV1MessageTranslationsByMessageIdResponses, PostApiV1MessagesData, PostApiV1MessagesRepliesData, PostApiV1MessagesRepliesResponses, PostApiV1MessagesResponses, PostApiV1ModelsData, PostApiV1ModelsResponses, PostApiV1PermissionsData, PostApiV1PermissionsResponses, PostApiV1ProvidersData, PostApiV1ProvidersResponses, PostApiV1ResponsesData, PostApiV1ResponsesResponses, PostApiV1RolesData, PostApiV1RolesResponses, PostApiV1TopicsData, PostApiV1TopicsResponses, PostApiV1UsersData, PostApiV1UsersResponses } from "./generated/types.gen.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/generated/core/auth.gen.d.ts
|
|
4
|
+
type AuthToken = string | undefined;
|
|
5
|
+
interface Auth {
|
|
6
|
+
/**
|
|
7
|
+
* Which part of the request do we use to send the auth?
|
|
8
|
+
*
|
|
9
|
+
* @default 'header'
|
|
10
|
+
*/
|
|
11
|
+
in?: 'header' | 'query' | 'cookie';
|
|
12
|
+
/**
|
|
13
|
+
* A unique identifier for the security scheme.
|
|
14
|
+
*
|
|
15
|
+
* Defined only when there are multiple security schemes whose `Auth`
|
|
16
|
+
* shape would otherwise be identical.
|
|
17
|
+
*/
|
|
18
|
+
key?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Header or query parameter name.
|
|
21
|
+
*
|
|
22
|
+
* @default 'Authorization'
|
|
23
|
+
*/
|
|
24
|
+
name?: string;
|
|
25
|
+
scheme?: 'basic' | 'bearer';
|
|
26
|
+
type: 'apiKey' | 'http';
|
|
27
|
+
}
|
|
28
|
+
//#endregion
|
|
29
|
+
//#region src/generated/core/pathSerializer.gen.d.ts
|
|
30
|
+
interface SerializerOptions<T> {
|
|
31
|
+
/**
|
|
32
|
+
* @default true
|
|
33
|
+
*/
|
|
34
|
+
explode: boolean;
|
|
35
|
+
style: T;
|
|
36
|
+
}
|
|
37
|
+
type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
|
|
38
|
+
type ObjectStyle = 'form' | 'deepObject';
|
|
39
|
+
//#endregion
|
|
40
|
+
//#region src/generated/core/bodySerializer.gen.d.ts
|
|
41
|
+
type QuerySerializer = (query: Record<string, unknown>) => string;
|
|
42
|
+
type BodySerializer = (body: unknown) => unknown;
|
|
43
|
+
type QuerySerializerOptionsObject = {
|
|
44
|
+
allowReserved?: boolean;
|
|
45
|
+
array?: Partial<SerializerOptions<ArrayStyle>>;
|
|
46
|
+
object?: Partial<SerializerOptions<ObjectStyle>>;
|
|
47
|
+
};
|
|
48
|
+
type QuerySerializerOptions = QuerySerializerOptionsObject & {
|
|
49
|
+
/**
|
|
50
|
+
* Per-parameter serialization overrides. When provided, these settings
|
|
51
|
+
* override the global array/object settings for specific parameter names.
|
|
52
|
+
*/
|
|
53
|
+
parameters?: Record<string, QuerySerializerOptionsObject>;
|
|
54
|
+
};
|
|
55
|
+
//#endregion
|
|
56
|
+
//#region src/generated/core/types.gen.d.ts
|
|
57
|
+
type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
|
|
58
|
+
type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
|
|
59
|
+
/**
|
|
60
|
+
* Returns the final request URL.
|
|
61
|
+
*/
|
|
62
|
+
buildUrl: BuildUrlFn;
|
|
63
|
+
getConfig: () => Config;
|
|
64
|
+
request: RequestFn;
|
|
65
|
+
setConfig: (config: Config) => Config;
|
|
66
|
+
} & { [K in HttpMethod]: MethodFn } & ([SseFn] extends [never] ? {
|
|
67
|
+
sse?: never;
|
|
68
|
+
} : {
|
|
69
|
+
sse: { [K in HttpMethod]: SseFn };
|
|
70
|
+
});
|
|
71
|
+
interface Config$1 {
|
|
72
|
+
/**
|
|
73
|
+
* Auth token or a function returning auth token. The resolved value will be
|
|
74
|
+
* added to the request payload as defined by its `security` array.
|
|
75
|
+
*/
|
|
76
|
+
auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
|
|
77
|
+
/**
|
|
78
|
+
* A function for serializing request body parameter. By default,
|
|
79
|
+
* {@link JSON.stringify()} will be used.
|
|
80
|
+
*/
|
|
81
|
+
bodySerializer?: BodySerializer | null;
|
|
82
|
+
/**
|
|
83
|
+
* An object containing any HTTP headers that you want to pre-populate your
|
|
84
|
+
* `Headers` object with.
|
|
85
|
+
*
|
|
86
|
+
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
|
87
|
+
*/
|
|
88
|
+
headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
|
|
89
|
+
/**
|
|
90
|
+
* The request method.
|
|
91
|
+
*
|
|
92
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
|
|
93
|
+
*/
|
|
94
|
+
method?: Uppercase<HttpMethod>;
|
|
95
|
+
/**
|
|
96
|
+
* A function for serializing request query parameters. By default, arrays
|
|
97
|
+
* will be exploded in form style, objects will be exploded in deepObject
|
|
98
|
+
* style, and reserved characters are percent-encoded.
|
|
99
|
+
*
|
|
100
|
+
* This method will have no effect if the native `paramsSerializer()` Axios
|
|
101
|
+
* API function is used.
|
|
102
|
+
*
|
|
103
|
+
* {@link https://swagger.io/docs/specification/serialization/#query View examples}
|
|
104
|
+
*/
|
|
105
|
+
querySerializer?: QuerySerializer | QuerySerializerOptions;
|
|
106
|
+
/**
|
|
107
|
+
* A function validating request data. This is useful if you want to ensure
|
|
108
|
+
* the request conforms to the desired shape, so it can be safely sent to
|
|
109
|
+
* the server.
|
|
110
|
+
*/
|
|
111
|
+
requestValidator?: (data: unknown) => Promise<unknown>;
|
|
112
|
+
/**
|
|
113
|
+
* A function transforming response data before it's returned. This is useful
|
|
114
|
+
* for post-processing data, e.g., converting ISO strings into Date objects.
|
|
115
|
+
*/
|
|
116
|
+
responseTransformer?: (data: unknown) => Promise<unknown>;
|
|
117
|
+
/**
|
|
118
|
+
* A function validating response data. This is useful if you want to ensure
|
|
119
|
+
* the response conforms to the desired shape, so it can be safely passed to
|
|
120
|
+
* the transformers and returned to the user.
|
|
121
|
+
*/
|
|
122
|
+
responseValidator?: (data: unknown) => Promise<unknown>;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Arbitrary metadata passed through the `meta` request option.
|
|
126
|
+
*/
|
|
127
|
+
interface ClientMeta {}
|
|
128
|
+
//#endregion
|
|
129
|
+
//#region src/generated/core/serverSentEvents.gen.d.ts
|
|
130
|
+
type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
|
|
131
|
+
/**
|
|
132
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
133
|
+
* fetch instance.
|
|
134
|
+
*
|
|
135
|
+
* @default globalThis.fetch
|
|
136
|
+
*/
|
|
137
|
+
fetch?: typeof fetch;
|
|
138
|
+
/**
|
|
139
|
+
* Implementing clients can call request interceptors inside this hook.
|
|
140
|
+
*/
|
|
141
|
+
onRequest?: (url: string, init: RequestInit) => Promise<Request>;
|
|
142
|
+
/**
|
|
143
|
+
* Callback invoked when a network or parsing error occurs during streaming.
|
|
144
|
+
*
|
|
145
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
146
|
+
*
|
|
147
|
+
* @param error The error that occurred.
|
|
148
|
+
*/
|
|
149
|
+
onSseError?: (error: unknown) => void;
|
|
150
|
+
/**
|
|
151
|
+
* Callback invoked when an event is streamed from the server.
|
|
152
|
+
*
|
|
153
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
154
|
+
*
|
|
155
|
+
* @param event Event streamed from the server.
|
|
156
|
+
* @returns Nothing (void).
|
|
157
|
+
*/
|
|
158
|
+
onSseEvent?: (event: StreamEvent<TData>) => void;
|
|
159
|
+
serializedBody?: RequestInit['body'];
|
|
160
|
+
/**
|
|
161
|
+
* Default retry delay in milliseconds.
|
|
162
|
+
*
|
|
163
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
164
|
+
*
|
|
165
|
+
* @default 3000
|
|
166
|
+
*/
|
|
167
|
+
sseDefaultRetryDelay?: number;
|
|
168
|
+
/**
|
|
169
|
+
* Maximum number of retry attempts before giving up.
|
|
170
|
+
*/
|
|
171
|
+
sseMaxRetryAttempts?: number;
|
|
172
|
+
/**
|
|
173
|
+
* Maximum retry delay in milliseconds.
|
|
174
|
+
*
|
|
175
|
+
* Applies only when exponential backoff is used.
|
|
176
|
+
*
|
|
177
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
178
|
+
*
|
|
179
|
+
* @default 30000
|
|
180
|
+
*/
|
|
181
|
+
sseMaxRetryDelay?: number;
|
|
182
|
+
/**
|
|
183
|
+
* Optional sleep function for retry backoff.
|
|
184
|
+
*
|
|
185
|
+
* Defaults to using `setTimeout`.
|
|
186
|
+
*/
|
|
187
|
+
sseSleepFn?: (ms: number) => Promise<void>;
|
|
188
|
+
url: string;
|
|
189
|
+
};
|
|
190
|
+
interface StreamEvent<TData = unknown> {
|
|
191
|
+
data: TData;
|
|
192
|
+
event?: string;
|
|
193
|
+
id?: string;
|
|
194
|
+
retry?: number;
|
|
195
|
+
}
|
|
196
|
+
type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
|
|
197
|
+
stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
|
|
198
|
+
};
|
|
199
|
+
//#endregion
|
|
200
|
+
//#region src/generated/client/utils.gen.d.ts
|
|
201
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
202
|
+
|
|
203
|
+
response: Res | undefined, /** request may be undefined, because error may be from building the request object itself */
|
|
204
|
+
|
|
205
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
206
|
+
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
207
|
+
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
208
|
+
declare class Interceptors<Interceptor> {
|
|
209
|
+
fns: Array<Interceptor | null>;
|
|
210
|
+
clear(): void;
|
|
211
|
+
eject(id: number | Interceptor): void;
|
|
212
|
+
exists(id: number | Interceptor): boolean;
|
|
213
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
214
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
215
|
+
use(fn: Interceptor): number;
|
|
216
|
+
}
|
|
217
|
+
interface Middleware<Req, Res, Err, Options> {
|
|
218
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
219
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
220
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
221
|
+
}
|
|
222
|
+
//#endregion
|
|
223
|
+
//#region src/generated/client/types.gen.d.ts
|
|
224
|
+
type ResponseStyle = 'data' | 'fields';
|
|
225
|
+
interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
|
|
226
|
+
/**
|
|
227
|
+
* Base URL for all requests made by this client.
|
|
228
|
+
*/
|
|
229
|
+
baseUrl?: T['baseUrl'];
|
|
230
|
+
/**
|
|
231
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
232
|
+
* fetch instance.
|
|
233
|
+
*
|
|
234
|
+
* @default globalThis.fetch
|
|
235
|
+
*/
|
|
236
|
+
fetch?: typeof fetch;
|
|
237
|
+
/**
|
|
238
|
+
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
239
|
+
* options won't have any effect.
|
|
240
|
+
*
|
|
241
|
+
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
242
|
+
*/
|
|
243
|
+
next?: never;
|
|
244
|
+
/**
|
|
245
|
+
* Return the response data parsed in a specified format. By default, `auto`
|
|
246
|
+
* will infer the appropriate method from the `Content-Type` response header.
|
|
247
|
+
* You can override this behavior with any of the {@link Body} methods.
|
|
248
|
+
* Select `stream` if you don't want to parse response data at all.
|
|
249
|
+
*
|
|
250
|
+
* @default 'auto'
|
|
251
|
+
*/
|
|
252
|
+
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
253
|
+
/**
|
|
254
|
+
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
255
|
+
*
|
|
256
|
+
* @default 'fields'
|
|
257
|
+
*/
|
|
258
|
+
responseStyle?: ResponseStyle;
|
|
259
|
+
/**
|
|
260
|
+
* Throw an error instead of returning it in the response?
|
|
261
|
+
*
|
|
262
|
+
* @default false
|
|
263
|
+
*/
|
|
264
|
+
throwOnError?: T['throwOnError'];
|
|
265
|
+
}
|
|
266
|
+
interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
267
|
+
responseStyle: TResponseStyle;
|
|
268
|
+
throwOnError: ThrowOnError;
|
|
269
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
270
|
+
/**
|
|
271
|
+
* Any body that you want to add to your request.
|
|
272
|
+
*
|
|
273
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
274
|
+
*/
|
|
275
|
+
body?: unknown;
|
|
276
|
+
path?: Record<string, unknown>;
|
|
277
|
+
query?: Record<string, unknown>;
|
|
278
|
+
/**
|
|
279
|
+
* Security mechanism(s) to use for the request.
|
|
280
|
+
*/
|
|
281
|
+
security?: ReadonlyArray<Auth>;
|
|
282
|
+
url: Url;
|
|
283
|
+
}
|
|
284
|
+
interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
285
|
+
headers: Headers;
|
|
286
|
+
serializedBody?: string;
|
|
287
|
+
}
|
|
288
|
+
type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
|
|
289
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
290
|
+
request: Request;
|
|
291
|
+
response: Response;
|
|
292
|
+
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
293
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
294
|
+
error: undefined;
|
|
295
|
+
} | {
|
|
296
|
+
data: undefined;
|
|
297
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
298
|
+
}) & {
|
|
299
|
+
/** request may be undefined, because error may be from building the request object itself */request?: Request; /** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
300
|
+
response?: Response;
|
|
301
|
+
}>;
|
|
302
|
+
interface ClientOptions$1 {
|
|
303
|
+
baseUrl?: string;
|
|
304
|
+
responseStyle?: ResponseStyle;
|
|
305
|
+
throwOnError?: boolean;
|
|
306
|
+
}
|
|
307
|
+
type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
308
|
+
type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
|
|
309
|
+
type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
310
|
+
type BuildUrlFn = <TData extends {
|
|
311
|
+
body?: unknown;
|
|
312
|
+
path?: Record<string, unknown>;
|
|
313
|
+
query?: Record<string, unknown>;
|
|
314
|
+
url: string;
|
|
315
|
+
}>(options: TData & Options$1<TData>) => string;
|
|
316
|
+
type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
317
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
318
|
+
};
|
|
319
|
+
interface TDataShape {
|
|
320
|
+
body?: unknown;
|
|
321
|
+
headers?: unknown;
|
|
322
|
+
path?: unknown;
|
|
323
|
+
query?: unknown;
|
|
324
|
+
url: string;
|
|
325
|
+
}
|
|
326
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
327
|
+
type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
328
|
+
//#endregion
|
|
329
|
+
//#region src/generated/sdk.gen.d.ts
|
|
330
|
+
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
|
|
331
|
+
/**
|
|
332
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
333
|
+
* individual options. This might be also useful if you want to implement a
|
|
334
|
+
* custom client.
|
|
335
|
+
*/
|
|
336
|
+
client?: Client;
|
|
337
|
+
/**
|
|
338
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
339
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
340
|
+
*/
|
|
341
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
342
|
+
};
|
|
343
|
+
declare class HeyApiClient {
|
|
344
|
+
protected client: Client;
|
|
345
|
+
constructor(args?: {
|
|
346
|
+
client?: Client;
|
|
347
|
+
});
|
|
348
|
+
}
|
|
349
|
+
declare class HeyApiRegistry<T> {
|
|
350
|
+
private readonly defaultKey;
|
|
351
|
+
private readonly instances;
|
|
352
|
+
get(key?: string): T;
|
|
353
|
+
set(value: T, key?: string): void;
|
|
354
|
+
}
|
|
355
|
+
declare class Health extends HeyApiClient {
|
|
356
|
+
/**
|
|
357
|
+
* Health check
|
|
358
|
+
*/
|
|
359
|
+
check<ThrowOnError extends boolean = false>(options?: Options<GetApiV1HealthData, ThrowOnError>): RequestResult<GetApiV1HealthResponses, unknown, ThrowOnError>;
|
|
360
|
+
}
|
|
361
|
+
declare class AgentGroups extends HeyApiClient {
|
|
362
|
+
/**
|
|
363
|
+
* Get agent group list
|
|
364
|
+
*/
|
|
365
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1AgentGroupsData, ThrowOnError>): RequestResult<GetApiV1AgentGroupsResponses, unknown, ThrowOnError>;
|
|
366
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1AgentGroupsData, ThrowOnError>): RequestResult<PostApiV1AgentGroupsResponses, unknown, ThrowOnError>;
|
|
367
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1AgentGroupsByIdData, ThrowOnError>): RequestResult<DeleteApiV1AgentGroupsByIdResponses, unknown, ThrowOnError>;
|
|
368
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1AgentGroupsByIdData, ThrowOnError>): RequestResult<GetApiV1AgentGroupsByIdResponses, unknown, ThrowOnError>;
|
|
369
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1AgentGroupsByIdData, ThrowOnError>): RequestResult<PatchApiV1AgentGroupsByIdResponses, unknown, ThrowOnError>;
|
|
370
|
+
}
|
|
371
|
+
declare class Agents extends HeyApiClient {
|
|
372
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1AgentsData, ThrowOnError>): RequestResult<GetApiV1AgentsResponses, unknown, ThrowOnError>;
|
|
373
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1AgentsData, ThrowOnError>): RequestResult<PostApiV1AgentsResponses, unknown, ThrowOnError>;
|
|
374
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1AgentsByIdData, ThrowOnError>): RequestResult<DeleteApiV1AgentsByIdResponses, unknown, ThrowOnError>;
|
|
375
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1AgentsByIdData, ThrowOnError>): RequestResult<GetApiV1AgentsByIdResponses, unknown, ThrowOnError>;
|
|
376
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1AgentsByIdData, ThrowOnError>): RequestResult<PatchApiV1AgentsByIdResponses, unknown, ThrowOnError>;
|
|
377
|
+
}
|
|
378
|
+
declare class Files extends HeyApiClient {
|
|
379
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1FilesData, ThrowOnError>): RequestResult<GetApiV1FilesResponses, unknown, ThrowOnError>;
|
|
380
|
+
/**
|
|
381
|
+
* Upload a file and return the corresponding file record
|
|
382
|
+
*/
|
|
383
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1FilesData, ThrowOnError>): RequestResult<PostApiV1FilesResponses, unknown, ThrowOnError>;
|
|
384
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1FilesByIdData, ThrowOnError>): RequestResult<DeleteApiV1FilesByIdResponses, unknown, ThrowOnError>;
|
|
385
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1FilesByIdData, ThrowOnError>): RequestResult<GetApiV1FilesByIdResponses, unknown, ThrowOnError>;
|
|
386
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1FilesByIdData, ThrowOnError>): RequestResult<PatchApiV1FilesByIdResponses, unknown, ThrowOnError>;
|
|
387
|
+
getUrl<ThrowOnError extends boolean = false>(options: Options<GetApiV1FilesByIdUrlData, ThrowOnError>): RequestResult<GetApiV1FilesByIdUrlResponses, unknown, ThrowOnError>;
|
|
388
|
+
parse<ThrowOnError extends boolean = false>(options: Options<PostApiV1FilesByIdParsesData, ThrowOnError>): RequestResult<PostApiV1FilesByIdParsesResponses, unknown, ThrowOnError>;
|
|
389
|
+
listChunks<ThrowOnError extends boolean = false>(options: Options<GetApiV1FilesByIdChunksData, ThrowOnError>): RequestResult<GetApiV1FilesByIdChunksResponses, unknown, ThrowOnError>;
|
|
390
|
+
createChunks<ThrowOnError extends boolean = false>(options: Options<PostApiV1FilesByIdChunksData, ThrowOnError>): RequestResult<PostApiV1FilesByIdChunksResponses, unknown, ThrowOnError>;
|
|
391
|
+
/**
|
|
392
|
+
* Batch file upload
|
|
393
|
+
*/
|
|
394
|
+
uploadBatch<ThrowOnError extends boolean = false>(options: Options<PostApiV1FilesBatchesData, ThrowOnError>): RequestResult<PostApiV1FilesBatchesResponses, unknown, ThrowOnError>;
|
|
395
|
+
query<ThrowOnError extends boolean = false>(options: Options<PostApiV1FilesQueriesData, ThrowOnError>): RequestResult<PostApiV1FilesQueriesResponses, unknown, ThrowOnError>;
|
|
396
|
+
}
|
|
397
|
+
declare class KnowledgeBases extends HeyApiClient {
|
|
398
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1KnowledgeBasesData, ThrowOnError>): RequestResult<GetApiV1KnowledgeBasesResponses, unknown, ThrowOnError>;
|
|
399
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1KnowledgeBasesData, ThrowOnError>): RequestResult<PostApiV1KnowledgeBasesResponses, unknown, ThrowOnError>;
|
|
400
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1KnowledgeBasesByIdData, ThrowOnError>): RequestResult<DeleteApiV1KnowledgeBasesByIdResponses, unknown, ThrowOnError>;
|
|
401
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1KnowledgeBasesByIdData, ThrowOnError>): RequestResult<GetApiV1KnowledgeBasesByIdResponses, unknown, ThrowOnError>;
|
|
402
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1KnowledgeBasesByIdData, ThrowOnError>): RequestResult<PatchApiV1KnowledgeBasesByIdResponses, unknown, ThrowOnError>;
|
|
403
|
+
listFiles<ThrowOnError extends boolean = false>(options: Options<GetApiV1KnowledgeBasesByIdFilesData, ThrowOnError>): RequestResult<GetApiV1KnowledgeBasesByIdFilesResponses, unknown, ThrowOnError>;
|
|
404
|
+
removeFiles<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1KnowledgeBasesByIdFilesBatchData, ThrowOnError>): RequestResult<DeleteApiV1KnowledgeBasesByIdFilesBatchResponses, unknown, ThrowOnError>;
|
|
405
|
+
addFiles<ThrowOnError extends boolean = false>(options: Options<PostApiV1KnowledgeBasesByIdFilesBatchData, ThrowOnError>): RequestResult<PostApiV1KnowledgeBasesByIdFilesBatchResponses, unknown, ThrowOnError>;
|
|
406
|
+
moveFiles<ThrowOnError extends boolean = false>(options: Options<PostApiV1KnowledgeBasesByIdFilesMoveData, ThrowOnError>): RequestResult<PostApiV1KnowledgeBasesByIdFilesMoveResponses, unknown, ThrowOnError>;
|
|
407
|
+
}
|
|
408
|
+
declare class MessageTranslations extends HeyApiClient {
|
|
409
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1MessageTranslationsByMessageIdData, ThrowOnError>): RequestResult<DeleteApiV1MessageTranslationsByMessageIdResponses, unknown, ThrowOnError>;
|
|
410
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1MessageTranslationsByMessageIdData, ThrowOnError>): RequestResult<GetApiV1MessageTranslationsByMessageIdResponses, unknown, ThrowOnError>;
|
|
411
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1MessageTranslationsByMessageIdData, ThrowOnError>): RequestResult<PatchApiV1MessageTranslationsByMessageIdResponses, unknown, ThrowOnError>;
|
|
412
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1MessageTranslationsByMessageIdData, ThrowOnError>): RequestResult<PostApiV1MessageTranslationsByMessageIdResponses, unknown, ThrowOnError>;
|
|
413
|
+
}
|
|
414
|
+
declare class Messages extends HeyApiClient {
|
|
415
|
+
getCount<ThrowOnError extends boolean = false>(options?: Options<GetApiV1MessagesCountData, ThrowOnError>): RequestResult<GetApiV1MessagesCountResponses, unknown, ThrowOnError>;
|
|
416
|
+
deleteMany<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1MessagesData, ThrowOnError>): RequestResult<DeleteApiV1MessagesResponses, unknown, ThrowOnError>;
|
|
417
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1MessagesData, ThrowOnError>): RequestResult<GetApiV1MessagesResponses, unknown, ThrowOnError>;
|
|
418
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1MessagesData, ThrowOnError>): RequestResult<PostApiV1MessagesResponses, unknown, ThrowOnError>;
|
|
419
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1MessagesByIdData, ThrowOnError>): RequestResult<DeleteApiV1MessagesByIdResponses, unknown, ThrowOnError>;
|
|
420
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1MessagesByIdData, ThrowOnError>): RequestResult<GetApiV1MessagesByIdResponses, unknown, ThrowOnError>;
|
|
421
|
+
createReply<ThrowOnError extends boolean = false>(options: Options<PostApiV1MessagesRepliesData, ThrowOnError>): RequestResult<PostApiV1MessagesRepliesResponses, unknown, ThrowOnError>;
|
|
422
|
+
}
|
|
423
|
+
declare class Models extends HeyApiClient {
|
|
424
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1ModelsData, ThrowOnError>): RequestResult<GetApiV1ModelsResponses, unknown, ThrowOnError>;
|
|
425
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1ModelsData, ThrowOnError>): RequestResult<PostApiV1ModelsResponses, unknown, ThrowOnError>;
|
|
426
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1ModelsByProviderIdByModelIdData, ThrowOnError>): RequestResult<GetApiV1ModelsByProviderIdByModelIdResponses, unknown, ThrowOnError>;
|
|
427
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1ModelsByProviderIdByModelIdData, ThrowOnError>): RequestResult<PatchApiV1ModelsByProviderIdByModelIdResponses, unknown, ThrowOnError>;
|
|
428
|
+
}
|
|
429
|
+
declare class Permissions extends HeyApiClient {
|
|
430
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1PermissionsData, ThrowOnError>): RequestResult<GetApiV1PermissionsResponses, unknown, ThrowOnError>;
|
|
431
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1PermissionsData, ThrowOnError>): RequestResult<PostApiV1PermissionsResponses, unknown, ThrowOnError>;
|
|
432
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1PermissionsByIdData, ThrowOnError>): RequestResult<DeleteApiV1PermissionsByIdResponses, unknown, ThrowOnError>;
|
|
433
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1PermissionsByIdData, ThrowOnError>): RequestResult<GetApiV1PermissionsByIdResponses, unknown, ThrowOnError>;
|
|
434
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1PermissionsByIdData, ThrowOnError>): RequestResult<PatchApiV1PermissionsByIdResponses, unknown, ThrowOnError>;
|
|
435
|
+
}
|
|
436
|
+
declare class Providers extends HeyApiClient {
|
|
437
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1ProvidersData, ThrowOnError>): RequestResult<GetApiV1ProvidersResponses, unknown, ThrowOnError>;
|
|
438
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1ProvidersData, ThrowOnError>): RequestResult<PostApiV1ProvidersResponses, unknown, ThrowOnError>;
|
|
439
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1ProvidersByIdData, ThrowOnError>): RequestResult<DeleteApiV1ProvidersByIdResponses, unknown, ThrowOnError>;
|
|
440
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1ProvidersByIdData, ThrowOnError>): RequestResult<GetApiV1ProvidersByIdResponses, unknown, ThrowOnError>;
|
|
441
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1ProvidersByIdData, ThrowOnError>): RequestResult<PatchApiV1ProvidersByIdResponses, unknown, ThrowOnError>;
|
|
442
|
+
}
|
|
443
|
+
declare class Responses extends HeyApiClient {
|
|
444
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1ResponsesData, ThrowOnError>): RequestResult<PostApiV1ResponsesResponses, unknown, ThrowOnError>;
|
|
445
|
+
}
|
|
446
|
+
declare class Roles extends HeyApiClient {
|
|
447
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1RolesData, ThrowOnError>): RequestResult<GetApiV1RolesResponses, unknown, ThrowOnError>;
|
|
448
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1RolesData, ThrowOnError>): RequestResult<PostApiV1RolesResponses, unknown, ThrowOnError>;
|
|
449
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1RolesByIdData, ThrowOnError>): RequestResult<DeleteApiV1RolesByIdResponses, unknown, ThrowOnError>;
|
|
450
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1RolesByIdData, ThrowOnError>): RequestResult<GetApiV1RolesByIdResponses, unknown, ThrowOnError>;
|
|
451
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1RolesByIdData, ThrowOnError>): RequestResult<PatchApiV1RolesByIdResponses, unknown, ThrowOnError>;
|
|
452
|
+
deletePermissions<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1RolesByIdPermissionsData, ThrowOnError>): RequestResult<DeleteApiV1RolesByIdPermissionsResponses, unknown, ThrowOnError>;
|
|
453
|
+
listPermissions<ThrowOnError extends boolean = false>(options: Options<GetApiV1RolesByIdPermissionsData, ThrowOnError>): RequestResult<GetApiV1RolesByIdPermissionsResponses, unknown, ThrowOnError>;
|
|
454
|
+
updatePermissions<ThrowOnError extends boolean = false>(options: Options<PatchApiV1RolesByIdPermissionsData, ThrowOnError>): RequestResult<PatchApiV1RolesByIdPermissionsResponses, unknown, ThrowOnError>;
|
|
455
|
+
}
|
|
456
|
+
declare class Topics extends HeyApiClient {
|
|
457
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1TopicsData, ThrowOnError>): RequestResult<GetApiV1TopicsResponses, unknown, ThrowOnError>;
|
|
458
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1TopicsData, ThrowOnError>): RequestResult<PostApiV1TopicsResponses, unknown, ThrowOnError>;
|
|
459
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1TopicsByIdData, ThrowOnError>): RequestResult<DeleteApiV1TopicsByIdResponses, unknown, ThrowOnError>;
|
|
460
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1TopicsByIdData, ThrowOnError>): RequestResult<GetApiV1TopicsByIdResponses, unknown, ThrowOnError>;
|
|
461
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1TopicsByIdData, ThrowOnError>): RequestResult<PatchApiV1TopicsByIdResponses, unknown, ThrowOnError>;
|
|
462
|
+
}
|
|
463
|
+
declare class Users extends HeyApiClient {
|
|
464
|
+
/**
|
|
465
|
+
* Get current authenticated user
|
|
466
|
+
*/
|
|
467
|
+
me<ThrowOnError extends boolean = false>(options?: Options<GetApiV1UsersMeData, ThrowOnError>): RequestResult<GetApiV1UsersMeResponses, unknown, ThrowOnError>;
|
|
468
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetApiV1UsersData, ThrowOnError>): RequestResult<GetApiV1UsersResponses, unknown, ThrowOnError>;
|
|
469
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostApiV1UsersData, ThrowOnError>): RequestResult<PostApiV1UsersResponses, unknown, ThrowOnError>;
|
|
470
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1UsersByIdData, ThrowOnError>): RequestResult<DeleteApiV1UsersByIdResponses, unknown, ThrowOnError>;
|
|
471
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetApiV1UsersByIdData, ThrowOnError>): RequestResult<GetApiV1UsersByIdResponses, unknown, ThrowOnError>;
|
|
472
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchApiV1UsersByIdData, ThrowOnError>): RequestResult<PatchApiV1UsersByIdResponses, unknown, ThrowOnError>;
|
|
473
|
+
deleteRoles<ThrowOnError extends boolean = false>(options: Options<DeleteApiV1UsersByIdRolesData, ThrowOnError>): RequestResult<DeleteApiV1UsersByIdRolesResponses, unknown, ThrowOnError>;
|
|
474
|
+
listRoles<ThrowOnError extends boolean = false>(options: Options<GetApiV1UsersByIdRolesData, ThrowOnError>): RequestResult<GetApiV1UsersByIdRolesResponses, unknown, ThrowOnError>;
|
|
475
|
+
updateRoles<ThrowOnError extends boolean = false>(options: Options<PatchApiV1UsersByIdRolesData, ThrowOnError>): RequestResult<PatchApiV1UsersByIdRolesResponses, unknown, ThrowOnError>;
|
|
476
|
+
}
|
|
477
|
+
declare class LobeHub extends HeyApiClient {
|
|
478
|
+
static readonly __registry: HeyApiRegistry<LobeHub>;
|
|
479
|
+
constructor(args?: {
|
|
480
|
+
client?: Client;
|
|
481
|
+
key?: string;
|
|
482
|
+
});
|
|
483
|
+
private _health?;
|
|
484
|
+
get health(): Health;
|
|
485
|
+
private _agentGroups?;
|
|
486
|
+
get agentGroups(): AgentGroups;
|
|
487
|
+
private _agents?;
|
|
488
|
+
get agents(): Agents;
|
|
489
|
+
private _files?;
|
|
490
|
+
get files(): Files;
|
|
491
|
+
private _knowledgeBases?;
|
|
492
|
+
get knowledgeBases(): KnowledgeBases;
|
|
493
|
+
private _messageTranslations?;
|
|
494
|
+
get messageTranslations(): MessageTranslations;
|
|
495
|
+
private _messages?;
|
|
496
|
+
get messages(): Messages;
|
|
497
|
+
private _models?;
|
|
498
|
+
get models(): Models;
|
|
499
|
+
private _permissions?;
|
|
500
|
+
get permissions(): Permissions;
|
|
501
|
+
private _providers?;
|
|
502
|
+
get providers(): Providers;
|
|
503
|
+
private _responses?;
|
|
504
|
+
get responses(): Responses;
|
|
505
|
+
private _roles?;
|
|
506
|
+
get roles(): Roles;
|
|
507
|
+
private _topics?;
|
|
508
|
+
get topics(): Topics;
|
|
509
|
+
private _users?;
|
|
510
|
+
get users(): Users;
|
|
511
|
+
}
|
|
512
|
+
//#endregion
|
|
513
|
+
//#region src/index.d.ts
|
|
514
|
+
declare const DEFAULT_BASE_URL = "https://app.lobehub.com";
|
|
515
|
+
interface LobeHubOptions extends Omit<Config, 'auth' | 'baseUrl'> {
|
|
516
|
+
/** LobeHub API Key (`sk-lh-...`) or an OIDC JWT */
|
|
517
|
+
apiKey: string;
|
|
518
|
+
/** API origin, defaults to LobeHub Cloud (`https://app.lobehub.com`) */
|
|
519
|
+
baseURL?: string;
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* Create a resource-style LobeHub API client: `lobehub.agents.list()`,
|
|
523
|
+
* `lobehub.files.uploadBatch()`, `lobehub.users.me()`, …
|
|
524
|
+
*
|
|
525
|
+
* Resources, methods, and schemas are generated from
|
|
526
|
+
* `packages/openapi/openapi.yml` — run `bun generate` after the spec changes.
|
|
527
|
+
*/
|
|
528
|
+
declare const createLobeHub: (options: LobeHubOptions) => LobeHub;
|
|
529
|
+
//#endregion
|
|
530
|
+
export { type Client, ClientOptions, type Config, DEFAULT_BASE_URL, DeleteApiV1AgentGroupsByIdData, DeleteApiV1AgentGroupsByIdResponses, DeleteApiV1AgentsByIdData, DeleteApiV1AgentsByIdResponses, DeleteApiV1FilesByIdData, DeleteApiV1FilesByIdResponses, DeleteApiV1KnowledgeBasesByIdData, DeleteApiV1KnowledgeBasesByIdFilesBatchData, DeleteApiV1KnowledgeBasesByIdFilesBatchResponses, DeleteApiV1KnowledgeBasesByIdResponses, DeleteApiV1MessageTranslationsByMessageIdData, DeleteApiV1MessageTranslationsByMessageIdResponses, DeleteApiV1MessagesByIdData, DeleteApiV1MessagesByIdResponses, DeleteApiV1MessagesData, DeleteApiV1MessagesResponses, DeleteApiV1PermissionsByIdData, DeleteApiV1PermissionsByIdResponses, DeleteApiV1ProvidersByIdData, DeleteApiV1ProvidersByIdResponses, DeleteApiV1RolesByIdData, DeleteApiV1RolesByIdPermissionsData, DeleteApiV1RolesByIdPermissionsResponses, DeleteApiV1RolesByIdResponses, DeleteApiV1TopicsByIdData, DeleteApiV1TopicsByIdResponses, DeleteApiV1UsersByIdData, DeleteApiV1UsersByIdResponses, DeleteApiV1UsersByIdRolesData, DeleteApiV1UsersByIdRolesResponses, GetApiV1AgentGroupsByIdData, GetApiV1AgentGroupsByIdResponses, GetApiV1AgentGroupsData, GetApiV1AgentGroupsResponses, GetApiV1AgentsByIdData, GetApiV1AgentsByIdResponses, GetApiV1AgentsData, GetApiV1AgentsResponses, GetApiV1FilesByIdChunksData, GetApiV1FilesByIdChunksResponses, GetApiV1FilesByIdData, GetApiV1FilesByIdResponses, GetApiV1FilesByIdUrlData, GetApiV1FilesByIdUrlResponses, GetApiV1FilesData, GetApiV1FilesResponses, GetApiV1HealthData, GetApiV1HealthResponses, GetApiV1KnowledgeBasesByIdData, GetApiV1KnowledgeBasesByIdFilesData, GetApiV1KnowledgeBasesByIdFilesResponses, GetApiV1KnowledgeBasesByIdResponses, GetApiV1KnowledgeBasesData, GetApiV1KnowledgeBasesResponses, GetApiV1MessageTranslationsByMessageIdData, GetApiV1MessageTranslationsByMessageIdResponses, GetApiV1MessagesByIdData, GetApiV1MessagesByIdResponses, GetApiV1MessagesCountData, GetApiV1MessagesCountResponses, GetApiV1MessagesData, GetApiV1MessagesResponses, GetApiV1ModelsByProviderIdByModelIdData, GetApiV1ModelsByProviderIdByModelIdResponses, GetApiV1ModelsData, GetApiV1ModelsResponses, GetApiV1PermissionsByIdData, GetApiV1PermissionsByIdResponses, GetApiV1PermissionsData, GetApiV1PermissionsResponses, GetApiV1ProvidersByIdData, GetApiV1ProvidersByIdResponses, GetApiV1ProvidersData, GetApiV1ProvidersResponses, GetApiV1RolesByIdData, GetApiV1RolesByIdPermissionsData, GetApiV1RolesByIdPermissionsResponses, GetApiV1RolesByIdResponses, GetApiV1RolesData, GetApiV1RolesResponses, GetApiV1TopicsByIdData, GetApiV1TopicsByIdResponses, GetApiV1TopicsData, GetApiV1TopicsResponses, GetApiV1UsersByIdData, GetApiV1UsersByIdResponses, GetApiV1UsersByIdRolesData, GetApiV1UsersByIdRolesResponses, GetApiV1UsersData, GetApiV1UsersMeData, GetApiV1UsersMeResponses, GetApiV1UsersResponses, LobeHub, LobeHubOptions, PatchApiV1AgentGroupsByIdData, PatchApiV1AgentGroupsByIdResponses, PatchApiV1AgentsByIdData, PatchApiV1AgentsByIdResponses, PatchApiV1FilesByIdData, PatchApiV1FilesByIdResponses, PatchApiV1KnowledgeBasesByIdData, PatchApiV1KnowledgeBasesByIdResponses, PatchApiV1MessageTranslationsByMessageIdData, PatchApiV1MessageTranslationsByMessageIdResponses, PatchApiV1ModelsByProviderIdByModelIdData, PatchApiV1ModelsByProviderIdByModelIdResponses, PatchApiV1PermissionsByIdData, PatchApiV1PermissionsByIdResponses, PatchApiV1ProvidersByIdData, PatchApiV1ProvidersByIdResponses, PatchApiV1RolesByIdData, PatchApiV1RolesByIdPermissionsData, PatchApiV1RolesByIdPermissionsResponses, PatchApiV1RolesByIdResponses, PatchApiV1TopicsByIdData, PatchApiV1TopicsByIdResponses, PatchApiV1UsersByIdData, PatchApiV1UsersByIdResponses, PatchApiV1UsersByIdRolesData, PatchApiV1UsersByIdRolesResponses, PostApiV1AgentGroupsData, PostApiV1AgentGroupsResponses, PostApiV1AgentsData, PostApiV1AgentsResponses, PostApiV1FilesBatchesData, PostApiV1FilesBatchesResponses, PostApiV1FilesByIdChunksData, PostApiV1FilesByIdChunksResponses, PostApiV1FilesByIdParsesData, PostApiV1FilesByIdParsesResponses, PostApiV1FilesData, PostApiV1FilesQueriesData, PostApiV1FilesQueriesResponses, PostApiV1FilesResponses, PostApiV1KnowledgeBasesByIdFilesBatchData, PostApiV1KnowledgeBasesByIdFilesBatchResponses, PostApiV1KnowledgeBasesByIdFilesMoveData, PostApiV1KnowledgeBasesByIdFilesMoveResponses, PostApiV1KnowledgeBasesData, PostApiV1KnowledgeBasesResponses, PostApiV1MessageTranslationsByMessageIdData, PostApiV1MessageTranslationsByMessageIdResponses, PostApiV1MessagesData, PostApiV1MessagesRepliesData, PostApiV1MessagesRepliesResponses, PostApiV1MessagesResponses, PostApiV1ModelsData, PostApiV1ModelsResponses, PostApiV1PermissionsData, PostApiV1PermissionsResponses, PostApiV1ProvidersData, PostApiV1ProvidersResponses, PostApiV1ResponsesData, PostApiV1ResponsesResponses, PostApiV1RolesData, PostApiV1RolesResponses, PostApiV1TopicsData, PostApiV1TopicsResponses, PostApiV1UsersData, PostApiV1UsersResponses, createLobeHub };
|