@engini/client 0.0.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +1115 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3026 -0
- package/dist/index.d.ts +3026 -0
- package/dist/index.js +1074 -0
- package/dist/index.js.map +1 -0
- package/package.json +44 -6
- package/README.md +0 -4
- package/index.js +0 -1
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3026 @@
|
|
|
1
|
+
type AuthToken = string | undefined;
|
|
2
|
+
interface Auth {
|
|
3
|
+
/**
|
|
4
|
+
* Which part of the request do we use to send the auth?
|
|
5
|
+
*
|
|
6
|
+
* @default 'header'
|
|
7
|
+
*/
|
|
8
|
+
in?: 'header' | 'query' | 'cookie';
|
|
9
|
+
/**
|
|
10
|
+
* A unique identifier for the security scheme.
|
|
11
|
+
*
|
|
12
|
+
* Defined only when there are multiple security schemes whose `Auth`
|
|
13
|
+
* shape would otherwise be identical.
|
|
14
|
+
*/
|
|
15
|
+
key?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Header or query parameter name.
|
|
18
|
+
*
|
|
19
|
+
* @default 'Authorization'
|
|
20
|
+
*/
|
|
21
|
+
name?: string;
|
|
22
|
+
scheme?: 'basic' | 'bearer';
|
|
23
|
+
type: 'apiKey' | 'http';
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
interface SerializerOptions<T> {
|
|
27
|
+
/**
|
|
28
|
+
* @default true
|
|
29
|
+
*/
|
|
30
|
+
explode: boolean;
|
|
31
|
+
style: T;
|
|
32
|
+
}
|
|
33
|
+
type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
|
|
34
|
+
type ObjectStyle = 'form' | 'deepObject';
|
|
35
|
+
|
|
36
|
+
type QuerySerializer = (query: Record<string, unknown>) => string;
|
|
37
|
+
type BodySerializer = (body: unknown) => unknown;
|
|
38
|
+
type QuerySerializerOptionsObject = {
|
|
39
|
+
allowReserved?: boolean;
|
|
40
|
+
array?: Partial<SerializerOptions<ArrayStyle>>;
|
|
41
|
+
object?: Partial<SerializerOptions<ObjectStyle>>;
|
|
42
|
+
};
|
|
43
|
+
type QuerySerializerOptions = QuerySerializerOptionsObject & {
|
|
44
|
+
/**
|
|
45
|
+
* Per-parameter serialization overrides. When provided, these settings
|
|
46
|
+
* override the global array/object settings for specific parameter names.
|
|
47
|
+
*/
|
|
48
|
+
parameters?: Record<string, QuerySerializerOptionsObject>;
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
|
|
52
|
+
type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
|
|
53
|
+
/**
|
|
54
|
+
* Returns the final request URL.
|
|
55
|
+
*/
|
|
56
|
+
buildUrl: BuildUrlFn;
|
|
57
|
+
getConfig: () => Config;
|
|
58
|
+
request: RequestFn;
|
|
59
|
+
setConfig: (config: Config) => Config;
|
|
60
|
+
} & {
|
|
61
|
+
[K in HttpMethod]: MethodFn;
|
|
62
|
+
} & ([SseFn] extends [never] ? {
|
|
63
|
+
sse?: never;
|
|
64
|
+
} : {
|
|
65
|
+
sse: {
|
|
66
|
+
[K in HttpMethod]: SseFn;
|
|
67
|
+
};
|
|
68
|
+
});
|
|
69
|
+
interface Config$1 {
|
|
70
|
+
/**
|
|
71
|
+
* Auth token or a function returning auth token. The resolved value will be
|
|
72
|
+
* added to the request payload as defined by its `security` array.
|
|
73
|
+
*/
|
|
74
|
+
auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
|
|
75
|
+
/**
|
|
76
|
+
* A function for serializing request body parameter. By default,
|
|
77
|
+
* {@link JSON.stringify()} will be used.
|
|
78
|
+
*/
|
|
79
|
+
bodySerializer?: BodySerializer | null;
|
|
80
|
+
/**
|
|
81
|
+
* An object containing any HTTP headers that you want to pre-populate your
|
|
82
|
+
* `Headers` object with.
|
|
83
|
+
*
|
|
84
|
+
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
|
85
|
+
*/
|
|
86
|
+
headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
|
|
87
|
+
/**
|
|
88
|
+
* The request method.
|
|
89
|
+
*
|
|
90
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
|
|
91
|
+
*/
|
|
92
|
+
method?: Uppercase<HttpMethod>;
|
|
93
|
+
/**
|
|
94
|
+
* A function for serializing request query parameters. By default, arrays
|
|
95
|
+
* will be exploded in form style, objects will be exploded in deepObject
|
|
96
|
+
* style, and reserved characters are percent-encoded.
|
|
97
|
+
*
|
|
98
|
+
* This method will have no effect if the native `paramsSerializer()` Axios
|
|
99
|
+
* API function is used.
|
|
100
|
+
*
|
|
101
|
+
* {@link https://swagger.io/docs/specification/serialization/#query View examples}
|
|
102
|
+
*/
|
|
103
|
+
querySerializer?: QuerySerializer | QuerySerializerOptions;
|
|
104
|
+
/**
|
|
105
|
+
* A function validating request data. This is useful if you want to ensure
|
|
106
|
+
* the request conforms to the desired shape, so it can be safely sent to
|
|
107
|
+
* the server.
|
|
108
|
+
*/
|
|
109
|
+
requestValidator?: (data: unknown) => Promise<unknown>;
|
|
110
|
+
/**
|
|
111
|
+
* A function transforming response data before it's returned. This is useful
|
|
112
|
+
* for post-processing data, e.g., converting ISO strings into Date objects.
|
|
113
|
+
*/
|
|
114
|
+
responseTransformer?: (data: unknown) => Promise<unknown>;
|
|
115
|
+
/**
|
|
116
|
+
* A function validating response data. This is useful if you want to ensure
|
|
117
|
+
* the response conforms to the desired shape, so it can be safely passed to
|
|
118
|
+
* the transformers and returned to the user.
|
|
119
|
+
*/
|
|
120
|
+
responseValidator?: (data: unknown) => Promise<unknown>;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
|
|
124
|
+
/**
|
|
125
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
126
|
+
* fetch instance.
|
|
127
|
+
*
|
|
128
|
+
* @default globalThis.fetch
|
|
129
|
+
*/
|
|
130
|
+
fetch?: typeof fetch;
|
|
131
|
+
/**
|
|
132
|
+
* Implementing clients can call request interceptors inside this hook.
|
|
133
|
+
*/
|
|
134
|
+
onRequest?: (url: string, init: RequestInit) => Promise<Request>;
|
|
135
|
+
/**
|
|
136
|
+
* Callback invoked when a network or parsing error occurs during streaming.
|
|
137
|
+
*
|
|
138
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
139
|
+
*
|
|
140
|
+
* @param error The error that occurred.
|
|
141
|
+
*/
|
|
142
|
+
onSseError?: (error: unknown) => void;
|
|
143
|
+
/**
|
|
144
|
+
* Callback invoked when an event is streamed from the server.
|
|
145
|
+
*
|
|
146
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
147
|
+
*
|
|
148
|
+
* @param event Event streamed from the server.
|
|
149
|
+
* @returns Nothing (void).
|
|
150
|
+
*/
|
|
151
|
+
onSseEvent?: (event: StreamEvent<TData>) => void;
|
|
152
|
+
serializedBody?: RequestInit['body'];
|
|
153
|
+
/**
|
|
154
|
+
* Default retry delay in milliseconds.
|
|
155
|
+
*
|
|
156
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
157
|
+
*
|
|
158
|
+
* @default 3000
|
|
159
|
+
*/
|
|
160
|
+
sseDefaultRetryDelay?: number;
|
|
161
|
+
/**
|
|
162
|
+
* Maximum number of retry attempts before giving up.
|
|
163
|
+
*/
|
|
164
|
+
sseMaxRetryAttempts?: number;
|
|
165
|
+
/**
|
|
166
|
+
* Maximum retry delay in milliseconds.
|
|
167
|
+
*
|
|
168
|
+
* Applies only when exponential backoff is used.
|
|
169
|
+
*
|
|
170
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
171
|
+
*
|
|
172
|
+
* @default 30000
|
|
173
|
+
*/
|
|
174
|
+
sseMaxRetryDelay?: number;
|
|
175
|
+
/**
|
|
176
|
+
* Optional sleep function for retry backoff.
|
|
177
|
+
*
|
|
178
|
+
* Defaults to using `setTimeout`.
|
|
179
|
+
*/
|
|
180
|
+
sseSleepFn?: (ms: number) => Promise<void>;
|
|
181
|
+
url: string;
|
|
182
|
+
};
|
|
183
|
+
interface StreamEvent<TData = unknown> {
|
|
184
|
+
data: TData;
|
|
185
|
+
event?: string;
|
|
186
|
+
id?: string;
|
|
187
|
+
retry?: number;
|
|
188
|
+
}
|
|
189
|
+
type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
|
|
190
|
+
stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
|
|
191
|
+
};
|
|
192
|
+
|
|
193
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
|
|
194
|
+
/** response may be undefined due to a network error where no response object is produced */
|
|
195
|
+
response: Res | undefined,
|
|
196
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
197
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
198
|
+
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
199
|
+
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
200
|
+
declare class Interceptors<Interceptor> {
|
|
201
|
+
fns: Array<Interceptor | null>;
|
|
202
|
+
clear(): void;
|
|
203
|
+
eject(id: number | Interceptor): void;
|
|
204
|
+
exists(id: number | Interceptor): boolean;
|
|
205
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
206
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
207
|
+
use(fn: Interceptor): number;
|
|
208
|
+
}
|
|
209
|
+
interface Middleware<Req, Res, Err, Options> {
|
|
210
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
211
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
212
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
type ResponseStyle = 'data' | 'fields';
|
|
216
|
+
interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
|
|
217
|
+
/**
|
|
218
|
+
* Base URL for all requests made by this client.
|
|
219
|
+
*/
|
|
220
|
+
baseUrl?: T['baseUrl'];
|
|
221
|
+
/**
|
|
222
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
223
|
+
* fetch instance.
|
|
224
|
+
*
|
|
225
|
+
* @default globalThis.fetch
|
|
226
|
+
*/
|
|
227
|
+
fetch?: typeof fetch;
|
|
228
|
+
/**
|
|
229
|
+
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
230
|
+
* options won't have any effect.
|
|
231
|
+
*
|
|
232
|
+
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
233
|
+
*/
|
|
234
|
+
next?: never;
|
|
235
|
+
/**
|
|
236
|
+
* Return the response data parsed in a specified format. By default, `auto`
|
|
237
|
+
* will infer the appropriate method from the `Content-Type` response header.
|
|
238
|
+
* You can override this behavior with any of the {@link Body} methods.
|
|
239
|
+
* Select `stream` if you don't want to parse response data at all.
|
|
240
|
+
*
|
|
241
|
+
* @default 'auto'
|
|
242
|
+
*/
|
|
243
|
+
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
244
|
+
/**
|
|
245
|
+
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
246
|
+
*
|
|
247
|
+
* @default 'fields'
|
|
248
|
+
*/
|
|
249
|
+
responseStyle?: ResponseStyle;
|
|
250
|
+
/**
|
|
251
|
+
* Throw an error instead of returning it in the response?
|
|
252
|
+
*
|
|
253
|
+
* @default false
|
|
254
|
+
*/
|
|
255
|
+
throwOnError?: T['throwOnError'];
|
|
256
|
+
}
|
|
257
|
+
interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
258
|
+
responseStyle: TResponseStyle;
|
|
259
|
+
throwOnError: ThrowOnError;
|
|
260
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
261
|
+
/**
|
|
262
|
+
* Any body that you want to add to your request.
|
|
263
|
+
*
|
|
264
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
265
|
+
*/
|
|
266
|
+
body?: unknown;
|
|
267
|
+
path?: Record<string, unknown>;
|
|
268
|
+
query?: Record<string, unknown>;
|
|
269
|
+
/**
|
|
270
|
+
* Security mechanism(s) to use for the request.
|
|
271
|
+
*/
|
|
272
|
+
security?: ReadonlyArray<Auth>;
|
|
273
|
+
url: Url;
|
|
274
|
+
}
|
|
275
|
+
interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
276
|
+
headers: Headers;
|
|
277
|
+
serializedBody?: string;
|
|
278
|
+
}
|
|
279
|
+
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 : {
|
|
280
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
281
|
+
request: Request;
|
|
282
|
+
response: Response;
|
|
283
|
+
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
284
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
285
|
+
error: undefined;
|
|
286
|
+
} | {
|
|
287
|
+
data: undefined;
|
|
288
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
289
|
+
}) & {
|
|
290
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
291
|
+
request?: Request;
|
|
292
|
+
/** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
293
|
+
response?: Response;
|
|
294
|
+
}>;
|
|
295
|
+
interface ClientOptions$1 {
|
|
296
|
+
baseUrl?: string;
|
|
297
|
+
responseStyle?: ResponseStyle;
|
|
298
|
+
throwOnError?: boolean;
|
|
299
|
+
}
|
|
300
|
+
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>;
|
|
301
|
+
type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
|
|
302
|
+
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>;
|
|
303
|
+
type BuildUrlFn = <TData extends {
|
|
304
|
+
body?: unknown;
|
|
305
|
+
path?: Record<string, unknown>;
|
|
306
|
+
query?: Record<string, unknown>;
|
|
307
|
+
url: string;
|
|
308
|
+
}>(options: TData & Options$1<TData>) => string;
|
|
309
|
+
type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
310
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
311
|
+
};
|
|
312
|
+
interface TDataShape {
|
|
313
|
+
body?: unknown;
|
|
314
|
+
headers?: unknown;
|
|
315
|
+
path?: unknown;
|
|
316
|
+
query?: unknown;
|
|
317
|
+
url: string;
|
|
318
|
+
}
|
|
319
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
320
|
+
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'>);
|
|
321
|
+
|
|
322
|
+
type ClientOptions = {
|
|
323
|
+
baseUrl: 'https://feat-public-api.staging.engini.io/api' | (string & {});
|
|
324
|
+
};
|
|
325
|
+
type SolutionAdminWriteResponse = {
|
|
326
|
+
solution: SolutionDetailResponse;
|
|
327
|
+
warnings: Array<string>;
|
|
328
|
+
};
|
|
329
|
+
type SolutionDetailResponse = {
|
|
330
|
+
solutionId: number;
|
|
331
|
+
slug: string;
|
|
332
|
+
name: string;
|
|
333
|
+
description?: string | null;
|
|
334
|
+
iconUrl?: string | null;
|
|
335
|
+
status: string;
|
|
336
|
+
manifestVersion: number;
|
|
337
|
+
installCount: number;
|
|
338
|
+
createdDate: string;
|
|
339
|
+
updatedDate?: string | null;
|
|
340
|
+
manifest: string;
|
|
341
|
+
};
|
|
342
|
+
type ErrorResponse = {
|
|
343
|
+
errorCode: string;
|
|
344
|
+
message: string;
|
|
345
|
+
requestId: string;
|
|
346
|
+
timestamp: string;
|
|
347
|
+
path: string;
|
|
348
|
+
details?: Array<ErrorDetail> | null;
|
|
349
|
+
};
|
|
350
|
+
type ErrorDetail = {
|
|
351
|
+
field: string;
|
|
352
|
+
issue: string;
|
|
353
|
+
};
|
|
354
|
+
type CreateSolutionRequest = {
|
|
355
|
+
slug: string;
|
|
356
|
+
name: string;
|
|
357
|
+
description?: string | null;
|
|
358
|
+
iconUrl?: string | null;
|
|
359
|
+
buildManifest: SolutionManifestBuildSpec;
|
|
360
|
+
};
|
|
361
|
+
type SolutionManifestBuildSpec = {
|
|
362
|
+
workflows: Array<BuildManifestWorkflow>;
|
|
363
|
+
tables: Array<BuildManifestTable>;
|
|
364
|
+
connections: Array<ManifestConnection>;
|
|
365
|
+
version?: string | null;
|
|
366
|
+
};
|
|
367
|
+
type BuildManifestWorkflow = {
|
|
368
|
+
workflowId: number;
|
|
369
|
+
key: string;
|
|
370
|
+
name?: string | null;
|
|
371
|
+
isWebhookEntrypoint: boolean;
|
|
372
|
+
};
|
|
373
|
+
type BuildManifestTable = {
|
|
374
|
+
tableId: string;
|
|
375
|
+
key: string;
|
|
376
|
+
};
|
|
377
|
+
type ManifestConnection = {
|
|
378
|
+
key: string;
|
|
379
|
+
applicationId: number;
|
|
380
|
+
label?: string | null;
|
|
381
|
+
required: boolean;
|
|
382
|
+
requiresUserToken: boolean;
|
|
383
|
+
defaultConfig?: ManifestConnectionDefaults | null;
|
|
384
|
+
};
|
|
385
|
+
type ManifestConnectionDefaults = {
|
|
386
|
+
baseUrl?: string | null;
|
|
387
|
+
};
|
|
388
|
+
type UpdateSolutionRequest = {
|
|
389
|
+
name?: string | null;
|
|
390
|
+
description?: string | null;
|
|
391
|
+
iconUrl?: string | null;
|
|
392
|
+
buildManifest?: SolutionManifestBuildSpec | null;
|
|
393
|
+
};
|
|
394
|
+
type BuildManifestResponse = {
|
|
395
|
+
manifest: SolutionManifest;
|
|
396
|
+
warnings: Array<string>;
|
|
397
|
+
solution?: SolutionDetailResponse | null;
|
|
398
|
+
};
|
|
399
|
+
type SolutionManifest = {
|
|
400
|
+
version: string;
|
|
401
|
+
connections?: Array<ManifestConnection> | null;
|
|
402
|
+
tables?: Array<ManifestTable> | null;
|
|
403
|
+
workflows?: Array<ManifestWorkflow> | null;
|
|
404
|
+
};
|
|
405
|
+
type ManifestTable = {
|
|
406
|
+
key: string;
|
|
407
|
+
definition: TableDefinitionDto;
|
|
408
|
+
};
|
|
409
|
+
type TableDefinitionDto = {
|
|
410
|
+
name: string;
|
|
411
|
+
description?: string | null;
|
|
412
|
+
fields: Array<TableFieldDto>;
|
|
413
|
+
};
|
|
414
|
+
type TableFieldDto = {
|
|
415
|
+
fieldName: string;
|
|
416
|
+
fieldTypeId: number;
|
|
417
|
+
displayName?: string | null;
|
|
418
|
+
defaultValue?: string | null;
|
|
419
|
+
fieldOrder: number;
|
|
420
|
+
isPrimaryKey: boolean;
|
|
421
|
+
isMandatory: boolean;
|
|
422
|
+
isHidden: boolean;
|
|
423
|
+
isMultiSelect: boolean;
|
|
424
|
+
picklistJson?: string | null;
|
|
425
|
+
databaseFieldName?: string | null;
|
|
426
|
+
databaseFieldLocationTable?: string | null;
|
|
427
|
+
};
|
|
428
|
+
type ManifestWorkflow = {
|
|
429
|
+
key: string;
|
|
430
|
+
name?: string | null;
|
|
431
|
+
definition?: unknown;
|
|
432
|
+
connectionMapping?: {
|
|
433
|
+
[key: string]: string;
|
|
434
|
+
} | null;
|
|
435
|
+
isWebhookEntrypoint: boolean;
|
|
436
|
+
};
|
|
437
|
+
type BuildManifestRequest = {
|
|
438
|
+
workflows: Array<BuildManifestWorkflow>;
|
|
439
|
+
tables: Array<BuildManifestTable>;
|
|
440
|
+
connections: Array<ManifestConnection>;
|
|
441
|
+
version?: string | null;
|
|
442
|
+
slug?: string | null;
|
|
443
|
+
};
|
|
444
|
+
type PaginatedResponseOfSolutionResponse = {
|
|
445
|
+
items: Array<SolutionResponse>;
|
|
446
|
+
totalCount: number;
|
|
447
|
+
offset: number;
|
|
448
|
+
top: number;
|
|
449
|
+
};
|
|
450
|
+
type SolutionResponse = {
|
|
451
|
+
solutionId: number;
|
|
452
|
+
slug: string;
|
|
453
|
+
name: string;
|
|
454
|
+
description?: string | null;
|
|
455
|
+
iconUrl?: string | null;
|
|
456
|
+
status: string;
|
|
457
|
+
manifestVersion: number;
|
|
458
|
+
installCount: number;
|
|
459
|
+
createdDate: string;
|
|
460
|
+
updatedDate?: string | null;
|
|
461
|
+
};
|
|
462
|
+
type SolutionInstallationResponse = {
|
|
463
|
+
solutionInstallationId: number;
|
|
464
|
+
solutionId: number;
|
|
465
|
+
solutionName?: string | null;
|
|
466
|
+
slug?: string | null;
|
|
467
|
+
workspaceId: string;
|
|
468
|
+
environmentId: string;
|
|
469
|
+
installedManifestVersion: number;
|
|
470
|
+
autoUpdate: boolean;
|
|
471
|
+
updateAvailable: boolean;
|
|
472
|
+
status: string;
|
|
473
|
+
installedDate: string;
|
|
474
|
+
};
|
|
475
|
+
type InstallationDetailResponse = {
|
|
476
|
+
solutionInstallationId: number;
|
|
477
|
+
solutionId: number;
|
|
478
|
+
solutionName?: string | null;
|
|
479
|
+
slug?: string | null;
|
|
480
|
+
workspaceId: string;
|
|
481
|
+
environmentId: string;
|
|
482
|
+
installedManifestVersion: number;
|
|
483
|
+
autoUpdate: boolean;
|
|
484
|
+
updateAvailable: boolean;
|
|
485
|
+
status: string;
|
|
486
|
+
installedDate: string;
|
|
487
|
+
installedResources: Array<InstalledResourceResponse>;
|
|
488
|
+
};
|
|
489
|
+
type InstalledResourceResponse = {
|
|
490
|
+
installedResourceId: number;
|
|
491
|
+
resourceType: string;
|
|
492
|
+
resourceKey: string;
|
|
493
|
+
resourceId: string;
|
|
494
|
+
metadata?: string | null;
|
|
495
|
+
webhookUrl?: string | null;
|
|
496
|
+
};
|
|
497
|
+
type InstallSolutionResponse = {
|
|
498
|
+
installationId: number;
|
|
499
|
+
resources: Array<ProvisionedResourceInfo>;
|
|
500
|
+
};
|
|
501
|
+
type ProvisionedResourceInfo = {
|
|
502
|
+
resourceType: string;
|
|
503
|
+
resourceKey: string;
|
|
504
|
+
resourceId: string;
|
|
505
|
+
webhookUrl?: string | null;
|
|
506
|
+
webhookToken?: string | null;
|
|
507
|
+
};
|
|
508
|
+
type InstallSolutionRequest = {
|
|
509
|
+
workspaceId: string;
|
|
510
|
+
environmentId: string;
|
|
511
|
+
existingConnections?: {
|
|
512
|
+
[key: string]: number;
|
|
513
|
+
} | null;
|
|
514
|
+
connectionMapping?: {
|
|
515
|
+
[key: string]: ConnectionInput;
|
|
516
|
+
} | null;
|
|
517
|
+
autoUpdate: boolean;
|
|
518
|
+
externalContext?: string | null;
|
|
519
|
+
};
|
|
520
|
+
type ConnectionInput = {
|
|
521
|
+
apiKey?: string | null;
|
|
522
|
+
baseUrl?: string | null;
|
|
523
|
+
customKeys?: {
|
|
524
|
+
[key: string]: string;
|
|
525
|
+
} | null;
|
|
526
|
+
};
|
|
527
|
+
type UpdateInstallationResponse = {
|
|
528
|
+
installationId: number;
|
|
529
|
+
fromVersion: number;
|
|
530
|
+
toVersion: number;
|
|
531
|
+
resources: Array<ProvisionedResourceInfo>;
|
|
532
|
+
brokenWebhookUrls: Array<string>;
|
|
533
|
+
};
|
|
534
|
+
type UpdateBlockedResponse = {
|
|
535
|
+
blockers: Array<UpdateBlocker>;
|
|
536
|
+
};
|
|
537
|
+
type UpdateBlocker = {
|
|
538
|
+
type: string;
|
|
539
|
+
key: string;
|
|
540
|
+
reason: string;
|
|
541
|
+
};
|
|
542
|
+
type UpdateInstallationRequest = {
|
|
543
|
+
forceModify: boolean;
|
|
544
|
+
};
|
|
545
|
+
type UninstallSolutionRequest = {
|
|
546
|
+
installationId: number;
|
|
547
|
+
deleteConnections: boolean;
|
|
548
|
+
deleteWorkflows: boolean;
|
|
549
|
+
deleteTables: boolean;
|
|
550
|
+
};
|
|
551
|
+
type PaginatedResponseOfApplicationDto = {
|
|
552
|
+
items: Array<ApplicationDto>;
|
|
553
|
+
totalCount: number;
|
|
554
|
+
offset: number;
|
|
555
|
+
top: number;
|
|
556
|
+
};
|
|
557
|
+
type ApplicationDto = {
|
|
558
|
+
slug: string;
|
|
559
|
+
applicationName?: string | null;
|
|
560
|
+
description: string;
|
|
561
|
+
applicationLogo?: string | null;
|
|
562
|
+
connectionRequirement: string;
|
|
563
|
+
categories: Array<string>;
|
|
564
|
+
toolsCount: number;
|
|
565
|
+
triggersCount: number;
|
|
566
|
+
};
|
|
567
|
+
type ApplicationDetailDto = ApplicationDto & {
|
|
568
|
+
supportsObjectSelection?: boolean;
|
|
569
|
+
helpUrl?: string | null;
|
|
570
|
+
authenticationMethods?: Array<ApplicationAuthMethod>;
|
|
571
|
+
};
|
|
572
|
+
type ApplicationAuthMethod = {
|
|
573
|
+
authenticationId: number;
|
|
574
|
+
authenticationType: string;
|
|
575
|
+
authenticationName: string;
|
|
576
|
+
description?: string | null;
|
|
577
|
+
connectionFields: Array<ApplicationConnectionField>;
|
|
578
|
+
requiresOAuthSignIn: boolean;
|
|
579
|
+
oAuthProvider?: string | null;
|
|
580
|
+
};
|
|
581
|
+
type ApplicationConnectionField = {
|
|
582
|
+
fieldName: string;
|
|
583
|
+
fieldDescription?: string | null;
|
|
584
|
+
isRequired: boolean;
|
|
585
|
+
isRequiredOnSignin: boolean;
|
|
586
|
+
isHidden: boolean;
|
|
587
|
+
isPassword: boolean;
|
|
588
|
+
inputType: AppConnectionFieldInputType;
|
|
589
|
+
defaultValue?: string | null;
|
|
590
|
+
tooltip?: string | null;
|
|
591
|
+
placeholder?: string | null;
|
|
592
|
+
listValues?: string | null;
|
|
593
|
+
allowOverride: boolean;
|
|
594
|
+
};
|
|
595
|
+
type AppConnectionFieldInputType = 0 | 1 | 2 | 3;
|
|
596
|
+
type PaginatedResponseOfConnectionPublicListItem = {
|
|
597
|
+
items: Array<ConnectionPublicListItem>;
|
|
598
|
+
totalCount: number;
|
|
599
|
+
offset: number;
|
|
600
|
+
top: number;
|
|
601
|
+
};
|
|
602
|
+
type ConnectionPublicListItem = {
|
|
603
|
+
connectionId: number;
|
|
604
|
+
connectionName: string;
|
|
605
|
+
description?: string | null;
|
|
606
|
+
applicationSlug: string;
|
|
607
|
+
applicationName?: string | null;
|
|
608
|
+
applicationLogo?: string | null;
|
|
609
|
+
isPublic: boolean;
|
|
610
|
+
createdBy: string;
|
|
611
|
+
createdDate: string;
|
|
612
|
+
updatedBy?: string | null;
|
|
613
|
+
updatedDate?: string | null;
|
|
614
|
+
};
|
|
615
|
+
type ConnectionPublicDetail = ConnectionPublicListItem & {
|
|
616
|
+
authenticationId?: number;
|
|
617
|
+
authenticationType?: string;
|
|
618
|
+
fields?: {
|
|
619
|
+
[key: string]: string | null;
|
|
620
|
+
};
|
|
621
|
+
useSelectDBObjects?: boolean;
|
|
622
|
+
connectionError?: string | null;
|
|
623
|
+
isAlive?: boolean;
|
|
624
|
+
metadata?: {
|
|
625
|
+
[key: string]: string;
|
|
626
|
+
} | null;
|
|
627
|
+
};
|
|
628
|
+
type CreateConnectionRequest = {
|
|
629
|
+
applicationSlug: string;
|
|
630
|
+
connectionName: string;
|
|
631
|
+
description?: string | null;
|
|
632
|
+
authenticationId: number;
|
|
633
|
+
fields: {
|
|
634
|
+
[key: string]: string;
|
|
635
|
+
};
|
|
636
|
+
metadata?: {
|
|
637
|
+
[key: string]: string;
|
|
638
|
+
} | null;
|
|
639
|
+
};
|
|
640
|
+
type UpdateConnectionRequest = {
|
|
641
|
+
connectionName?: string | null;
|
|
642
|
+
description?: string | null;
|
|
643
|
+
fields?: {
|
|
644
|
+
[key: string]: string;
|
|
645
|
+
} | null;
|
|
646
|
+
metadata?: {
|
|
647
|
+
[key: string]: string;
|
|
648
|
+
} | null;
|
|
649
|
+
};
|
|
650
|
+
type DefaultConnectionsResponse = {
|
|
651
|
+
items: Array<DefaultConnectionDto>;
|
|
652
|
+
};
|
|
653
|
+
type DefaultConnectionDto = {
|
|
654
|
+
applicationSlug: string;
|
|
655
|
+
applicationName?: string | null;
|
|
656
|
+
connectionId: number;
|
|
657
|
+
connectionName?: string | null;
|
|
658
|
+
};
|
|
659
|
+
type SetDefaultConnectionResponse = {
|
|
660
|
+
applicationSlug: string;
|
|
661
|
+
connectionId: number;
|
|
662
|
+
isDefault: boolean;
|
|
663
|
+
};
|
|
664
|
+
type ReplaceConnectionRequest = {
|
|
665
|
+
workflowId: number;
|
|
666
|
+
originalConnectionId: number;
|
|
667
|
+
newConnectionId: number;
|
|
668
|
+
};
|
|
669
|
+
type RefreshStatusResponse = {
|
|
670
|
+
status: RefreshStatus;
|
|
671
|
+
statusDescription?: string | null;
|
|
672
|
+
error?: string | null;
|
|
673
|
+
errorDate?: string | null;
|
|
674
|
+
lastRefreshDate?: string | null;
|
|
675
|
+
};
|
|
676
|
+
type RefreshStatus = 0 | 1 | 2;
|
|
677
|
+
type SelectObjectsRequest = {
|
|
678
|
+
objectIds: Array<number>;
|
|
679
|
+
};
|
|
680
|
+
type PaginatedResponseOfConnectionObject = {
|
|
681
|
+
items: Array<ConnectionObject>;
|
|
682
|
+
totalCount: number;
|
|
683
|
+
offset: number;
|
|
684
|
+
top: number;
|
|
685
|
+
};
|
|
686
|
+
type ConnectionObject = {
|
|
687
|
+
objectId: number;
|
|
688
|
+
name: string;
|
|
689
|
+
type: string;
|
|
690
|
+
isSelected: boolean;
|
|
691
|
+
};
|
|
692
|
+
type SignInUrlResponse = {
|
|
693
|
+
signInUrl: string;
|
|
694
|
+
state: string;
|
|
695
|
+
};
|
|
696
|
+
type SignInUrlRequest = {
|
|
697
|
+
applicationSlug: string;
|
|
698
|
+
authenticationId: number;
|
|
699
|
+
environment?: string | null;
|
|
700
|
+
fields?: {
|
|
701
|
+
[key: string]: string;
|
|
702
|
+
} | null;
|
|
703
|
+
};
|
|
704
|
+
type AccessTokenResponse = {
|
|
705
|
+
status: string;
|
|
706
|
+
error_message?: string | null;
|
|
707
|
+
tokenData: {
|
|
708
|
+
[key: string]: unknown;
|
|
709
|
+
};
|
|
710
|
+
connectionData: {
|
|
711
|
+
[key: string]: unknown;
|
|
712
|
+
};
|
|
713
|
+
};
|
|
714
|
+
type PaginatedResponseOfToolDto = {
|
|
715
|
+
items: Array<ToolDto>;
|
|
716
|
+
totalCount: number;
|
|
717
|
+
offset: number;
|
|
718
|
+
top: number;
|
|
719
|
+
};
|
|
720
|
+
type ToolDto = {
|
|
721
|
+
toolSlug: string;
|
|
722
|
+
toolName?: string | null;
|
|
723
|
+
description?: string | null;
|
|
724
|
+
category: string;
|
|
725
|
+
applicationSlug: string;
|
|
726
|
+
applicationName?: string | null;
|
|
727
|
+
version?: string | null;
|
|
728
|
+
isDeprecated: boolean;
|
|
729
|
+
};
|
|
730
|
+
type ToolDetailDto = ToolDto & {
|
|
731
|
+
inputSchema?: unknown;
|
|
732
|
+
outputSchema?: unknown;
|
|
733
|
+
supportsFilters?: boolean;
|
|
734
|
+
supportsSort?: boolean;
|
|
735
|
+
supportsTopOffset?: boolean;
|
|
736
|
+
maxFilters?: number;
|
|
737
|
+
maxSorts?: number;
|
|
738
|
+
};
|
|
739
|
+
type ToolExecuteResponse = {
|
|
740
|
+
isSuccess: boolean;
|
|
741
|
+
errorMessage?: string | null;
|
|
742
|
+
executionInfo?: ExecutionInfo | null;
|
|
743
|
+
output?: unknown;
|
|
744
|
+
historyId?: number | null;
|
|
745
|
+
};
|
|
746
|
+
type ExecutionInfo = {
|
|
747
|
+
statusCode?: number | null;
|
|
748
|
+
headers?: {
|
|
749
|
+
[key: string]: string;
|
|
750
|
+
} | null;
|
|
751
|
+
executionTime?: number | null;
|
|
752
|
+
dataSize?: number | null;
|
|
753
|
+
};
|
|
754
|
+
type ToolExecuteRequest = {
|
|
755
|
+
fields?: {
|
|
756
|
+
[key: string]: unknown;
|
|
757
|
+
} | null;
|
|
758
|
+
contextValue?: string | null;
|
|
759
|
+
filters?: Array<ActivityCondition> | null;
|
|
760
|
+
sort?: Array<ActivitySort> | null;
|
|
761
|
+
offset?: number | null;
|
|
762
|
+
top?: number | null;
|
|
763
|
+
subItems?: {
|
|
764
|
+
[key: string]: unknown;
|
|
765
|
+
} | null;
|
|
766
|
+
customConnectionData?: Array<CustomConnectionDataItem> | null;
|
|
767
|
+
};
|
|
768
|
+
type ActivityCondition = {
|
|
769
|
+
fieldName: string;
|
|
770
|
+
operator: string;
|
|
771
|
+
value: string;
|
|
772
|
+
};
|
|
773
|
+
type ActivitySort = {
|
|
774
|
+
fieldName: string;
|
|
775
|
+
orderDirection: OrderDirection;
|
|
776
|
+
};
|
|
777
|
+
type OrderDirection = 1 | -1;
|
|
778
|
+
type CustomConnectionDataItem = {
|
|
779
|
+
fieldName: string;
|
|
780
|
+
value: string;
|
|
781
|
+
};
|
|
782
|
+
type PaginatedResponseOfToolsetDto = {
|
|
783
|
+
items: Array<ToolsetDto>;
|
|
784
|
+
totalCount: number;
|
|
785
|
+
offset: number;
|
|
786
|
+
top: number;
|
|
787
|
+
};
|
|
788
|
+
type ToolsetDto = {
|
|
789
|
+
toolsetId: string;
|
|
790
|
+
name: string;
|
|
791
|
+
connections: Array<ToolsetConnectionDto>;
|
|
792
|
+
workflows: Array<string>;
|
|
793
|
+
createdDate: string;
|
|
794
|
+
updatedDate?: string | null;
|
|
795
|
+
createdByAccountUserId?: number | null;
|
|
796
|
+
updatedByAccountUserId?: number | null;
|
|
797
|
+
};
|
|
798
|
+
type ToolsetConnectionDto = {
|
|
799
|
+
connectionId: number;
|
|
800
|
+
applicationSlug: string;
|
|
801
|
+
applicationName?: string | null;
|
|
802
|
+
toolSlugs: Array<string>;
|
|
803
|
+
};
|
|
804
|
+
type CreateToolsetRequest = {
|
|
805
|
+
name: string;
|
|
806
|
+
connections: Array<ToolsetConnectionRequest>;
|
|
807
|
+
workflows?: Array<string> | null;
|
|
808
|
+
};
|
|
809
|
+
type ToolsetConnectionRequest = {
|
|
810
|
+
connectionId: number;
|
|
811
|
+
toolSlugs?: Array<string> | null;
|
|
812
|
+
};
|
|
813
|
+
type UpdateToolsetRequest = {
|
|
814
|
+
name?: string | null;
|
|
815
|
+
connections?: Array<ToolsetConnectionRequest> | null;
|
|
816
|
+
workflows?: Array<string> | null;
|
|
817
|
+
};
|
|
818
|
+
type SolutionsCreateSolutionData = {
|
|
819
|
+
/**
|
|
820
|
+
* The solution metadata and build manifest used to create the solution.
|
|
821
|
+
*/
|
|
822
|
+
body: CreateSolutionRequest;
|
|
823
|
+
headers?: {
|
|
824
|
+
/**
|
|
825
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
826
|
+
*/
|
|
827
|
+
companytoken?: string;
|
|
828
|
+
};
|
|
829
|
+
path?: never;
|
|
830
|
+
query?: never;
|
|
831
|
+
url: '/v1/solutions/admin';
|
|
832
|
+
};
|
|
833
|
+
type SolutionsCreateSolutionErrors = {
|
|
834
|
+
400: ErrorResponse;
|
|
835
|
+
/**
|
|
836
|
+
* Unauthorized — missing or invalid bearer token.
|
|
837
|
+
*/
|
|
838
|
+
401: ErrorResponse;
|
|
839
|
+
403: ErrorResponse;
|
|
840
|
+
/**
|
|
841
|
+
* Not found — the resource does not exist.
|
|
842
|
+
*/
|
|
843
|
+
404: ErrorResponse;
|
|
844
|
+
/**
|
|
845
|
+
* Too many requests — rate limit exceeded.
|
|
846
|
+
*/
|
|
847
|
+
429: ErrorResponse;
|
|
848
|
+
/**
|
|
849
|
+
* Internal server error — an unexpected error occurred.
|
|
850
|
+
*/
|
|
851
|
+
500: ErrorResponse;
|
|
852
|
+
};
|
|
853
|
+
type SolutionsCreateSolutionError = SolutionsCreateSolutionErrors[keyof SolutionsCreateSolutionErrors];
|
|
854
|
+
type SolutionsCreateSolutionResponses = {
|
|
855
|
+
/**
|
|
856
|
+
* The newly created solution along with any manifest build warnings.
|
|
857
|
+
*/
|
|
858
|
+
200: SolutionAdminWriteResponse;
|
|
859
|
+
};
|
|
860
|
+
type SolutionsCreateSolutionResponse = SolutionsCreateSolutionResponses[keyof SolutionsCreateSolutionResponses];
|
|
861
|
+
type SolutionsArchiveSolutionData = {
|
|
862
|
+
body?: never;
|
|
863
|
+
headers?: {
|
|
864
|
+
/**
|
|
865
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
866
|
+
*/
|
|
867
|
+
companytoken?: string;
|
|
868
|
+
};
|
|
869
|
+
path: {
|
|
870
|
+
/**
|
|
871
|
+
* The slug identifying the solution to archive.
|
|
872
|
+
*/
|
|
873
|
+
slug: string;
|
|
874
|
+
};
|
|
875
|
+
query?: never;
|
|
876
|
+
url: '/v1/solutions/admin/{slug}';
|
|
877
|
+
};
|
|
878
|
+
type SolutionsArchiveSolutionErrors = {
|
|
879
|
+
/**
|
|
880
|
+
* Bad request — malformed body or invalid parameters.
|
|
881
|
+
*/
|
|
882
|
+
400: ErrorResponse;
|
|
883
|
+
/**
|
|
884
|
+
* Unauthorized — missing or invalid bearer token.
|
|
885
|
+
*/
|
|
886
|
+
401: ErrorResponse;
|
|
887
|
+
403: ErrorResponse;
|
|
888
|
+
404: ErrorResponse;
|
|
889
|
+
/**
|
|
890
|
+
* Too many requests — rate limit exceeded.
|
|
891
|
+
*/
|
|
892
|
+
429: ErrorResponse;
|
|
893
|
+
/**
|
|
894
|
+
* Internal server error — an unexpected error occurred.
|
|
895
|
+
*/
|
|
896
|
+
500: ErrorResponse;
|
|
897
|
+
};
|
|
898
|
+
type SolutionsArchiveSolutionError = SolutionsArchiveSolutionErrors[keyof SolutionsArchiveSolutionErrors];
|
|
899
|
+
type SolutionsArchiveSolutionResponses = {
|
|
900
|
+
/**
|
|
901
|
+
* No content on success.
|
|
902
|
+
*/
|
|
903
|
+
204: void;
|
|
904
|
+
};
|
|
905
|
+
type SolutionsArchiveSolutionResponse = SolutionsArchiveSolutionResponses[keyof SolutionsArchiveSolutionResponses];
|
|
906
|
+
type SolutionsUpdateSolutionData = {
|
|
907
|
+
/**
|
|
908
|
+
* The updated solution metadata and optional build manifest.
|
|
909
|
+
*/
|
|
910
|
+
body: UpdateSolutionRequest;
|
|
911
|
+
headers?: {
|
|
912
|
+
/**
|
|
913
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
914
|
+
*/
|
|
915
|
+
companytoken?: string;
|
|
916
|
+
};
|
|
917
|
+
path: {
|
|
918
|
+
/**
|
|
919
|
+
* The slug identifying the solution to update.
|
|
920
|
+
*/
|
|
921
|
+
slug: string;
|
|
922
|
+
};
|
|
923
|
+
query?: never;
|
|
924
|
+
url: '/v1/solutions/admin/{slug}';
|
|
925
|
+
};
|
|
926
|
+
type SolutionsUpdateSolutionErrors = {
|
|
927
|
+
400: ErrorResponse;
|
|
928
|
+
/**
|
|
929
|
+
* Unauthorized — missing or invalid bearer token.
|
|
930
|
+
*/
|
|
931
|
+
401: ErrorResponse;
|
|
932
|
+
403: ErrorResponse;
|
|
933
|
+
404: ErrorResponse;
|
|
934
|
+
/**
|
|
935
|
+
* Too many requests — rate limit exceeded.
|
|
936
|
+
*/
|
|
937
|
+
429: ErrorResponse;
|
|
938
|
+
/**
|
|
939
|
+
* Internal server error — an unexpected error occurred.
|
|
940
|
+
*/
|
|
941
|
+
500: ErrorResponse;
|
|
942
|
+
};
|
|
943
|
+
type SolutionsUpdateSolutionError = SolutionsUpdateSolutionErrors[keyof SolutionsUpdateSolutionErrors];
|
|
944
|
+
type SolutionsUpdateSolutionResponses = {
|
|
945
|
+
/**
|
|
946
|
+
* The updated solution along with any manifest build warnings.
|
|
947
|
+
*/
|
|
948
|
+
200: SolutionAdminWriteResponse;
|
|
949
|
+
};
|
|
950
|
+
type SolutionsUpdateSolutionResponse = SolutionsUpdateSolutionResponses[keyof SolutionsUpdateSolutionResponses];
|
|
951
|
+
type SolutionsPublishSolutionData = {
|
|
952
|
+
body?: never;
|
|
953
|
+
headers?: {
|
|
954
|
+
/**
|
|
955
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
956
|
+
*/
|
|
957
|
+
companytoken?: string;
|
|
958
|
+
};
|
|
959
|
+
path: {
|
|
960
|
+
/**
|
|
961
|
+
* The slug identifying the solution to publish.
|
|
962
|
+
*/
|
|
963
|
+
slug: string;
|
|
964
|
+
};
|
|
965
|
+
query?: never;
|
|
966
|
+
url: '/v1/solutions/admin/{slug}/publish';
|
|
967
|
+
};
|
|
968
|
+
type SolutionsPublishSolutionErrors = {
|
|
969
|
+
400: ErrorResponse;
|
|
970
|
+
/**
|
|
971
|
+
* Unauthorized — missing or invalid bearer token.
|
|
972
|
+
*/
|
|
973
|
+
401: ErrorResponse;
|
|
974
|
+
403: ErrorResponse;
|
|
975
|
+
404: ErrorResponse;
|
|
976
|
+
/**
|
|
977
|
+
* Too many requests — rate limit exceeded.
|
|
978
|
+
*/
|
|
979
|
+
429: ErrorResponse;
|
|
980
|
+
/**
|
|
981
|
+
* Internal server error — an unexpected error occurred.
|
|
982
|
+
*/
|
|
983
|
+
500: ErrorResponse;
|
|
984
|
+
};
|
|
985
|
+
type SolutionsPublishSolutionError = SolutionsPublishSolutionErrors[keyof SolutionsPublishSolutionErrors];
|
|
986
|
+
type SolutionsPublishSolutionResponses = {
|
|
987
|
+
/**
|
|
988
|
+
* The published solution detail.
|
|
989
|
+
*/
|
|
990
|
+
200: SolutionDetailResponse;
|
|
991
|
+
};
|
|
992
|
+
type SolutionsPublishSolutionResponse = SolutionsPublishSolutionResponses[keyof SolutionsPublishSolutionResponses];
|
|
993
|
+
type SolutionsBuildManifestData = {
|
|
994
|
+
/**
|
|
995
|
+
* The manifest build inputs and an optional slug of an existing solution to update.
|
|
996
|
+
*/
|
|
997
|
+
body: BuildManifestRequest;
|
|
998
|
+
headers?: {
|
|
999
|
+
/**
|
|
1000
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1001
|
+
*/
|
|
1002
|
+
companytoken?: string;
|
|
1003
|
+
};
|
|
1004
|
+
path?: never;
|
|
1005
|
+
query?: never;
|
|
1006
|
+
url: '/v1/solutions/admin/build-manifest';
|
|
1007
|
+
};
|
|
1008
|
+
type SolutionsBuildManifestErrors = {
|
|
1009
|
+
400: ErrorResponse;
|
|
1010
|
+
/**
|
|
1011
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1012
|
+
*/
|
|
1013
|
+
401: ErrorResponse;
|
|
1014
|
+
403: ErrorResponse;
|
|
1015
|
+
404: ErrorResponse;
|
|
1016
|
+
/**
|
|
1017
|
+
* Too many requests — rate limit exceeded.
|
|
1018
|
+
*/
|
|
1019
|
+
429: ErrorResponse;
|
|
1020
|
+
/**
|
|
1021
|
+
* Internal server error — an unexpected error occurred.
|
|
1022
|
+
*/
|
|
1023
|
+
500: ErrorResponse;
|
|
1024
|
+
};
|
|
1025
|
+
type SolutionsBuildManifestError = SolutionsBuildManifestErrors[keyof SolutionsBuildManifestErrors];
|
|
1026
|
+
type SolutionsBuildManifestResponses = {
|
|
1027
|
+
/**
|
|
1028
|
+
* The built manifest with any warnings, plus the updated solution when a slug was supplied.
|
|
1029
|
+
*/
|
|
1030
|
+
200: BuildManifestResponse;
|
|
1031
|
+
};
|
|
1032
|
+
type SolutionsBuildManifestResponse = SolutionsBuildManifestResponses[keyof SolutionsBuildManifestResponses];
|
|
1033
|
+
type SolutionsGetPublishedSolutionsData = {
|
|
1034
|
+
body?: never;
|
|
1035
|
+
headers?: {
|
|
1036
|
+
/**
|
|
1037
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1038
|
+
*/
|
|
1039
|
+
companytoken?: string;
|
|
1040
|
+
};
|
|
1041
|
+
path?: never;
|
|
1042
|
+
query?: {
|
|
1043
|
+
Search?: string | null;
|
|
1044
|
+
Offset?: number;
|
|
1045
|
+
Top?: number;
|
|
1046
|
+
};
|
|
1047
|
+
url: '/v1/solutions';
|
|
1048
|
+
};
|
|
1049
|
+
type SolutionsGetPublishedSolutionsErrors = {
|
|
1050
|
+
/**
|
|
1051
|
+
* Bad request — malformed body or invalid parameters.
|
|
1052
|
+
*/
|
|
1053
|
+
400: ErrorResponse;
|
|
1054
|
+
/**
|
|
1055
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1056
|
+
*/
|
|
1057
|
+
401: ErrorResponse;
|
|
1058
|
+
/**
|
|
1059
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1060
|
+
*/
|
|
1061
|
+
403: ErrorResponse;
|
|
1062
|
+
/**
|
|
1063
|
+
* Not found — the resource does not exist.
|
|
1064
|
+
*/
|
|
1065
|
+
404: ErrorResponse;
|
|
1066
|
+
/**
|
|
1067
|
+
* Too many requests — rate limit exceeded.
|
|
1068
|
+
*/
|
|
1069
|
+
429: ErrorResponse;
|
|
1070
|
+
/**
|
|
1071
|
+
* Internal server error — an unexpected error occurred.
|
|
1072
|
+
*/
|
|
1073
|
+
500: ErrorResponse;
|
|
1074
|
+
};
|
|
1075
|
+
type SolutionsGetPublishedSolutionsError = SolutionsGetPublishedSolutionsErrors[keyof SolutionsGetPublishedSolutionsErrors];
|
|
1076
|
+
type SolutionsGetPublishedSolutionsResponses = {
|
|
1077
|
+
/**
|
|
1078
|
+
* A paginated collection of published solutions.
|
|
1079
|
+
*/
|
|
1080
|
+
200: PaginatedResponseOfSolutionResponse;
|
|
1081
|
+
};
|
|
1082
|
+
type SolutionsGetPublishedSolutionsResponse = SolutionsGetPublishedSolutionsResponses[keyof SolutionsGetPublishedSolutionsResponses];
|
|
1083
|
+
type SolutionsGetSolutionBySlugData = {
|
|
1084
|
+
body?: never;
|
|
1085
|
+
headers?: {
|
|
1086
|
+
/**
|
|
1087
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1088
|
+
*/
|
|
1089
|
+
companytoken?: string;
|
|
1090
|
+
};
|
|
1091
|
+
path: {
|
|
1092
|
+
/**
|
|
1093
|
+
* The slug identifying the solution to retrieve.
|
|
1094
|
+
*/
|
|
1095
|
+
slug: string;
|
|
1096
|
+
};
|
|
1097
|
+
query?: never;
|
|
1098
|
+
url: '/v1/solutions/{slug}';
|
|
1099
|
+
};
|
|
1100
|
+
type SolutionsGetSolutionBySlugErrors = {
|
|
1101
|
+
/**
|
|
1102
|
+
* Bad request — malformed body or invalid parameters.
|
|
1103
|
+
*/
|
|
1104
|
+
400: ErrorResponse;
|
|
1105
|
+
/**
|
|
1106
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1107
|
+
*/
|
|
1108
|
+
401: ErrorResponse;
|
|
1109
|
+
/**
|
|
1110
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1111
|
+
*/
|
|
1112
|
+
403: ErrorResponse;
|
|
1113
|
+
404: ErrorResponse;
|
|
1114
|
+
/**
|
|
1115
|
+
* Too many requests — rate limit exceeded.
|
|
1116
|
+
*/
|
|
1117
|
+
429: ErrorResponse;
|
|
1118
|
+
/**
|
|
1119
|
+
* Internal server error — an unexpected error occurred.
|
|
1120
|
+
*/
|
|
1121
|
+
500: ErrorResponse;
|
|
1122
|
+
};
|
|
1123
|
+
type SolutionsGetSolutionBySlugError = SolutionsGetSolutionBySlugErrors[keyof SolutionsGetSolutionBySlugErrors];
|
|
1124
|
+
type SolutionsGetSolutionBySlugResponses = {
|
|
1125
|
+
/**
|
|
1126
|
+
* The solution detail.
|
|
1127
|
+
*/
|
|
1128
|
+
200: SolutionDetailResponse;
|
|
1129
|
+
};
|
|
1130
|
+
type SolutionsGetSolutionBySlugResponse = SolutionsGetSolutionBySlugResponses[keyof SolutionsGetSolutionBySlugResponses];
|
|
1131
|
+
type SolutionsGetInstallationsData = {
|
|
1132
|
+
body?: never;
|
|
1133
|
+
headers?: {
|
|
1134
|
+
/**
|
|
1135
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1136
|
+
*/
|
|
1137
|
+
companytoken?: string;
|
|
1138
|
+
};
|
|
1139
|
+
path?: never;
|
|
1140
|
+
query?: {
|
|
1141
|
+
/**
|
|
1142
|
+
* Optional solution slug to filter the installations.
|
|
1143
|
+
*/
|
|
1144
|
+
slug?: string | null;
|
|
1145
|
+
/**
|
|
1146
|
+
* Optional installation status name to filter by; must be a valid InstallationStatus value.
|
|
1147
|
+
*/
|
|
1148
|
+
status?: string | null;
|
|
1149
|
+
};
|
|
1150
|
+
url: '/v1/solutions/installations';
|
|
1151
|
+
};
|
|
1152
|
+
type SolutionsGetInstallationsErrors = {
|
|
1153
|
+
400: ErrorResponse;
|
|
1154
|
+
/**
|
|
1155
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1156
|
+
*/
|
|
1157
|
+
401: ErrorResponse;
|
|
1158
|
+
/**
|
|
1159
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1160
|
+
*/
|
|
1161
|
+
403: ErrorResponse;
|
|
1162
|
+
/**
|
|
1163
|
+
* Not found — the resource does not exist.
|
|
1164
|
+
*/
|
|
1165
|
+
404: ErrorResponse;
|
|
1166
|
+
/**
|
|
1167
|
+
* Too many requests — rate limit exceeded.
|
|
1168
|
+
*/
|
|
1169
|
+
429: ErrorResponse;
|
|
1170
|
+
/**
|
|
1171
|
+
* Internal server error — an unexpected error occurred.
|
|
1172
|
+
*/
|
|
1173
|
+
500: ErrorResponse;
|
|
1174
|
+
};
|
|
1175
|
+
type SolutionsGetInstallationsError = SolutionsGetInstallationsErrors[keyof SolutionsGetInstallationsErrors];
|
|
1176
|
+
type SolutionsGetInstallationsResponses = {
|
|
1177
|
+
/**
|
|
1178
|
+
* The matching installations for the account.
|
|
1179
|
+
*/
|
|
1180
|
+
200: Array<SolutionInstallationResponse>;
|
|
1181
|
+
};
|
|
1182
|
+
type SolutionsGetInstallationsResponse = SolutionsGetInstallationsResponses[keyof SolutionsGetInstallationsResponses];
|
|
1183
|
+
type SolutionsGetInstallationDetailData = {
|
|
1184
|
+
body?: never;
|
|
1185
|
+
headers?: {
|
|
1186
|
+
/**
|
|
1187
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1188
|
+
*/
|
|
1189
|
+
companytoken?: string;
|
|
1190
|
+
};
|
|
1191
|
+
path: {
|
|
1192
|
+
/**
|
|
1193
|
+
* The identifier of the installation to retrieve.
|
|
1194
|
+
*/
|
|
1195
|
+
id: number;
|
|
1196
|
+
};
|
|
1197
|
+
query?: never;
|
|
1198
|
+
url: '/v1/solutions/installations/{id}';
|
|
1199
|
+
};
|
|
1200
|
+
type SolutionsGetInstallationDetailErrors = {
|
|
1201
|
+
400: ErrorResponse;
|
|
1202
|
+
/**
|
|
1203
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1204
|
+
*/
|
|
1205
|
+
401: ErrorResponse;
|
|
1206
|
+
/**
|
|
1207
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1208
|
+
*/
|
|
1209
|
+
403: ErrorResponse;
|
|
1210
|
+
404: ErrorResponse;
|
|
1211
|
+
/**
|
|
1212
|
+
* Too many requests — rate limit exceeded.
|
|
1213
|
+
*/
|
|
1214
|
+
429: ErrorResponse;
|
|
1215
|
+
/**
|
|
1216
|
+
* Internal server error — an unexpected error occurred.
|
|
1217
|
+
*/
|
|
1218
|
+
500: ErrorResponse;
|
|
1219
|
+
};
|
|
1220
|
+
type SolutionsGetInstallationDetailError = SolutionsGetInstallationDetailErrors[keyof SolutionsGetInstallationDetailErrors];
|
|
1221
|
+
type SolutionsGetInstallationDetailResponses = {
|
|
1222
|
+
/**
|
|
1223
|
+
* The installation detail.
|
|
1224
|
+
*/
|
|
1225
|
+
200: InstallationDetailResponse;
|
|
1226
|
+
};
|
|
1227
|
+
type SolutionsGetInstallationDetailResponse = SolutionsGetInstallationDetailResponses[keyof SolutionsGetInstallationDetailResponses];
|
|
1228
|
+
type SolutionsGetInstallationResourcesData = {
|
|
1229
|
+
body?: never;
|
|
1230
|
+
headers?: {
|
|
1231
|
+
/**
|
|
1232
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1233
|
+
*/
|
|
1234
|
+
companytoken?: string;
|
|
1235
|
+
};
|
|
1236
|
+
path: {
|
|
1237
|
+
/**
|
|
1238
|
+
* The identifier of the installation whose resources are requested.
|
|
1239
|
+
*/
|
|
1240
|
+
id: number;
|
|
1241
|
+
};
|
|
1242
|
+
query?: {
|
|
1243
|
+
/**
|
|
1244
|
+
* Optional resource key to filter the resources.
|
|
1245
|
+
*/
|
|
1246
|
+
resourceKey?: string | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* Optional resource type name to filter by; must be a valid ResourceType value.
|
|
1249
|
+
*/
|
|
1250
|
+
resourceType?: string | null;
|
|
1251
|
+
};
|
|
1252
|
+
url: '/v1/solutions/installations/{id}/resources';
|
|
1253
|
+
};
|
|
1254
|
+
type SolutionsGetInstallationResourcesErrors = {
|
|
1255
|
+
400: ErrorResponse;
|
|
1256
|
+
/**
|
|
1257
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1258
|
+
*/
|
|
1259
|
+
401: ErrorResponse;
|
|
1260
|
+
/**
|
|
1261
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1262
|
+
*/
|
|
1263
|
+
403: ErrorResponse;
|
|
1264
|
+
404: ErrorResponse;
|
|
1265
|
+
/**
|
|
1266
|
+
* Too many requests — rate limit exceeded.
|
|
1267
|
+
*/
|
|
1268
|
+
429: ErrorResponse;
|
|
1269
|
+
/**
|
|
1270
|
+
* Internal server error — an unexpected error occurred.
|
|
1271
|
+
*/
|
|
1272
|
+
500: ErrorResponse;
|
|
1273
|
+
};
|
|
1274
|
+
type SolutionsGetInstallationResourcesError = SolutionsGetInstallationResourcesErrors[keyof SolutionsGetInstallationResourcesErrors];
|
|
1275
|
+
type SolutionsGetInstallationResourcesResponses = {
|
|
1276
|
+
/**
|
|
1277
|
+
* The matching installed resources.
|
|
1278
|
+
*/
|
|
1279
|
+
200: Array<InstalledResourceResponse>;
|
|
1280
|
+
};
|
|
1281
|
+
type SolutionsGetInstallationResourcesResponse = SolutionsGetInstallationResourcesResponses[keyof SolutionsGetInstallationResourcesResponses];
|
|
1282
|
+
type SolutionsInstallSolutionData = {
|
|
1283
|
+
/**
|
|
1284
|
+
* The installation options and provisioning inputs.
|
|
1285
|
+
*/
|
|
1286
|
+
body: InstallSolutionRequest;
|
|
1287
|
+
headers?: {
|
|
1288
|
+
/**
|
|
1289
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1290
|
+
*/
|
|
1291
|
+
companytoken?: string;
|
|
1292
|
+
};
|
|
1293
|
+
path: {
|
|
1294
|
+
/**
|
|
1295
|
+
* The slug identifying the solution to install.
|
|
1296
|
+
*/
|
|
1297
|
+
slug: string;
|
|
1298
|
+
};
|
|
1299
|
+
query?: never;
|
|
1300
|
+
url: '/v1/solutions/{slug}/install';
|
|
1301
|
+
};
|
|
1302
|
+
type SolutionsInstallSolutionErrors = {
|
|
1303
|
+
400: ErrorResponse;
|
|
1304
|
+
401: ErrorResponse;
|
|
1305
|
+
/**
|
|
1306
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1307
|
+
*/
|
|
1308
|
+
403: ErrorResponse;
|
|
1309
|
+
404: ErrorResponse;
|
|
1310
|
+
409: ErrorResponse;
|
|
1311
|
+
/**
|
|
1312
|
+
* Too many requests — rate limit exceeded.
|
|
1313
|
+
*/
|
|
1314
|
+
429: ErrorResponse;
|
|
1315
|
+
/**
|
|
1316
|
+
* Internal server error — an unexpected error occurred.
|
|
1317
|
+
*/
|
|
1318
|
+
500: ErrorResponse;
|
|
1319
|
+
};
|
|
1320
|
+
type SolutionsInstallSolutionError = SolutionsInstallSolutionErrors[keyof SolutionsInstallSolutionErrors];
|
|
1321
|
+
type SolutionsInstallSolutionResponses = {
|
|
1322
|
+
/**
|
|
1323
|
+
* The result of the installation, including the created installation and provisioned resources.
|
|
1324
|
+
*/
|
|
1325
|
+
200: InstallSolutionResponse;
|
|
1326
|
+
};
|
|
1327
|
+
type SolutionsInstallSolutionResponse = SolutionsInstallSolutionResponses[keyof SolutionsInstallSolutionResponses];
|
|
1328
|
+
type SolutionsUpdateInstallationData = {
|
|
1329
|
+
/**
|
|
1330
|
+
* Optional update options, including whether to force the update past blockers.
|
|
1331
|
+
*/
|
|
1332
|
+
body?: UpdateInstallationRequest;
|
|
1333
|
+
headers?: {
|
|
1334
|
+
/**
|
|
1335
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1336
|
+
*/
|
|
1337
|
+
companytoken?: string;
|
|
1338
|
+
};
|
|
1339
|
+
path: {
|
|
1340
|
+
/**
|
|
1341
|
+
* The identifier of the installation to update.
|
|
1342
|
+
*/
|
|
1343
|
+
id: number;
|
|
1344
|
+
};
|
|
1345
|
+
query?: never;
|
|
1346
|
+
url: '/v1/solutions/installations/{id}/update';
|
|
1347
|
+
};
|
|
1348
|
+
type SolutionsUpdateInstallationErrors = {
|
|
1349
|
+
400: ErrorResponse;
|
|
1350
|
+
/**
|
|
1351
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1352
|
+
*/
|
|
1353
|
+
401: ErrorResponse;
|
|
1354
|
+
/**
|
|
1355
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1356
|
+
*/
|
|
1357
|
+
403: ErrorResponse;
|
|
1358
|
+
404: ErrorResponse;
|
|
1359
|
+
409: UpdateBlockedResponse;
|
|
1360
|
+
/**
|
|
1361
|
+
* Too many requests — rate limit exceeded.
|
|
1362
|
+
*/
|
|
1363
|
+
429: ErrorResponse;
|
|
1364
|
+
/**
|
|
1365
|
+
* Internal server error — an unexpected error occurred.
|
|
1366
|
+
*/
|
|
1367
|
+
500: ErrorResponse;
|
|
1368
|
+
};
|
|
1369
|
+
type SolutionsUpdateInstallationError = SolutionsUpdateInstallationErrors[keyof SolutionsUpdateInstallationErrors];
|
|
1370
|
+
type SolutionsUpdateInstallationResponses = {
|
|
1371
|
+
/**
|
|
1372
|
+
* The result of the installation update.
|
|
1373
|
+
*/
|
|
1374
|
+
200: UpdateInstallationResponse;
|
|
1375
|
+
};
|
|
1376
|
+
type SolutionsUpdateInstallationResponse = SolutionsUpdateInstallationResponses[keyof SolutionsUpdateInstallationResponses];
|
|
1377
|
+
type SolutionsUninstallSolutionData = {
|
|
1378
|
+
/**
|
|
1379
|
+
* The uninstall options, including the installation identifier and which resource types to delete.
|
|
1380
|
+
*/
|
|
1381
|
+
body: UninstallSolutionRequest;
|
|
1382
|
+
headers?: {
|
|
1383
|
+
/**
|
|
1384
|
+
* Account token. The server resolves the account token from this header OR from the `AccountToken` claim on the Bearer JWT - either alone is sufficient. OAuth-issued JWTs include the claim automatically; password sign-in JWTs do not. If both are sent, the header wins.
|
|
1385
|
+
*/
|
|
1386
|
+
companytoken?: string;
|
|
1387
|
+
};
|
|
1388
|
+
path: {
|
|
1389
|
+
/**
|
|
1390
|
+
* The slug identifying the solution to uninstall.
|
|
1391
|
+
*/
|
|
1392
|
+
slug: string;
|
|
1393
|
+
};
|
|
1394
|
+
query?: never;
|
|
1395
|
+
url: '/v1/solutions/{slug}/uninstall';
|
|
1396
|
+
};
|
|
1397
|
+
type SolutionsUninstallSolutionErrors = {
|
|
1398
|
+
400: ErrorResponse;
|
|
1399
|
+
/**
|
|
1400
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1401
|
+
*/
|
|
1402
|
+
401: ErrorResponse;
|
|
1403
|
+
/**
|
|
1404
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1405
|
+
*/
|
|
1406
|
+
403: ErrorResponse;
|
|
1407
|
+
404: ErrorResponse;
|
|
1408
|
+
/**
|
|
1409
|
+
* Too many requests — rate limit exceeded.
|
|
1410
|
+
*/
|
|
1411
|
+
429: ErrorResponse;
|
|
1412
|
+
/**
|
|
1413
|
+
* Internal server error — an unexpected error occurred.
|
|
1414
|
+
*/
|
|
1415
|
+
500: ErrorResponse;
|
|
1416
|
+
};
|
|
1417
|
+
type SolutionsUninstallSolutionError = SolutionsUninstallSolutionErrors[keyof SolutionsUninstallSolutionErrors];
|
|
1418
|
+
type SolutionsUninstallSolutionResponses = {
|
|
1419
|
+
/**
|
|
1420
|
+
* No content on success.
|
|
1421
|
+
*/
|
|
1422
|
+
204: void;
|
|
1423
|
+
};
|
|
1424
|
+
type SolutionsUninstallSolutionResponse = SolutionsUninstallSolutionResponses[keyof SolutionsUninstallSolutionResponses];
|
|
1425
|
+
type ApplicationsListApplicationsData = {
|
|
1426
|
+
body?: never;
|
|
1427
|
+
headers?: {
|
|
1428
|
+
/**
|
|
1429
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1430
|
+
*/
|
|
1431
|
+
companytoken?: string;
|
|
1432
|
+
};
|
|
1433
|
+
path?: never;
|
|
1434
|
+
query?: {
|
|
1435
|
+
/**
|
|
1436
|
+
* Optional free-text search applied across application fields.
|
|
1437
|
+
*/
|
|
1438
|
+
search?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* Optional exact-name filter.
|
|
1441
|
+
*/
|
|
1442
|
+
name?: string | null;
|
|
1443
|
+
/**
|
|
1444
|
+
* Optional filter on the application's connection requirement.
|
|
1445
|
+
*/
|
|
1446
|
+
connectionRequirement?: string | null;
|
|
1447
|
+
/**
|
|
1448
|
+
* Optional list of categories to filter by.
|
|
1449
|
+
*/
|
|
1450
|
+
category?: Array<string> | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* When true, returns only applications the caller can currently use. Defaults to false.
|
|
1453
|
+
*/
|
|
1454
|
+
available?: boolean;
|
|
1455
|
+
/**
|
|
1456
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
1457
|
+
*/
|
|
1458
|
+
offset?: number;
|
|
1459
|
+
/**
|
|
1460
|
+
* Maximum number of items to return. Defaults to 100.
|
|
1461
|
+
*/
|
|
1462
|
+
top?: number;
|
|
1463
|
+
};
|
|
1464
|
+
url: '/v1/applications';
|
|
1465
|
+
};
|
|
1466
|
+
type ApplicationsListApplicationsErrors = {
|
|
1467
|
+
400: ErrorResponse;
|
|
1468
|
+
401: ErrorResponse;
|
|
1469
|
+
/**
|
|
1470
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1471
|
+
*/
|
|
1472
|
+
403: ErrorResponse;
|
|
1473
|
+
/**
|
|
1474
|
+
* Not found — the resource does not exist.
|
|
1475
|
+
*/
|
|
1476
|
+
404: ErrorResponse;
|
|
1477
|
+
/**
|
|
1478
|
+
* Too many requests — rate limit exceeded.
|
|
1479
|
+
*/
|
|
1480
|
+
429: ErrorResponse;
|
|
1481
|
+
/**
|
|
1482
|
+
* Internal server error — an unexpected error occurred.
|
|
1483
|
+
*/
|
|
1484
|
+
500: ErrorResponse;
|
|
1485
|
+
};
|
|
1486
|
+
type ApplicationsListApplicationsError = ApplicationsListApplicationsErrors[keyof ApplicationsListApplicationsErrors];
|
|
1487
|
+
type ApplicationsListApplicationsResponses = {
|
|
1488
|
+
/**
|
|
1489
|
+
* A paginated list of applications.
|
|
1490
|
+
*/
|
|
1491
|
+
200: PaginatedResponseOfApplicationDto;
|
|
1492
|
+
};
|
|
1493
|
+
type ApplicationsListApplicationsResponse = ApplicationsListApplicationsResponses[keyof ApplicationsListApplicationsResponses];
|
|
1494
|
+
type ApplicationsGetApplicationData = {
|
|
1495
|
+
body?: never;
|
|
1496
|
+
headers?: {
|
|
1497
|
+
/**
|
|
1498
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1499
|
+
*/
|
|
1500
|
+
companytoken?: string;
|
|
1501
|
+
};
|
|
1502
|
+
path: {
|
|
1503
|
+
/**
|
|
1504
|
+
* The slug identifying the application to retrieve.
|
|
1505
|
+
*/
|
|
1506
|
+
slug: string;
|
|
1507
|
+
};
|
|
1508
|
+
query?: never;
|
|
1509
|
+
url: '/v1/applications/{slug}';
|
|
1510
|
+
};
|
|
1511
|
+
type ApplicationsGetApplicationErrors = {
|
|
1512
|
+
/**
|
|
1513
|
+
* Bad request — malformed body or invalid parameters.
|
|
1514
|
+
*/
|
|
1515
|
+
400: ErrorResponse;
|
|
1516
|
+
401: ErrorResponse;
|
|
1517
|
+
/**
|
|
1518
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1519
|
+
*/
|
|
1520
|
+
403: ErrorResponse;
|
|
1521
|
+
404: ErrorResponse;
|
|
1522
|
+
/**
|
|
1523
|
+
* Too many requests — rate limit exceeded.
|
|
1524
|
+
*/
|
|
1525
|
+
429: ErrorResponse;
|
|
1526
|
+
/**
|
|
1527
|
+
* Internal server error — an unexpected error occurred.
|
|
1528
|
+
*/
|
|
1529
|
+
500: ErrorResponse;
|
|
1530
|
+
};
|
|
1531
|
+
type ApplicationsGetApplicationError = ApplicationsGetApplicationErrors[keyof ApplicationsGetApplicationErrors];
|
|
1532
|
+
type ApplicationsGetApplicationResponses = {
|
|
1533
|
+
/**
|
|
1534
|
+
* The detailed representation of the application.
|
|
1535
|
+
*/
|
|
1536
|
+
200: ApplicationDetailDto;
|
|
1537
|
+
};
|
|
1538
|
+
type ApplicationsGetApplicationResponse = ApplicationsGetApplicationResponses[keyof ApplicationsGetApplicationResponses];
|
|
1539
|
+
type ConnectionsGetConnectionsData = {
|
|
1540
|
+
body?: never;
|
|
1541
|
+
headers?: {
|
|
1542
|
+
/**
|
|
1543
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1544
|
+
*/
|
|
1545
|
+
companytoken?: string;
|
|
1546
|
+
};
|
|
1547
|
+
path?: never;
|
|
1548
|
+
query?: {
|
|
1549
|
+
/**
|
|
1550
|
+
* Optional filter limiting results to connections of a specific application.
|
|
1551
|
+
*/
|
|
1552
|
+
applicationSlug?: string | null;
|
|
1553
|
+
/**
|
|
1554
|
+
* Optional name filter.
|
|
1555
|
+
*/
|
|
1556
|
+
name?: string | null;
|
|
1557
|
+
/**
|
|
1558
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
1559
|
+
*/
|
|
1560
|
+
offset?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* Maximum number of items to return (capped at 100). Defaults to 25.
|
|
1563
|
+
*/
|
|
1564
|
+
top?: number;
|
|
1565
|
+
/**
|
|
1566
|
+
* Optional metadata key/value pairs to filter connections by.
|
|
1567
|
+
*/
|
|
1568
|
+
metadata?: {
|
|
1569
|
+
[key: string]: string;
|
|
1570
|
+
} | null;
|
|
1571
|
+
};
|
|
1572
|
+
url: '/v1/connections';
|
|
1573
|
+
};
|
|
1574
|
+
type ConnectionsGetConnectionsErrors = {
|
|
1575
|
+
/**
|
|
1576
|
+
* Bad request — malformed body or invalid parameters.
|
|
1577
|
+
*/
|
|
1578
|
+
400: ErrorResponse;
|
|
1579
|
+
/**
|
|
1580
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1581
|
+
*/
|
|
1582
|
+
401: ErrorResponse;
|
|
1583
|
+
/**
|
|
1584
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1585
|
+
*/
|
|
1586
|
+
403: ErrorResponse;
|
|
1587
|
+
/**
|
|
1588
|
+
* Not found — the resource does not exist.
|
|
1589
|
+
*/
|
|
1590
|
+
404: ErrorResponse;
|
|
1591
|
+
/**
|
|
1592
|
+
* Too many requests — rate limit exceeded.
|
|
1593
|
+
*/
|
|
1594
|
+
429: ErrorResponse;
|
|
1595
|
+
/**
|
|
1596
|
+
* Internal server error — an unexpected error occurred.
|
|
1597
|
+
*/
|
|
1598
|
+
500: ErrorResponse;
|
|
1599
|
+
};
|
|
1600
|
+
type ConnectionsGetConnectionsError = ConnectionsGetConnectionsErrors[keyof ConnectionsGetConnectionsErrors];
|
|
1601
|
+
type ConnectionsGetConnectionsResponses = {
|
|
1602
|
+
/**
|
|
1603
|
+
* A paginated list of connections.
|
|
1604
|
+
*/
|
|
1605
|
+
200: PaginatedResponseOfConnectionPublicListItem;
|
|
1606
|
+
};
|
|
1607
|
+
type ConnectionsGetConnectionsResponse = ConnectionsGetConnectionsResponses[keyof ConnectionsGetConnectionsResponses];
|
|
1608
|
+
type ConnectionsCreateConnectionData = {
|
|
1609
|
+
/**
|
|
1610
|
+
* The connection creation payload, including the connection name and application slug.
|
|
1611
|
+
*/
|
|
1612
|
+
body: CreateConnectionRequest;
|
|
1613
|
+
headers?: {
|
|
1614
|
+
/**
|
|
1615
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1616
|
+
*/
|
|
1617
|
+
companytoken?: string;
|
|
1618
|
+
};
|
|
1619
|
+
path?: never;
|
|
1620
|
+
query?: never;
|
|
1621
|
+
url: '/v1/connections';
|
|
1622
|
+
};
|
|
1623
|
+
type ConnectionsCreateConnectionErrors = {
|
|
1624
|
+
/**
|
|
1625
|
+
* Bad request — malformed body or invalid parameters.
|
|
1626
|
+
*/
|
|
1627
|
+
400: ErrorResponse;
|
|
1628
|
+
/**
|
|
1629
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1630
|
+
*/
|
|
1631
|
+
401: ErrorResponse;
|
|
1632
|
+
/**
|
|
1633
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1634
|
+
*/
|
|
1635
|
+
403: ErrorResponse;
|
|
1636
|
+
/**
|
|
1637
|
+
* Not found — the resource does not exist.
|
|
1638
|
+
*/
|
|
1639
|
+
404: ErrorResponse;
|
|
1640
|
+
/**
|
|
1641
|
+
* Too many requests — rate limit exceeded.
|
|
1642
|
+
*/
|
|
1643
|
+
429: ErrorResponse;
|
|
1644
|
+
/**
|
|
1645
|
+
* Internal server error — an unexpected error occurred.
|
|
1646
|
+
*/
|
|
1647
|
+
500: ErrorResponse;
|
|
1648
|
+
};
|
|
1649
|
+
type ConnectionsCreateConnectionError = ConnectionsCreateConnectionErrors[keyof ConnectionsCreateConnectionErrors];
|
|
1650
|
+
type ConnectionsCreateConnectionResponses = {
|
|
1651
|
+
/**
|
|
1652
|
+
* The newly created connection.
|
|
1653
|
+
*/
|
|
1654
|
+
200: ConnectionPublicDetail;
|
|
1655
|
+
};
|
|
1656
|
+
type ConnectionsCreateConnectionResponse = ConnectionsCreateConnectionResponses[keyof ConnectionsCreateConnectionResponses];
|
|
1657
|
+
type ConnectionsDeleteConnectionData = {
|
|
1658
|
+
body?: never;
|
|
1659
|
+
headers?: {
|
|
1660
|
+
/**
|
|
1661
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1662
|
+
*/
|
|
1663
|
+
companytoken?: string;
|
|
1664
|
+
};
|
|
1665
|
+
path: {
|
|
1666
|
+
/**
|
|
1667
|
+
* The identifier of the connection to delete.
|
|
1668
|
+
*/
|
|
1669
|
+
connectionId: number;
|
|
1670
|
+
};
|
|
1671
|
+
query?: never;
|
|
1672
|
+
url: '/v1/connections/{connectionId}';
|
|
1673
|
+
};
|
|
1674
|
+
type ConnectionsDeleteConnectionErrors = {
|
|
1675
|
+
/**
|
|
1676
|
+
* Bad request — malformed body or invalid parameters.
|
|
1677
|
+
*/
|
|
1678
|
+
400: ErrorResponse;
|
|
1679
|
+
/**
|
|
1680
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1681
|
+
*/
|
|
1682
|
+
401: ErrorResponse;
|
|
1683
|
+
/**
|
|
1684
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1685
|
+
*/
|
|
1686
|
+
403: ErrorResponse;
|
|
1687
|
+
/**
|
|
1688
|
+
* Not found — the resource does not exist.
|
|
1689
|
+
*/
|
|
1690
|
+
404: ErrorResponse;
|
|
1691
|
+
/**
|
|
1692
|
+
* Too many requests — rate limit exceeded.
|
|
1693
|
+
*/
|
|
1694
|
+
429: ErrorResponse;
|
|
1695
|
+
/**
|
|
1696
|
+
* Internal server error — an unexpected error occurred.
|
|
1697
|
+
*/
|
|
1698
|
+
500: ErrorResponse;
|
|
1699
|
+
};
|
|
1700
|
+
type ConnectionsDeleteConnectionError = ConnectionsDeleteConnectionErrors[keyof ConnectionsDeleteConnectionErrors];
|
|
1701
|
+
type ConnectionsDeleteConnectionResponses = {
|
|
1702
|
+
/**
|
|
1703
|
+
* An empty success response when the connection is deleted.
|
|
1704
|
+
*/
|
|
1705
|
+
200: Blob | File;
|
|
1706
|
+
};
|
|
1707
|
+
type ConnectionsDeleteConnectionResponse = ConnectionsDeleteConnectionResponses[keyof ConnectionsDeleteConnectionResponses];
|
|
1708
|
+
type ConnectionsGetConnectionData = {
|
|
1709
|
+
body?: never;
|
|
1710
|
+
headers?: {
|
|
1711
|
+
/**
|
|
1712
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1713
|
+
*/
|
|
1714
|
+
companytoken?: string;
|
|
1715
|
+
};
|
|
1716
|
+
path: {
|
|
1717
|
+
/**
|
|
1718
|
+
* The identifier of the connection to retrieve.
|
|
1719
|
+
*/
|
|
1720
|
+
connectionId: number;
|
|
1721
|
+
};
|
|
1722
|
+
query?: never;
|
|
1723
|
+
url: '/v1/connections/{connectionId}';
|
|
1724
|
+
};
|
|
1725
|
+
type ConnectionsGetConnectionErrors = {
|
|
1726
|
+
/**
|
|
1727
|
+
* Bad request — malformed body or invalid parameters.
|
|
1728
|
+
*/
|
|
1729
|
+
400: ErrorResponse;
|
|
1730
|
+
/**
|
|
1731
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1732
|
+
*/
|
|
1733
|
+
401: ErrorResponse;
|
|
1734
|
+
/**
|
|
1735
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1736
|
+
*/
|
|
1737
|
+
403: ErrorResponse;
|
|
1738
|
+
/**
|
|
1739
|
+
* Not found — the resource does not exist.
|
|
1740
|
+
*/
|
|
1741
|
+
404: ErrorResponse;
|
|
1742
|
+
/**
|
|
1743
|
+
* Too many requests — rate limit exceeded.
|
|
1744
|
+
*/
|
|
1745
|
+
429: ErrorResponse;
|
|
1746
|
+
/**
|
|
1747
|
+
* Internal server error — an unexpected error occurred.
|
|
1748
|
+
*/
|
|
1749
|
+
500: ErrorResponse;
|
|
1750
|
+
};
|
|
1751
|
+
type ConnectionsGetConnectionError = ConnectionsGetConnectionErrors[keyof ConnectionsGetConnectionErrors];
|
|
1752
|
+
type ConnectionsGetConnectionResponses = {
|
|
1753
|
+
/**
|
|
1754
|
+
* The detailed representation of the connection.
|
|
1755
|
+
*/
|
|
1756
|
+
200: ConnectionPublicDetail;
|
|
1757
|
+
};
|
|
1758
|
+
type ConnectionsGetConnectionResponse = ConnectionsGetConnectionResponses[keyof ConnectionsGetConnectionResponses];
|
|
1759
|
+
type ConnectionsUpdateConnectionData = {
|
|
1760
|
+
/**
|
|
1761
|
+
* The fields to update on the connection.
|
|
1762
|
+
*/
|
|
1763
|
+
body: UpdateConnectionRequest;
|
|
1764
|
+
headers?: {
|
|
1765
|
+
/**
|
|
1766
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1767
|
+
*/
|
|
1768
|
+
companytoken?: string;
|
|
1769
|
+
};
|
|
1770
|
+
path: {
|
|
1771
|
+
/**
|
|
1772
|
+
* The identifier of the connection to update.
|
|
1773
|
+
*/
|
|
1774
|
+
connectionId: number;
|
|
1775
|
+
};
|
|
1776
|
+
query?: never;
|
|
1777
|
+
url: '/v1/connections/{connectionId}';
|
|
1778
|
+
};
|
|
1779
|
+
type ConnectionsUpdateConnectionErrors = {
|
|
1780
|
+
/**
|
|
1781
|
+
* Bad request — malformed body or invalid parameters.
|
|
1782
|
+
*/
|
|
1783
|
+
400: ErrorResponse;
|
|
1784
|
+
/**
|
|
1785
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1786
|
+
*/
|
|
1787
|
+
401: ErrorResponse;
|
|
1788
|
+
/**
|
|
1789
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1790
|
+
*/
|
|
1791
|
+
403: ErrorResponse;
|
|
1792
|
+
/**
|
|
1793
|
+
* Not found — the resource does not exist.
|
|
1794
|
+
*/
|
|
1795
|
+
404: ErrorResponse;
|
|
1796
|
+
/**
|
|
1797
|
+
* Too many requests — rate limit exceeded.
|
|
1798
|
+
*/
|
|
1799
|
+
429: ErrorResponse;
|
|
1800
|
+
/**
|
|
1801
|
+
* Internal server error — an unexpected error occurred.
|
|
1802
|
+
*/
|
|
1803
|
+
500: ErrorResponse;
|
|
1804
|
+
};
|
|
1805
|
+
type ConnectionsUpdateConnectionError = ConnectionsUpdateConnectionErrors[keyof ConnectionsUpdateConnectionErrors];
|
|
1806
|
+
type ConnectionsUpdateConnectionResponses = {
|
|
1807
|
+
/**
|
|
1808
|
+
* The updated connection.
|
|
1809
|
+
*/
|
|
1810
|
+
200: ConnectionPublicDetail;
|
|
1811
|
+
};
|
|
1812
|
+
type ConnectionsUpdateConnectionResponse = ConnectionsUpdateConnectionResponses[keyof ConnectionsUpdateConnectionResponses];
|
|
1813
|
+
type ConnectionsGetDefaultConnectionsData = {
|
|
1814
|
+
body?: never;
|
|
1815
|
+
headers?: {
|
|
1816
|
+
/**
|
|
1817
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1818
|
+
*/
|
|
1819
|
+
companytoken?: string;
|
|
1820
|
+
};
|
|
1821
|
+
path?: never;
|
|
1822
|
+
query?: never;
|
|
1823
|
+
url: '/v1/connections/Defaults';
|
|
1824
|
+
};
|
|
1825
|
+
type ConnectionsGetDefaultConnectionsErrors = {
|
|
1826
|
+
/**
|
|
1827
|
+
* Bad request — malformed body or invalid parameters.
|
|
1828
|
+
*/
|
|
1829
|
+
400: ErrorResponse;
|
|
1830
|
+
/**
|
|
1831
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1832
|
+
*/
|
|
1833
|
+
401: ErrorResponse;
|
|
1834
|
+
/**
|
|
1835
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1836
|
+
*/
|
|
1837
|
+
403: ErrorResponse;
|
|
1838
|
+
/**
|
|
1839
|
+
* Not found — the resource does not exist.
|
|
1840
|
+
*/
|
|
1841
|
+
404: ErrorResponse;
|
|
1842
|
+
/**
|
|
1843
|
+
* Too many requests — rate limit exceeded.
|
|
1844
|
+
*/
|
|
1845
|
+
429: ErrorResponse;
|
|
1846
|
+
/**
|
|
1847
|
+
* Internal server error — an unexpected error occurred.
|
|
1848
|
+
*/
|
|
1849
|
+
500: ErrorResponse;
|
|
1850
|
+
};
|
|
1851
|
+
type ConnectionsGetDefaultConnectionsError = ConnectionsGetDefaultConnectionsErrors[keyof ConnectionsGetDefaultConnectionsErrors];
|
|
1852
|
+
type ConnectionsGetDefaultConnectionsResponses = {
|
|
1853
|
+
/**
|
|
1854
|
+
* The caller's default connections.
|
|
1855
|
+
*/
|
|
1856
|
+
200: DefaultConnectionsResponse;
|
|
1857
|
+
};
|
|
1858
|
+
type ConnectionsGetDefaultConnectionsResponse = ConnectionsGetDefaultConnectionsResponses[keyof ConnectionsGetDefaultConnectionsResponses];
|
|
1859
|
+
type ConnectionsClearDefaultConnectionData = {
|
|
1860
|
+
body?: never;
|
|
1861
|
+
headers?: {
|
|
1862
|
+
/**
|
|
1863
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1864
|
+
*/
|
|
1865
|
+
companytoken?: string;
|
|
1866
|
+
};
|
|
1867
|
+
path: {
|
|
1868
|
+
/**
|
|
1869
|
+
* The identifier of the connection to clear as default.
|
|
1870
|
+
*/
|
|
1871
|
+
connectionId: number;
|
|
1872
|
+
};
|
|
1873
|
+
query?: never;
|
|
1874
|
+
url: '/v1/connections/{connectionId}/Default';
|
|
1875
|
+
};
|
|
1876
|
+
type ConnectionsClearDefaultConnectionErrors = {
|
|
1877
|
+
/**
|
|
1878
|
+
* Bad request — malformed body or invalid parameters.
|
|
1879
|
+
*/
|
|
1880
|
+
400: ErrorResponse;
|
|
1881
|
+
/**
|
|
1882
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1883
|
+
*/
|
|
1884
|
+
401: ErrorResponse;
|
|
1885
|
+
/**
|
|
1886
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1887
|
+
*/
|
|
1888
|
+
403: ErrorResponse;
|
|
1889
|
+
/**
|
|
1890
|
+
* Not found — the resource does not exist.
|
|
1891
|
+
*/
|
|
1892
|
+
404: ErrorResponse;
|
|
1893
|
+
/**
|
|
1894
|
+
* Too many requests — rate limit exceeded.
|
|
1895
|
+
*/
|
|
1896
|
+
429: ErrorResponse;
|
|
1897
|
+
/**
|
|
1898
|
+
* Internal server error — an unexpected error occurred.
|
|
1899
|
+
*/
|
|
1900
|
+
500: ErrorResponse;
|
|
1901
|
+
};
|
|
1902
|
+
type ConnectionsClearDefaultConnectionError = ConnectionsClearDefaultConnectionErrors[keyof ConnectionsClearDefaultConnectionErrors];
|
|
1903
|
+
type ConnectionsClearDefaultConnectionResponses = {
|
|
1904
|
+
/**
|
|
1905
|
+
* No content when the default is cleared successfully.
|
|
1906
|
+
*/
|
|
1907
|
+
200: Blob | File;
|
|
1908
|
+
};
|
|
1909
|
+
type ConnectionsClearDefaultConnectionResponse = ConnectionsClearDefaultConnectionResponses[keyof ConnectionsClearDefaultConnectionResponses];
|
|
1910
|
+
type ConnectionsSetDefaultConnectionData = {
|
|
1911
|
+
body?: never;
|
|
1912
|
+
headers?: {
|
|
1913
|
+
/**
|
|
1914
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1915
|
+
*/
|
|
1916
|
+
companytoken?: string;
|
|
1917
|
+
};
|
|
1918
|
+
path: {
|
|
1919
|
+
/**
|
|
1920
|
+
* The identifier of the connection to mark as default.
|
|
1921
|
+
*/
|
|
1922
|
+
connectionId: number;
|
|
1923
|
+
};
|
|
1924
|
+
query?: never;
|
|
1925
|
+
url: '/v1/connections/{connectionId}/Default';
|
|
1926
|
+
};
|
|
1927
|
+
type ConnectionsSetDefaultConnectionErrors = {
|
|
1928
|
+
/**
|
|
1929
|
+
* Bad request — malformed body or invalid parameters.
|
|
1930
|
+
*/
|
|
1931
|
+
400: ErrorResponse;
|
|
1932
|
+
/**
|
|
1933
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1934
|
+
*/
|
|
1935
|
+
401: ErrorResponse;
|
|
1936
|
+
/**
|
|
1937
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1938
|
+
*/
|
|
1939
|
+
403: ErrorResponse;
|
|
1940
|
+
/**
|
|
1941
|
+
* Not found — the resource does not exist.
|
|
1942
|
+
*/
|
|
1943
|
+
404: ErrorResponse;
|
|
1944
|
+
/**
|
|
1945
|
+
* Too many requests — rate limit exceeded.
|
|
1946
|
+
*/
|
|
1947
|
+
429: ErrorResponse;
|
|
1948
|
+
/**
|
|
1949
|
+
* Internal server error — an unexpected error occurred.
|
|
1950
|
+
*/
|
|
1951
|
+
500: ErrorResponse;
|
|
1952
|
+
};
|
|
1953
|
+
type ConnectionsSetDefaultConnectionError = ConnectionsSetDefaultConnectionErrors[keyof ConnectionsSetDefaultConnectionErrors];
|
|
1954
|
+
type ConnectionsSetDefaultConnectionResponses = {
|
|
1955
|
+
/**
|
|
1956
|
+
* The result of setting the default connection.
|
|
1957
|
+
*/
|
|
1958
|
+
200: SetDefaultConnectionResponse;
|
|
1959
|
+
};
|
|
1960
|
+
type ConnectionsSetDefaultConnectionResponse = ConnectionsSetDefaultConnectionResponses[keyof ConnectionsSetDefaultConnectionResponses];
|
|
1961
|
+
type ConnectionsReplaceConnectionData = {
|
|
1962
|
+
/**
|
|
1963
|
+
* The replacement payload identifying the source and target connections.
|
|
1964
|
+
*/
|
|
1965
|
+
body: ReplaceConnectionRequest;
|
|
1966
|
+
headers?: {
|
|
1967
|
+
/**
|
|
1968
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1969
|
+
*/
|
|
1970
|
+
companytoken?: string;
|
|
1971
|
+
};
|
|
1972
|
+
path?: never;
|
|
1973
|
+
query?: never;
|
|
1974
|
+
url: '/v1/connections/Replace';
|
|
1975
|
+
};
|
|
1976
|
+
type ConnectionsReplaceConnectionErrors = {
|
|
1977
|
+
/**
|
|
1978
|
+
* Bad request — malformed body or invalid parameters.
|
|
1979
|
+
*/
|
|
1980
|
+
400: ErrorResponse;
|
|
1981
|
+
/**
|
|
1982
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1983
|
+
*/
|
|
1984
|
+
401: ErrorResponse;
|
|
1985
|
+
/**
|
|
1986
|
+
* Forbidden — the caller lacks access to the resource.
|
|
1987
|
+
*/
|
|
1988
|
+
403: ErrorResponse;
|
|
1989
|
+
/**
|
|
1990
|
+
* Not found — the resource does not exist.
|
|
1991
|
+
*/
|
|
1992
|
+
404: ErrorResponse;
|
|
1993
|
+
/**
|
|
1994
|
+
* Too many requests — rate limit exceeded.
|
|
1995
|
+
*/
|
|
1996
|
+
429: ErrorResponse;
|
|
1997
|
+
/**
|
|
1998
|
+
* Internal server error — an unexpected error occurred.
|
|
1999
|
+
*/
|
|
2000
|
+
500: ErrorResponse;
|
|
2001
|
+
};
|
|
2002
|
+
type ConnectionsReplaceConnectionError = ConnectionsReplaceConnectionErrors[keyof ConnectionsReplaceConnectionErrors];
|
|
2003
|
+
type ConnectionsReplaceConnectionResponses = {
|
|
2004
|
+
/**
|
|
2005
|
+
* An empty success response when the replacement completes.
|
|
2006
|
+
*/
|
|
2007
|
+
200: Blob | File;
|
|
2008
|
+
};
|
|
2009
|
+
type ConnectionsReplaceConnectionResponse = ConnectionsReplaceConnectionResponses[keyof ConnectionsReplaceConnectionResponses];
|
|
2010
|
+
type ConnectionsRefreshObjectsData = {
|
|
2011
|
+
body?: never;
|
|
2012
|
+
headers?: {
|
|
2013
|
+
/**
|
|
2014
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2015
|
+
*/
|
|
2016
|
+
companytoken?: string;
|
|
2017
|
+
};
|
|
2018
|
+
path: {
|
|
2019
|
+
/**
|
|
2020
|
+
* The identifier of the connection whose objects should be refreshed.
|
|
2021
|
+
*/
|
|
2022
|
+
connectionId: number;
|
|
2023
|
+
};
|
|
2024
|
+
query?: never;
|
|
2025
|
+
url: '/v1/connections/{connectionId}/RefreshObjects';
|
|
2026
|
+
};
|
|
2027
|
+
type ConnectionsRefreshObjectsErrors = {
|
|
2028
|
+
/**
|
|
2029
|
+
* Bad request — malformed body or invalid parameters.
|
|
2030
|
+
*/
|
|
2031
|
+
400: ErrorResponse;
|
|
2032
|
+
/**
|
|
2033
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2034
|
+
*/
|
|
2035
|
+
401: ErrorResponse;
|
|
2036
|
+
/**
|
|
2037
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2038
|
+
*/
|
|
2039
|
+
403: ErrorResponse;
|
|
2040
|
+
/**
|
|
2041
|
+
* Not found — the resource does not exist.
|
|
2042
|
+
*/
|
|
2043
|
+
404: ErrorResponse;
|
|
2044
|
+
/**
|
|
2045
|
+
* Too many requests — rate limit exceeded.
|
|
2046
|
+
*/
|
|
2047
|
+
429: ErrorResponse;
|
|
2048
|
+
/**
|
|
2049
|
+
* Internal server error — an unexpected error occurred.
|
|
2050
|
+
*/
|
|
2051
|
+
500: ErrorResponse;
|
|
2052
|
+
};
|
|
2053
|
+
type ConnectionsRefreshObjectsError = ConnectionsRefreshObjectsErrors[keyof ConnectionsRefreshObjectsErrors];
|
|
2054
|
+
type ConnectionsRefreshObjectsResponses = {
|
|
2055
|
+
/**
|
|
2056
|
+
* An empty success response when the refresh is initiated.
|
|
2057
|
+
*/
|
|
2058
|
+
200: Blob | File;
|
|
2059
|
+
};
|
|
2060
|
+
type ConnectionsRefreshObjectsResponse = ConnectionsRefreshObjectsResponses[keyof ConnectionsRefreshObjectsResponses];
|
|
2061
|
+
type ConnectionsGetRefreshStatusData = {
|
|
2062
|
+
body?: never;
|
|
2063
|
+
headers?: {
|
|
2064
|
+
/**
|
|
2065
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2066
|
+
*/
|
|
2067
|
+
companytoken?: string;
|
|
2068
|
+
};
|
|
2069
|
+
path: {
|
|
2070
|
+
/**
|
|
2071
|
+
* The identifier of the connection whose refresh status is requested.
|
|
2072
|
+
*/
|
|
2073
|
+
connectionId: number;
|
|
2074
|
+
};
|
|
2075
|
+
query?: never;
|
|
2076
|
+
url: '/v1/connections/{connectionId}/RefreshStatus';
|
|
2077
|
+
};
|
|
2078
|
+
type ConnectionsGetRefreshStatusErrors = {
|
|
2079
|
+
/**
|
|
2080
|
+
* Bad request — malformed body or invalid parameters.
|
|
2081
|
+
*/
|
|
2082
|
+
400: ErrorResponse;
|
|
2083
|
+
/**
|
|
2084
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2085
|
+
*/
|
|
2086
|
+
401: ErrorResponse;
|
|
2087
|
+
/**
|
|
2088
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2089
|
+
*/
|
|
2090
|
+
403: ErrorResponse;
|
|
2091
|
+
/**
|
|
2092
|
+
* Not found — the resource does not exist.
|
|
2093
|
+
*/
|
|
2094
|
+
404: ErrorResponse;
|
|
2095
|
+
/**
|
|
2096
|
+
* Too many requests — rate limit exceeded.
|
|
2097
|
+
*/
|
|
2098
|
+
429: ErrorResponse;
|
|
2099
|
+
/**
|
|
2100
|
+
* Internal server error — an unexpected error occurred.
|
|
2101
|
+
*/
|
|
2102
|
+
500: ErrorResponse;
|
|
2103
|
+
};
|
|
2104
|
+
type ConnectionsGetRefreshStatusError = ConnectionsGetRefreshStatusErrors[keyof ConnectionsGetRefreshStatusErrors];
|
|
2105
|
+
type ConnectionsGetRefreshStatusResponses = {
|
|
2106
|
+
/**
|
|
2107
|
+
* The current refresh status for the connection.
|
|
2108
|
+
*/
|
|
2109
|
+
200: RefreshStatusResponse;
|
|
2110
|
+
};
|
|
2111
|
+
type ConnectionsGetRefreshStatusResponse = ConnectionsGetRefreshStatusResponses[keyof ConnectionsGetRefreshStatusResponses];
|
|
2112
|
+
type ConnectionsSelectObjectsData = {
|
|
2113
|
+
/**
|
|
2114
|
+
* The request containing the identifiers of the objects to select.
|
|
2115
|
+
*/
|
|
2116
|
+
body: SelectObjectsRequest;
|
|
2117
|
+
headers?: {
|
|
2118
|
+
/**
|
|
2119
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2120
|
+
*/
|
|
2121
|
+
companytoken?: string;
|
|
2122
|
+
};
|
|
2123
|
+
path: {
|
|
2124
|
+
/**
|
|
2125
|
+
* The identifier of the connection whose objects are being selected.
|
|
2126
|
+
*/
|
|
2127
|
+
connectionId: number;
|
|
2128
|
+
};
|
|
2129
|
+
query?: never;
|
|
2130
|
+
url: '/v1/connections/{connectionId}/SelectObjects';
|
|
2131
|
+
};
|
|
2132
|
+
type ConnectionsSelectObjectsErrors = {
|
|
2133
|
+
/**
|
|
2134
|
+
* Bad request — malformed body or invalid parameters.
|
|
2135
|
+
*/
|
|
2136
|
+
400: ErrorResponse;
|
|
2137
|
+
/**
|
|
2138
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2139
|
+
*/
|
|
2140
|
+
401: ErrorResponse;
|
|
2141
|
+
/**
|
|
2142
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2143
|
+
*/
|
|
2144
|
+
403: ErrorResponse;
|
|
2145
|
+
/**
|
|
2146
|
+
* Not found — the resource does not exist.
|
|
2147
|
+
*/
|
|
2148
|
+
404: ErrorResponse;
|
|
2149
|
+
/**
|
|
2150
|
+
* Too many requests — rate limit exceeded.
|
|
2151
|
+
*/
|
|
2152
|
+
429: ErrorResponse;
|
|
2153
|
+
/**
|
|
2154
|
+
* Internal server error — an unexpected error occurred.
|
|
2155
|
+
*/
|
|
2156
|
+
500: ErrorResponse;
|
|
2157
|
+
};
|
|
2158
|
+
type ConnectionsSelectObjectsError = ConnectionsSelectObjectsErrors[keyof ConnectionsSelectObjectsErrors];
|
|
2159
|
+
type ConnectionsSelectObjectsResponses = {
|
|
2160
|
+
/**
|
|
2161
|
+
* An empty success response when the selection is saved.
|
|
2162
|
+
*/
|
|
2163
|
+
200: Blob | File;
|
|
2164
|
+
};
|
|
2165
|
+
type ConnectionsSelectObjectsResponse = ConnectionsSelectObjectsResponses[keyof ConnectionsSelectObjectsResponses];
|
|
2166
|
+
type ConnectionsGetConnectionObjectsData = {
|
|
2167
|
+
body?: never;
|
|
2168
|
+
headers?: {
|
|
2169
|
+
/**
|
|
2170
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2171
|
+
*/
|
|
2172
|
+
companytoken?: string;
|
|
2173
|
+
};
|
|
2174
|
+
path: {
|
|
2175
|
+
/**
|
|
2176
|
+
* The identifier of the connection whose objects are listed.
|
|
2177
|
+
*/
|
|
2178
|
+
connectionId: number;
|
|
2179
|
+
};
|
|
2180
|
+
query?: {
|
|
2181
|
+
/**
|
|
2182
|
+
* Optional name filter applied to the objects.
|
|
2183
|
+
*/
|
|
2184
|
+
name?: string | null;
|
|
2185
|
+
/**
|
|
2186
|
+
* Optional sort expression for ordering the objects.
|
|
2187
|
+
*/
|
|
2188
|
+
sort?: string | null;
|
|
2189
|
+
/**
|
|
2190
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
2191
|
+
*/
|
|
2192
|
+
offset?: number;
|
|
2193
|
+
/**
|
|
2194
|
+
* Maximum number of items to return (capped at 1000). Defaults to 100.
|
|
2195
|
+
*/
|
|
2196
|
+
top?: number;
|
|
2197
|
+
};
|
|
2198
|
+
url: '/v1/connections/{connectionId}/Objects';
|
|
2199
|
+
};
|
|
2200
|
+
type ConnectionsGetConnectionObjectsErrors = {
|
|
2201
|
+
/**
|
|
2202
|
+
* Bad request — malformed body or invalid parameters.
|
|
2203
|
+
*/
|
|
2204
|
+
400: ErrorResponse;
|
|
2205
|
+
/**
|
|
2206
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2207
|
+
*/
|
|
2208
|
+
401: ErrorResponse;
|
|
2209
|
+
/**
|
|
2210
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2211
|
+
*/
|
|
2212
|
+
403: ErrorResponse;
|
|
2213
|
+
/**
|
|
2214
|
+
* Not found — the resource does not exist.
|
|
2215
|
+
*/
|
|
2216
|
+
404: ErrorResponse;
|
|
2217
|
+
/**
|
|
2218
|
+
* Too many requests — rate limit exceeded.
|
|
2219
|
+
*/
|
|
2220
|
+
429: ErrorResponse;
|
|
2221
|
+
/**
|
|
2222
|
+
* Internal server error — an unexpected error occurred.
|
|
2223
|
+
*/
|
|
2224
|
+
500: ErrorResponse;
|
|
2225
|
+
};
|
|
2226
|
+
type ConnectionsGetConnectionObjectsError = ConnectionsGetConnectionObjectsErrors[keyof ConnectionsGetConnectionObjectsErrors];
|
|
2227
|
+
type ConnectionsGetConnectionObjectsResponses = {
|
|
2228
|
+
/**
|
|
2229
|
+
* A paginated list of connection objects.
|
|
2230
|
+
*/
|
|
2231
|
+
200: PaginatedResponseOfConnectionObject;
|
|
2232
|
+
};
|
|
2233
|
+
type ConnectionsGetConnectionObjectsResponse = ConnectionsGetConnectionObjectsResponses[keyof ConnectionsGetConnectionObjectsResponses];
|
|
2234
|
+
type ConnectionsCheckConnectionData = {
|
|
2235
|
+
body?: never;
|
|
2236
|
+
headers?: {
|
|
2237
|
+
/**
|
|
2238
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2239
|
+
*/
|
|
2240
|
+
companytoken?: string;
|
|
2241
|
+
};
|
|
2242
|
+
path: {
|
|
2243
|
+
/**
|
|
2244
|
+
* The identifier of the connection to check.
|
|
2245
|
+
*/
|
|
2246
|
+
connectionId: number;
|
|
2247
|
+
};
|
|
2248
|
+
query?: never;
|
|
2249
|
+
url: '/v1/connections/{connectionId}/Check';
|
|
2250
|
+
};
|
|
2251
|
+
type ConnectionsCheckConnectionErrors = {
|
|
2252
|
+
/**
|
|
2253
|
+
* Bad request — malformed body or invalid parameters.
|
|
2254
|
+
*/
|
|
2255
|
+
400: ErrorResponse;
|
|
2256
|
+
/**
|
|
2257
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2258
|
+
*/
|
|
2259
|
+
401: ErrorResponse;
|
|
2260
|
+
/**
|
|
2261
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2262
|
+
*/
|
|
2263
|
+
403: ErrorResponse;
|
|
2264
|
+
/**
|
|
2265
|
+
* Not found — the resource does not exist.
|
|
2266
|
+
*/
|
|
2267
|
+
404: ErrorResponse;
|
|
2268
|
+
/**
|
|
2269
|
+
* Too many requests — rate limit exceeded.
|
|
2270
|
+
*/
|
|
2271
|
+
429: ErrorResponse;
|
|
2272
|
+
/**
|
|
2273
|
+
* Internal server error — an unexpected error occurred.
|
|
2274
|
+
*/
|
|
2275
|
+
500: ErrorResponse;
|
|
2276
|
+
};
|
|
2277
|
+
type ConnectionsCheckConnectionError = ConnectionsCheckConnectionErrors[keyof ConnectionsCheckConnectionErrors];
|
|
2278
|
+
type ConnectionsCheckConnectionResponses = {
|
|
2279
|
+
/**
|
|
2280
|
+
* An empty success response when the connection is healthy.
|
|
2281
|
+
*/
|
|
2282
|
+
200: Blob | File;
|
|
2283
|
+
};
|
|
2284
|
+
type ConnectionsCheckConnectionResponse = ConnectionsCheckConnectionResponses[keyof ConnectionsCheckConnectionResponses];
|
|
2285
|
+
type ConnectionsGetSignInUrlData = {
|
|
2286
|
+
/**
|
|
2287
|
+
* The request describing the application, authentication method, and any provider fields.
|
|
2288
|
+
*/
|
|
2289
|
+
body: SignInUrlRequest;
|
|
2290
|
+
headers?: {
|
|
2291
|
+
/**
|
|
2292
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2293
|
+
*/
|
|
2294
|
+
companytoken?: string;
|
|
2295
|
+
};
|
|
2296
|
+
path?: never;
|
|
2297
|
+
query?: never;
|
|
2298
|
+
url: '/v1/connections/GetSignInUrl';
|
|
2299
|
+
};
|
|
2300
|
+
type ConnectionsGetSignInUrlErrors = {
|
|
2301
|
+
/**
|
|
2302
|
+
* Bad request — malformed body or invalid parameters.
|
|
2303
|
+
*/
|
|
2304
|
+
400: ErrorResponse;
|
|
2305
|
+
/**
|
|
2306
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2307
|
+
*/
|
|
2308
|
+
401: ErrorResponse;
|
|
2309
|
+
/**
|
|
2310
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2311
|
+
*/
|
|
2312
|
+
403: ErrorResponse;
|
|
2313
|
+
/**
|
|
2314
|
+
* Not found — the resource does not exist.
|
|
2315
|
+
*/
|
|
2316
|
+
404: ErrorResponse;
|
|
2317
|
+
/**
|
|
2318
|
+
* Too many requests — rate limit exceeded.
|
|
2319
|
+
*/
|
|
2320
|
+
429: ErrorResponse;
|
|
2321
|
+
/**
|
|
2322
|
+
* Internal server error — an unexpected error occurred.
|
|
2323
|
+
*/
|
|
2324
|
+
500: ErrorResponse;
|
|
2325
|
+
};
|
|
2326
|
+
type ConnectionsGetSignInUrlError = ConnectionsGetSignInUrlErrors[keyof ConnectionsGetSignInUrlErrors];
|
|
2327
|
+
type ConnectionsGetSignInUrlResponses = {
|
|
2328
|
+
/**
|
|
2329
|
+
* The sign-in URL together with the generated state value used to correlate the callback.
|
|
2330
|
+
*/
|
|
2331
|
+
200: SignInUrlResponse;
|
|
2332
|
+
};
|
|
2333
|
+
type ConnectionsGetSignInUrlResponse = ConnectionsGetSignInUrlResponses[keyof ConnectionsGetSignInUrlResponses];
|
|
2334
|
+
type ConnectionsGetAccessTokenData = {
|
|
2335
|
+
body?: never;
|
|
2336
|
+
headers?: {
|
|
2337
|
+
/**
|
|
2338
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2339
|
+
*/
|
|
2340
|
+
companytoken?: string;
|
|
2341
|
+
};
|
|
2342
|
+
path: {
|
|
2343
|
+
/**
|
|
2344
|
+
* The state value returned when the sign-in URL was generated.
|
|
2345
|
+
*/
|
|
2346
|
+
state: string;
|
|
2347
|
+
};
|
|
2348
|
+
query?: never;
|
|
2349
|
+
url: '/v1/connections/AccessToken/{state}';
|
|
2350
|
+
};
|
|
2351
|
+
type ConnectionsGetAccessTokenErrors = {
|
|
2352
|
+
/**
|
|
2353
|
+
* Bad request — malformed body or invalid parameters.
|
|
2354
|
+
*/
|
|
2355
|
+
400: ErrorResponse;
|
|
2356
|
+
/**
|
|
2357
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2358
|
+
*/
|
|
2359
|
+
401: ErrorResponse;
|
|
2360
|
+
/**
|
|
2361
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2362
|
+
*/
|
|
2363
|
+
403: ErrorResponse;
|
|
2364
|
+
/**
|
|
2365
|
+
* Not found — the resource does not exist.
|
|
2366
|
+
*/
|
|
2367
|
+
404: ErrorResponse;
|
|
2368
|
+
/**
|
|
2369
|
+
* Too many requests — rate limit exceeded.
|
|
2370
|
+
*/
|
|
2371
|
+
429: ErrorResponse;
|
|
2372
|
+
/**
|
|
2373
|
+
* Internal server error — an unexpected error occurred.
|
|
2374
|
+
*/
|
|
2375
|
+
500: ErrorResponse;
|
|
2376
|
+
};
|
|
2377
|
+
type ConnectionsGetAccessTokenError = ConnectionsGetAccessTokenErrors[keyof ConnectionsGetAccessTokenErrors];
|
|
2378
|
+
type ConnectionsGetAccessTokenResponses = {
|
|
2379
|
+
/**
|
|
2380
|
+
* The access token data for the state, or null if no token has been captured yet.
|
|
2381
|
+
*/
|
|
2382
|
+
200: AccessTokenResponse;
|
|
2383
|
+
};
|
|
2384
|
+
type ConnectionsGetAccessTokenResponse = ConnectionsGetAccessTokenResponses[keyof ConnectionsGetAccessTokenResponses];
|
|
2385
|
+
type ToolsListToolsData = {
|
|
2386
|
+
body?: never;
|
|
2387
|
+
headers?: {
|
|
2388
|
+
/**
|
|
2389
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2390
|
+
*/
|
|
2391
|
+
companytoken?: string;
|
|
2392
|
+
};
|
|
2393
|
+
path?: never;
|
|
2394
|
+
query?: {
|
|
2395
|
+
/**
|
|
2396
|
+
* Optional free-text search applied across tool fields.
|
|
2397
|
+
*/
|
|
2398
|
+
search?: string | null;
|
|
2399
|
+
/**
|
|
2400
|
+
* Optional exact-name filter.
|
|
2401
|
+
*/
|
|
2402
|
+
name?: string | null;
|
|
2403
|
+
/**
|
|
2404
|
+
* Optional filter limiting results to tools of a specific application.
|
|
2405
|
+
*/
|
|
2406
|
+
applicationSlug?: string | null;
|
|
2407
|
+
/**
|
|
2408
|
+
* Optional category filter.
|
|
2409
|
+
*/
|
|
2410
|
+
category?: string | null;
|
|
2411
|
+
/**
|
|
2412
|
+
* When true, returns only tools the caller can currently execute. Defaults to false.
|
|
2413
|
+
*/
|
|
2414
|
+
available?: boolean;
|
|
2415
|
+
/**
|
|
2416
|
+
* When true, includes deprecated tools in the results. Defaults to false.
|
|
2417
|
+
*/
|
|
2418
|
+
includeDeprecated?: boolean;
|
|
2419
|
+
/**
|
|
2420
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
2421
|
+
*/
|
|
2422
|
+
offset?: number;
|
|
2423
|
+
/**
|
|
2424
|
+
* Maximum number of items to return. Defaults to 100.
|
|
2425
|
+
*/
|
|
2426
|
+
top?: number;
|
|
2427
|
+
};
|
|
2428
|
+
url: '/v1/tools';
|
|
2429
|
+
};
|
|
2430
|
+
type ToolsListToolsErrors = {
|
|
2431
|
+
400: ErrorResponse;
|
|
2432
|
+
401: ErrorResponse;
|
|
2433
|
+
/**
|
|
2434
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2435
|
+
*/
|
|
2436
|
+
403: ErrorResponse;
|
|
2437
|
+
/**
|
|
2438
|
+
* Not found — the resource does not exist.
|
|
2439
|
+
*/
|
|
2440
|
+
404: ErrorResponse;
|
|
2441
|
+
/**
|
|
2442
|
+
* Too many requests — rate limit exceeded.
|
|
2443
|
+
*/
|
|
2444
|
+
429: ErrorResponse;
|
|
2445
|
+
/**
|
|
2446
|
+
* Internal server error — an unexpected error occurred.
|
|
2447
|
+
*/
|
|
2448
|
+
500: ErrorResponse;
|
|
2449
|
+
};
|
|
2450
|
+
type ToolsListToolsError = ToolsListToolsErrors[keyof ToolsListToolsErrors];
|
|
2451
|
+
type ToolsListToolsResponses = {
|
|
2452
|
+
/**
|
|
2453
|
+
* A paginated list of tools.
|
|
2454
|
+
*/
|
|
2455
|
+
200: PaginatedResponseOfToolDto;
|
|
2456
|
+
};
|
|
2457
|
+
type ToolsListToolsResponse = ToolsListToolsResponses[keyof ToolsListToolsResponses];
|
|
2458
|
+
type ToolsGetToolData = {
|
|
2459
|
+
body?: never;
|
|
2460
|
+
headers?: {
|
|
2461
|
+
/**
|
|
2462
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2463
|
+
*/
|
|
2464
|
+
companytoken?: string;
|
|
2465
|
+
};
|
|
2466
|
+
path: {
|
|
2467
|
+
/**
|
|
2468
|
+
* The slug identifying the tool to retrieve.
|
|
2469
|
+
*/
|
|
2470
|
+
toolSlug: string;
|
|
2471
|
+
};
|
|
2472
|
+
query?: {
|
|
2473
|
+
/**
|
|
2474
|
+
* Optional parent-application slug used to disambiguate when the same tool slug exists across applications.
|
|
2475
|
+
*/
|
|
2476
|
+
applicationSlug?: string | null;
|
|
2477
|
+
};
|
|
2478
|
+
url: '/v1/tools/{toolSlug}';
|
|
2479
|
+
};
|
|
2480
|
+
type ToolsGetToolErrors = {
|
|
2481
|
+
400: ErrorResponse;
|
|
2482
|
+
401: ErrorResponse;
|
|
2483
|
+
/**
|
|
2484
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2485
|
+
*/
|
|
2486
|
+
403: ErrorResponse;
|
|
2487
|
+
404: ErrorResponse;
|
|
2488
|
+
/**
|
|
2489
|
+
* Too many requests — rate limit exceeded.
|
|
2490
|
+
*/
|
|
2491
|
+
429: ErrorResponse;
|
|
2492
|
+
/**
|
|
2493
|
+
* Internal server error — an unexpected error occurred.
|
|
2494
|
+
*/
|
|
2495
|
+
500: ErrorResponse;
|
|
2496
|
+
};
|
|
2497
|
+
type ToolsGetToolError = ToolsGetToolErrors[keyof ToolsGetToolErrors];
|
|
2498
|
+
type ToolsGetToolResponses = {
|
|
2499
|
+
/**
|
|
2500
|
+
* The detailed representation of the tool.
|
|
2501
|
+
*/
|
|
2502
|
+
200: ToolDetailDto;
|
|
2503
|
+
};
|
|
2504
|
+
type ToolsGetToolResponse = ToolsGetToolResponses[keyof ToolsGetToolResponses];
|
|
2505
|
+
type ToolsExecuteToolData = {
|
|
2506
|
+
/**
|
|
2507
|
+
* The execution request containing the tool's input arguments.
|
|
2508
|
+
*/
|
|
2509
|
+
body: ToolExecuteRequest;
|
|
2510
|
+
headers?: {
|
|
2511
|
+
/**
|
|
2512
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2513
|
+
*/
|
|
2514
|
+
companytoken?: string;
|
|
2515
|
+
};
|
|
2516
|
+
path: {
|
|
2517
|
+
/**
|
|
2518
|
+
* The slug identifying the tool to execute.
|
|
2519
|
+
*/
|
|
2520
|
+
toolSlug: string;
|
|
2521
|
+
};
|
|
2522
|
+
query?: {
|
|
2523
|
+
/**
|
|
2524
|
+
* Optional parent-application slug used to disambiguate the tool and resolve the connection.
|
|
2525
|
+
*/
|
|
2526
|
+
applicationSlug?: string | null;
|
|
2527
|
+
/**
|
|
2528
|
+
* Optional toolset identifier used to scope connection resolution.
|
|
2529
|
+
*/
|
|
2530
|
+
toolsetId?: string | null;
|
|
2531
|
+
/**
|
|
2532
|
+
* Optional explicit connection identifier to use instead of the implicitly resolved connection.
|
|
2533
|
+
*/
|
|
2534
|
+
connectionId?: number | null;
|
|
2535
|
+
};
|
|
2536
|
+
url: '/v1/tools/{toolSlug}/execute';
|
|
2537
|
+
};
|
|
2538
|
+
type ToolsExecuteToolErrors = {
|
|
2539
|
+
400: ErrorResponse;
|
|
2540
|
+
401: ErrorResponse;
|
|
2541
|
+
403: ErrorResponse;
|
|
2542
|
+
404: ErrorResponse;
|
|
2543
|
+
409: ErrorResponse;
|
|
2544
|
+
/**
|
|
2545
|
+
* Too many requests — rate limit exceeded.
|
|
2546
|
+
*/
|
|
2547
|
+
429: ErrorResponse;
|
|
2548
|
+
/**
|
|
2549
|
+
* Internal server error — an unexpected error occurred.
|
|
2550
|
+
*/
|
|
2551
|
+
500: ErrorResponse;
|
|
2552
|
+
};
|
|
2553
|
+
type ToolsExecuteToolError = ToolsExecuteToolErrors[keyof ToolsExecuteToolErrors];
|
|
2554
|
+
type ToolsExecuteToolResponses = {
|
|
2555
|
+
/**
|
|
2556
|
+
* The tool execution result, including success status and any output.
|
|
2557
|
+
*/
|
|
2558
|
+
200: ToolExecuteResponse;
|
|
2559
|
+
};
|
|
2560
|
+
type ToolsExecuteToolResponse = ToolsExecuteToolResponses[keyof ToolsExecuteToolResponses];
|
|
2561
|
+
type ToolsetsListToolsetsData = {
|
|
2562
|
+
body?: never;
|
|
2563
|
+
headers?: {
|
|
2564
|
+
/**
|
|
2565
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2566
|
+
*/
|
|
2567
|
+
companytoken?: string;
|
|
2568
|
+
};
|
|
2569
|
+
path?: never;
|
|
2570
|
+
query?: {
|
|
2571
|
+
/**
|
|
2572
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
2573
|
+
*/
|
|
2574
|
+
offset?: number;
|
|
2575
|
+
/**
|
|
2576
|
+
* Maximum number of items to return (capped at 100). Defaults to 100.
|
|
2577
|
+
*/
|
|
2578
|
+
top?: number;
|
|
2579
|
+
};
|
|
2580
|
+
url: '/v1/toolsets';
|
|
2581
|
+
};
|
|
2582
|
+
type ToolsetsListToolsetsErrors = {
|
|
2583
|
+
/**
|
|
2584
|
+
* Bad request — malformed body or invalid parameters.
|
|
2585
|
+
*/
|
|
2586
|
+
400: ErrorResponse;
|
|
2587
|
+
/**
|
|
2588
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2589
|
+
*/
|
|
2590
|
+
401: ErrorResponse;
|
|
2591
|
+
/**
|
|
2592
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2593
|
+
*/
|
|
2594
|
+
403: ErrorResponse;
|
|
2595
|
+
/**
|
|
2596
|
+
* Not found — the resource does not exist.
|
|
2597
|
+
*/
|
|
2598
|
+
404: ErrorResponse;
|
|
2599
|
+
/**
|
|
2600
|
+
* Too many requests — rate limit exceeded.
|
|
2601
|
+
*/
|
|
2602
|
+
429: ErrorResponse;
|
|
2603
|
+
/**
|
|
2604
|
+
* Internal server error — an unexpected error occurred.
|
|
2605
|
+
*/
|
|
2606
|
+
500: ErrorResponse;
|
|
2607
|
+
};
|
|
2608
|
+
type ToolsetsListToolsetsError = ToolsetsListToolsetsErrors[keyof ToolsetsListToolsetsErrors];
|
|
2609
|
+
type ToolsetsListToolsetsResponses = {
|
|
2610
|
+
/**
|
|
2611
|
+
* A paginated list of toolsets.
|
|
2612
|
+
*/
|
|
2613
|
+
200: PaginatedResponseOfToolsetDto;
|
|
2614
|
+
};
|
|
2615
|
+
type ToolsetsListToolsetsResponse = ToolsetsListToolsetsResponses[keyof ToolsetsListToolsetsResponses];
|
|
2616
|
+
type ToolsetsCreateToolsetData = {
|
|
2617
|
+
/**
|
|
2618
|
+
* The toolset creation payload.
|
|
2619
|
+
*/
|
|
2620
|
+
body: CreateToolsetRequest;
|
|
2621
|
+
headers?: {
|
|
2622
|
+
/**
|
|
2623
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2624
|
+
*/
|
|
2625
|
+
companytoken?: string;
|
|
2626
|
+
};
|
|
2627
|
+
path?: never;
|
|
2628
|
+
query?: never;
|
|
2629
|
+
url: '/v1/toolsets';
|
|
2630
|
+
};
|
|
2631
|
+
type ToolsetsCreateToolsetErrors = {
|
|
2632
|
+
/**
|
|
2633
|
+
* Bad request — malformed body or invalid parameters.
|
|
2634
|
+
*/
|
|
2635
|
+
400: ErrorResponse;
|
|
2636
|
+
/**
|
|
2637
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2638
|
+
*/
|
|
2639
|
+
401: ErrorResponse;
|
|
2640
|
+
/**
|
|
2641
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2642
|
+
*/
|
|
2643
|
+
403: ErrorResponse;
|
|
2644
|
+
/**
|
|
2645
|
+
* Not found — the resource does not exist.
|
|
2646
|
+
*/
|
|
2647
|
+
404: ErrorResponse;
|
|
2648
|
+
/**
|
|
2649
|
+
* Too many requests — rate limit exceeded.
|
|
2650
|
+
*/
|
|
2651
|
+
429: ErrorResponse;
|
|
2652
|
+
/**
|
|
2653
|
+
* Internal server error — an unexpected error occurred.
|
|
2654
|
+
*/
|
|
2655
|
+
500: ErrorResponse;
|
|
2656
|
+
};
|
|
2657
|
+
type ToolsetsCreateToolsetError = ToolsetsCreateToolsetErrors[keyof ToolsetsCreateToolsetErrors];
|
|
2658
|
+
type ToolsetsCreateToolsetResponses = {
|
|
2659
|
+
/**
|
|
2660
|
+
* The newly created toolset.
|
|
2661
|
+
*/
|
|
2662
|
+
200: ToolsetDto;
|
|
2663
|
+
};
|
|
2664
|
+
type ToolsetsCreateToolsetResponse = ToolsetsCreateToolsetResponses[keyof ToolsetsCreateToolsetResponses];
|
|
2665
|
+
type ToolsetsDeleteToolsetData = {
|
|
2666
|
+
body?: never;
|
|
2667
|
+
headers?: {
|
|
2668
|
+
/**
|
|
2669
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2670
|
+
*/
|
|
2671
|
+
companytoken?: string;
|
|
2672
|
+
};
|
|
2673
|
+
path: {
|
|
2674
|
+
/**
|
|
2675
|
+
* The identifier of the toolset to delete.
|
|
2676
|
+
*/
|
|
2677
|
+
toolsetId: string;
|
|
2678
|
+
};
|
|
2679
|
+
query?: never;
|
|
2680
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
2681
|
+
};
|
|
2682
|
+
type ToolsetsDeleteToolsetErrors = {
|
|
2683
|
+
/**
|
|
2684
|
+
* Bad request — malformed body or invalid parameters.
|
|
2685
|
+
*/
|
|
2686
|
+
400: ErrorResponse;
|
|
2687
|
+
/**
|
|
2688
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2689
|
+
*/
|
|
2690
|
+
401: ErrorResponse;
|
|
2691
|
+
/**
|
|
2692
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2693
|
+
*/
|
|
2694
|
+
403: ErrorResponse;
|
|
2695
|
+
/**
|
|
2696
|
+
* Not found — the resource does not exist.
|
|
2697
|
+
*/
|
|
2698
|
+
404: ErrorResponse;
|
|
2699
|
+
/**
|
|
2700
|
+
* Too many requests — rate limit exceeded.
|
|
2701
|
+
*/
|
|
2702
|
+
429: ErrorResponse;
|
|
2703
|
+
/**
|
|
2704
|
+
* Internal server error — an unexpected error occurred.
|
|
2705
|
+
*/
|
|
2706
|
+
500: ErrorResponse;
|
|
2707
|
+
};
|
|
2708
|
+
type ToolsetsDeleteToolsetError = ToolsetsDeleteToolsetErrors[keyof ToolsetsDeleteToolsetErrors];
|
|
2709
|
+
type ToolsetsDeleteToolsetResponses = {
|
|
2710
|
+
/**
|
|
2711
|
+
* No content when the toolset is deleted successfully.
|
|
2712
|
+
*/
|
|
2713
|
+
200: Blob | File;
|
|
2714
|
+
};
|
|
2715
|
+
type ToolsetsDeleteToolsetResponse = ToolsetsDeleteToolsetResponses[keyof ToolsetsDeleteToolsetResponses];
|
|
2716
|
+
type ToolsetsGetToolsetData = {
|
|
2717
|
+
body?: never;
|
|
2718
|
+
headers?: {
|
|
2719
|
+
/**
|
|
2720
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2721
|
+
*/
|
|
2722
|
+
companytoken?: string;
|
|
2723
|
+
};
|
|
2724
|
+
path: {
|
|
2725
|
+
/**
|
|
2726
|
+
* The identifier of the toolset to retrieve.
|
|
2727
|
+
*/
|
|
2728
|
+
toolsetId: string;
|
|
2729
|
+
};
|
|
2730
|
+
query?: never;
|
|
2731
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
2732
|
+
};
|
|
2733
|
+
type ToolsetsGetToolsetErrors = {
|
|
2734
|
+
/**
|
|
2735
|
+
* Bad request — malformed body or invalid parameters.
|
|
2736
|
+
*/
|
|
2737
|
+
400: ErrorResponse;
|
|
2738
|
+
/**
|
|
2739
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2740
|
+
*/
|
|
2741
|
+
401: ErrorResponse;
|
|
2742
|
+
/**
|
|
2743
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2744
|
+
*/
|
|
2745
|
+
403: ErrorResponse;
|
|
2746
|
+
/**
|
|
2747
|
+
* Not found — the resource does not exist.
|
|
2748
|
+
*/
|
|
2749
|
+
404: ErrorResponse;
|
|
2750
|
+
/**
|
|
2751
|
+
* Too many requests — rate limit exceeded.
|
|
2752
|
+
*/
|
|
2753
|
+
429: ErrorResponse;
|
|
2754
|
+
/**
|
|
2755
|
+
* Internal server error — an unexpected error occurred.
|
|
2756
|
+
*/
|
|
2757
|
+
500: ErrorResponse;
|
|
2758
|
+
};
|
|
2759
|
+
type ToolsetsGetToolsetError = ToolsetsGetToolsetErrors[keyof ToolsetsGetToolsetErrors];
|
|
2760
|
+
type ToolsetsGetToolsetResponses = {
|
|
2761
|
+
/**
|
|
2762
|
+
* The requested toolset.
|
|
2763
|
+
*/
|
|
2764
|
+
200: ToolsetDto;
|
|
2765
|
+
};
|
|
2766
|
+
type ToolsetsGetToolsetResponse = ToolsetsGetToolsetResponses[keyof ToolsetsGetToolsetResponses];
|
|
2767
|
+
type ToolsetsUpdateToolsetData = {
|
|
2768
|
+
/**
|
|
2769
|
+
* The fields to update on the toolset.
|
|
2770
|
+
*/
|
|
2771
|
+
body: UpdateToolsetRequest;
|
|
2772
|
+
headers?: {
|
|
2773
|
+
/**
|
|
2774
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2775
|
+
*/
|
|
2776
|
+
companytoken?: string;
|
|
2777
|
+
};
|
|
2778
|
+
path: {
|
|
2779
|
+
/**
|
|
2780
|
+
* The identifier of the toolset to update.
|
|
2781
|
+
*/
|
|
2782
|
+
toolsetId: string;
|
|
2783
|
+
};
|
|
2784
|
+
query?: never;
|
|
2785
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
2786
|
+
};
|
|
2787
|
+
type ToolsetsUpdateToolsetErrors = {
|
|
2788
|
+
/**
|
|
2789
|
+
* Bad request — malformed body or invalid parameters.
|
|
2790
|
+
*/
|
|
2791
|
+
400: ErrorResponse;
|
|
2792
|
+
/**
|
|
2793
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2794
|
+
*/
|
|
2795
|
+
401: ErrorResponse;
|
|
2796
|
+
/**
|
|
2797
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2798
|
+
*/
|
|
2799
|
+
403: ErrorResponse;
|
|
2800
|
+
/**
|
|
2801
|
+
* Not found — the resource does not exist.
|
|
2802
|
+
*/
|
|
2803
|
+
404: ErrorResponse;
|
|
2804
|
+
/**
|
|
2805
|
+
* Too many requests — rate limit exceeded.
|
|
2806
|
+
*/
|
|
2807
|
+
429: ErrorResponse;
|
|
2808
|
+
/**
|
|
2809
|
+
* Internal server error — an unexpected error occurred.
|
|
2810
|
+
*/
|
|
2811
|
+
500: ErrorResponse;
|
|
2812
|
+
};
|
|
2813
|
+
type ToolsetsUpdateToolsetError = ToolsetsUpdateToolsetErrors[keyof ToolsetsUpdateToolsetErrors];
|
|
2814
|
+
type ToolsetsUpdateToolsetResponses = {
|
|
2815
|
+
/**
|
|
2816
|
+
* The updated toolset.
|
|
2817
|
+
*/
|
|
2818
|
+
200: ToolsetDto;
|
|
2819
|
+
};
|
|
2820
|
+
type ToolsetsUpdateToolsetResponse = ToolsetsUpdateToolsetResponses[keyof ToolsetsUpdateToolsetResponses];
|
|
2821
|
+
|
|
2822
|
+
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
|
|
2823
|
+
/**
|
|
2824
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
2825
|
+
* individual options. This might be also useful if you want to implement a
|
|
2826
|
+
* custom client.
|
|
2827
|
+
*/
|
|
2828
|
+
client?: Client;
|
|
2829
|
+
/**
|
|
2830
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
2831
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
2832
|
+
*/
|
|
2833
|
+
meta?: Record<string, unknown>;
|
|
2834
|
+
};
|
|
2835
|
+
/**
|
|
2836
|
+
* Creates a new solution (Engini admin only). The request's build manifest is compiled into a
|
|
2837
|
+
* stored manifest, and the resulting solution is returned together with any build warnings.
|
|
2838
|
+
*/
|
|
2839
|
+
declare const solutionsCreateSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsCreateSolutionData, ThrowOnError>) => RequestResult<SolutionsCreateSolutionResponses, SolutionsCreateSolutionErrors, ThrowOnError>;
|
|
2840
|
+
/**
|
|
2841
|
+
* Archives the solution identified by its slug (Engini admin only), removing it from the published catalog.
|
|
2842
|
+
*/
|
|
2843
|
+
declare const solutionsArchiveSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsArchiveSolutionData, ThrowOnError>) => RequestResult<SolutionsArchiveSolutionResponses, SolutionsArchiveSolutionErrors, ThrowOnError>;
|
|
2844
|
+
/**
|
|
2845
|
+
* Updates an existing solution identified by its slug (Engini admin only). When a build manifest
|
|
2846
|
+
* is supplied, the manifest is rebuilt and persisted; otherwise only the solution metadata is updated.
|
|
2847
|
+
*/
|
|
2848
|
+
declare const solutionsUpdateSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsUpdateSolutionData, ThrowOnError>) => RequestResult<SolutionsUpdateSolutionResponses, SolutionsUpdateSolutionErrors, ThrowOnError>;
|
|
2849
|
+
/**
|
|
2850
|
+
* Publishes the solution identified by its slug (Engini admin only), making it available in the public catalog.
|
|
2851
|
+
*/
|
|
2852
|
+
declare const solutionsPublishSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsPublishSolutionData, ThrowOnError>) => RequestResult<SolutionsPublishSolutionResponses, SolutionsPublishSolutionErrors, ThrowOnError>;
|
|
2853
|
+
/**
|
|
2854
|
+
* Builds a solution manifest from the supplied workflows, tables, and connections (Engini admin only).
|
|
2855
|
+
* When a slug is provided, the freshly built manifest is also persisted onto the existing solution,
|
|
2856
|
+
* bumping its manifest version and notifying installations.
|
|
2857
|
+
*/
|
|
2858
|
+
declare const solutionsBuildManifest: <ThrowOnError extends boolean = false>(options: Options<SolutionsBuildManifestData, ThrowOnError>) => RequestResult<SolutionsBuildManifestResponses, SolutionsBuildManifestErrors, ThrowOnError>;
|
|
2859
|
+
/**
|
|
2860
|
+
* Returns a paginated list of published solutions from the public catalog.
|
|
2861
|
+
*/
|
|
2862
|
+
declare const solutionsGetPublishedSolutions: <ThrowOnError extends boolean = false>(options?: Options<SolutionsGetPublishedSolutionsData, ThrowOnError>) => RequestResult<SolutionsGetPublishedSolutionsResponses, SolutionsGetPublishedSolutionsErrors, ThrowOnError>;
|
|
2863
|
+
/**
|
|
2864
|
+
* Returns the detail of a single published solution identified by its slug.
|
|
2865
|
+
*/
|
|
2866
|
+
declare const solutionsGetSolutionBySlug: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetSolutionBySlugData, ThrowOnError>) => RequestResult<SolutionsGetSolutionBySlugResponses, SolutionsGetSolutionBySlugErrors, ThrowOnError>;
|
|
2867
|
+
/**
|
|
2868
|
+
* Returns the solution installations belonging to the calling account, optionally filtered by
|
|
2869
|
+
* solution slug and installation status.
|
|
2870
|
+
*/
|
|
2871
|
+
declare const solutionsGetInstallations: <ThrowOnError extends boolean = false>(options?: Options<SolutionsGetInstallationsData, ThrowOnError>) => RequestResult<SolutionsGetInstallationsResponses, SolutionsGetInstallationsErrors, ThrowOnError>;
|
|
2872
|
+
/**
|
|
2873
|
+
* Returns the detail of a single installation belonging to the calling account.
|
|
2874
|
+
*/
|
|
2875
|
+
declare const solutionsGetInstallationDetail: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetInstallationDetailData, ThrowOnError>) => RequestResult<SolutionsGetInstallationDetailResponses, SolutionsGetInstallationDetailErrors, ThrowOnError>;
|
|
2876
|
+
/**
|
|
2877
|
+
* Returns the provisioned resources for a given installation belonging to the calling account,
|
|
2878
|
+
* optionally filtered by resource key and resource type.
|
|
2879
|
+
*/
|
|
2880
|
+
declare const solutionsGetInstallationResources: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetInstallationResourcesData, ThrowOnError>) => RequestResult<SolutionsGetInstallationResourcesResponses, SolutionsGetInstallationResourcesErrors, ThrowOnError>;
|
|
2881
|
+
/**
|
|
2882
|
+
* Installs the solution identified by its slug into the calling account's workspace, provisioning
|
|
2883
|
+
* the solution's resources. This endpoint is rate limited.
|
|
2884
|
+
*/
|
|
2885
|
+
declare const solutionsInstallSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsInstallSolutionData, ThrowOnError>) => RequestResult<SolutionsInstallSolutionResponses, SolutionsInstallSolutionErrors, ThrowOnError>;
|
|
2886
|
+
/**
|
|
2887
|
+
* Updates an existing installation to the latest solution manifest version, re-provisioning resources
|
|
2888
|
+
* as needed. Returns a 409 with the blocking conditions when the update is blocked and not forced.
|
|
2889
|
+
* This endpoint is rate limited.
|
|
2890
|
+
*/
|
|
2891
|
+
declare const solutionsUpdateInstallation: <ThrowOnError extends boolean = false>(options: Options<SolutionsUpdateInstallationData, ThrowOnError>) => RequestResult<SolutionsUpdateInstallationResponses, SolutionsUpdateInstallationErrors, ThrowOnError>;
|
|
2892
|
+
/**
|
|
2893
|
+
* Uninstalls a solution installation from the calling account's workspace, optionally deleting the
|
|
2894
|
+
* associated connections, workflows, and tables. This endpoint is rate limited.
|
|
2895
|
+
*/
|
|
2896
|
+
declare const solutionsUninstallSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsUninstallSolutionData, ThrowOnError>) => RequestResult<SolutionsUninstallSolutionResponses, SolutionsUninstallSolutionErrors, ThrowOnError>;
|
|
2897
|
+
/**
|
|
2898
|
+
* List the applications available to the caller, with optional filtering and pagination.
|
|
2899
|
+
*/
|
|
2900
|
+
declare const applicationsListApplications: <ThrowOnError extends boolean = false>(options?: Options<ApplicationsListApplicationsData, ThrowOnError>) => RequestResult<ApplicationsListApplicationsResponses, ApplicationsListApplicationsErrors, ThrowOnError>;
|
|
2901
|
+
/**
|
|
2902
|
+
* Get the full details of a single application identified by its slug.
|
|
2903
|
+
*/
|
|
2904
|
+
declare const applicationsGetApplication: <ThrowOnError extends boolean = false>(options: Options<ApplicationsGetApplicationData, ThrowOnError>) => RequestResult<ApplicationsGetApplicationResponses, ApplicationsGetApplicationErrors, ThrowOnError>;
|
|
2905
|
+
/**
|
|
2906
|
+
* List the connections available to the caller, with optional filtering and pagination.
|
|
2907
|
+
*/
|
|
2908
|
+
declare const connectionsGetConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionsResponses, ConnectionsGetConnectionsErrors, ThrowOnError>;
|
|
2909
|
+
/**
|
|
2910
|
+
* Create a new connection for the caller.
|
|
2911
|
+
*/
|
|
2912
|
+
declare const connectionsCreateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCreateConnectionData, ThrowOnError>) => RequestResult<ConnectionsCreateConnectionResponses, ConnectionsCreateConnectionErrors, ThrowOnError>;
|
|
2913
|
+
/**
|
|
2914
|
+
* Delete a connection owned by the caller.
|
|
2915
|
+
*/
|
|
2916
|
+
declare const connectionsDeleteConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsDeleteConnectionData, ThrowOnError>) => RequestResult<ConnectionsDeleteConnectionResponses, ConnectionsDeleteConnectionErrors, ThrowOnError>;
|
|
2917
|
+
/**
|
|
2918
|
+
* Get the full details of a single connection identified by its id.
|
|
2919
|
+
*/
|
|
2920
|
+
declare const connectionsGetConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionResponses, ConnectionsGetConnectionErrors, ThrowOnError>;
|
|
2921
|
+
/**
|
|
2922
|
+
* Update an existing connection owned by the caller.
|
|
2923
|
+
*/
|
|
2924
|
+
declare const connectionsUpdateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsUpdateConnectionData, ThrowOnError>) => RequestResult<ConnectionsUpdateConnectionResponses, ConnectionsUpdateConnectionErrors, ThrowOnError>;
|
|
2925
|
+
/**
|
|
2926
|
+
* List the caller's default connections, one per application where a default is set.
|
|
2927
|
+
*/
|
|
2928
|
+
declare const connectionsGetDefaultConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetDefaultConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetDefaultConnectionsResponses, ConnectionsGetDefaultConnectionsErrors, ThrowOnError>;
|
|
2929
|
+
/**
|
|
2930
|
+
* Clear the default designation for the given connection.
|
|
2931
|
+
*/
|
|
2932
|
+
declare const connectionsClearDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsClearDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsClearDefaultConnectionResponses, ConnectionsClearDefaultConnectionErrors, ThrowOnError>;
|
|
2933
|
+
/**
|
|
2934
|
+
* Set the given connection as the caller's default for its application.
|
|
2935
|
+
*/
|
|
2936
|
+
declare const connectionsSetDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSetDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsSetDefaultConnectionResponses, ConnectionsSetDefaultConnectionErrors, ThrowOnError>;
|
|
2937
|
+
/**
|
|
2938
|
+
* Replace one connection with another across the caller's usages.
|
|
2939
|
+
*/
|
|
2940
|
+
declare const connectionsReplaceConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsReplaceConnectionData, ThrowOnError>) => RequestResult<ConnectionsReplaceConnectionResponses, ConnectionsReplaceConnectionErrors, ThrowOnError>;
|
|
2941
|
+
/**
|
|
2942
|
+
* Trigger a refresh of the objects available through the given connection.
|
|
2943
|
+
*/
|
|
2944
|
+
declare const connectionsRefreshObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsRefreshObjectsData, ThrowOnError>) => RequestResult<ConnectionsRefreshObjectsResponses, ConnectionsRefreshObjectsErrors, ThrowOnError>;
|
|
2945
|
+
/**
|
|
2946
|
+
* Get the status of the most recent object refresh for the given connection.
|
|
2947
|
+
*/
|
|
2948
|
+
declare const connectionsGetRefreshStatus: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetRefreshStatusData, ThrowOnError>) => RequestResult<ConnectionsGetRefreshStatusResponses, ConnectionsGetRefreshStatusErrors, ThrowOnError>;
|
|
2949
|
+
/**
|
|
2950
|
+
* Select which objects from the given connection are active for the caller.
|
|
2951
|
+
*/
|
|
2952
|
+
declare const connectionsSelectObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSelectObjectsData, ThrowOnError>) => RequestResult<ConnectionsSelectObjectsResponses, ConnectionsSelectObjectsErrors, ThrowOnError>;
|
|
2953
|
+
/**
|
|
2954
|
+
* List the objects available through the given connection, with optional filtering, sorting, and pagination.
|
|
2955
|
+
*/
|
|
2956
|
+
declare const connectionsGetConnectionObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionObjectsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionObjectsResponses, ConnectionsGetConnectionObjectsErrors, ThrowOnError>;
|
|
2957
|
+
/**
|
|
2958
|
+
* Verify that the given connection is valid and currently usable.
|
|
2959
|
+
*/
|
|
2960
|
+
declare const connectionsCheckConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCheckConnectionData, ThrowOnError>) => RequestResult<ConnectionsCheckConnectionResponses, ConnectionsCheckConnectionErrors, ThrowOnError>;
|
|
2961
|
+
/**
|
|
2962
|
+
* Build an OAuth sign-in URL for an application so the caller can authorize a new connection.
|
|
2963
|
+
*/
|
|
2964
|
+
declare const connectionsGetSignInUrl: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetSignInUrlData, ThrowOnError>) => RequestResult<ConnectionsGetSignInUrlResponses, ConnectionsGetSignInUrlErrors, ThrowOnError>;
|
|
2965
|
+
/**
|
|
2966
|
+
* Retrieve the access token captured for a previously issued sign-in URL, identified by its state value.
|
|
2967
|
+
*/
|
|
2968
|
+
declare const connectionsGetAccessToken: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetAccessTokenData, ThrowOnError>) => RequestResult<ConnectionsGetAccessTokenResponses, ConnectionsGetAccessTokenErrors, ThrowOnError>;
|
|
2969
|
+
/**
|
|
2970
|
+
* List the tools available to the caller, with optional filtering and pagination.
|
|
2971
|
+
*/
|
|
2972
|
+
declare const toolsListTools: <ThrowOnError extends boolean = false>(options?: Options<ToolsListToolsData, ThrowOnError>) => RequestResult<ToolsListToolsResponses, ToolsListToolsErrors, ThrowOnError>;
|
|
2973
|
+
/**
|
|
2974
|
+
* Get the full details of a single tool identified by its slug.
|
|
2975
|
+
*/
|
|
2976
|
+
declare const toolsGetTool: <ThrowOnError extends boolean = false>(options: Options<ToolsGetToolData, ThrowOnError>) => RequestResult<ToolsGetToolResponses, ToolsGetToolErrors, ThrowOnError>;
|
|
2977
|
+
/**
|
|
2978
|
+
* Execute a tool. Connection is resolved implicitly from the caller's
|
|
2979
|
+
* account-user, the tool's parent application, and optional toolsetId.
|
|
2980
|
+
* Tool-runtime failures return 200 with isSuccess=false; all other failures
|
|
2981
|
+
* use the standard error envelope.
|
|
2982
|
+
*/
|
|
2983
|
+
declare const toolsExecuteTool: <ThrowOnError extends boolean = false>(options: Options<ToolsExecuteToolData, ThrowOnError>) => RequestResult<ToolsExecuteToolResponses, ToolsExecuteToolErrors, ThrowOnError>;
|
|
2984
|
+
/**
|
|
2985
|
+
* List the toolsets belonging to the caller, with pagination.
|
|
2986
|
+
*/
|
|
2987
|
+
declare const toolsetsListToolsets: <ThrowOnError extends boolean = false>(options?: Options<ToolsetsListToolsetsData, ThrowOnError>) => RequestResult<ToolsetsListToolsetsResponses, ToolsetsListToolsetsErrors, ThrowOnError>;
|
|
2988
|
+
/**
|
|
2989
|
+
* Create a new toolset for the caller.
|
|
2990
|
+
*/
|
|
2991
|
+
declare const toolsetsCreateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsCreateToolsetData, ThrowOnError>) => RequestResult<ToolsetsCreateToolsetResponses, ToolsetsCreateToolsetErrors, ThrowOnError>;
|
|
2992
|
+
/**
|
|
2993
|
+
* Delete a toolset owned by the caller.
|
|
2994
|
+
*/
|
|
2995
|
+
declare const toolsetsDeleteToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsDeleteToolsetData, ThrowOnError>) => RequestResult<ToolsetsDeleteToolsetResponses, ToolsetsDeleteToolsetErrors, ThrowOnError>;
|
|
2996
|
+
/**
|
|
2997
|
+
* Get a single toolset owned by the caller, identified by its id.
|
|
2998
|
+
*/
|
|
2999
|
+
declare const toolsetsGetToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsGetToolsetData, ThrowOnError>) => RequestResult<ToolsetsGetToolsetResponses, ToolsetsGetToolsetErrors, ThrowOnError>;
|
|
3000
|
+
/**
|
|
3001
|
+
* Update an existing toolset owned by the caller.
|
|
3002
|
+
*/
|
|
3003
|
+
declare const toolsetsUpdateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsUpdateToolsetData, ThrowOnError>) => RequestResult<ToolsetsUpdateToolsetResponses, ToolsetsUpdateToolsetErrors, ThrowOnError>;
|
|
3004
|
+
|
|
3005
|
+
/**
|
|
3006
|
+
* @engini/client — TypeScript REST client for the Engini Public API.
|
|
3007
|
+
*
|
|
3008
|
+
* The code under ./generated is produced by @hey-api/openapi-ts and committed.
|
|
3009
|
+
* DO NOT edit it by hand — regenerate via scripts/regen.sh. This file is the one
|
|
3010
|
+
* hand-written module in the package: it re-exports the generated SDK + types and
|
|
3011
|
+
* adds the Engini-named client factory.
|
|
3012
|
+
*/
|
|
3013
|
+
|
|
3014
|
+
interface EnginiClientOptions {
|
|
3015
|
+
/** API base URL. Requests append `/v1/...`. */
|
|
3016
|
+
baseUrl: string;
|
|
3017
|
+
/** Optional JWT. When set, bearer-secured operations send `Authorization: Bearer <token>`. */
|
|
3018
|
+
token?: string;
|
|
3019
|
+
}
|
|
3020
|
+
/**
|
|
3021
|
+
* Create a configured Engini API client to pass to the generated operation
|
|
3022
|
+
* functions, e.g. `await connectionsGetConnections({ client })`.
|
|
3023
|
+
*/
|
|
3024
|
+
declare function createEnginiClient(options: EnginiClientOptions): Client;
|
|
3025
|
+
|
|
3026
|
+
export { type AccessTokenResponse, type ActivityCondition, type ActivitySort, type AppConnectionFieldInputType, type ApplicationAuthMethod, type ApplicationConnectionField, type ApplicationDetailDto, type ApplicationDto, type ApplicationsGetApplicationData, type ApplicationsGetApplicationError, type ApplicationsGetApplicationErrors, type ApplicationsGetApplicationResponse, type ApplicationsGetApplicationResponses, type ApplicationsListApplicationsData, type ApplicationsListApplicationsError, type ApplicationsListApplicationsErrors, type ApplicationsListApplicationsResponse, type ApplicationsListApplicationsResponses, type BuildManifestRequest, type BuildManifestResponse, type BuildManifestTable, type BuildManifestWorkflow, type ClientOptions, type ConnectionInput, type ConnectionObject, type ConnectionPublicDetail, type ConnectionPublicListItem, type ConnectionsCheckConnectionData, type ConnectionsCheckConnectionError, type ConnectionsCheckConnectionErrors, type ConnectionsCheckConnectionResponse, type ConnectionsCheckConnectionResponses, type ConnectionsClearDefaultConnectionData, type ConnectionsClearDefaultConnectionError, type ConnectionsClearDefaultConnectionErrors, type ConnectionsClearDefaultConnectionResponse, type ConnectionsClearDefaultConnectionResponses, type ConnectionsCreateConnectionData, type ConnectionsCreateConnectionError, type ConnectionsCreateConnectionErrors, type ConnectionsCreateConnectionResponse, type ConnectionsCreateConnectionResponses, type ConnectionsDeleteConnectionData, type ConnectionsDeleteConnectionError, type ConnectionsDeleteConnectionErrors, type ConnectionsDeleteConnectionResponse, type ConnectionsDeleteConnectionResponses, type ConnectionsGetAccessTokenData, type ConnectionsGetAccessTokenError, type ConnectionsGetAccessTokenErrors, type ConnectionsGetAccessTokenResponse, type ConnectionsGetAccessTokenResponses, type ConnectionsGetConnectionData, type ConnectionsGetConnectionError, type ConnectionsGetConnectionErrors, type ConnectionsGetConnectionObjectsData, type ConnectionsGetConnectionObjectsError, type ConnectionsGetConnectionObjectsErrors, type ConnectionsGetConnectionObjectsResponse, type ConnectionsGetConnectionObjectsResponses, type ConnectionsGetConnectionResponse, type ConnectionsGetConnectionResponses, type ConnectionsGetConnectionsData, type ConnectionsGetConnectionsError, type ConnectionsGetConnectionsErrors, type ConnectionsGetConnectionsResponse, type ConnectionsGetConnectionsResponses, type ConnectionsGetDefaultConnectionsData, type ConnectionsGetDefaultConnectionsError, type ConnectionsGetDefaultConnectionsErrors, type ConnectionsGetDefaultConnectionsResponse, type ConnectionsGetDefaultConnectionsResponses, type ConnectionsGetRefreshStatusData, type ConnectionsGetRefreshStatusError, type ConnectionsGetRefreshStatusErrors, type ConnectionsGetRefreshStatusResponse, type ConnectionsGetRefreshStatusResponses, type ConnectionsGetSignInUrlData, type ConnectionsGetSignInUrlError, type ConnectionsGetSignInUrlErrors, type ConnectionsGetSignInUrlResponse, type ConnectionsGetSignInUrlResponses, type ConnectionsRefreshObjectsData, type ConnectionsRefreshObjectsError, type ConnectionsRefreshObjectsErrors, type ConnectionsRefreshObjectsResponse, type ConnectionsRefreshObjectsResponses, type ConnectionsReplaceConnectionData, type ConnectionsReplaceConnectionError, type ConnectionsReplaceConnectionErrors, type ConnectionsReplaceConnectionResponse, type ConnectionsReplaceConnectionResponses, type ConnectionsSelectObjectsData, type ConnectionsSelectObjectsError, type ConnectionsSelectObjectsErrors, type ConnectionsSelectObjectsResponse, type ConnectionsSelectObjectsResponses, type ConnectionsSetDefaultConnectionData, type ConnectionsSetDefaultConnectionError, type ConnectionsSetDefaultConnectionErrors, type ConnectionsSetDefaultConnectionResponse, type ConnectionsSetDefaultConnectionResponses, type ConnectionsUpdateConnectionData, type ConnectionsUpdateConnectionError, type ConnectionsUpdateConnectionErrors, type ConnectionsUpdateConnectionResponse, type ConnectionsUpdateConnectionResponses, type CreateConnectionRequest, type CreateSolutionRequest, type CreateToolsetRequest, type CustomConnectionDataItem, type DefaultConnectionDto, type DefaultConnectionsResponse, type EnginiClientOptions, type ErrorDetail, type ErrorResponse, type ExecutionInfo, type InstallSolutionRequest, type InstallSolutionResponse, type InstallationDetailResponse, type InstalledResourceResponse, type ManifestConnection, type ManifestConnectionDefaults, type ManifestTable, type ManifestWorkflow, type Options, type OrderDirection, type PaginatedResponseOfApplicationDto, type PaginatedResponseOfConnectionObject, type PaginatedResponseOfConnectionPublicListItem, type PaginatedResponseOfSolutionResponse, type PaginatedResponseOfToolDto, type PaginatedResponseOfToolsetDto, type ProvisionedResourceInfo, type RefreshStatus, type RefreshStatusResponse, type ReplaceConnectionRequest, type SelectObjectsRequest, type SetDefaultConnectionResponse, type SignInUrlRequest, type SignInUrlResponse, type SolutionAdminWriteResponse, type SolutionDetailResponse, type SolutionInstallationResponse, type SolutionManifest, type SolutionManifestBuildSpec, type SolutionResponse, type SolutionsArchiveSolutionData, type SolutionsArchiveSolutionError, type SolutionsArchiveSolutionErrors, type SolutionsArchiveSolutionResponse, type SolutionsArchiveSolutionResponses, type SolutionsBuildManifestData, type SolutionsBuildManifestError, type SolutionsBuildManifestErrors, type SolutionsBuildManifestResponse, type SolutionsBuildManifestResponses, type SolutionsCreateSolutionData, type SolutionsCreateSolutionError, type SolutionsCreateSolutionErrors, type SolutionsCreateSolutionResponse, type SolutionsCreateSolutionResponses, type SolutionsGetInstallationDetailData, type SolutionsGetInstallationDetailError, type SolutionsGetInstallationDetailErrors, type SolutionsGetInstallationDetailResponse, type SolutionsGetInstallationDetailResponses, type SolutionsGetInstallationResourcesData, type SolutionsGetInstallationResourcesError, type SolutionsGetInstallationResourcesErrors, type SolutionsGetInstallationResourcesResponse, type SolutionsGetInstallationResourcesResponses, type SolutionsGetInstallationsData, type SolutionsGetInstallationsError, type SolutionsGetInstallationsErrors, type SolutionsGetInstallationsResponse, type SolutionsGetInstallationsResponses, type SolutionsGetPublishedSolutionsData, type SolutionsGetPublishedSolutionsError, type SolutionsGetPublishedSolutionsErrors, type SolutionsGetPublishedSolutionsResponse, type SolutionsGetPublishedSolutionsResponses, type SolutionsGetSolutionBySlugData, type SolutionsGetSolutionBySlugError, type SolutionsGetSolutionBySlugErrors, type SolutionsGetSolutionBySlugResponse, type SolutionsGetSolutionBySlugResponses, type SolutionsInstallSolutionData, type SolutionsInstallSolutionError, type SolutionsInstallSolutionErrors, type SolutionsInstallSolutionResponse, type SolutionsInstallSolutionResponses, type SolutionsPublishSolutionData, type SolutionsPublishSolutionError, type SolutionsPublishSolutionErrors, type SolutionsPublishSolutionResponse, type SolutionsPublishSolutionResponses, type SolutionsUninstallSolutionData, type SolutionsUninstallSolutionError, type SolutionsUninstallSolutionErrors, type SolutionsUninstallSolutionResponse, type SolutionsUninstallSolutionResponses, type SolutionsUpdateInstallationData, type SolutionsUpdateInstallationError, type SolutionsUpdateInstallationErrors, type SolutionsUpdateInstallationResponse, type SolutionsUpdateInstallationResponses, type SolutionsUpdateSolutionData, type SolutionsUpdateSolutionError, type SolutionsUpdateSolutionErrors, type SolutionsUpdateSolutionResponse, type SolutionsUpdateSolutionResponses, type TableDefinitionDto, type TableFieldDto, type ToolDetailDto, type ToolDto, type ToolExecuteRequest, type ToolExecuteResponse, type ToolsExecuteToolData, type ToolsExecuteToolError, type ToolsExecuteToolErrors, type ToolsExecuteToolResponse, type ToolsExecuteToolResponses, type ToolsGetToolData, type ToolsGetToolError, type ToolsGetToolErrors, type ToolsGetToolResponse, type ToolsGetToolResponses, type ToolsListToolsData, type ToolsListToolsError, type ToolsListToolsErrors, type ToolsListToolsResponse, type ToolsListToolsResponses, type ToolsetConnectionDto, type ToolsetConnectionRequest, type ToolsetDto, type ToolsetsCreateToolsetData, type ToolsetsCreateToolsetError, type ToolsetsCreateToolsetErrors, type ToolsetsCreateToolsetResponse, type ToolsetsCreateToolsetResponses, type ToolsetsDeleteToolsetData, type ToolsetsDeleteToolsetError, type ToolsetsDeleteToolsetErrors, type ToolsetsDeleteToolsetResponse, type ToolsetsDeleteToolsetResponses, type ToolsetsGetToolsetData, type ToolsetsGetToolsetError, type ToolsetsGetToolsetErrors, type ToolsetsGetToolsetResponse, type ToolsetsGetToolsetResponses, type ToolsetsListToolsetsData, type ToolsetsListToolsetsError, type ToolsetsListToolsetsErrors, type ToolsetsListToolsetsResponse, type ToolsetsListToolsetsResponses, type ToolsetsUpdateToolsetData, type ToolsetsUpdateToolsetError, type ToolsetsUpdateToolsetErrors, type ToolsetsUpdateToolsetResponse, type ToolsetsUpdateToolsetResponses, type UninstallSolutionRequest, type UpdateBlockedResponse, type UpdateBlocker, type UpdateConnectionRequest, type UpdateInstallationRequest, type UpdateInstallationResponse, type UpdateSolutionRequest, type UpdateToolsetRequest, applicationsGetApplication, applicationsListApplications, connectionsCheckConnection, connectionsClearDefaultConnection, connectionsCreateConnection, connectionsDeleteConnection, connectionsGetAccessToken, connectionsGetConnection, connectionsGetConnectionObjects, connectionsGetConnections, connectionsGetDefaultConnections, connectionsGetRefreshStatus, connectionsGetSignInUrl, connectionsRefreshObjects, connectionsReplaceConnection, connectionsSelectObjects, connectionsSetDefaultConnection, connectionsUpdateConnection, createEnginiClient, solutionsArchiveSolution, solutionsBuildManifest, solutionsCreateSolution, solutionsGetInstallationDetail, solutionsGetInstallationResources, solutionsGetInstallations, solutionsGetPublishedSolutions, solutionsGetSolutionBySlug, solutionsInstallSolution, solutionsPublishSolution, solutionsUninstallSolution, solutionsUpdateInstallation, solutionsUpdateSolution, toolsExecuteTool, toolsGetTool, toolsListTools, toolsetsCreateToolset, toolsetsDeleteToolset, toolsetsGetToolset, toolsetsListToolsets, toolsetsUpdateToolset };
|