@engini/client 0.0.0 → 0.4.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 +1223 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +4137 -0
- package/dist/index.d.ts +4137 -0
- package/dist/index.js +1181 -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.cts
ADDED
|
@@ -0,0 +1,4137 @@
|
|
|
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
|
+
/**
|
|
326
|
+
* Identity of the principal a Developer API request is authenticated as, returned by
|
|
327
|
+
* GET /api/DeveloperAPI/v1/auth/whoami. For x-api-key requests the identity is the
|
|
328
|
+
* token's owner (the key acts as the owner) and UserType is "apiuser".
|
|
329
|
+
*/
|
|
330
|
+
type WhoAmIResponse = {
|
|
331
|
+
/**
|
|
332
|
+
* The acting user's full name.
|
|
333
|
+
*/
|
|
334
|
+
fullName?: string | null;
|
|
335
|
+
/**
|
|
336
|
+
* The acting user's email address.
|
|
337
|
+
*/
|
|
338
|
+
email?: string | null;
|
|
339
|
+
/**
|
|
340
|
+
* Display name of the account/company the request is scoped to.
|
|
341
|
+
*/
|
|
342
|
+
currentCompany?: string | null;
|
|
343
|
+
/**
|
|
344
|
+
* Role within the current company (e.g. "Admin", "Member").
|
|
345
|
+
*/
|
|
346
|
+
role?: string | null;
|
|
347
|
+
/**
|
|
348
|
+
* Caller type: "apiuser" (x-api-key), "anonymous" (deleted profile), or "user".
|
|
349
|
+
*/
|
|
350
|
+
userType: string;
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* Unified error envelope for every non-200 response from /api/DeveloperAPI/v1*.
|
|
354
|
+
* See applications-tools-spec.md §"Error envelope".
|
|
355
|
+
*/
|
|
356
|
+
type ErrorResponse = {
|
|
357
|
+
/**
|
|
358
|
+
* Machine-readable error code identifying the failure.
|
|
359
|
+
*/
|
|
360
|
+
errorCode: string;
|
|
361
|
+
/**
|
|
362
|
+
* Human-readable error message.
|
|
363
|
+
*/
|
|
364
|
+
message: string;
|
|
365
|
+
/**
|
|
366
|
+
* Identifier of the request, for support/correlation.
|
|
367
|
+
*/
|
|
368
|
+
requestId: string;
|
|
369
|
+
/**
|
|
370
|
+
* Timestamp when the error occurred (ISO 8601).
|
|
371
|
+
*/
|
|
372
|
+
timestamp: string;
|
|
373
|
+
/**
|
|
374
|
+
* Request path that produced the error.
|
|
375
|
+
*/
|
|
376
|
+
path: string;
|
|
377
|
+
/**
|
|
378
|
+
* Per-field validation details, when applicable.
|
|
379
|
+
*/
|
|
380
|
+
details?: Array<ErrorDetail> | null;
|
|
381
|
+
};
|
|
382
|
+
/**
|
|
383
|
+
* A single field-level error detail within an ErrorResponse.
|
|
384
|
+
*/
|
|
385
|
+
type ErrorDetail = {
|
|
386
|
+
/**
|
|
387
|
+
* Name of the field the issue relates to.
|
|
388
|
+
*/
|
|
389
|
+
field: string;
|
|
390
|
+
/**
|
|
391
|
+
* Description of the issue with the field.
|
|
392
|
+
*/
|
|
393
|
+
issue: string;
|
|
394
|
+
};
|
|
395
|
+
type SolutionAdminWriteResponse = {
|
|
396
|
+
/**
|
|
397
|
+
* The created or updated solution detail.
|
|
398
|
+
*/
|
|
399
|
+
solution: SolutionDetailResponse;
|
|
400
|
+
/**
|
|
401
|
+
* Warnings produced while building the manifest.
|
|
402
|
+
*/
|
|
403
|
+
warnings: Array<string>;
|
|
404
|
+
};
|
|
405
|
+
type SolutionDetailResponse = {
|
|
406
|
+
/**
|
|
407
|
+
* Identifier of the solution.
|
|
408
|
+
*/
|
|
409
|
+
solutionId: number;
|
|
410
|
+
/**
|
|
411
|
+
* Unique slug of the solution.
|
|
412
|
+
*/
|
|
413
|
+
slug: string;
|
|
414
|
+
/**
|
|
415
|
+
* Display name of the solution.
|
|
416
|
+
*/
|
|
417
|
+
name: string;
|
|
418
|
+
/**
|
|
419
|
+
* Description of the solution.
|
|
420
|
+
*/
|
|
421
|
+
description?: string | null;
|
|
422
|
+
/**
|
|
423
|
+
* URL of the solution's icon.
|
|
424
|
+
*/
|
|
425
|
+
iconUrl?: string | null;
|
|
426
|
+
/**
|
|
427
|
+
* Current status of the solution.
|
|
428
|
+
*/
|
|
429
|
+
status: string;
|
|
430
|
+
/**
|
|
431
|
+
* Current manifest version of the solution.
|
|
432
|
+
*/
|
|
433
|
+
manifestVersion: number;
|
|
434
|
+
/**
|
|
435
|
+
* Number of times the solution has been installed.
|
|
436
|
+
*/
|
|
437
|
+
installCount: number;
|
|
438
|
+
/**
|
|
439
|
+
* When the solution was created.
|
|
440
|
+
*/
|
|
441
|
+
createdDate: string;
|
|
442
|
+
/**
|
|
443
|
+
* When the solution was last updated; null if never updated.
|
|
444
|
+
*/
|
|
445
|
+
updatedDate?: string | null;
|
|
446
|
+
/**
|
|
447
|
+
* The serialized solution manifest JSON.
|
|
448
|
+
*/
|
|
449
|
+
manifest: string;
|
|
450
|
+
};
|
|
451
|
+
type CreateSolutionRequest = {
|
|
452
|
+
/**
|
|
453
|
+
* Unique slug identifying the new solution.
|
|
454
|
+
*/
|
|
455
|
+
slug: string;
|
|
456
|
+
/**
|
|
457
|
+
* Display name of the solution.
|
|
458
|
+
*/
|
|
459
|
+
name: string;
|
|
460
|
+
/**
|
|
461
|
+
* Optional description of the solution.
|
|
462
|
+
*/
|
|
463
|
+
description?: string | null;
|
|
464
|
+
/**
|
|
465
|
+
* Optional URL of the solution's icon.
|
|
466
|
+
*/
|
|
467
|
+
iconUrl?: string | null;
|
|
468
|
+
/**
|
|
469
|
+
* Build inputs used to generate the solution manifest.
|
|
470
|
+
*/
|
|
471
|
+
buildManifest: SolutionManifestBuildSpec;
|
|
472
|
+
};
|
|
473
|
+
type SolutionManifestBuildSpec = {
|
|
474
|
+
/**
|
|
475
|
+
* Workflows to include in the built manifest.
|
|
476
|
+
*/
|
|
477
|
+
workflows: Array<BuildManifestWorkflow>;
|
|
478
|
+
/**
|
|
479
|
+
* Tables to include in the built manifest.
|
|
480
|
+
*/
|
|
481
|
+
tables: Array<BuildManifestTable>;
|
|
482
|
+
/**
|
|
483
|
+
* Connections to include in the built manifest.
|
|
484
|
+
*/
|
|
485
|
+
connections: Array<ManifestConnection>;
|
|
486
|
+
/**
|
|
487
|
+
* Optional manifest version; defaults when null.
|
|
488
|
+
*/
|
|
489
|
+
version?: string | null;
|
|
490
|
+
};
|
|
491
|
+
type BuildManifestWorkflow = {
|
|
492
|
+
/**
|
|
493
|
+
* Identifier of the workflow to include.
|
|
494
|
+
*/
|
|
495
|
+
workflowId: number;
|
|
496
|
+
/**
|
|
497
|
+
* Manifest-local key to assign the workflow.
|
|
498
|
+
*/
|
|
499
|
+
key: string;
|
|
500
|
+
/**
|
|
501
|
+
* Optional display name for the workflow.
|
|
502
|
+
*/
|
|
503
|
+
name?: string | null;
|
|
504
|
+
/**
|
|
505
|
+
* Whether the workflow is triggered by an incoming webhook.
|
|
506
|
+
*/
|
|
507
|
+
isWebhookEntrypoint: boolean;
|
|
508
|
+
};
|
|
509
|
+
type BuildManifestTable = {
|
|
510
|
+
/**
|
|
511
|
+
* Identifier of the table to include.
|
|
512
|
+
*/
|
|
513
|
+
tableId: string;
|
|
514
|
+
/**
|
|
515
|
+
* Manifest-local key to assign the table.
|
|
516
|
+
*/
|
|
517
|
+
key: string;
|
|
518
|
+
};
|
|
519
|
+
/**
|
|
520
|
+
* A connection requirement declared by a solution manifest.
|
|
521
|
+
*/
|
|
522
|
+
type ManifestConnection = {
|
|
523
|
+
/**
|
|
524
|
+
* Manifest-local key used to reference this connection from workflows.
|
|
525
|
+
*/
|
|
526
|
+
key: string;
|
|
527
|
+
/**
|
|
528
|
+
* Identifier of the application this connection is for.
|
|
529
|
+
*/
|
|
530
|
+
applicationId: number;
|
|
531
|
+
/**
|
|
532
|
+
* Display label for the connection during install.
|
|
533
|
+
*/
|
|
534
|
+
label?: string | null;
|
|
535
|
+
/**
|
|
536
|
+
* Whether the connection must be supplied to install the solution.
|
|
537
|
+
*/
|
|
538
|
+
required: boolean;
|
|
539
|
+
/**
|
|
540
|
+
* Whether the connection requires a per-user token.
|
|
541
|
+
*/
|
|
542
|
+
requiresUserToken: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* Default configuration to seed the connection with.
|
|
545
|
+
*/
|
|
546
|
+
defaultConfig?: ManifestConnectionDefaults | null;
|
|
547
|
+
};
|
|
548
|
+
/**
|
|
549
|
+
* Default configuration values for a manifest connection.
|
|
550
|
+
*/
|
|
551
|
+
type ManifestConnectionDefaults = {
|
|
552
|
+
/**
|
|
553
|
+
* Default base URL for the connection.
|
|
554
|
+
*/
|
|
555
|
+
baseUrl?: string | null;
|
|
556
|
+
};
|
|
557
|
+
type UpdateSolutionRequest = {
|
|
558
|
+
/**
|
|
559
|
+
* New display name; null leaves it unchanged.
|
|
560
|
+
*/
|
|
561
|
+
name?: string | null;
|
|
562
|
+
/**
|
|
563
|
+
* New description; null leaves it unchanged.
|
|
564
|
+
*/
|
|
565
|
+
description?: string | null;
|
|
566
|
+
/**
|
|
567
|
+
* New icon URL; null leaves it unchanged.
|
|
568
|
+
*/
|
|
569
|
+
iconUrl?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
* New build inputs to rebuild the manifest; null leaves it unchanged.
|
|
572
|
+
*/
|
|
573
|
+
buildManifest?: SolutionManifestBuildSpec | null;
|
|
574
|
+
};
|
|
575
|
+
type BuildManifestResponse = {
|
|
576
|
+
/**
|
|
577
|
+
* The built solution manifest.
|
|
578
|
+
*/
|
|
579
|
+
manifest: SolutionManifest;
|
|
580
|
+
/**
|
|
581
|
+
* Warnings produced while building the manifest.
|
|
582
|
+
*/
|
|
583
|
+
warnings: Array<string>;
|
|
584
|
+
/**
|
|
585
|
+
* Updated solution detail, populated only when a slug was supplied and the update succeeded.
|
|
586
|
+
*/
|
|
587
|
+
solution?: SolutionDetailResponse | null;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* The manifest describing the connections, tables, and workflows that make up a solution.
|
|
591
|
+
*/
|
|
592
|
+
type SolutionManifest = {
|
|
593
|
+
/**
|
|
594
|
+
* Manifest schema version.
|
|
595
|
+
*/
|
|
596
|
+
version: string;
|
|
597
|
+
/**
|
|
598
|
+
* Connections the solution requires.
|
|
599
|
+
*/
|
|
600
|
+
connections?: Array<ManifestConnection> | null;
|
|
601
|
+
/**
|
|
602
|
+
* Tables the solution provisions.
|
|
603
|
+
*/
|
|
604
|
+
tables?: Array<ManifestTable> | null;
|
|
605
|
+
/**
|
|
606
|
+
* Workflows the solution provisions.
|
|
607
|
+
*/
|
|
608
|
+
workflows?: Array<ManifestWorkflow> | null;
|
|
609
|
+
};
|
|
610
|
+
/**
|
|
611
|
+
* A table provisioned by a solution manifest.
|
|
612
|
+
*/
|
|
613
|
+
type ManifestTable = {
|
|
614
|
+
/**
|
|
615
|
+
* Manifest-local key used to reference this table.
|
|
616
|
+
*/
|
|
617
|
+
key: string;
|
|
618
|
+
/**
|
|
619
|
+
* Definition of the table to provision.
|
|
620
|
+
*/
|
|
621
|
+
definition: TableDefinitionDto;
|
|
622
|
+
};
|
|
623
|
+
/**
|
|
624
|
+
* Cross-service DTO describing a table to provision. Consumed by WorkappBackend's
|
|
625
|
+
* POST /api/v1/tables/provision endpoint when installing a solution.
|
|
626
|
+
*/
|
|
627
|
+
type TableDefinitionDto = {
|
|
628
|
+
/**
|
|
629
|
+
* Name of the table to provision.
|
|
630
|
+
*/
|
|
631
|
+
name: string;
|
|
632
|
+
/**
|
|
633
|
+
* Description of the table.
|
|
634
|
+
*/
|
|
635
|
+
description?: string | null;
|
|
636
|
+
/**
|
|
637
|
+
* Fields (columns) that make up the table.
|
|
638
|
+
*/
|
|
639
|
+
fields: Array<TableFieldDto>;
|
|
640
|
+
};
|
|
641
|
+
/**
|
|
642
|
+
* Definition of a single field (column) within a TableDefinitionDto.
|
|
643
|
+
*/
|
|
644
|
+
type TableFieldDto = {
|
|
645
|
+
/**
|
|
646
|
+
* Logical name of the field.
|
|
647
|
+
*/
|
|
648
|
+
fieldName: string;
|
|
649
|
+
/**
|
|
650
|
+
* Matches Engini.Models.WorkappModels.DbModels.FieldTypeEnum
|
|
651
|
+
* (String=2, Bool=3, DateTime=5, Integer=6, Numeric=7, Dropdown=10, ...).
|
|
652
|
+
*/
|
|
653
|
+
fieldTypeId: number;
|
|
654
|
+
/**
|
|
655
|
+
* Display name shown for the field.
|
|
656
|
+
*/
|
|
657
|
+
displayName?: string | null;
|
|
658
|
+
/**
|
|
659
|
+
* Default value for the field.
|
|
660
|
+
*/
|
|
661
|
+
defaultValue?: string | null;
|
|
662
|
+
/**
|
|
663
|
+
* Ordinal position of the field within the table.
|
|
664
|
+
*/
|
|
665
|
+
fieldOrder: number;
|
|
666
|
+
/**
|
|
667
|
+
* Whether the field is the table's primary key.
|
|
668
|
+
*/
|
|
669
|
+
isPrimaryKey: boolean;
|
|
670
|
+
/**
|
|
671
|
+
* Whether the field is required.
|
|
672
|
+
*/
|
|
673
|
+
isMandatory: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* Whether the field is hidden from default views.
|
|
676
|
+
*/
|
|
677
|
+
isHidden: boolean;
|
|
678
|
+
/**
|
|
679
|
+
* Whether the field allows selecting multiple values.
|
|
680
|
+
*/
|
|
681
|
+
isMultiSelect: boolean;
|
|
682
|
+
/**
|
|
683
|
+
* JSON-serialized picklist values for Dropdown/Status/Labels field types.
|
|
684
|
+
* Shape matches TableFieldPicklist.
|
|
685
|
+
*/
|
|
686
|
+
picklistJson?: string | null;
|
|
687
|
+
/**
|
|
688
|
+
* Physical column name in storage. When omitted on provisioning, falls back to FieldName.
|
|
689
|
+
*/
|
|
690
|
+
databaseFieldName?: string | null;
|
|
691
|
+
/**
|
|
692
|
+
* Physical storage table name when the field is stored outside the default per-table layout.
|
|
693
|
+
*/
|
|
694
|
+
databaseFieldLocationTable?: string | null;
|
|
695
|
+
};
|
|
696
|
+
/**
|
|
697
|
+
* A workflow provisioned by a solution manifest.
|
|
698
|
+
*/
|
|
699
|
+
type ManifestWorkflow = {
|
|
700
|
+
/**
|
|
701
|
+
* Manifest-local key used to reference this workflow.
|
|
702
|
+
*/
|
|
703
|
+
key: string;
|
|
704
|
+
/**
|
|
705
|
+
* Display name of the workflow.
|
|
706
|
+
*/
|
|
707
|
+
name?: string | null;
|
|
708
|
+
/**
|
|
709
|
+
* The serialized workflow definition as an opaque JSON object. The internal shape is the
|
|
710
|
+
* engine's workflow graph and is not part of the public contract, so it is left untyped
|
|
711
|
+
* (api-spec-feedback.md C3) — treat it as an opaque blob to round-trip during install.
|
|
712
|
+
*/
|
|
713
|
+
definition?: unknown;
|
|
714
|
+
/**
|
|
715
|
+
* Maps the workflow's connection references to manifest connection keys.
|
|
716
|
+
*/
|
|
717
|
+
connectionMapping?: {
|
|
718
|
+
[key: string]: string;
|
|
719
|
+
} | null;
|
|
720
|
+
/**
|
|
721
|
+
* Whether this workflow is triggered by an incoming webhook.
|
|
722
|
+
*/
|
|
723
|
+
isWebhookEntrypoint: boolean;
|
|
724
|
+
};
|
|
725
|
+
type BuildManifestRequest = {
|
|
726
|
+
/**
|
|
727
|
+
* Workflows to include in the built manifest.
|
|
728
|
+
*/
|
|
729
|
+
workflows: Array<BuildManifestWorkflow>;
|
|
730
|
+
/**
|
|
731
|
+
* Tables to include in the built manifest.
|
|
732
|
+
*/
|
|
733
|
+
tables: Array<BuildManifestTable>;
|
|
734
|
+
/**
|
|
735
|
+
* Connections to include in the built manifest.
|
|
736
|
+
*/
|
|
737
|
+
connections: Array<ManifestConnection>;
|
|
738
|
+
/**
|
|
739
|
+
* Optional manifest version; defaults when null.
|
|
740
|
+
*/
|
|
741
|
+
version?: string | null;
|
|
742
|
+
/**
|
|
743
|
+
* When set, updates the existing solution with this slug after building the manifest; omit to build only.
|
|
744
|
+
*/
|
|
745
|
+
slug?: string | null;
|
|
746
|
+
};
|
|
747
|
+
/**
|
|
748
|
+
* Offset-based paginated wrapper for a list of items.
|
|
749
|
+
*/
|
|
750
|
+
type PaginatedResponseOfSolutionResponse = {
|
|
751
|
+
/**
|
|
752
|
+
* The items in the current page.
|
|
753
|
+
*/
|
|
754
|
+
items: Array<SolutionResponse>;
|
|
755
|
+
/**
|
|
756
|
+
* Total number of items available across all pages.
|
|
757
|
+
*/
|
|
758
|
+
totalCount: number;
|
|
759
|
+
/**
|
|
760
|
+
* Number of items skipped before this page (the requested offset).
|
|
761
|
+
*/
|
|
762
|
+
offset: number;
|
|
763
|
+
/**
|
|
764
|
+
* Maximum number of items requested for this page.
|
|
765
|
+
*/
|
|
766
|
+
top: number;
|
|
767
|
+
};
|
|
768
|
+
type SolutionResponse = {
|
|
769
|
+
/**
|
|
770
|
+
* Identifier of the solution.
|
|
771
|
+
*/
|
|
772
|
+
solutionId: number;
|
|
773
|
+
/**
|
|
774
|
+
* Unique slug of the solution.
|
|
775
|
+
*/
|
|
776
|
+
slug: string;
|
|
777
|
+
/**
|
|
778
|
+
* Display name of the solution.
|
|
779
|
+
*/
|
|
780
|
+
name: string;
|
|
781
|
+
/**
|
|
782
|
+
* Description of the solution.
|
|
783
|
+
*/
|
|
784
|
+
description?: string | null;
|
|
785
|
+
/**
|
|
786
|
+
* URL of the solution's icon.
|
|
787
|
+
*/
|
|
788
|
+
iconUrl?: string | null;
|
|
789
|
+
/**
|
|
790
|
+
* Current status of the solution.
|
|
791
|
+
*/
|
|
792
|
+
status: string;
|
|
793
|
+
/**
|
|
794
|
+
* Current manifest version of the solution.
|
|
795
|
+
*/
|
|
796
|
+
manifestVersion: number;
|
|
797
|
+
/**
|
|
798
|
+
* Number of times the solution has been installed.
|
|
799
|
+
*/
|
|
800
|
+
installCount: number;
|
|
801
|
+
/**
|
|
802
|
+
* When the solution was created.
|
|
803
|
+
*/
|
|
804
|
+
createdDate: string;
|
|
805
|
+
/**
|
|
806
|
+
* When the solution was last updated; null if never updated.
|
|
807
|
+
*/
|
|
808
|
+
updatedDate?: string | null;
|
|
809
|
+
};
|
|
810
|
+
type SolutionInstallationResponse = {
|
|
811
|
+
/**
|
|
812
|
+
* Identifier of the installation.
|
|
813
|
+
*/
|
|
814
|
+
solutionInstallationId: number;
|
|
815
|
+
/**
|
|
816
|
+
* Identifier of the installed solution.
|
|
817
|
+
*/
|
|
818
|
+
solutionId: number;
|
|
819
|
+
/**
|
|
820
|
+
* Display name of the installed solution.
|
|
821
|
+
*/
|
|
822
|
+
solutionName?: string | null;
|
|
823
|
+
/**
|
|
824
|
+
* Slug of the installed solution.
|
|
825
|
+
*/
|
|
826
|
+
slug?: string | null;
|
|
827
|
+
/**
|
|
828
|
+
* Workspace the solution is installed in.
|
|
829
|
+
*/
|
|
830
|
+
workspaceId: string;
|
|
831
|
+
/**
|
|
832
|
+
* Environment the solution is installed in.
|
|
833
|
+
*/
|
|
834
|
+
environmentId: string;
|
|
835
|
+
/**
|
|
836
|
+
* Manifest version that is currently installed.
|
|
837
|
+
*/
|
|
838
|
+
installedManifestVersion: number;
|
|
839
|
+
/**
|
|
840
|
+
* Whether the installation auto-updates to new versions.
|
|
841
|
+
*/
|
|
842
|
+
autoUpdate: boolean;
|
|
843
|
+
/**
|
|
844
|
+
* Whether a newer manifest version is available.
|
|
845
|
+
*/
|
|
846
|
+
updateAvailable: boolean;
|
|
847
|
+
/**
|
|
848
|
+
* Current status of the installation.
|
|
849
|
+
*/
|
|
850
|
+
status: string;
|
|
851
|
+
/**
|
|
852
|
+
* When the solution was installed.
|
|
853
|
+
*/
|
|
854
|
+
installedDate: string;
|
|
855
|
+
};
|
|
856
|
+
type InstallationDetailResponse = {
|
|
857
|
+
/**
|
|
858
|
+
* Identifier of the installation.
|
|
859
|
+
*/
|
|
860
|
+
solutionInstallationId: number;
|
|
861
|
+
/**
|
|
862
|
+
* Identifier of the installed solution.
|
|
863
|
+
*/
|
|
864
|
+
solutionId: number;
|
|
865
|
+
/**
|
|
866
|
+
* Display name of the installed solution.
|
|
867
|
+
*/
|
|
868
|
+
solutionName?: string | null;
|
|
869
|
+
/**
|
|
870
|
+
* Slug of the installed solution.
|
|
871
|
+
*/
|
|
872
|
+
slug?: string | null;
|
|
873
|
+
/**
|
|
874
|
+
* Workspace the solution is installed in.
|
|
875
|
+
*/
|
|
876
|
+
workspaceId: string;
|
|
877
|
+
/**
|
|
878
|
+
* Environment the solution is installed in.
|
|
879
|
+
*/
|
|
880
|
+
environmentId: string;
|
|
881
|
+
/**
|
|
882
|
+
* Manifest version that is currently installed.
|
|
883
|
+
*/
|
|
884
|
+
installedManifestVersion: number;
|
|
885
|
+
/**
|
|
886
|
+
* Whether the installation auto-updates to new versions.
|
|
887
|
+
*/
|
|
888
|
+
autoUpdate: boolean;
|
|
889
|
+
/**
|
|
890
|
+
* Whether a newer manifest version is available.
|
|
891
|
+
*/
|
|
892
|
+
updateAvailable: boolean;
|
|
893
|
+
/**
|
|
894
|
+
* Current status of the installation.
|
|
895
|
+
*/
|
|
896
|
+
status: string;
|
|
897
|
+
/**
|
|
898
|
+
* When the solution was installed.
|
|
899
|
+
*/
|
|
900
|
+
installedDate: string;
|
|
901
|
+
/**
|
|
902
|
+
* Resources provisioned by this installation.
|
|
903
|
+
*/
|
|
904
|
+
installedResources: Array<InstalledResourceResponse>;
|
|
905
|
+
};
|
|
906
|
+
type InstalledResourceResponse = {
|
|
907
|
+
/**
|
|
908
|
+
* Identifier of the installed resource record.
|
|
909
|
+
*/
|
|
910
|
+
installedResourceId: number;
|
|
911
|
+
/**
|
|
912
|
+
* Type of the provisioned resource (e.g. connection, table, workflow).
|
|
913
|
+
*/
|
|
914
|
+
resourceType: string;
|
|
915
|
+
/**
|
|
916
|
+
* Manifest-local key of the resource.
|
|
917
|
+
*/
|
|
918
|
+
resourceKey: string;
|
|
919
|
+
/**
|
|
920
|
+
* Identifier of the provisioned resource in the target system.
|
|
921
|
+
*/
|
|
922
|
+
resourceId: string;
|
|
923
|
+
/**
|
|
924
|
+
* Optional metadata about the resource.
|
|
925
|
+
*/
|
|
926
|
+
metadata?: string | null;
|
|
927
|
+
/**
|
|
928
|
+
* Webhook URL for the resource, when applicable.
|
|
929
|
+
*/
|
|
930
|
+
webhookUrl?: string | null;
|
|
931
|
+
};
|
|
932
|
+
type InstallSolutionResponse = {
|
|
933
|
+
/**
|
|
934
|
+
* Identifier of the created installation.
|
|
935
|
+
*/
|
|
936
|
+
installationId: number;
|
|
937
|
+
/**
|
|
938
|
+
* Resources provisioned during installation.
|
|
939
|
+
*/
|
|
940
|
+
resources: Array<ProvisionedResourceInfo>;
|
|
941
|
+
};
|
|
942
|
+
type ProvisionedResourceInfo = {
|
|
943
|
+
/**
|
|
944
|
+
* Type of the provisioned resource (e.g. connection, table, workflow).
|
|
945
|
+
*/
|
|
946
|
+
resourceType: string;
|
|
947
|
+
/**
|
|
948
|
+
* Manifest-local key of the resource.
|
|
949
|
+
*/
|
|
950
|
+
resourceKey: string;
|
|
951
|
+
/**
|
|
952
|
+
* Identifier of the provisioned resource in the target system.
|
|
953
|
+
*/
|
|
954
|
+
resourceId: string;
|
|
955
|
+
/**
|
|
956
|
+
* Webhook URL for the resource, when applicable.
|
|
957
|
+
*/
|
|
958
|
+
webhookUrl?: string | null;
|
|
959
|
+
/**
|
|
960
|
+
* Webhook token for the resource, when applicable.
|
|
961
|
+
*/
|
|
962
|
+
webhookToken?: string | null;
|
|
963
|
+
};
|
|
964
|
+
type InstallSolutionRequest = {
|
|
965
|
+
/**
|
|
966
|
+
* Workspace to install the solution into.
|
|
967
|
+
*/
|
|
968
|
+
workspaceId: string;
|
|
969
|
+
/**
|
|
970
|
+
* Environment to install the solution into.
|
|
971
|
+
*/
|
|
972
|
+
environmentId: string;
|
|
973
|
+
/**
|
|
974
|
+
* Maps manifest connection keys to existing connection IDs to reuse.
|
|
975
|
+
*/
|
|
976
|
+
existingConnections?: {
|
|
977
|
+
[key: string]: number;
|
|
978
|
+
} | null;
|
|
979
|
+
/**
|
|
980
|
+
* Maps manifest connection keys to new connection inputs to create.
|
|
981
|
+
*/
|
|
982
|
+
connectionMapping?: {
|
|
983
|
+
[key: string]: ConnectionInput;
|
|
984
|
+
} | null;
|
|
985
|
+
/**
|
|
986
|
+
* Whether the installation should auto-update to new versions.
|
|
987
|
+
*/
|
|
988
|
+
autoUpdate: boolean;
|
|
989
|
+
/**
|
|
990
|
+
* Optional external context passed through to provisioning.
|
|
991
|
+
*/
|
|
992
|
+
externalContext?: string | null;
|
|
993
|
+
};
|
|
994
|
+
type ConnectionInput = {
|
|
995
|
+
/**
|
|
996
|
+
* API key credential for the connection.
|
|
997
|
+
*/
|
|
998
|
+
apiKey?: string | null;
|
|
999
|
+
/**
|
|
1000
|
+
* Base URL for the connection.
|
|
1001
|
+
*/
|
|
1002
|
+
baseUrl?: string | null;
|
|
1003
|
+
/**
|
|
1004
|
+
* Additional custom credential/config values, keyed by name.
|
|
1005
|
+
*/
|
|
1006
|
+
customKeys?: {
|
|
1007
|
+
[key: string]: string;
|
|
1008
|
+
} | null;
|
|
1009
|
+
};
|
|
1010
|
+
type UpdateInstallationResponse = {
|
|
1011
|
+
/**
|
|
1012
|
+
* Identifier of the updated installation.
|
|
1013
|
+
*/
|
|
1014
|
+
installationId: number;
|
|
1015
|
+
/**
|
|
1016
|
+
* Manifest version before the update.
|
|
1017
|
+
*/
|
|
1018
|
+
fromVersion: number;
|
|
1019
|
+
/**
|
|
1020
|
+
* Manifest version after the update.
|
|
1021
|
+
*/
|
|
1022
|
+
toVersion: number;
|
|
1023
|
+
/**
|
|
1024
|
+
* Resources provisioned or updated during the update.
|
|
1025
|
+
*/
|
|
1026
|
+
resources: Array<ProvisionedResourceInfo>;
|
|
1027
|
+
/**
|
|
1028
|
+
* Webhook URLs that were invalidated by the update.
|
|
1029
|
+
*/
|
|
1030
|
+
brokenWebhookUrls: Array<string>;
|
|
1031
|
+
};
|
|
1032
|
+
type UpdateBlockedResponse = {
|
|
1033
|
+
/**
|
|
1034
|
+
* The blockers preventing the update.
|
|
1035
|
+
*/
|
|
1036
|
+
blockers: Array<UpdateBlocker>;
|
|
1037
|
+
};
|
|
1038
|
+
type UpdateBlocker = {
|
|
1039
|
+
/**
|
|
1040
|
+
* Type of resource that blocks the update.
|
|
1041
|
+
*/
|
|
1042
|
+
type: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* Manifest-local key of the blocking resource.
|
|
1045
|
+
*/
|
|
1046
|
+
key: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* Reason the resource blocks the update.
|
|
1049
|
+
*/
|
|
1050
|
+
reason: string;
|
|
1051
|
+
};
|
|
1052
|
+
type UpdateInstallationRequest = {
|
|
1053
|
+
/**
|
|
1054
|
+
* Whether to proceed with the update despite blockers/local modifications.
|
|
1055
|
+
*/
|
|
1056
|
+
forceModify: boolean;
|
|
1057
|
+
};
|
|
1058
|
+
type UninstallSolutionRequest = {
|
|
1059
|
+
/**
|
|
1060
|
+
* Identifier of the installation to uninstall.
|
|
1061
|
+
*/
|
|
1062
|
+
installationId: number;
|
|
1063
|
+
/**
|
|
1064
|
+
* Whether to also delete connections provisioned by the installation.
|
|
1065
|
+
*/
|
|
1066
|
+
deleteConnections: boolean;
|
|
1067
|
+
/**
|
|
1068
|
+
* Whether to also delete workflows provisioned by the installation.
|
|
1069
|
+
*/
|
|
1070
|
+
deleteWorkflows: boolean;
|
|
1071
|
+
/**
|
|
1072
|
+
* Whether to also delete tables provisioned by the installation.
|
|
1073
|
+
*/
|
|
1074
|
+
deleteTables: boolean;
|
|
1075
|
+
};
|
|
1076
|
+
/**
|
|
1077
|
+
* Offset-based paginated wrapper for a list of items.
|
|
1078
|
+
*/
|
|
1079
|
+
type PaginatedResponseOfApplicationDto = {
|
|
1080
|
+
/**
|
|
1081
|
+
* The items in the current page.
|
|
1082
|
+
*/
|
|
1083
|
+
items: Array<ApplicationDto>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Total number of items available across all pages.
|
|
1086
|
+
*/
|
|
1087
|
+
totalCount: number;
|
|
1088
|
+
/**
|
|
1089
|
+
* Number of items skipped before this page (the requested offset).
|
|
1090
|
+
*/
|
|
1091
|
+
offset: number;
|
|
1092
|
+
/**
|
|
1093
|
+
* Maximum number of items requested for this page.
|
|
1094
|
+
*/
|
|
1095
|
+
top: number;
|
|
1096
|
+
};
|
|
1097
|
+
/**
|
|
1098
|
+
* Public Developer API v1 representation of an Application.
|
|
1099
|
+
* Returned by GET /api/DeveloperAPI/v1/applications.
|
|
1100
|
+
*/
|
|
1101
|
+
type ApplicationDto = {
|
|
1102
|
+
/**
|
|
1103
|
+
* Stable public slug identifying the application.
|
|
1104
|
+
*/
|
|
1105
|
+
slug: string;
|
|
1106
|
+
/**
|
|
1107
|
+
* Human-readable display name of the application.
|
|
1108
|
+
*/
|
|
1109
|
+
applicationName?: string | null;
|
|
1110
|
+
/**
|
|
1111
|
+
* Description of what the application does.
|
|
1112
|
+
*/
|
|
1113
|
+
description: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* URL of the application's logo image.
|
|
1116
|
+
*/
|
|
1117
|
+
applicationLogo?: string | null;
|
|
1118
|
+
/**
|
|
1119
|
+
* Whether and how a connection is required to use this application.
|
|
1120
|
+
*/
|
|
1121
|
+
connectionRequirement: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* Categories the application belongs to.
|
|
1124
|
+
*/
|
|
1125
|
+
categories: Array<string>;
|
|
1126
|
+
/**
|
|
1127
|
+
* Number of tools (activities) the application exposes.
|
|
1128
|
+
*/
|
|
1129
|
+
toolsCount: number;
|
|
1130
|
+
/**
|
|
1131
|
+
* Number of triggers the application exposes.
|
|
1132
|
+
*/
|
|
1133
|
+
triggersCount: number;
|
|
1134
|
+
};
|
|
1135
|
+
type ApplicationDetailDto = ApplicationDto & {
|
|
1136
|
+
/**
|
|
1137
|
+
* Whether the application supports selecting specific objects for a connection.
|
|
1138
|
+
*/
|
|
1139
|
+
supportsObjectSelection?: boolean;
|
|
1140
|
+
/**
|
|
1141
|
+
* URL of help/documentation for the application.
|
|
1142
|
+
*/
|
|
1143
|
+
helpUrl?: string | null;
|
|
1144
|
+
/**
|
|
1145
|
+
* Authentication methods supported by the application.
|
|
1146
|
+
*/
|
|
1147
|
+
authenticationMethods?: Array<ApplicationAuthMethod>;
|
|
1148
|
+
};
|
|
1149
|
+
type ApplicationAuthMethod = {
|
|
1150
|
+
authenticationId: number;
|
|
1151
|
+
authenticationType: string;
|
|
1152
|
+
authenticationName: string;
|
|
1153
|
+
description?: string | null;
|
|
1154
|
+
connectionFields: Array<ApplicationConnectionField>;
|
|
1155
|
+
requiresOAuthSignIn: boolean;
|
|
1156
|
+
oAuthProvider?: string | null;
|
|
1157
|
+
};
|
|
1158
|
+
type ApplicationConnectionField = {
|
|
1159
|
+
fieldName: string;
|
|
1160
|
+
fieldDescription?: string | null;
|
|
1161
|
+
isRequired: boolean;
|
|
1162
|
+
isRequiredOnSignin: boolean;
|
|
1163
|
+
isHidden: boolean;
|
|
1164
|
+
isPassword: boolean;
|
|
1165
|
+
inputType: AppConnectionFieldInputType;
|
|
1166
|
+
defaultValue?: string | null;
|
|
1167
|
+
tooltip?: string | null;
|
|
1168
|
+
placeholder?: string | null;
|
|
1169
|
+
listValues?: string | null;
|
|
1170
|
+
/**
|
|
1171
|
+
* When true, callers can supply this field's value per-execution via the
|
|
1172
|
+
* `customConnectionData` array on POST /tools/{toolSlug}/execute. Mirrors
|
|
1173
|
+
* AppConnectionField.AllowOverride.
|
|
1174
|
+
*/
|
|
1175
|
+
allowOverride: boolean;
|
|
1176
|
+
};
|
|
1177
|
+
type AppConnectionFieldInputType = 0 | 1 | 2 | 3;
|
|
1178
|
+
/**
|
|
1179
|
+
* Offset-based paginated wrapper for a list of items.
|
|
1180
|
+
*/
|
|
1181
|
+
type PaginatedResponseOfConnectionPublicListItem = {
|
|
1182
|
+
/**
|
|
1183
|
+
* The items in the current page.
|
|
1184
|
+
*/
|
|
1185
|
+
items: Array<ConnectionPublicListItem>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Total number of items available across all pages.
|
|
1188
|
+
*/
|
|
1189
|
+
totalCount: number;
|
|
1190
|
+
/**
|
|
1191
|
+
* Number of items skipped before this page (the requested offset).
|
|
1192
|
+
*/
|
|
1193
|
+
offset: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* Maximum number of items requested for this page.
|
|
1196
|
+
*/
|
|
1197
|
+
top: number;
|
|
1198
|
+
};
|
|
1199
|
+
/**
|
|
1200
|
+
* Public-shape list item for /api/DeveloperAPI/v1/Connections.
|
|
1201
|
+
* Applications are identified by slug only (no ApplicationId in the wire response).
|
|
1202
|
+
* Internal queries continue to use ConnectionList which carries both.
|
|
1203
|
+
*/
|
|
1204
|
+
type ConnectionPublicListItem = {
|
|
1205
|
+
/**
|
|
1206
|
+
* Identifier of the connection.
|
|
1207
|
+
*/
|
|
1208
|
+
connectionId: number;
|
|
1209
|
+
/**
|
|
1210
|
+
* Display name of the connection.
|
|
1211
|
+
*/
|
|
1212
|
+
connectionName: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* Description of the connection.
|
|
1215
|
+
*/
|
|
1216
|
+
description?: string | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* Slug of the connection's application.
|
|
1219
|
+
*/
|
|
1220
|
+
applicationSlug: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* Display name of the connection's application.
|
|
1223
|
+
*/
|
|
1224
|
+
applicationName?: string | null;
|
|
1225
|
+
/**
|
|
1226
|
+
* URL of the application's logo image.
|
|
1227
|
+
*/
|
|
1228
|
+
applicationLogo?: string | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* Whether the connection is shared/public.
|
|
1231
|
+
*/
|
|
1232
|
+
isPublic: boolean;
|
|
1233
|
+
/**
|
|
1234
|
+
* Identifier of the user who created the connection.
|
|
1235
|
+
*/
|
|
1236
|
+
createdBy: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* When the connection was created.
|
|
1239
|
+
*/
|
|
1240
|
+
createdDate: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* Identifier of the user who last updated the connection; null if never updated.
|
|
1243
|
+
*/
|
|
1244
|
+
updatedBy?: string | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* When the connection was last updated; null if never updated.
|
|
1247
|
+
*/
|
|
1248
|
+
updatedDate?: string | null;
|
|
1249
|
+
};
|
|
1250
|
+
type ConnectionPublicDetail = ConnectionPublicListItem & {
|
|
1251
|
+
/**
|
|
1252
|
+
* Identifier of the authentication method used by the connection.
|
|
1253
|
+
*/
|
|
1254
|
+
authenticationId?: number;
|
|
1255
|
+
/**
|
|
1256
|
+
* Name of the authentication type used by the connection.
|
|
1257
|
+
*/
|
|
1258
|
+
authenticationType?: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* Connection field values, keyed by field name (sensitive values may be masked).
|
|
1261
|
+
*/
|
|
1262
|
+
fields?: {
|
|
1263
|
+
[key: string]: string | null;
|
|
1264
|
+
};
|
|
1265
|
+
/**
|
|
1266
|
+
* Whether the connection uses selected database objects.
|
|
1267
|
+
*/
|
|
1268
|
+
useSelectDBObjects?: boolean;
|
|
1269
|
+
/**
|
|
1270
|
+
* Last connection error message, if any.
|
|
1271
|
+
*/
|
|
1272
|
+
connectionError?: string | null;
|
|
1273
|
+
/**
|
|
1274
|
+
* Whether the connection is currently healthy/reachable.
|
|
1275
|
+
*/
|
|
1276
|
+
isAlive?: boolean;
|
|
1277
|
+
/**
|
|
1278
|
+
* Additional connection metadata, keyed by name.
|
|
1279
|
+
*/
|
|
1280
|
+
metadata?: {
|
|
1281
|
+
[key: string]: string;
|
|
1282
|
+
} | null;
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* Request body for creating a connection.
|
|
1286
|
+
*/
|
|
1287
|
+
type CreateConnectionRequest = {
|
|
1288
|
+
/**
|
|
1289
|
+
* Slug of the application to connect to.
|
|
1290
|
+
*/
|
|
1291
|
+
applicationSlug: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* Display name for the new connection.
|
|
1294
|
+
*/
|
|
1295
|
+
connectionName: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Optional description of the connection.
|
|
1298
|
+
*/
|
|
1299
|
+
description?: string | null;
|
|
1300
|
+
/**
|
|
1301
|
+
* Identifier of the authentication method to use.
|
|
1302
|
+
*/
|
|
1303
|
+
authenticationId: number;
|
|
1304
|
+
/**
|
|
1305
|
+
* Connection field values, keyed by field name.
|
|
1306
|
+
*/
|
|
1307
|
+
fields: {
|
|
1308
|
+
[key: string]: string;
|
|
1309
|
+
};
|
|
1310
|
+
/**
|
|
1311
|
+
* Optional additional connection metadata, keyed by name.
|
|
1312
|
+
*/
|
|
1313
|
+
metadata?: {
|
|
1314
|
+
[key: string]: string;
|
|
1315
|
+
} | null;
|
|
1316
|
+
};
|
|
1317
|
+
/**
|
|
1318
|
+
* Request body for updating a connection; null members are left unchanged.
|
|
1319
|
+
*/
|
|
1320
|
+
type UpdateConnectionRequest = {
|
|
1321
|
+
/**
|
|
1322
|
+
* New display name; null leaves it unchanged.
|
|
1323
|
+
*/
|
|
1324
|
+
connectionName?: string | null;
|
|
1325
|
+
/**
|
|
1326
|
+
* New description; null leaves it unchanged.
|
|
1327
|
+
*/
|
|
1328
|
+
description?: string | null;
|
|
1329
|
+
/**
|
|
1330
|
+
* Connection field values to update, keyed by field name; null leaves them unchanged.
|
|
1331
|
+
*/
|
|
1332
|
+
fields?: {
|
|
1333
|
+
[key: string]: string;
|
|
1334
|
+
} | null;
|
|
1335
|
+
/**
|
|
1336
|
+
* Metadata to update, keyed by name; null leaves it unchanged.
|
|
1337
|
+
*/
|
|
1338
|
+
metadata?: {
|
|
1339
|
+
[key: string]: string;
|
|
1340
|
+
} | null;
|
|
1341
|
+
};
|
|
1342
|
+
/**
|
|
1343
|
+
* Response listing the caller's default connection per application.
|
|
1344
|
+
*/
|
|
1345
|
+
type DefaultConnectionsResponse = {
|
|
1346
|
+
/**
|
|
1347
|
+
* The default-connection entries, one per application.
|
|
1348
|
+
*/
|
|
1349
|
+
items: Array<DefaultConnectionDto>;
|
|
1350
|
+
};
|
|
1351
|
+
/**
|
|
1352
|
+
* Per-(account-user, application) default-connection responses for the
|
|
1353
|
+
* /connections/defaults endpoints. See toolsets-and-connections-spec.md.
|
|
1354
|
+
*/
|
|
1355
|
+
type DefaultConnectionDto = {
|
|
1356
|
+
/**
|
|
1357
|
+
* Slug of the application this default applies to.
|
|
1358
|
+
*/
|
|
1359
|
+
applicationSlug: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* Display name of the application.
|
|
1362
|
+
*/
|
|
1363
|
+
applicationName?: string | null;
|
|
1364
|
+
/**
|
|
1365
|
+
* Identifier of the default connection (Connector ID).
|
|
1366
|
+
*/
|
|
1367
|
+
connectionId: number;
|
|
1368
|
+
/**
|
|
1369
|
+
* Display name of the default connection.
|
|
1370
|
+
*/
|
|
1371
|
+
connectionName?: string | null;
|
|
1372
|
+
};
|
|
1373
|
+
/**
|
|
1374
|
+
* Response confirming a connection was set as the default for an application.
|
|
1375
|
+
*/
|
|
1376
|
+
type SetDefaultConnectionResponse = {
|
|
1377
|
+
/**
|
|
1378
|
+
* Slug of the application the default was set for.
|
|
1379
|
+
*/
|
|
1380
|
+
applicationSlug: string;
|
|
1381
|
+
/**
|
|
1382
|
+
* Identifier of the connection set as default.
|
|
1383
|
+
*/
|
|
1384
|
+
connectionId: number;
|
|
1385
|
+
/**
|
|
1386
|
+
* Whether the connection is now the default (always true).
|
|
1387
|
+
*/
|
|
1388
|
+
isDefault: boolean;
|
|
1389
|
+
};
|
|
1390
|
+
/**
|
|
1391
|
+
* Request body for replacing a connection used by a workflow.
|
|
1392
|
+
*/
|
|
1393
|
+
type ReplaceConnectionRequest = {
|
|
1394
|
+
/**
|
|
1395
|
+
* Identifier of the workflow whose connection is being replaced.
|
|
1396
|
+
*/
|
|
1397
|
+
workflowId: number;
|
|
1398
|
+
/**
|
|
1399
|
+
* Identifier of the connection currently used by the workflow.
|
|
1400
|
+
*/
|
|
1401
|
+
originalConnectionId: number;
|
|
1402
|
+
/**
|
|
1403
|
+
* Identifier of the connection to use instead.
|
|
1404
|
+
*/
|
|
1405
|
+
newConnectionId: number;
|
|
1406
|
+
};
|
|
1407
|
+
/**
|
|
1408
|
+
* Status of a connection's most recent metadata/object refresh.
|
|
1409
|
+
*/
|
|
1410
|
+
type RefreshStatusResponse = {
|
|
1411
|
+
/**
|
|
1412
|
+
* Current refresh status.
|
|
1413
|
+
*/
|
|
1414
|
+
status: RefreshStatus;
|
|
1415
|
+
/**
|
|
1416
|
+
* Human-readable description of the current status.
|
|
1417
|
+
*/
|
|
1418
|
+
statusDescription?: string | null;
|
|
1419
|
+
/**
|
|
1420
|
+
* Error message from the last failed refresh, if any.
|
|
1421
|
+
*/
|
|
1422
|
+
error?: string | null;
|
|
1423
|
+
/**
|
|
1424
|
+
* When the last error occurred, if any.
|
|
1425
|
+
*/
|
|
1426
|
+
errorDate?: string | null;
|
|
1427
|
+
/**
|
|
1428
|
+
* When the connection was last refreshed successfully.
|
|
1429
|
+
*/
|
|
1430
|
+
lastRefreshDate?: string | null;
|
|
1431
|
+
};
|
|
1432
|
+
/**
|
|
1433
|
+
* Possible states of a connection refresh.
|
|
1434
|
+
*/
|
|
1435
|
+
type RefreshStatus = 0 | 1 | 2;
|
|
1436
|
+
/**
|
|
1437
|
+
* Request body for selecting which objects a connection exposes.
|
|
1438
|
+
*/
|
|
1439
|
+
type SelectObjectsRequest = {
|
|
1440
|
+
/**
|
|
1441
|
+
* Identifiers of the objects to select for the connection.
|
|
1442
|
+
*/
|
|
1443
|
+
objectIds: Array<number>;
|
|
1444
|
+
};
|
|
1445
|
+
/**
|
|
1446
|
+
* Offset-based paginated wrapper for a list of items.
|
|
1447
|
+
*/
|
|
1448
|
+
type PaginatedResponseOfConnectionObject = {
|
|
1449
|
+
/**
|
|
1450
|
+
* The items in the current page.
|
|
1451
|
+
*/
|
|
1452
|
+
items: Array<ConnectionObject>;
|
|
1453
|
+
/**
|
|
1454
|
+
* Total number of items available across all pages.
|
|
1455
|
+
*/
|
|
1456
|
+
totalCount: number;
|
|
1457
|
+
/**
|
|
1458
|
+
* Number of items skipped before this page (the requested offset).
|
|
1459
|
+
*/
|
|
1460
|
+
offset: number;
|
|
1461
|
+
/**
|
|
1462
|
+
* Maximum number of items requested for this page.
|
|
1463
|
+
*/
|
|
1464
|
+
top: number;
|
|
1465
|
+
};
|
|
1466
|
+
type ConnectionObject = {
|
|
1467
|
+
objectId: number;
|
|
1468
|
+
name: string;
|
|
1469
|
+
type: string;
|
|
1470
|
+
isSelected: boolean;
|
|
1471
|
+
};
|
|
1472
|
+
/**
|
|
1473
|
+
* Response containing a generated OAuth sign-in URL.
|
|
1474
|
+
*/
|
|
1475
|
+
type SignInUrlResponse = {
|
|
1476
|
+
/**
|
|
1477
|
+
* The URL the user should visit to authenticate.
|
|
1478
|
+
*/
|
|
1479
|
+
signInUrl: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* Opaque state value tying the sign-in flow back to the request.
|
|
1482
|
+
*/
|
|
1483
|
+
state: string;
|
|
1484
|
+
};
|
|
1485
|
+
/**
|
|
1486
|
+
* Request body for generating an OAuth sign-in URL.
|
|
1487
|
+
*/
|
|
1488
|
+
type SignInUrlRequest = {
|
|
1489
|
+
/**
|
|
1490
|
+
* Slug of the application to authenticate against.
|
|
1491
|
+
*/
|
|
1492
|
+
applicationSlug: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* Identifier of the authentication method to use.
|
|
1495
|
+
*/
|
|
1496
|
+
authenticationId: number;
|
|
1497
|
+
/**
|
|
1498
|
+
* Optional environment to target for sign-in.
|
|
1499
|
+
*/
|
|
1500
|
+
environment?: string | null;
|
|
1501
|
+
/**
|
|
1502
|
+
* Optional field values required to build the sign-in URL, keyed by field name.
|
|
1503
|
+
*/
|
|
1504
|
+
fields?: {
|
|
1505
|
+
[key: string]: string;
|
|
1506
|
+
} | null;
|
|
1507
|
+
};
|
|
1508
|
+
type AccessTokenResponse = {
|
|
1509
|
+
status: string;
|
|
1510
|
+
error_message?: string | null;
|
|
1511
|
+
tokenData: {
|
|
1512
|
+
[key: string]: unknown;
|
|
1513
|
+
};
|
|
1514
|
+
connectionData: {
|
|
1515
|
+
[key: string]: unknown;
|
|
1516
|
+
};
|
|
1517
|
+
};
|
|
1518
|
+
/**
|
|
1519
|
+
* Offset-based paginated wrapper for a list of items.
|
|
1520
|
+
*/
|
|
1521
|
+
type PaginatedResponseOfToolDto = {
|
|
1522
|
+
/**
|
|
1523
|
+
* The items in the current page.
|
|
1524
|
+
*/
|
|
1525
|
+
items: Array<ToolDto>;
|
|
1526
|
+
/**
|
|
1527
|
+
* Total number of items available across all pages.
|
|
1528
|
+
*/
|
|
1529
|
+
totalCount: number;
|
|
1530
|
+
/**
|
|
1531
|
+
* Number of items skipped before this page (the requested offset).
|
|
1532
|
+
*/
|
|
1533
|
+
offset: number;
|
|
1534
|
+
/**
|
|
1535
|
+
* Maximum number of items requested for this page.
|
|
1536
|
+
*/
|
|
1537
|
+
top: number;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* Public Developer API v1 representation of a tool (Activity).
|
|
1541
|
+
* Returned by GET /api/DeveloperAPI/v1/tools.
|
|
1542
|
+
*/
|
|
1543
|
+
type ToolDto = {
|
|
1544
|
+
/**
|
|
1545
|
+
* Public identifier, sourced from Activity.McpToolName.
|
|
1546
|
+
*/
|
|
1547
|
+
toolSlug: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* Human-readable display name of the tool.
|
|
1550
|
+
*/
|
|
1551
|
+
toolName?: string | null;
|
|
1552
|
+
/**
|
|
1553
|
+
* Description of what the tool does.
|
|
1554
|
+
*/
|
|
1555
|
+
description?: string | null;
|
|
1556
|
+
/**
|
|
1557
|
+
* Category the tool belongs to.
|
|
1558
|
+
*/
|
|
1559
|
+
category: string;
|
|
1560
|
+
/**
|
|
1561
|
+
* Slug of the application this tool belongs to.
|
|
1562
|
+
*/
|
|
1563
|
+
applicationSlug: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* Display name of the application this tool belongs to.
|
|
1566
|
+
*/
|
|
1567
|
+
applicationName?: string | null;
|
|
1568
|
+
/**
|
|
1569
|
+
* Version of the tool.
|
|
1570
|
+
*/
|
|
1571
|
+
version?: string | null;
|
|
1572
|
+
/**
|
|
1573
|
+
* Whether the tool is deprecated.
|
|
1574
|
+
*/
|
|
1575
|
+
isDeprecated: boolean;
|
|
1576
|
+
};
|
|
1577
|
+
type ToolDetailDto = ToolDto & {
|
|
1578
|
+
/**
|
|
1579
|
+
* JSON Schema describing the tool's input fields.
|
|
1580
|
+
*/
|
|
1581
|
+
inputSchema?: unknown;
|
|
1582
|
+
/**
|
|
1583
|
+
* JSON Schema describing the tool's output shape.
|
|
1584
|
+
*/
|
|
1585
|
+
outputSchema?: unknown;
|
|
1586
|
+
/**
|
|
1587
|
+
* Whether the tool supports filter conditions on execution.
|
|
1588
|
+
*/
|
|
1589
|
+
supportsFilters?: boolean;
|
|
1590
|
+
/**
|
|
1591
|
+
* Whether the tool supports sort ordering on execution.
|
|
1592
|
+
*/
|
|
1593
|
+
supportsSort?: boolean;
|
|
1594
|
+
/**
|
|
1595
|
+
* Whether the tool supports top/offset pagination on execution.
|
|
1596
|
+
*/
|
|
1597
|
+
supportsTopOffset?: boolean;
|
|
1598
|
+
/**
|
|
1599
|
+
* Maximum number of filter conditions allowed per execution.
|
|
1600
|
+
*/
|
|
1601
|
+
maxFilters?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Maximum number of sort clauses allowed per execution.
|
|
1604
|
+
*/
|
|
1605
|
+
maxSorts?: number;
|
|
1606
|
+
};
|
|
1607
|
+
/**
|
|
1608
|
+
* 200 response shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute.
|
|
1609
|
+
* Tool-runtime failures (downstream API errors) return 200 + IsSuccess=false
|
|
1610
|
+
* + ErrorMessage — not the standard error envelope. All non-200 responses use
|
|
1611
|
+
* the standard ErrorResponse envelope, not this type.
|
|
1612
|
+
* See applications-tools-spec.md §"Response 200".
|
|
1613
|
+
*/
|
|
1614
|
+
type ToolExecuteResponse = {
|
|
1615
|
+
/**
|
|
1616
|
+
* Whether the tool executed successfully. When false, see ErrorMessage.
|
|
1617
|
+
*/
|
|
1618
|
+
isSuccess: boolean;
|
|
1619
|
+
/**
|
|
1620
|
+
* Human-readable failure reason when IsSuccess is false; otherwise null.
|
|
1621
|
+
*/
|
|
1622
|
+
errorMessage?: string | null;
|
|
1623
|
+
/**
|
|
1624
|
+
* Metadata about the execution (HTTP status, headers, timing, payload size).
|
|
1625
|
+
*/
|
|
1626
|
+
executionInfo?: ExecutionInfo | null;
|
|
1627
|
+
/**
|
|
1628
|
+
* The tool's result payload. Intentionally free-form (any JSON): its shape is defined by the
|
|
1629
|
+
* individual tool's output schema, not by this envelope (api-spec-feedback.md C3).
|
|
1630
|
+
*/
|
|
1631
|
+
output?: unknown;
|
|
1632
|
+
/**
|
|
1633
|
+
* Identifier of the workflow-history record for this execution, when one was created.
|
|
1634
|
+
*/
|
|
1635
|
+
historyId?: number | null;
|
|
1636
|
+
};
|
|
1637
|
+
/**
|
|
1638
|
+
* Metadata about a tool execution (downstream HTTP status, headers, timing, payload size).
|
|
1639
|
+
*/
|
|
1640
|
+
type ExecutionInfo = {
|
|
1641
|
+
/**
|
|
1642
|
+
* HTTP status code returned by the downstream call.
|
|
1643
|
+
*/
|
|
1644
|
+
statusCode?: number | null;
|
|
1645
|
+
/**
|
|
1646
|
+
* Response headers from the downstream call, keyed by header name.
|
|
1647
|
+
*/
|
|
1648
|
+
headers?: {
|
|
1649
|
+
[key: string]: string;
|
|
1650
|
+
} | null;
|
|
1651
|
+
/**
|
|
1652
|
+
* Execution time in milliseconds.
|
|
1653
|
+
*/
|
|
1654
|
+
executionTime?: number | null;
|
|
1655
|
+
/**
|
|
1656
|
+
* Size of the response payload in bytes.
|
|
1657
|
+
*/
|
|
1658
|
+
dataSize?: number | null;
|
|
1659
|
+
};
|
|
1660
|
+
/**
|
|
1661
|
+
* Body shape for POST /api/DeveloperAPI/v1/tools/{toolSlug}/execute.
|
|
1662
|
+
* activityName is intentionally absent — the activity is resolved from the
|
|
1663
|
+
* path slug (+ optional ?applicationSlug=). Connection is resolved implicitly
|
|
1664
|
+
* from the caller's account-user, the tool's parent application, and the
|
|
1665
|
+
* optional ?toolsetId= query param. See applications-tools-spec.md §"POST
|
|
1666
|
+
* /api/DeveloperAPI/v1/tools/{toolSlug}/execute".
|
|
1667
|
+
*/
|
|
1668
|
+
type ToolExecuteRequest = {
|
|
1669
|
+
/**
|
|
1670
|
+
* Input field values for the tool, keyed by field name.
|
|
1671
|
+
*/
|
|
1672
|
+
fields?: {
|
|
1673
|
+
[key: string]: unknown;
|
|
1674
|
+
} | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Optional context value passed to the tool.
|
|
1677
|
+
*/
|
|
1678
|
+
contextValue?: string | null;
|
|
1679
|
+
/**
|
|
1680
|
+
* Filter conditions to apply to the tool's results.
|
|
1681
|
+
*/
|
|
1682
|
+
filters?: Array<ActivityCondition> | null;
|
|
1683
|
+
/**
|
|
1684
|
+
* Sort clauses to apply to the tool's results.
|
|
1685
|
+
*/
|
|
1686
|
+
sort?: Array<ActivitySort> | null;
|
|
1687
|
+
/**
|
|
1688
|
+
* Number of leading results to skip (pagination offset).
|
|
1689
|
+
*/
|
|
1690
|
+
offset?: number | null;
|
|
1691
|
+
/**
|
|
1692
|
+
* Maximum number of results to return.
|
|
1693
|
+
*/
|
|
1694
|
+
top?: number | null;
|
|
1695
|
+
/**
|
|
1696
|
+
* Sub-item input values for the tool, keyed by name.
|
|
1697
|
+
*/
|
|
1698
|
+
subItems?: {
|
|
1699
|
+
[key: string]: unknown;
|
|
1700
|
+
} | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Per-call overrides for the resolved connection's fields; only fields marked overridable are accepted.
|
|
1703
|
+
*/
|
|
1704
|
+
customConnectionData?: Array<CustomConnectionDataItem> | null;
|
|
1705
|
+
};
|
|
1706
|
+
type ActivityCondition = {
|
|
1707
|
+
fieldName: string;
|
|
1708
|
+
operator: string;
|
|
1709
|
+
value: string;
|
|
1710
|
+
};
|
|
1711
|
+
type ActivitySort = {
|
|
1712
|
+
fieldName: string;
|
|
1713
|
+
orderDirection: OrderDirection;
|
|
1714
|
+
};
|
|
1715
|
+
type OrderDirection = 1 | -1;
|
|
1716
|
+
/**
|
|
1717
|
+
* A single per-call override of a connection field value.
|
|
1718
|
+
*/
|
|
1719
|
+
type CustomConnectionDataItem = {
|
|
1720
|
+
/**
|
|
1721
|
+
* Name of the connection field to override.
|
|
1722
|
+
*/
|
|
1723
|
+
fieldName: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* Override value for the field.
|
|
1726
|
+
*/
|
|
1727
|
+
value: string;
|
|
1728
|
+
};
|
|
1729
|
+
/**
|
|
1730
|
+
* Offset-based paginated wrapper for a list of items.
|
|
1731
|
+
*/
|
|
1732
|
+
type PaginatedResponseOfToolsetDto = {
|
|
1733
|
+
/**
|
|
1734
|
+
* The items in the current page.
|
|
1735
|
+
*/
|
|
1736
|
+
items: Array<ToolsetDto>;
|
|
1737
|
+
/**
|
|
1738
|
+
* Total number of items available across all pages.
|
|
1739
|
+
*/
|
|
1740
|
+
totalCount: number;
|
|
1741
|
+
/**
|
|
1742
|
+
* Number of items skipped before this page (the requested offset).
|
|
1743
|
+
*/
|
|
1744
|
+
offset: number;
|
|
1745
|
+
/**
|
|
1746
|
+
* Maximum number of items requested for this page.
|
|
1747
|
+
*/
|
|
1748
|
+
top: number;
|
|
1749
|
+
};
|
|
1750
|
+
/**
|
|
1751
|
+
* Public-shape DTO for a toolset (per-account-user, named scope bundling specific
|
|
1752
|
+
* connections + an allowed tool set). See toolsets-and-connections-spec.md.
|
|
1753
|
+
*/
|
|
1754
|
+
type ToolsetDto = {
|
|
1755
|
+
/**
|
|
1756
|
+
* Unique identifier of the toolset (the MCPServer token GUID).
|
|
1757
|
+
*/
|
|
1758
|
+
toolsetId: string;
|
|
1759
|
+
/**
|
|
1760
|
+
* Display name of the toolset.
|
|
1761
|
+
*/
|
|
1762
|
+
name: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* Connections included in this toolset and their permitted tools.
|
|
1765
|
+
*/
|
|
1766
|
+
connections: Array<ToolsetConnectionDto>;
|
|
1767
|
+
/**
|
|
1768
|
+
* Workflow token GUIDs included in this toolset.
|
|
1769
|
+
*/
|
|
1770
|
+
workflows: Array<string>;
|
|
1771
|
+
/**
|
|
1772
|
+
* When the toolset was created.
|
|
1773
|
+
*/
|
|
1774
|
+
createdDate: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* When the toolset was last updated; null if never updated.
|
|
1777
|
+
*/
|
|
1778
|
+
updatedDate?: string | null;
|
|
1779
|
+
/**
|
|
1780
|
+
* Account-user ID that created the toolset.
|
|
1781
|
+
*/
|
|
1782
|
+
createdByAccountUserId?: number | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* Account-user ID that last updated the toolset; null/0 until first updated.
|
|
1785
|
+
*/
|
|
1786
|
+
updatedByAccountUserId?: number | null;
|
|
1787
|
+
};
|
|
1788
|
+
/**
|
|
1789
|
+
* A connection within a toolset, scoped to a set of permitted tools.
|
|
1790
|
+
*/
|
|
1791
|
+
type ToolsetConnectionDto = {
|
|
1792
|
+
/**
|
|
1793
|
+
* Identifier of the connection (Connector ID).
|
|
1794
|
+
*/
|
|
1795
|
+
connectionId: number;
|
|
1796
|
+
/**
|
|
1797
|
+
* Slug of the connection's application.
|
|
1798
|
+
*/
|
|
1799
|
+
applicationSlug: string;
|
|
1800
|
+
/**
|
|
1801
|
+
* Display name of the connection's application.
|
|
1802
|
+
*/
|
|
1803
|
+
applicationName?: string | null;
|
|
1804
|
+
/**
|
|
1805
|
+
* Tool slugs permitted for this connection; empty means all tools of the app are permitted.
|
|
1806
|
+
*/
|
|
1807
|
+
toolSlugs: Array<string>;
|
|
1808
|
+
};
|
|
1809
|
+
/**
|
|
1810
|
+
* Request body for creating a toolset.
|
|
1811
|
+
*/
|
|
1812
|
+
type CreateToolsetRequest = {
|
|
1813
|
+
/**
|
|
1814
|
+
* Display name for the new toolset.
|
|
1815
|
+
*/
|
|
1816
|
+
name: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Connections to include in the toolset and their permitted tools.
|
|
1819
|
+
*/
|
|
1820
|
+
connections: Array<ToolsetConnectionRequest>;
|
|
1821
|
+
/**
|
|
1822
|
+
* Workflow token GUIDs to include in the toolset.
|
|
1823
|
+
*/
|
|
1824
|
+
workflows?: Array<string> | null;
|
|
1825
|
+
};
|
|
1826
|
+
/**
|
|
1827
|
+
* A connection entry in a create/update toolset request.
|
|
1828
|
+
*/
|
|
1829
|
+
type ToolsetConnectionRequest = {
|
|
1830
|
+
/**
|
|
1831
|
+
* Optional connection identifier (Connector ID). Omit it to let the backend pick the
|
|
1832
|
+
* caller's default connection for the application of the listed tools (resolved and
|
|
1833
|
+
* stored as a concrete id at save time); when omitted, ToolSlugs must list
|
|
1834
|
+
* at least one tool so the application can be determined.
|
|
1835
|
+
*/
|
|
1836
|
+
connectionId?: number | null;
|
|
1837
|
+
/**
|
|
1838
|
+
* Optional application slug. When ConnectionId is omitted, supply this to
|
|
1839
|
+
* scope the entry to a whole application (all its tools) using the caller's default
|
|
1840
|
+
* connection for that app — resolved and stored as a concrete connectionId at save time.
|
|
1841
|
+
* An alternative to listing tool slugs; if both are supplied, applicationSlug is
|
|
1842
|
+
* authoritative for the application.
|
|
1843
|
+
*/
|
|
1844
|
+
applicationSlug?: string | null;
|
|
1845
|
+
/**
|
|
1846
|
+
* Tool slugs to permit for this connection; omit/empty to permit all tools of the app. When ConnectionId is omitted, supply either applicationSlug or at least one tool slug.
|
|
1847
|
+
*/
|
|
1848
|
+
toolSlugs?: Array<string> | null;
|
|
1849
|
+
};
|
|
1850
|
+
/**
|
|
1851
|
+
* Request body for updating a toolset; null members are left unchanged.
|
|
1852
|
+
*/
|
|
1853
|
+
type UpdateToolsetRequest = {
|
|
1854
|
+
/**
|
|
1855
|
+
* New display name; null leaves it unchanged.
|
|
1856
|
+
*/
|
|
1857
|
+
name?: string | null;
|
|
1858
|
+
/**
|
|
1859
|
+
* Replacement connection set; null leaves it unchanged.
|
|
1860
|
+
*/
|
|
1861
|
+
connections?: Array<ToolsetConnectionRequest> | null;
|
|
1862
|
+
/**
|
|
1863
|
+
* Replacement workflow set; null leaves it unchanged.
|
|
1864
|
+
*/
|
|
1865
|
+
workflows?: Array<string> | null;
|
|
1866
|
+
};
|
|
1867
|
+
type AuthWhoAmIData = {
|
|
1868
|
+
body?: never;
|
|
1869
|
+
headers?: {
|
|
1870
|
+
/**
|
|
1871
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1872
|
+
*/
|
|
1873
|
+
companytoken?: string;
|
|
1874
|
+
};
|
|
1875
|
+
path?: never;
|
|
1876
|
+
query?: never;
|
|
1877
|
+
url: '/v1/auth/whoami';
|
|
1878
|
+
};
|
|
1879
|
+
type AuthWhoAmIErrors = {
|
|
1880
|
+
/**
|
|
1881
|
+
* Bad request — malformed body or invalid parameters.
|
|
1882
|
+
*/
|
|
1883
|
+
400: ErrorResponse;
|
|
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 AuthWhoAmIError = AuthWhoAmIErrors[keyof AuthWhoAmIErrors];
|
|
1903
|
+
type AuthWhoAmIResponses = {
|
|
1904
|
+
/**
|
|
1905
|
+
* The acting principal's identity.
|
|
1906
|
+
*/
|
|
1907
|
+
200: WhoAmIResponse;
|
|
1908
|
+
};
|
|
1909
|
+
type AuthWhoAmIResponse = AuthWhoAmIResponses[keyof AuthWhoAmIResponses];
|
|
1910
|
+
type SolutionsCreateSolutionData = {
|
|
1911
|
+
/**
|
|
1912
|
+
* The solution metadata and build manifest used to create the solution.
|
|
1913
|
+
*/
|
|
1914
|
+
body: CreateSolutionRequest;
|
|
1915
|
+
headers?: {
|
|
1916
|
+
/**
|
|
1917
|
+
* 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.
|
|
1918
|
+
*/
|
|
1919
|
+
companytoken?: string;
|
|
1920
|
+
};
|
|
1921
|
+
path?: never;
|
|
1922
|
+
query?: never;
|
|
1923
|
+
url: '/v1/solutions/admin';
|
|
1924
|
+
};
|
|
1925
|
+
type SolutionsCreateSolutionErrors = {
|
|
1926
|
+
400: ErrorResponse;
|
|
1927
|
+
/**
|
|
1928
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1929
|
+
*/
|
|
1930
|
+
401: ErrorResponse;
|
|
1931
|
+
403: ErrorResponse;
|
|
1932
|
+
/**
|
|
1933
|
+
* Not found — the resource does not exist.
|
|
1934
|
+
*/
|
|
1935
|
+
404: ErrorResponse;
|
|
1936
|
+
/**
|
|
1937
|
+
* Too many requests — rate limit exceeded.
|
|
1938
|
+
*/
|
|
1939
|
+
429: ErrorResponse;
|
|
1940
|
+
/**
|
|
1941
|
+
* Internal server error — an unexpected error occurred.
|
|
1942
|
+
*/
|
|
1943
|
+
500: ErrorResponse;
|
|
1944
|
+
};
|
|
1945
|
+
type SolutionsCreateSolutionError = SolutionsCreateSolutionErrors[keyof SolutionsCreateSolutionErrors];
|
|
1946
|
+
type SolutionsCreateSolutionResponses = {
|
|
1947
|
+
/**
|
|
1948
|
+
* The newly created solution along with any manifest build warnings.
|
|
1949
|
+
*/
|
|
1950
|
+
200: SolutionAdminWriteResponse;
|
|
1951
|
+
};
|
|
1952
|
+
type SolutionsCreateSolutionResponse = SolutionsCreateSolutionResponses[keyof SolutionsCreateSolutionResponses];
|
|
1953
|
+
type SolutionsArchiveSolutionData = {
|
|
1954
|
+
body?: never;
|
|
1955
|
+
headers?: {
|
|
1956
|
+
/**
|
|
1957
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
1958
|
+
*/
|
|
1959
|
+
companytoken?: string;
|
|
1960
|
+
};
|
|
1961
|
+
path: {
|
|
1962
|
+
/**
|
|
1963
|
+
* The slug identifying the solution to archive.
|
|
1964
|
+
*/
|
|
1965
|
+
slug: string;
|
|
1966
|
+
};
|
|
1967
|
+
query?: never;
|
|
1968
|
+
url: '/v1/solutions/admin/{slug}';
|
|
1969
|
+
};
|
|
1970
|
+
type SolutionsArchiveSolutionErrors = {
|
|
1971
|
+
/**
|
|
1972
|
+
* Bad request — malformed body or invalid parameters.
|
|
1973
|
+
*/
|
|
1974
|
+
400: ErrorResponse;
|
|
1975
|
+
/**
|
|
1976
|
+
* Unauthorized — missing or invalid bearer token.
|
|
1977
|
+
*/
|
|
1978
|
+
401: ErrorResponse;
|
|
1979
|
+
403: ErrorResponse;
|
|
1980
|
+
404: ErrorResponse;
|
|
1981
|
+
/**
|
|
1982
|
+
* Too many requests — rate limit exceeded.
|
|
1983
|
+
*/
|
|
1984
|
+
429: ErrorResponse;
|
|
1985
|
+
/**
|
|
1986
|
+
* Internal server error — an unexpected error occurred.
|
|
1987
|
+
*/
|
|
1988
|
+
500: ErrorResponse;
|
|
1989
|
+
};
|
|
1990
|
+
type SolutionsArchiveSolutionError = SolutionsArchiveSolutionErrors[keyof SolutionsArchiveSolutionErrors];
|
|
1991
|
+
type SolutionsArchiveSolutionResponses = {
|
|
1992
|
+
/**
|
|
1993
|
+
* No content on success.
|
|
1994
|
+
*/
|
|
1995
|
+
204: void;
|
|
1996
|
+
};
|
|
1997
|
+
type SolutionsArchiveSolutionResponse = SolutionsArchiveSolutionResponses[keyof SolutionsArchiveSolutionResponses];
|
|
1998
|
+
type SolutionsUpdateSolutionData = {
|
|
1999
|
+
/**
|
|
2000
|
+
* The updated solution metadata and optional build manifest.
|
|
2001
|
+
*/
|
|
2002
|
+
body: UpdateSolutionRequest;
|
|
2003
|
+
headers?: {
|
|
2004
|
+
/**
|
|
2005
|
+
* 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.
|
|
2006
|
+
*/
|
|
2007
|
+
companytoken?: string;
|
|
2008
|
+
};
|
|
2009
|
+
path: {
|
|
2010
|
+
/**
|
|
2011
|
+
* The slug identifying the solution to update.
|
|
2012
|
+
*/
|
|
2013
|
+
slug: string;
|
|
2014
|
+
};
|
|
2015
|
+
query?: never;
|
|
2016
|
+
url: '/v1/solutions/admin/{slug}';
|
|
2017
|
+
};
|
|
2018
|
+
type SolutionsUpdateSolutionErrors = {
|
|
2019
|
+
400: ErrorResponse;
|
|
2020
|
+
/**
|
|
2021
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2022
|
+
*/
|
|
2023
|
+
401: ErrorResponse;
|
|
2024
|
+
403: ErrorResponse;
|
|
2025
|
+
404: ErrorResponse;
|
|
2026
|
+
/**
|
|
2027
|
+
* Too many requests — rate limit exceeded.
|
|
2028
|
+
*/
|
|
2029
|
+
429: ErrorResponse;
|
|
2030
|
+
/**
|
|
2031
|
+
* Internal server error — an unexpected error occurred.
|
|
2032
|
+
*/
|
|
2033
|
+
500: ErrorResponse;
|
|
2034
|
+
};
|
|
2035
|
+
type SolutionsUpdateSolutionError = SolutionsUpdateSolutionErrors[keyof SolutionsUpdateSolutionErrors];
|
|
2036
|
+
type SolutionsUpdateSolutionResponses = {
|
|
2037
|
+
/**
|
|
2038
|
+
* The updated solution along with any manifest build warnings.
|
|
2039
|
+
*/
|
|
2040
|
+
200: SolutionAdminWriteResponse;
|
|
2041
|
+
};
|
|
2042
|
+
type SolutionsUpdateSolutionResponse = SolutionsUpdateSolutionResponses[keyof SolutionsUpdateSolutionResponses];
|
|
2043
|
+
type SolutionsPublishSolutionData = {
|
|
2044
|
+
body?: never;
|
|
2045
|
+
headers?: {
|
|
2046
|
+
/**
|
|
2047
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2048
|
+
*/
|
|
2049
|
+
companytoken?: string;
|
|
2050
|
+
};
|
|
2051
|
+
path: {
|
|
2052
|
+
/**
|
|
2053
|
+
* The slug identifying the solution to publish.
|
|
2054
|
+
*/
|
|
2055
|
+
slug: string;
|
|
2056
|
+
};
|
|
2057
|
+
query?: never;
|
|
2058
|
+
url: '/v1/solutions/admin/{slug}/publish';
|
|
2059
|
+
};
|
|
2060
|
+
type SolutionsPublishSolutionErrors = {
|
|
2061
|
+
400: ErrorResponse;
|
|
2062
|
+
/**
|
|
2063
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2064
|
+
*/
|
|
2065
|
+
401: ErrorResponse;
|
|
2066
|
+
403: ErrorResponse;
|
|
2067
|
+
404: ErrorResponse;
|
|
2068
|
+
/**
|
|
2069
|
+
* Too many requests — rate limit exceeded.
|
|
2070
|
+
*/
|
|
2071
|
+
429: ErrorResponse;
|
|
2072
|
+
/**
|
|
2073
|
+
* Internal server error — an unexpected error occurred.
|
|
2074
|
+
*/
|
|
2075
|
+
500: ErrorResponse;
|
|
2076
|
+
};
|
|
2077
|
+
type SolutionsPublishSolutionError = SolutionsPublishSolutionErrors[keyof SolutionsPublishSolutionErrors];
|
|
2078
|
+
type SolutionsPublishSolutionResponses = {
|
|
2079
|
+
/**
|
|
2080
|
+
* The published solution detail.
|
|
2081
|
+
*/
|
|
2082
|
+
200: SolutionDetailResponse;
|
|
2083
|
+
};
|
|
2084
|
+
type SolutionsPublishSolutionResponse = SolutionsPublishSolutionResponses[keyof SolutionsPublishSolutionResponses];
|
|
2085
|
+
type SolutionsBuildManifestData = {
|
|
2086
|
+
/**
|
|
2087
|
+
* The manifest build inputs and an optional slug of an existing solution to update.
|
|
2088
|
+
*/
|
|
2089
|
+
body: BuildManifestRequest;
|
|
2090
|
+
headers?: {
|
|
2091
|
+
/**
|
|
2092
|
+
* 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.
|
|
2093
|
+
*/
|
|
2094
|
+
companytoken?: string;
|
|
2095
|
+
};
|
|
2096
|
+
path?: never;
|
|
2097
|
+
query?: never;
|
|
2098
|
+
url: '/v1/solutions/admin/build-manifest';
|
|
2099
|
+
};
|
|
2100
|
+
type SolutionsBuildManifestErrors = {
|
|
2101
|
+
400: ErrorResponse;
|
|
2102
|
+
/**
|
|
2103
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2104
|
+
*/
|
|
2105
|
+
401: ErrorResponse;
|
|
2106
|
+
403: ErrorResponse;
|
|
2107
|
+
404: ErrorResponse;
|
|
2108
|
+
/**
|
|
2109
|
+
* Too many requests — rate limit exceeded.
|
|
2110
|
+
*/
|
|
2111
|
+
429: ErrorResponse;
|
|
2112
|
+
/**
|
|
2113
|
+
* Internal server error — an unexpected error occurred.
|
|
2114
|
+
*/
|
|
2115
|
+
500: ErrorResponse;
|
|
2116
|
+
};
|
|
2117
|
+
type SolutionsBuildManifestError = SolutionsBuildManifestErrors[keyof SolutionsBuildManifestErrors];
|
|
2118
|
+
type SolutionsBuildManifestResponses = {
|
|
2119
|
+
/**
|
|
2120
|
+
* The built manifest with any warnings, plus the updated solution when a slug was supplied.
|
|
2121
|
+
*/
|
|
2122
|
+
200: BuildManifestResponse;
|
|
2123
|
+
};
|
|
2124
|
+
type SolutionsBuildManifestResponse = SolutionsBuildManifestResponses[keyof SolutionsBuildManifestResponses];
|
|
2125
|
+
type SolutionsGetPublishedSolutionsData = {
|
|
2126
|
+
body?: never;
|
|
2127
|
+
headers?: {
|
|
2128
|
+
/**
|
|
2129
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2130
|
+
*/
|
|
2131
|
+
companytoken?: string;
|
|
2132
|
+
};
|
|
2133
|
+
path?: never;
|
|
2134
|
+
query?: {
|
|
2135
|
+
/**
|
|
2136
|
+
* Optional search term to filter solutions by.
|
|
2137
|
+
*/
|
|
2138
|
+
Search?: string | null;
|
|
2139
|
+
/**
|
|
2140
|
+
* Number of items to skip (pagination offset).
|
|
2141
|
+
*/
|
|
2142
|
+
Offset?: number;
|
|
2143
|
+
/**
|
|
2144
|
+
* Maximum number of items to return.
|
|
2145
|
+
*/
|
|
2146
|
+
Top?: number;
|
|
2147
|
+
};
|
|
2148
|
+
url: '/v1/solutions';
|
|
2149
|
+
};
|
|
2150
|
+
type SolutionsGetPublishedSolutionsErrors = {
|
|
2151
|
+
/**
|
|
2152
|
+
* Bad request — malformed body or invalid parameters.
|
|
2153
|
+
*/
|
|
2154
|
+
400: ErrorResponse;
|
|
2155
|
+
/**
|
|
2156
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2157
|
+
*/
|
|
2158
|
+
401: ErrorResponse;
|
|
2159
|
+
/**
|
|
2160
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2161
|
+
*/
|
|
2162
|
+
403: ErrorResponse;
|
|
2163
|
+
/**
|
|
2164
|
+
* Not found — the resource does not exist.
|
|
2165
|
+
*/
|
|
2166
|
+
404: ErrorResponse;
|
|
2167
|
+
/**
|
|
2168
|
+
* Too many requests — rate limit exceeded.
|
|
2169
|
+
*/
|
|
2170
|
+
429: ErrorResponse;
|
|
2171
|
+
/**
|
|
2172
|
+
* Internal server error — an unexpected error occurred.
|
|
2173
|
+
*/
|
|
2174
|
+
500: ErrorResponse;
|
|
2175
|
+
};
|
|
2176
|
+
type SolutionsGetPublishedSolutionsError = SolutionsGetPublishedSolutionsErrors[keyof SolutionsGetPublishedSolutionsErrors];
|
|
2177
|
+
type SolutionsGetPublishedSolutionsResponses = {
|
|
2178
|
+
/**
|
|
2179
|
+
* A paginated collection of published solutions.
|
|
2180
|
+
*/
|
|
2181
|
+
200: PaginatedResponseOfSolutionResponse;
|
|
2182
|
+
};
|
|
2183
|
+
type SolutionsGetPublishedSolutionsResponse = SolutionsGetPublishedSolutionsResponses[keyof SolutionsGetPublishedSolutionsResponses];
|
|
2184
|
+
type SolutionsGetSolutionBySlugData = {
|
|
2185
|
+
body?: never;
|
|
2186
|
+
headers?: {
|
|
2187
|
+
/**
|
|
2188
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2189
|
+
*/
|
|
2190
|
+
companytoken?: string;
|
|
2191
|
+
};
|
|
2192
|
+
path: {
|
|
2193
|
+
/**
|
|
2194
|
+
* The slug identifying the solution to retrieve.
|
|
2195
|
+
*/
|
|
2196
|
+
slug: string;
|
|
2197
|
+
};
|
|
2198
|
+
query?: never;
|
|
2199
|
+
url: '/v1/solutions/{slug}';
|
|
2200
|
+
};
|
|
2201
|
+
type SolutionsGetSolutionBySlugErrors = {
|
|
2202
|
+
/**
|
|
2203
|
+
* Bad request — malformed body or invalid parameters.
|
|
2204
|
+
*/
|
|
2205
|
+
400: ErrorResponse;
|
|
2206
|
+
/**
|
|
2207
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2208
|
+
*/
|
|
2209
|
+
401: ErrorResponse;
|
|
2210
|
+
/**
|
|
2211
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2212
|
+
*/
|
|
2213
|
+
403: ErrorResponse;
|
|
2214
|
+
404: ErrorResponse;
|
|
2215
|
+
/**
|
|
2216
|
+
* Too many requests — rate limit exceeded.
|
|
2217
|
+
*/
|
|
2218
|
+
429: ErrorResponse;
|
|
2219
|
+
/**
|
|
2220
|
+
* Internal server error — an unexpected error occurred.
|
|
2221
|
+
*/
|
|
2222
|
+
500: ErrorResponse;
|
|
2223
|
+
};
|
|
2224
|
+
type SolutionsGetSolutionBySlugError = SolutionsGetSolutionBySlugErrors[keyof SolutionsGetSolutionBySlugErrors];
|
|
2225
|
+
type SolutionsGetSolutionBySlugResponses = {
|
|
2226
|
+
/**
|
|
2227
|
+
* The solution detail.
|
|
2228
|
+
*/
|
|
2229
|
+
200: SolutionDetailResponse;
|
|
2230
|
+
};
|
|
2231
|
+
type SolutionsGetSolutionBySlugResponse = SolutionsGetSolutionBySlugResponses[keyof SolutionsGetSolutionBySlugResponses];
|
|
2232
|
+
type SolutionsGetInstallationsData = {
|
|
2233
|
+
body?: never;
|
|
2234
|
+
headers?: {
|
|
2235
|
+
/**
|
|
2236
|
+
* 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.
|
|
2237
|
+
*/
|
|
2238
|
+
companytoken?: string;
|
|
2239
|
+
};
|
|
2240
|
+
path?: never;
|
|
2241
|
+
query?: {
|
|
2242
|
+
/**
|
|
2243
|
+
* Optional solution slug to filter the installations.
|
|
2244
|
+
*/
|
|
2245
|
+
slug?: string | null;
|
|
2246
|
+
/**
|
|
2247
|
+
* Optional installation status name to filter by; must be a valid InstallationStatus value.
|
|
2248
|
+
*/
|
|
2249
|
+
status?: string | null;
|
|
2250
|
+
};
|
|
2251
|
+
url: '/v1/solutions/installations';
|
|
2252
|
+
};
|
|
2253
|
+
type SolutionsGetInstallationsErrors = {
|
|
2254
|
+
400: ErrorResponse;
|
|
2255
|
+
/**
|
|
2256
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2257
|
+
*/
|
|
2258
|
+
401: ErrorResponse;
|
|
2259
|
+
/**
|
|
2260
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2261
|
+
*/
|
|
2262
|
+
403: ErrorResponse;
|
|
2263
|
+
/**
|
|
2264
|
+
* Not found — the resource does not exist.
|
|
2265
|
+
*/
|
|
2266
|
+
404: ErrorResponse;
|
|
2267
|
+
/**
|
|
2268
|
+
* Too many requests — rate limit exceeded.
|
|
2269
|
+
*/
|
|
2270
|
+
429: ErrorResponse;
|
|
2271
|
+
/**
|
|
2272
|
+
* Internal server error — an unexpected error occurred.
|
|
2273
|
+
*/
|
|
2274
|
+
500: ErrorResponse;
|
|
2275
|
+
};
|
|
2276
|
+
type SolutionsGetInstallationsError = SolutionsGetInstallationsErrors[keyof SolutionsGetInstallationsErrors];
|
|
2277
|
+
type SolutionsGetInstallationsResponses = {
|
|
2278
|
+
/**
|
|
2279
|
+
* The matching installations for the account.
|
|
2280
|
+
*/
|
|
2281
|
+
200: Array<SolutionInstallationResponse>;
|
|
2282
|
+
};
|
|
2283
|
+
type SolutionsGetInstallationsResponse = SolutionsGetInstallationsResponses[keyof SolutionsGetInstallationsResponses];
|
|
2284
|
+
type SolutionsGetInstallationDetailData = {
|
|
2285
|
+
body?: never;
|
|
2286
|
+
headers?: {
|
|
2287
|
+
/**
|
|
2288
|
+
* 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.
|
|
2289
|
+
*/
|
|
2290
|
+
companytoken?: string;
|
|
2291
|
+
};
|
|
2292
|
+
path: {
|
|
2293
|
+
/**
|
|
2294
|
+
* The identifier of the installation to retrieve.
|
|
2295
|
+
*/
|
|
2296
|
+
id: number;
|
|
2297
|
+
};
|
|
2298
|
+
query?: never;
|
|
2299
|
+
url: '/v1/solutions/installations/{id}';
|
|
2300
|
+
};
|
|
2301
|
+
type SolutionsGetInstallationDetailErrors = {
|
|
2302
|
+
400: ErrorResponse;
|
|
2303
|
+
/**
|
|
2304
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2305
|
+
*/
|
|
2306
|
+
401: ErrorResponse;
|
|
2307
|
+
/**
|
|
2308
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2309
|
+
*/
|
|
2310
|
+
403: ErrorResponse;
|
|
2311
|
+
404: ErrorResponse;
|
|
2312
|
+
/**
|
|
2313
|
+
* Too many requests — rate limit exceeded.
|
|
2314
|
+
*/
|
|
2315
|
+
429: ErrorResponse;
|
|
2316
|
+
/**
|
|
2317
|
+
* Internal server error — an unexpected error occurred.
|
|
2318
|
+
*/
|
|
2319
|
+
500: ErrorResponse;
|
|
2320
|
+
};
|
|
2321
|
+
type SolutionsGetInstallationDetailError = SolutionsGetInstallationDetailErrors[keyof SolutionsGetInstallationDetailErrors];
|
|
2322
|
+
type SolutionsGetInstallationDetailResponses = {
|
|
2323
|
+
/**
|
|
2324
|
+
* The installation detail.
|
|
2325
|
+
*/
|
|
2326
|
+
200: InstallationDetailResponse;
|
|
2327
|
+
};
|
|
2328
|
+
type SolutionsGetInstallationDetailResponse = SolutionsGetInstallationDetailResponses[keyof SolutionsGetInstallationDetailResponses];
|
|
2329
|
+
type SolutionsGetInstallationResourcesData = {
|
|
2330
|
+
body?: never;
|
|
2331
|
+
headers?: {
|
|
2332
|
+
/**
|
|
2333
|
+
* 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.
|
|
2334
|
+
*/
|
|
2335
|
+
companytoken?: string;
|
|
2336
|
+
};
|
|
2337
|
+
path: {
|
|
2338
|
+
/**
|
|
2339
|
+
* The identifier of the installation whose resources are requested.
|
|
2340
|
+
*/
|
|
2341
|
+
id: number;
|
|
2342
|
+
};
|
|
2343
|
+
query?: {
|
|
2344
|
+
/**
|
|
2345
|
+
* Optional resource key to filter the resources.
|
|
2346
|
+
*/
|
|
2347
|
+
resourceKey?: string | null;
|
|
2348
|
+
/**
|
|
2349
|
+
* Optional resource type name to filter by; must be a valid ResourceType value.
|
|
2350
|
+
*/
|
|
2351
|
+
resourceType?: string | null;
|
|
2352
|
+
};
|
|
2353
|
+
url: '/v1/solutions/installations/{id}/resources';
|
|
2354
|
+
};
|
|
2355
|
+
type SolutionsGetInstallationResourcesErrors = {
|
|
2356
|
+
400: ErrorResponse;
|
|
2357
|
+
/**
|
|
2358
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2359
|
+
*/
|
|
2360
|
+
401: ErrorResponse;
|
|
2361
|
+
/**
|
|
2362
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2363
|
+
*/
|
|
2364
|
+
403: ErrorResponse;
|
|
2365
|
+
404: ErrorResponse;
|
|
2366
|
+
/**
|
|
2367
|
+
* Too many requests — rate limit exceeded.
|
|
2368
|
+
*/
|
|
2369
|
+
429: ErrorResponse;
|
|
2370
|
+
/**
|
|
2371
|
+
* Internal server error — an unexpected error occurred.
|
|
2372
|
+
*/
|
|
2373
|
+
500: ErrorResponse;
|
|
2374
|
+
};
|
|
2375
|
+
type SolutionsGetInstallationResourcesError = SolutionsGetInstallationResourcesErrors[keyof SolutionsGetInstallationResourcesErrors];
|
|
2376
|
+
type SolutionsGetInstallationResourcesResponses = {
|
|
2377
|
+
/**
|
|
2378
|
+
* The matching installed resources.
|
|
2379
|
+
*/
|
|
2380
|
+
200: Array<InstalledResourceResponse>;
|
|
2381
|
+
};
|
|
2382
|
+
type SolutionsGetInstallationResourcesResponse = SolutionsGetInstallationResourcesResponses[keyof SolutionsGetInstallationResourcesResponses];
|
|
2383
|
+
type SolutionsInstallSolutionData = {
|
|
2384
|
+
/**
|
|
2385
|
+
* The installation options and provisioning inputs.
|
|
2386
|
+
*/
|
|
2387
|
+
body: InstallSolutionRequest;
|
|
2388
|
+
headers?: {
|
|
2389
|
+
/**
|
|
2390
|
+
* 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.
|
|
2391
|
+
*/
|
|
2392
|
+
companytoken?: string;
|
|
2393
|
+
};
|
|
2394
|
+
path: {
|
|
2395
|
+
/**
|
|
2396
|
+
* The slug identifying the solution to install.
|
|
2397
|
+
*/
|
|
2398
|
+
slug: string;
|
|
2399
|
+
};
|
|
2400
|
+
query?: never;
|
|
2401
|
+
url: '/v1/solutions/{slug}/install';
|
|
2402
|
+
};
|
|
2403
|
+
type SolutionsInstallSolutionErrors = {
|
|
2404
|
+
400: ErrorResponse;
|
|
2405
|
+
401: ErrorResponse;
|
|
2406
|
+
/**
|
|
2407
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2408
|
+
*/
|
|
2409
|
+
403: ErrorResponse;
|
|
2410
|
+
404: ErrorResponse;
|
|
2411
|
+
409: ErrorResponse;
|
|
2412
|
+
/**
|
|
2413
|
+
* Too many requests — rate limit exceeded.
|
|
2414
|
+
*/
|
|
2415
|
+
429: ErrorResponse;
|
|
2416
|
+
/**
|
|
2417
|
+
* Internal server error — an unexpected error occurred.
|
|
2418
|
+
*/
|
|
2419
|
+
500: ErrorResponse;
|
|
2420
|
+
};
|
|
2421
|
+
type SolutionsInstallSolutionError = SolutionsInstallSolutionErrors[keyof SolutionsInstallSolutionErrors];
|
|
2422
|
+
type SolutionsInstallSolutionResponses = {
|
|
2423
|
+
/**
|
|
2424
|
+
* The result of the installation, including the created installation and provisioned resources.
|
|
2425
|
+
*/
|
|
2426
|
+
200: InstallSolutionResponse;
|
|
2427
|
+
};
|
|
2428
|
+
type SolutionsInstallSolutionResponse = SolutionsInstallSolutionResponses[keyof SolutionsInstallSolutionResponses];
|
|
2429
|
+
type SolutionsUpdateInstallationData = {
|
|
2430
|
+
/**
|
|
2431
|
+
* Optional update options, including whether to force the update past blockers.
|
|
2432
|
+
*/
|
|
2433
|
+
body?: UpdateInstallationRequest;
|
|
2434
|
+
headers?: {
|
|
2435
|
+
/**
|
|
2436
|
+
* 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.
|
|
2437
|
+
*/
|
|
2438
|
+
companytoken?: string;
|
|
2439
|
+
};
|
|
2440
|
+
path: {
|
|
2441
|
+
/**
|
|
2442
|
+
* The identifier of the installation to update.
|
|
2443
|
+
*/
|
|
2444
|
+
id: number;
|
|
2445
|
+
};
|
|
2446
|
+
query?: never;
|
|
2447
|
+
url: '/v1/solutions/installations/{id}/update';
|
|
2448
|
+
};
|
|
2449
|
+
type SolutionsUpdateInstallationErrors = {
|
|
2450
|
+
400: ErrorResponse;
|
|
2451
|
+
/**
|
|
2452
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2453
|
+
*/
|
|
2454
|
+
401: ErrorResponse;
|
|
2455
|
+
/**
|
|
2456
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2457
|
+
*/
|
|
2458
|
+
403: ErrorResponse;
|
|
2459
|
+
404: ErrorResponse;
|
|
2460
|
+
409: UpdateBlockedResponse;
|
|
2461
|
+
/**
|
|
2462
|
+
* Too many requests — rate limit exceeded.
|
|
2463
|
+
*/
|
|
2464
|
+
429: ErrorResponse;
|
|
2465
|
+
/**
|
|
2466
|
+
* Internal server error — an unexpected error occurred.
|
|
2467
|
+
*/
|
|
2468
|
+
500: ErrorResponse;
|
|
2469
|
+
};
|
|
2470
|
+
type SolutionsUpdateInstallationError = SolutionsUpdateInstallationErrors[keyof SolutionsUpdateInstallationErrors];
|
|
2471
|
+
type SolutionsUpdateInstallationResponses = {
|
|
2472
|
+
/**
|
|
2473
|
+
* The result of the installation update.
|
|
2474
|
+
*/
|
|
2475
|
+
200: UpdateInstallationResponse;
|
|
2476
|
+
};
|
|
2477
|
+
type SolutionsUpdateInstallationResponse = SolutionsUpdateInstallationResponses[keyof SolutionsUpdateInstallationResponses];
|
|
2478
|
+
type SolutionsUninstallSolutionData = {
|
|
2479
|
+
/**
|
|
2480
|
+
* The uninstall options, including the installation identifier and which resource types to delete.
|
|
2481
|
+
*/
|
|
2482
|
+
body: UninstallSolutionRequest;
|
|
2483
|
+
headers?: {
|
|
2484
|
+
/**
|
|
2485
|
+
* 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.
|
|
2486
|
+
*/
|
|
2487
|
+
companytoken?: string;
|
|
2488
|
+
};
|
|
2489
|
+
path: {
|
|
2490
|
+
/**
|
|
2491
|
+
* The slug identifying the solution to uninstall.
|
|
2492
|
+
*/
|
|
2493
|
+
slug: string;
|
|
2494
|
+
};
|
|
2495
|
+
query?: never;
|
|
2496
|
+
url: '/v1/solutions/{slug}/uninstall';
|
|
2497
|
+
};
|
|
2498
|
+
type SolutionsUninstallSolutionErrors = {
|
|
2499
|
+
400: ErrorResponse;
|
|
2500
|
+
/**
|
|
2501
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2502
|
+
*/
|
|
2503
|
+
401: ErrorResponse;
|
|
2504
|
+
/**
|
|
2505
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2506
|
+
*/
|
|
2507
|
+
403: ErrorResponse;
|
|
2508
|
+
404: ErrorResponse;
|
|
2509
|
+
/**
|
|
2510
|
+
* Too many requests — rate limit exceeded.
|
|
2511
|
+
*/
|
|
2512
|
+
429: ErrorResponse;
|
|
2513
|
+
/**
|
|
2514
|
+
* Internal server error — an unexpected error occurred.
|
|
2515
|
+
*/
|
|
2516
|
+
500: ErrorResponse;
|
|
2517
|
+
};
|
|
2518
|
+
type SolutionsUninstallSolutionError = SolutionsUninstallSolutionErrors[keyof SolutionsUninstallSolutionErrors];
|
|
2519
|
+
type SolutionsUninstallSolutionResponses = {
|
|
2520
|
+
/**
|
|
2521
|
+
* No content on success.
|
|
2522
|
+
*/
|
|
2523
|
+
204: void;
|
|
2524
|
+
};
|
|
2525
|
+
type SolutionsUninstallSolutionResponse = SolutionsUninstallSolutionResponses[keyof SolutionsUninstallSolutionResponses];
|
|
2526
|
+
type ApplicationsListApplicationsData = {
|
|
2527
|
+
body?: never;
|
|
2528
|
+
headers?: {
|
|
2529
|
+
/**
|
|
2530
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2531
|
+
*/
|
|
2532
|
+
companytoken?: string;
|
|
2533
|
+
};
|
|
2534
|
+
path?: never;
|
|
2535
|
+
query?: {
|
|
2536
|
+
/**
|
|
2537
|
+
* Optional free-text search applied across application fields.
|
|
2538
|
+
*/
|
|
2539
|
+
search?: string | null;
|
|
2540
|
+
/**
|
|
2541
|
+
* Optional exact-name filter.
|
|
2542
|
+
*/
|
|
2543
|
+
name?: string | null;
|
|
2544
|
+
/**
|
|
2545
|
+
* Optional filter on the application's connection requirement.
|
|
2546
|
+
*/
|
|
2547
|
+
connectionRequirement?: string | null;
|
|
2548
|
+
/**
|
|
2549
|
+
* Optional list of categories to filter by.
|
|
2550
|
+
*/
|
|
2551
|
+
category?: Array<string> | null;
|
|
2552
|
+
/**
|
|
2553
|
+
* When true, returns only applications the caller can currently use. Defaults to false.
|
|
2554
|
+
*/
|
|
2555
|
+
available?: boolean;
|
|
2556
|
+
/**
|
|
2557
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
2558
|
+
*/
|
|
2559
|
+
offset?: number;
|
|
2560
|
+
/**
|
|
2561
|
+
* Maximum number of items to return. Defaults to 100.
|
|
2562
|
+
*/
|
|
2563
|
+
top?: number;
|
|
2564
|
+
};
|
|
2565
|
+
url: '/v1/applications';
|
|
2566
|
+
};
|
|
2567
|
+
type ApplicationsListApplicationsErrors = {
|
|
2568
|
+
400: ErrorResponse;
|
|
2569
|
+
401: ErrorResponse;
|
|
2570
|
+
/**
|
|
2571
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2572
|
+
*/
|
|
2573
|
+
403: ErrorResponse;
|
|
2574
|
+
/**
|
|
2575
|
+
* Not found — the resource does not exist.
|
|
2576
|
+
*/
|
|
2577
|
+
404: ErrorResponse;
|
|
2578
|
+
/**
|
|
2579
|
+
* Too many requests — rate limit exceeded.
|
|
2580
|
+
*/
|
|
2581
|
+
429: ErrorResponse;
|
|
2582
|
+
/**
|
|
2583
|
+
* Internal server error — an unexpected error occurred.
|
|
2584
|
+
*/
|
|
2585
|
+
500: ErrorResponse;
|
|
2586
|
+
};
|
|
2587
|
+
type ApplicationsListApplicationsError = ApplicationsListApplicationsErrors[keyof ApplicationsListApplicationsErrors];
|
|
2588
|
+
type ApplicationsListApplicationsResponses = {
|
|
2589
|
+
/**
|
|
2590
|
+
* A paginated list of applications.
|
|
2591
|
+
*/
|
|
2592
|
+
200: PaginatedResponseOfApplicationDto;
|
|
2593
|
+
};
|
|
2594
|
+
type ApplicationsListApplicationsResponse = ApplicationsListApplicationsResponses[keyof ApplicationsListApplicationsResponses];
|
|
2595
|
+
type ApplicationsGetApplicationData = {
|
|
2596
|
+
body?: never;
|
|
2597
|
+
headers?: {
|
|
2598
|
+
/**
|
|
2599
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2600
|
+
*/
|
|
2601
|
+
companytoken?: string;
|
|
2602
|
+
};
|
|
2603
|
+
path: {
|
|
2604
|
+
/**
|
|
2605
|
+
* The slug identifying the application to retrieve.
|
|
2606
|
+
*/
|
|
2607
|
+
slug: string;
|
|
2608
|
+
};
|
|
2609
|
+
query?: never;
|
|
2610
|
+
url: '/v1/applications/{slug}';
|
|
2611
|
+
};
|
|
2612
|
+
type ApplicationsGetApplicationErrors = {
|
|
2613
|
+
/**
|
|
2614
|
+
* Bad request — malformed body or invalid parameters.
|
|
2615
|
+
*/
|
|
2616
|
+
400: ErrorResponse;
|
|
2617
|
+
401: ErrorResponse;
|
|
2618
|
+
/**
|
|
2619
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2620
|
+
*/
|
|
2621
|
+
403: ErrorResponse;
|
|
2622
|
+
404: ErrorResponse;
|
|
2623
|
+
/**
|
|
2624
|
+
* Too many requests — rate limit exceeded.
|
|
2625
|
+
*/
|
|
2626
|
+
429: ErrorResponse;
|
|
2627
|
+
/**
|
|
2628
|
+
* Internal server error — an unexpected error occurred.
|
|
2629
|
+
*/
|
|
2630
|
+
500: ErrorResponse;
|
|
2631
|
+
};
|
|
2632
|
+
type ApplicationsGetApplicationError = ApplicationsGetApplicationErrors[keyof ApplicationsGetApplicationErrors];
|
|
2633
|
+
type ApplicationsGetApplicationResponses = {
|
|
2634
|
+
/**
|
|
2635
|
+
* The detailed representation of the application.
|
|
2636
|
+
*/
|
|
2637
|
+
200: ApplicationDetailDto;
|
|
2638
|
+
};
|
|
2639
|
+
type ApplicationsGetApplicationResponse = ApplicationsGetApplicationResponses[keyof ApplicationsGetApplicationResponses];
|
|
2640
|
+
type ConnectionsGetConnectionsData = {
|
|
2641
|
+
body?: never;
|
|
2642
|
+
headers?: {
|
|
2643
|
+
/**
|
|
2644
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2645
|
+
*/
|
|
2646
|
+
companytoken?: string;
|
|
2647
|
+
};
|
|
2648
|
+
path?: never;
|
|
2649
|
+
query?: {
|
|
2650
|
+
/**
|
|
2651
|
+
* Optional filter limiting results to connections of a specific application.
|
|
2652
|
+
*/
|
|
2653
|
+
applicationSlug?: string | null;
|
|
2654
|
+
/**
|
|
2655
|
+
* Optional name filter.
|
|
2656
|
+
*/
|
|
2657
|
+
name?: string | null;
|
|
2658
|
+
/**
|
|
2659
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
2660
|
+
*/
|
|
2661
|
+
offset?: number;
|
|
2662
|
+
/**
|
|
2663
|
+
* Maximum number of items to return (capped at 100). Defaults to 25.
|
|
2664
|
+
*/
|
|
2665
|
+
top?: number;
|
|
2666
|
+
/**
|
|
2667
|
+
* Optional metadata key/value pairs to filter connections by.
|
|
2668
|
+
*/
|
|
2669
|
+
metadata?: {
|
|
2670
|
+
[key: string]: string;
|
|
2671
|
+
} | null;
|
|
2672
|
+
};
|
|
2673
|
+
url: '/v1/connections';
|
|
2674
|
+
};
|
|
2675
|
+
type ConnectionsGetConnectionsErrors = {
|
|
2676
|
+
/**
|
|
2677
|
+
* Bad request — malformed body or invalid parameters.
|
|
2678
|
+
*/
|
|
2679
|
+
400: ErrorResponse;
|
|
2680
|
+
/**
|
|
2681
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2682
|
+
*/
|
|
2683
|
+
401: ErrorResponse;
|
|
2684
|
+
/**
|
|
2685
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2686
|
+
*/
|
|
2687
|
+
403: ErrorResponse;
|
|
2688
|
+
/**
|
|
2689
|
+
* Not found — the resource does not exist.
|
|
2690
|
+
*/
|
|
2691
|
+
404: ErrorResponse;
|
|
2692
|
+
/**
|
|
2693
|
+
* Too many requests — rate limit exceeded.
|
|
2694
|
+
*/
|
|
2695
|
+
429: ErrorResponse;
|
|
2696
|
+
/**
|
|
2697
|
+
* Internal server error — an unexpected error occurred.
|
|
2698
|
+
*/
|
|
2699
|
+
500: ErrorResponse;
|
|
2700
|
+
};
|
|
2701
|
+
type ConnectionsGetConnectionsError = ConnectionsGetConnectionsErrors[keyof ConnectionsGetConnectionsErrors];
|
|
2702
|
+
type ConnectionsGetConnectionsResponses = {
|
|
2703
|
+
/**
|
|
2704
|
+
* A paginated list of connections.
|
|
2705
|
+
*/
|
|
2706
|
+
200: PaginatedResponseOfConnectionPublicListItem;
|
|
2707
|
+
};
|
|
2708
|
+
type ConnectionsGetConnectionsResponse = ConnectionsGetConnectionsResponses[keyof ConnectionsGetConnectionsResponses];
|
|
2709
|
+
type ConnectionsCreateConnectionData = {
|
|
2710
|
+
/**
|
|
2711
|
+
* The connection creation payload, including the connection name and application slug.
|
|
2712
|
+
*/
|
|
2713
|
+
body: CreateConnectionRequest;
|
|
2714
|
+
headers?: {
|
|
2715
|
+
/**
|
|
2716
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2717
|
+
*/
|
|
2718
|
+
companytoken?: string;
|
|
2719
|
+
};
|
|
2720
|
+
path?: never;
|
|
2721
|
+
query?: never;
|
|
2722
|
+
url: '/v1/connections';
|
|
2723
|
+
};
|
|
2724
|
+
type ConnectionsCreateConnectionErrors = {
|
|
2725
|
+
/**
|
|
2726
|
+
* Bad request — malformed body or invalid parameters.
|
|
2727
|
+
*/
|
|
2728
|
+
400: ErrorResponse;
|
|
2729
|
+
/**
|
|
2730
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2731
|
+
*/
|
|
2732
|
+
401: ErrorResponse;
|
|
2733
|
+
/**
|
|
2734
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2735
|
+
*/
|
|
2736
|
+
403: ErrorResponse;
|
|
2737
|
+
/**
|
|
2738
|
+
* Not found — the resource does not exist.
|
|
2739
|
+
*/
|
|
2740
|
+
404: ErrorResponse;
|
|
2741
|
+
/**
|
|
2742
|
+
* Too many requests — rate limit exceeded.
|
|
2743
|
+
*/
|
|
2744
|
+
429: ErrorResponse;
|
|
2745
|
+
/**
|
|
2746
|
+
* Internal server error — an unexpected error occurred.
|
|
2747
|
+
*/
|
|
2748
|
+
500: ErrorResponse;
|
|
2749
|
+
};
|
|
2750
|
+
type ConnectionsCreateConnectionError = ConnectionsCreateConnectionErrors[keyof ConnectionsCreateConnectionErrors];
|
|
2751
|
+
type ConnectionsCreateConnectionResponses = {
|
|
2752
|
+
/**
|
|
2753
|
+
* The newly created connection.
|
|
2754
|
+
*/
|
|
2755
|
+
200: ConnectionPublicDetail;
|
|
2756
|
+
};
|
|
2757
|
+
type ConnectionsCreateConnectionResponse = ConnectionsCreateConnectionResponses[keyof ConnectionsCreateConnectionResponses];
|
|
2758
|
+
type ConnectionsDeleteConnectionData = {
|
|
2759
|
+
body?: never;
|
|
2760
|
+
headers?: {
|
|
2761
|
+
/**
|
|
2762
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2763
|
+
*/
|
|
2764
|
+
companytoken?: string;
|
|
2765
|
+
};
|
|
2766
|
+
path: {
|
|
2767
|
+
/**
|
|
2768
|
+
* The identifier of the connection to delete.
|
|
2769
|
+
*/
|
|
2770
|
+
connectionId: number;
|
|
2771
|
+
};
|
|
2772
|
+
query?: never;
|
|
2773
|
+
url: '/v1/connections/{connectionId}';
|
|
2774
|
+
};
|
|
2775
|
+
type ConnectionsDeleteConnectionErrors = {
|
|
2776
|
+
/**
|
|
2777
|
+
* Bad request — malformed body or invalid parameters.
|
|
2778
|
+
*/
|
|
2779
|
+
400: ErrorResponse;
|
|
2780
|
+
/**
|
|
2781
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2782
|
+
*/
|
|
2783
|
+
401: ErrorResponse;
|
|
2784
|
+
/**
|
|
2785
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2786
|
+
*/
|
|
2787
|
+
403: ErrorResponse;
|
|
2788
|
+
/**
|
|
2789
|
+
* Not found — the resource does not exist.
|
|
2790
|
+
*/
|
|
2791
|
+
404: ErrorResponse;
|
|
2792
|
+
/**
|
|
2793
|
+
* Too many requests — rate limit exceeded.
|
|
2794
|
+
*/
|
|
2795
|
+
429: ErrorResponse;
|
|
2796
|
+
/**
|
|
2797
|
+
* Internal server error — an unexpected error occurred.
|
|
2798
|
+
*/
|
|
2799
|
+
500: ErrorResponse;
|
|
2800
|
+
};
|
|
2801
|
+
type ConnectionsDeleteConnectionError = ConnectionsDeleteConnectionErrors[keyof ConnectionsDeleteConnectionErrors];
|
|
2802
|
+
type ConnectionsDeleteConnectionResponses = {
|
|
2803
|
+
/**
|
|
2804
|
+
* An empty success response when the connection is deleted.
|
|
2805
|
+
*/
|
|
2806
|
+
200: Blob | File;
|
|
2807
|
+
};
|
|
2808
|
+
type ConnectionsDeleteConnectionResponse = ConnectionsDeleteConnectionResponses[keyof ConnectionsDeleteConnectionResponses];
|
|
2809
|
+
type ConnectionsGetConnectionData = {
|
|
2810
|
+
body?: never;
|
|
2811
|
+
headers?: {
|
|
2812
|
+
/**
|
|
2813
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2814
|
+
*/
|
|
2815
|
+
companytoken?: string;
|
|
2816
|
+
};
|
|
2817
|
+
path: {
|
|
2818
|
+
/**
|
|
2819
|
+
* The identifier of the connection to retrieve.
|
|
2820
|
+
*/
|
|
2821
|
+
connectionId: number;
|
|
2822
|
+
};
|
|
2823
|
+
query?: never;
|
|
2824
|
+
url: '/v1/connections/{connectionId}';
|
|
2825
|
+
};
|
|
2826
|
+
type ConnectionsGetConnectionErrors = {
|
|
2827
|
+
/**
|
|
2828
|
+
* Bad request — malformed body or invalid parameters.
|
|
2829
|
+
*/
|
|
2830
|
+
400: ErrorResponse;
|
|
2831
|
+
/**
|
|
2832
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2833
|
+
*/
|
|
2834
|
+
401: ErrorResponse;
|
|
2835
|
+
/**
|
|
2836
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2837
|
+
*/
|
|
2838
|
+
403: ErrorResponse;
|
|
2839
|
+
/**
|
|
2840
|
+
* Not found — the resource does not exist.
|
|
2841
|
+
*/
|
|
2842
|
+
404: ErrorResponse;
|
|
2843
|
+
/**
|
|
2844
|
+
* Too many requests — rate limit exceeded.
|
|
2845
|
+
*/
|
|
2846
|
+
429: ErrorResponse;
|
|
2847
|
+
/**
|
|
2848
|
+
* Internal server error — an unexpected error occurred.
|
|
2849
|
+
*/
|
|
2850
|
+
500: ErrorResponse;
|
|
2851
|
+
};
|
|
2852
|
+
type ConnectionsGetConnectionError = ConnectionsGetConnectionErrors[keyof ConnectionsGetConnectionErrors];
|
|
2853
|
+
type ConnectionsGetConnectionResponses = {
|
|
2854
|
+
/**
|
|
2855
|
+
* The detailed representation of the connection.
|
|
2856
|
+
*/
|
|
2857
|
+
200: ConnectionPublicDetail;
|
|
2858
|
+
};
|
|
2859
|
+
type ConnectionsGetConnectionResponse = ConnectionsGetConnectionResponses[keyof ConnectionsGetConnectionResponses];
|
|
2860
|
+
type ConnectionsUpdateConnectionData = {
|
|
2861
|
+
/**
|
|
2862
|
+
* The fields to update on the connection.
|
|
2863
|
+
*/
|
|
2864
|
+
body: UpdateConnectionRequest;
|
|
2865
|
+
headers?: {
|
|
2866
|
+
/**
|
|
2867
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2868
|
+
*/
|
|
2869
|
+
companytoken?: string;
|
|
2870
|
+
};
|
|
2871
|
+
path: {
|
|
2872
|
+
/**
|
|
2873
|
+
* The identifier of the connection to update.
|
|
2874
|
+
*/
|
|
2875
|
+
connectionId: number;
|
|
2876
|
+
};
|
|
2877
|
+
query?: never;
|
|
2878
|
+
url: '/v1/connections/{connectionId}';
|
|
2879
|
+
};
|
|
2880
|
+
type ConnectionsUpdateConnectionErrors = {
|
|
2881
|
+
/**
|
|
2882
|
+
* Bad request — malformed body or invalid parameters.
|
|
2883
|
+
*/
|
|
2884
|
+
400: ErrorResponse;
|
|
2885
|
+
/**
|
|
2886
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2887
|
+
*/
|
|
2888
|
+
401: ErrorResponse;
|
|
2889
|
+
/**
|
|
2890
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2891
|
+
*/
|
|
2892
|
+
403: ErrorResponse;
|
|
2893
|
+
/**
|
|
2894
|
+
* Not found — the resource does not exist.
|
|
2895
|
+
*/
|
|
2896
|
+
404: ErrorResponse;
|
|
2897
|
+
/**
|
|
2898
|
+
* Too many requests — rate limit exceeded.
|
|
2899
|
+
*/
|
|
2900
|
+
429: ErrorResponse;
|
|
2901
|
+
/**
|
|
2902
|
+
* Internal server error — an unexpected error occurred.
|
|
2903
|
+
*/
|
|
2904
|
+
500: ErrorResponse;
|
|
2905
|
+
};
|
|
2906
|
+
type ConnectionsUpdateConnectionError = ConnectionsUpdateConnectionErrors[keyof ConnectionsUpdateConnectionErrors];
|
|
2907
|
+
type ConnectionsUpdateConnectionResponses = {
|
|
2908
|
+
/**
|
|
2909
|
+
* The updated connection.
|
|
2910
|
+
*/
|
|
2911
|
+
200: ConnectionPublicDetail;
|
|
2912
|
+
};
|
|
2913
|
+
type ConnectionsUpdateConnectionResponse = ConnectionsUpdateConnectionResponses[keyof ConnectionsUpdateConnectionResponses];
|
|
2914
|
+
type ConnectionsGetDefaultConnectionsData = {
|
|
2915
|
+
body?: never;
|
|
2916
|
+
headers?: {
|
|
2917
|
+
/**
|
|
2918
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2919
|
+
*/
|
|
2920
|
+
companytoken?: string;
|
|
2921
|
+
};
|
|
2922
|
+
path?: never;
|
|
2923
|
+
query?: never;
|
|
2924
|
+
url: '/v1/connections/Defaults';
|
|
2925
|
+
};
|
|
2926
|
+
type ConnectionsGetDefaultConnectionsErrors = {
|
|
2927
|
+
/**
|
|
2928
|
+
* Bad request — malformed body or invalid parameters.
|
|
2929
|
+
*/
|
|
2930
|
+
400: ErrorResponse;
|
|
2931
|
+
/**
|
|
2932
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2933
|
+
*/
|
|
2934
|
+
401: ErrorResponse;
|
|
2935
|
+
/**
|
|
2936
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2937
|
+
*/
|
|
2938
|
+
403: ErrorResponse;
|
|
2939
|
+
/**
|
|
2940
|
+
* Not found — the resource does not exist.
|
|
2941
|
+
*/
|
|
2942
|
+
404: ErrorResponse;
|
|
2943
|
+
/**
|
|
2944
|
+
* Too many requests — rate limit exceeded.
|
|
2945
|
+
*/
|
|
2946
|
+
429: ErrorResponse;
|
|
2947
|
+
/**
|
|
2948
|
+
* Internal server error — an unexpected error occurred.
|
|
2949
|
+
*/
|
|
2950
|
+
500: ErrorResponse;
|
|
2951
|
+
};
|
|
2952
|
+
type ConnectionsGetDefaultConnectionsError = ConnectionsGetDefaultConnectionsErrors[keyof ConnectionsGetDefaultConnectionsErrors];
|
|
2953
|
+
type ConnectionsGetDefaultConnectionsResponses = {
|
|
2954
|
+
/**
|
|
2955
|
+
* The caller's default connections.
|
|
2956
|
+
*/
|
|
2957
|
+
200: DefaultConnectionsResponse;
|
|
2958
|
+
};
|
|
2959
|
+
type ConnectionsGetDefaultConnectionsResponse = ConnectionsGetDefaultConnectionsResponses[keyof ConnectionsGetDefaultConnectionsResponses];
|
|
2960
|
+
type ConnectionsClearDefaultConnectionData = {
|
|
2961
|
+
body?: never;
|
|
2962
|
+
headers?: {
|
|
2963
|
+
/**
|
|
2964
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
2965
|
+
*/
|
|
2966
|
+
companytoken?: string;
|
|
2967
|
+
};
|
|
2968
|
+
path: {
|
|
2969
|
+
/**
|
|
2970
|
+
* The identifier of the connection to clear as default.
|
|
2971
|
+
*/
|
|
2972
|
+
connectionId: number;
|
|
2973
|
+
};
|
|
2974
|
+
query?: never;
|
|
2975
|
+
url: '/v1/connections/{connectionId}/Default';
|
|
2976
|
+
};
|
|
2977
|
+
type ConnectionsClearDefaultConnectionErrors = {
|
|
2978
|
+
/**
|
|
2979
|
+
* Bad request — malformed body or invalid parameters.
|
|
2980
|
+
*/
|
|
2981
|
+
400: ErrorResponse;
|
|
2982
|
+
/**
|
|
2983
|
+
* Unauthorized — missing or invalid bearer token.
|
|
2984
|
+
*/
|
|
2985
|
+
401: ErrorResponse;
|
|
2986
|
+
/**
|
|
2987
|
+
* Forbidden — the caller lacks access to the resource.
|
|
2988
|
+
*/
|
|
2989
|
+
403: ErrorResponse;
|
|
2990
|
+
/**
|
|
2991
|
+
* Not found — the resource does not exist.
|
|
2992
|
+
*/
|
|
2993
|
+
404: ErrorResponse;
|
|
2994
|
+
/**
|
|
2995
|
+
* Too many requests — rate limit exceeded.
|
|
2996
|
+
*/
|
|
2997
|
+
429: ErrorResponse;
|
|
2998
|
+
/**
|
|
2999
|
+
* Internal server error — an unexpected error occurred.
|
|
3000
|
+
*/
|
|
3001
|
+
500: ErrorResponse;
|
|
3002
|
+
};
|
|
3003
|
+
type ConnectionsClearDefaultConnectionError = ConnectionsClearDefaultConnectionErrors[keyof ConnectionsClearDefaultConnectionErrors];
|
|
3004
|
+
type ConnectionsClearDefaultConnectionResponses = {
|
|
3005
|
+
/**
|
|
3006
|
+
* No content when the default is cleared successfully.
|
|
3007
|
+
*/
|
|
3008
|
+
200: Blob | File;
|
|
3009
|
+
};
|
|
3010
|
+
type ConnectionsClearDefaultConnectionResponse = ConnectionsClearDefaultConnectionResponses[keyof ConnectionsClearDefaultConnectionResponses];
|
|
3011
|
+
type ConnectionsSetDefaultConnectionData = {
|
|
3012
|
+
body?: never;
|
|
3013
|
+
headers?: {
|
|
3014
|
+
/**
|
|
3015
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3016
|
+
*/
|
|
3017
|
+
companytoken?: string;
|
|
3018
|
+
};
|
|
3019
|
+
path: {
|
|
3020
|
+
/**
|
|
3021
|
+
* The identifier of the connection to mark as default.
|
|
3022
|
+
*/
|
|
3023
|
+
connectionId: number;
|
|
3024
|
+
};
|
|
3025
|
+
query?: never;
|
|
3026
|
+
url: '/v1/connections/{connectionId}/Default';
|
|
3027
|
+
};
|
|
3028
|
+
type ConnectionsSetDefaultConnectionErrors = {
|
|
3029
|
+
/**
|
|
3030
|
+
* Bad request — malformed body or invalid parameters.
|
|
3031
|
+
*/
|
|
3032
|
+
400: ErrorResponse;
|
|
3033
|
+
/**
|
|
3034
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3035
|
+
*/
|
|
3036
|
+
401: ErrorResponse;
|
|
3037
|
+
/**
|
|
3038
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3039
|
+
*/
|
|
3040
|
+
403: ErrorResponse;
|
|
3041
|
+
/**
|
|
3042
|
+
* Not found — the resource does not exist.
|
|
3043
|
+
*/
|
|
3044
|
+
404: ErrorResponse;
|
|
3045
|
+
/**
|
|
3046
|
+
* Too many requests — rate limit exceeded.
|
|
3047
|
+
*/
|
|
3048
|
+
429: ErrorResponse;
|
|
3049
|
+
/**
|
|
3050
|
+
* Internal server error — an unexpected error occurred.
|
|
3051
|
+
*/
|
|
3052
|
+
500: ErrorResponse;
|
|
3053
|
+
};
|
|
3054
|
+
type ConnectionsSetDefaultConnectionError = ConnectionsSetDefaultConnectionErrors[keyof ConnectionsSetDefaultConnectionErrors];
|
|
3055
|
+
type ConnectionsSetDefaultConnectionResponses = {
|
|
3056
|
+
/**
|
|
3057
|
+
* The result of setting the default connection.
|
|
3058
|
+
*/
|
|
3059
|
+
200: SetDefaultConnectionResponse;
|
|
3060
|
+
};
|
|
3061
|
+
type ConnectionsSetDefaultConnectionResponse = ConnectionsSetDefaultConnectionResponses[keyof ConnectionsSetDefaultConnectionResponses];
|
|
3062
|
+
type ConnectionsReplaceConnectionData = {
|
|
3063
|
+
/**
|
|
3064
|
+
* The replacement payload identifying the source and target connections.
|
|
3065
|
+
*/
|
|
3066
|
+
body: ReplaceConnectionRequest;
|
|
3067
|
+
headers?: {
|
|
3068
|
+
/**
|
|
3069
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3070
|
+
*/
|
|
3071
|
+
companytoken?: string;
|
|
3072
|
+
};
|
|
3073
|
+
path?: never;
|
|
3074
|
+
query?: never;
|
|
3075
|
+
url: '/v1/connections/Replace';
|
|
3076
|
+
};
|
|
3077
|
+
type ConnectionsReplaceConnectionErrors = {
|
|
3078
|
+
/**
|
|
3079
|
+
* Bad request — malformed body or invalid parameters.
|
|
3080
|
+
*/
|
|
3081
|
+
400: ErrorResponse;
|
|
3082
|
+
/**
|
|
3083
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3084
|
+
*/
|
|
3085
|
+
401: ErrorResponse;
|
|
3086
|
+
/**
|
|
3087
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3088
|
+
*/
|
|
3089
|
+
403: ErrorResponse;
|
|
3090
|
+
/**
|
|
3091
|
+
* Not found — the resource does not exist.
|
|
3092
|
+
*/
|
|
3093
|
+
404: ErrorResponse;
|
|
3094
|
+
/**
|
|
3095
|
+
* Too many requests — rate limit exceeded.
|
|
3096
|
+
*/
|
|
3097
|
+
429: ErrorResponse;
|
|
3098
|
+
/**
|
|
3099
|
+
* Internal server error — an unexpected error occurred.
|
|
3100
|
+
*/
|
|
3101
|
+
500: ErrorResponse;
|
|
3102
|
+
};
|
|
3103
|
+
type ConnectionsReplaceConnectionError = ConnectionsReplaceConnectionErrors[keyof ConnectionsReplaceConnectionErrors];
|
|
3104
|
+
type ConnectionsReplaceConnectionResponses = {
|
|
3105
|
+
/**
|
|
3106
|
+
* An empty success response when the replacement completes.
|
|
3107
|
+
*/
|
|
3108
|
+
200: Blob | File;
|
|
3109
|
+
};
|
|
3110
|
+
type ConnectionsReplaceConnectionResponse = ConnectionsReplaceConnectionResponses[keyof ConnectionsReplaceConnectionResponses];
|
|
3111
|
+
type ConnectionsRefreshObjectsData = {
|
|
3112
|
+
body?: never;
|
|
3113
|
+
headers?: {
|
|
3114
|
+
/**
|
|
3115
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3116
|
+
*/
|
|
3117
|
+
companytoken?: string;
|
|
3118
|
+
};
|
|
3119
|
+
path: {
|
|
3120
|
+
/**
|
|
3121
|
+
* The identifier of the connection whose objects should be refreshed.
|
|
3122
|
+
*/
|
|
3123
|
+
connectionId: number;
|
|
3124
|
+
};
|
|
3125
|
+
query?: never;
|
|
3126
|
+
url: '/v1/connections/{connectionId}/RefreshObjects';
|
|
3127
|
+
};
|
|
3128
|
+
type ConnectionsRefreshObjectsErrors = {
|
|
3129
|
+
/**
|
|
3130
|
+
* Bad request — malformed body or invalid parameters.
|
|
3131
|
+
*/
|
|
3132
|
+
400: ErrorResponse;
|
|
3133
|
+
/**
|
|
3134
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3135
|
+
*/
|
|
3136
|
+
401: ErrorResponse;
|
|
3137
|
+
/**
|
|
3138
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3139
|
+
*/
|
|
3140
|
+
403: ErrorResponse;
|
|
3141
|
+
/**
|
|
3142
|
+
* Not found — the resource does not exist.
|
|
3143
|
+
*/
|
|
3144
|
+
404: ErrorResponse;
|
|
3145
|
+
/**
|
|
3146
|
+
* Too many requests — rate limit exceeded.
|
|
3147
|
+
*/
|
|
3148
|
+
429: ErrorResponse;
|
|
3149
|
+
/**
|
|
3150
|
+
* Internal server error — an unexpected error occurred.
|
|
3151
|
+
*/
|
|
3152
|
+
500: ErrorResponse;
|
|
3153
|
+
};
|
|
3154
|
+
type ConnectionsRefreshObjectsError = ConnectionsRefreshObjectsErrors[keyof ConnectionsRefreshObjectsErrors];
|
|
3155
|
+
type ConnectionsRefreshObjectsResponses = {
|
|
3156
|
+
/**
|
|
3157
|
+
* An empty success response when the refresh is initiated.
|
|
3158
|
+
*/
|
|
3159
|
+
200: Blob | File;
|
|
3160
|
+
};
|
|
3161
|
+
type ConnectionsRefreshObjectsResponse = ConnectionsRefreshObjectsResponses[keyof ConnectionsRefreshObjectsResponses];
|
|
3162
|
+
type ConnectionsGetRefreshStatusData = {
|
|
3163
|
+
body?: never;
|
|
3164
|
+
headers?: {
|
|
3165
|
+
/**
|
|
3166
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3167
|
+
*/
|
|
3168
|
+
companytoken?: string;
|
|
3169
|
+
};
|
|
3170
|
+
path: {
|
|
3171
|
+
/**
|
|
3172
|
+
* The identifier of the connection whose refresh status is requested.
|
|
3173
|
+
*/
|
|
3174
|
+
connectionId: number;
|
|
3175
|
+
};
|
|
3176
|
+
query?: never;
|
|
3177
|
+
url: '/v1/connections/{connectionId}/RefreshStatus';
|
|
3178
|
+
};
|
|
3179
|
+
type ConnectionsGetRefreshStatusErrors = {
|
|
3180
|
+
/**
|
|
3181
|
+
* Bad request — malformed body or invalid parameters.
|
|
3182
|
+
*/
|
|
3183
|
+
400: ErrorResponse;
|
|
3184
|
+
/**
|
|
3185
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3186
|
+
*/
|
|
3187
|
+
401: ErrorResponse;
|
|
3188
|
+
/**
|
|
3189
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3190
|
+
*/
|
|
3191
|
+
403: ErrorResponse;
|
|
3192
|
+
/**
|
|
3193
|
+
* Not found — the resource does not exist.
|
|
3194
|
+
*/
|
|
3195
|
+
404: ErrorResponse;
|
|
3196
|
+
/**
|
|
3197
|
+
* Too many requests — rate limit exceeded.
|
|
3198
|
+
*/
|
|
3199
|
+
429: ErrorResponse;
|
|
3200
|
+
/**
|
|
3201
|
+
* Internal server error — an unexpected error occurred.
|
|
3202
|
+
*/
|
|
3203
|
+
500: ErrorResponse;
|
|
3204
|
+
};
|
|
3205
|
+
type ConnectionsGetRefreshStatusError = ConnectionsGetRefreshStatusErrors[keyof ConnectionsGetRefreshStatusErrors];
|
|
3206
|
+
type ConnectionsGetRefreshStatusResponses = {
|
|
3207
|
+
/**
|
|
3208
|
+
* The current refresh status for the connection.
|
|
3209
|
+
*/
|
|
3210
|
+
200: RefreshStatusResponse;
|
|
3211
|
+
};
|
|
3212
|
+
type ConnectionsGetRefreshStatusResponse = ConnectionsGetRefreshStatusResponses[keyof ConnectionsGetRefreshStatusResponses];
|
|
3213
|
+
type ConnectionsSelectObjectsData = {
|
|
3214
|
+
/**
|
|
3215
|
+
* The request containing the identifiers of the objects to select.
|
|
3216
|
+
*/
|
|
3217
|
+
body: SelectObjectsRequest;
|
|
3218
|
+
headers?: {
|
|
3219
|
+
/**
|
|
3220
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3221
|
+
*/
|
|
3222
|
+
companytoken?: string;
|
|
3223
|
+
};
|
|
3224
|
+
path: {
|
|
3225
|
+
/**
|
|
3226
|
+
* The identifier of the connection whose objects are being selected.
|
|
3227
|
+
*/
|
|
3228
|
+
connectionId: number;
|
|
3229
|
+
};
|
|
3230
|
+
query?: never;
|
|
3231
|
+
url: '/v1/connections/{connectionId}/SelectObjects';
|
|
3232
|
+
};
|
|
3233
|
+
type ConnectionsSelectObjectsErrors = {
|
|
3234
|
+
/**
|
|
3235
|
+
* Bad request — malformed body or invalid parameters.
|
|
3236
|
+
*/
|
|
3237
|
+
400: ErrorResponse;
|
|
3238
|
+
/**
|
|
3239
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3240
|
+
*/
|
|
3241
|
+
401: ErrorResponse;
|
|
3242
|
+
/**
|
|
3243
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3244
|
+
*/
|
|
3245
|
+
403: ErrorResponse;
|
|
3246
|
+
/**
|
|
3247
|
+
* Not found — the resource does not exist.
|
|
3248
|
+
*/
|
|
3249
|
+
404: ErrorResponse;
|
|
3250
|
+
/**
|
|
3251
|
+
* Too many requests — rate limit exceeded.
|
|
3252
|
+
*/
|
|
3253
|
+
429: ErrorResponse;
|
|
3254
|
+
/**
|
|
3255
|
+
* Internal server error — an unexpected error occurred.
|
|
3256
|
+
*/
|
|
3257
|
+
500: ErrorResponse;
|
|
3258
|
+
};
|
|
3259
|
+
type ConnectionsSelectObjectsError = ConnectionsSelectObjectsErrors[keyof ConnectionsSelectObjectsErrors];
|
|
3260
|
+
type ConnectionsSelectObjectsResponses = {
|
|
3261
|
+
/**
|
|
3262
|
+
* An empty success response when the selection is saved.
|
|
3263
|
+
*/
|
|
3264
|
+
200: Blob | File;
|
|
3265
|
+
};
|
|
3266
|
+
type ConnectionsSelectObjectsResponse = ConnectionsSelectObjectsResponses[keyof ConnectionsSelectObjectsResponses];
|
|
3267
|
+
type ConnectionsGetConnectionObjectsData = {
|
|
3268
|
+
body?: never;
|
|
3269
|
+
headers?: {
|
|
3270
|
+
/**
|
|
3271
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3272
|
+
*/
|
|
3273
|
+
companytoken?: string;
|
|
3274
|
+
};
|
|
3275
|
+
path: {
|
|
3276
|
+
/**
|
|
3277
|
+
* The identifier of the connection whose objects are listed.
|
|
3278
|
+
*/
|
|
3279
|
+
connectionId: number;
|
|
3280
|
+
};
|
|
3281
|
+
query?: {
|
|
3282
|
+
/**
|
|
3283
|
+
* Optional name filter applied to the objects.
|
|
3284
|
+
*/
|
|
3285
|
+
name?: string | null;
|
|
3286
|
+
/**
|
|
3287
|
+
* Optional sort expression for ordering the objects.
|
|
3288
|
+
*/
|
|
3289
|
+
sort?: string | null;
|
|
3290
|
+
/**
|
|
3291
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
3292
|
+
*/
|
|
3293
|
+
offset?: number;
|
|
3294
|
+
/**
|
|
3295
|
+
* Maximum number of items to return (capped at 1000). Defaults to 100.
|
|
3296
|
+
*/
|
|
3297
|
+
top?: number;
|
|
3298
|
+
};
|
|
3299
|
+
url: '/v1/connections/{connectionId}/Objects';
|
|
3300
|
+
};
|
|
3301
|
+
type ConnectionsGetConnectionObjectsErrors = {
|
|
3302
|
+
/**
|
|
3303
|
+
* Bad request — malformed body or invalid parameters.
|
|
3304
|
+
*/
|
|
3305
|
+
400: ErrorResponse;
|
|
3306
|
+
/**
|
|
3307
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3308
|
+
*/
|
|
3309
|
+
401: ErrorResponse;
|
|
3310
|
+
/**
|
|
3311
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3312
|
+
*/
|
|
3313
|
+
403: ErrorResponse;
|
|
3314
|
+
/**
|
|
3315
|
+
* Not found — the resource does not exist.
|
|
3316
|
+
*/
|
|
3317
|
+
404: ErrorResponse;
|
|
3318
|
+
/**
|
|
3319
|
+
* Too many requests — rate limit exceeded.
|
|
3320
|
+
*/
|
|
3321
|
+
429: ErrorResponse;
|
|
3322
|
+
/**
|
|
3323
|
+
* Internal server error — an unexpected error occurred.
|
|
3324
|
+
*/
|
|
3325
|
+
500: ErrorResponse;
|
|
3326
|
+
};
|
|
3327
|
+
type ConnectionsGetConnectionObjectsError = ConnectionsGetConnectionObjectsErrors[keyof ConnectionsGetConnectionObjectsErrors];
|
|
3328
|
+
type ConnectionsGetConnectionObjectsResponses = {
|
|
3329
|
+
/**
|
|
3330
|
+
* A paginated list of connection objects.
|
|
3331
|
+
*/
|
|
3332
|
+
200: PaginatedResponseOfConnectionObject;
|
|
3333
|
+
};
|
|
3334
|
+
type ConnectionsGetConnectionObjectsResponse = ConnectionsGetConnectionObjectsResponses[keyof ConnectionsGetConnectionObjectsResponses];
|
|
3335
|
+
type ConnectionsCheckConnectionData = {
|
|
3336
|
+
body?: never;
|
|
3337
|
+
headers?: {
|
|
3338
|
+
/**
|
|
3339
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3340
|
+
*/
|
|
3341
|
+
companytoken?: string;
|
|
3342
|
+
};
|
|
3343
|
+
path: {
|
|
3344
|
+
/**
|
|
3345
|
+
* The identifier of the connection to check.
|
|
3346
|
+
*/
|
|
3347
|
+
connectionId: number;
|
|
3348
|
+
};
|
|
3349
|
+
query?: never;
|
|
3350
|
+
url: '/v1/connections/{connectionId}/Check';
|
|
3351
|
+
};
|
|
3352
|
+
type ConnectionsCheckConnectionErrors = {
|
|
3353
|
+
/**
|
|
3354
|
+
* Bad request — malformed body or invalid parameters.
|
|
3355
|
+
*/
|
|
3356
|
+
400: ErrorResponse;
|
|
3357
|
+
/**
|
|
3358
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3359
|
+
*/
|
|
3360
|
+
401: ErrorResponse;
|
|
3361
|
+
/**
|
|
3362
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3363
|
+
*/
|
|
3364
|
+
403: ErrorResponse;
|
|
3365
|
+
/**
|
|
3366
|
+
* Not found — the resource does not exist.
|
|
3367
|
+
*/
|
|
3368
|
+
404: ErrorResponse;
|
|
3369
|
+
/**
|
|
3370
|
+
* Too many requests — rate limit exceeded.
|
|
3371
|
+
*/
|
|
3372
|
+
429: ErrorResponse;
|
|
3373
|
+
/**
|
|
3374
|
+
* Internal server error — an unexpected error occurred.
|
|
3375
|
+
*/
|
|
3376
|
+
500: ErrorResponse;
|
|
3377
|
+
};
|
|
3378
|
+
type ConnectionsCheckConnectionError = ConnectionsCheckConnectionErrors[keyof ConnectionsCheckConnectionErrors];
|
|
3379
|
+
type ConnectionsCheckConnectionResponses = {
|
|
3380
|
+
/**
|
|
3381
|
+
* An empty success response when the connection is healthy.
|
|
3382
|
+
*/
|
|
3383
|
+
200: Blob | File;
|
|
3384
|
+
};
|
|
3385
|
+
type ConnectionsCheckConnectionResponse = ConnectionsCheckConnectionResponses[keyof ConnectionsCheckConnectionResponses];
|
|
3386
|
+
type ConnectionsGetSignInUrlData = {
|
|
3387
|
+
/**
|
|
3388
|
+
* The request describing the application, authentication method, and any provider fields.
|
|
3389
|
+
*/
|
|
3390
|
+
body: SignInUrlRequest;
|
|
3391
|
+
headers?: {
|
|
3392
|
+
/**
|
|
3393
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3394
|
+
*/
|
|
3395
|
+
companytoken?: string;
|
|
3396
|
+
};
|
|
3397
|
+
path?: never;
|
|
3398
|
+
query?: never;
|
|
3399
|
+
url: '/v1/connections/GetSignInUrl';
|
|
3400
|
+
};
|
|
3401
|
+
type ConnectionsGetSignInUrlErrors = {
|
|
3402
|
+
/**
|
|
3403
|
+
* Bad request — malformed body or invalid parameters.
|
|
3404
|
+
*/
|
|
3405
|
+
400: ErrorResponse;
|
|
3406
|
+
/**
|
|
3407
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3408
|
+
*/
|
|
3409
|
+
401: ErrorResponse;
|
|
3410
|
+
/**
|
|
3411
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3412
|
+
*/
|
|
3413
|
+
403: ErrorResponse;
|
|
3414
|
+
/**
|
|
3415
|
+
* Not found — the resource does not exist.
|
|
3416
|
+
*/
|
|
3417
|
+
404: ErrorResponse;
|
|
3418
|
+
/**
|
|
3419
|
+
* Too many requests — rate limit exceeded.
|
|
3420
|
+
*/
|
|
3421
|
+
429: ErrorResponse;
|
|
3422
|
+
/**
|
|
3423
|
+
* Internal server error — an unexpected error occurred.
|
|
3424
|
+
*/
|
|
3425
|
+
500: ErrorResponse;
|
|
3426
|
+
};
|
|
3427
|
+
type ConnectionsGetSignInUrlError = ConnectionsGetSignInUrlErrors[keyof ConnectionsGetSignInUrlErrors];
|
|
3428
|
+
type ConnectionsGetSignInUrlResponses = {
|
|
3429
|
+
/**
|
|
3430
|
+
* The sign-in URL together with the generated state value used to correlate the callback.
|
|
3431
|
+
*/
|
|
3432
|
+
200: SignInUrlResponse;
|
|
3433
|
+
};
|
|
3434
|
+
type ConnectionsGetSignInUrlResponse = ConnectionsGetSignInUrlResponses[keyof ConnectionsGetSignInUrlResponses];
|
|
3435
|
+
type ConnectionsGetAccessTokenData = {
|
|
3436
|
+
body?: never;
|
|
3437
|
+
headers?: {
|
|
3438
|
+
/**
|
|
3439
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3440
|
+
*/
|
|
3441
|
+
companytoken?: string;
|
|
3442
|
+
};
|
|
3443
|
+
path: {
|
|
3444
|
+
/**
|
|
3445
|
+
* The state value returned when the sign-in URL was generated.
|
|
3446
|
+
*/
|
|
3447
|
+
state: string;
|
|
3448
|
+
};
|
|
3449
|
+
query?: never;
|
|
3450
|
+
url: '/v1/connections/AccessToken/{state}';
|
|
3451
|
+
};
|
|
3452
|
+
type ConnectionsGetAccessTokenErrors = {
|
|
3453
|
+
/**
|
|
3454
|
+
* Bad request — malformed body or invalid parameters.
|
|
3455
|
+
*/
|
|
3456
|
+
400: ErrorResponse;
|
|
3457
|
+
/**
|
|
3458
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3459
|
+
*/
|
|
3460
|
+
401: ErrorResponse;
|
|
3461
|
+
/**
|
|
3462
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3463
|
+
*/
|
|
3464
|
+
403: ErrorResponse;
|
|
3465
|
+
/**
|
|
3466
|
+
* Not found — the resource does not exist.
|
|
3467
|
+
*/
|
|
3468
|
+
404: ErrorResponse;
|
|
3469
|
+
/**
|
|
3470
|
+
* Too many requests — rate limit exceeded.
|
|
3471
|
+
*/
|
|
3472
|
+
429: ErrorResponse;
|
|
3473
|
+
/**
|
|
3474
|
+
* Internal server error — an unexpected error occurred.
|
|
3475
|
+
*/
|
|
3476
|
+
500: ErrorResponse;
|
|
3477
|
+
};
|
|
3478
|
+
type ConnectionsGetAccessTokenError = ConnectionsGetAccessTokenErrors[keyof ConnectionsGetAccessTokenErrors];
|
|
3479
|
+
type ConnectionsGetAccessTokenResponses = {
|
|
3480
|
+
/**
|
|
3481
|
+
* The access token data for the state, or null if no token has been captured yet.
|
|
3482
|
+
*/
|
|
3483
|
+
200: AccessTokenResponse;
|
|
3484
|
+
};
|
|
3485
|
+
type ConnectionsGetAccessTokenResponse = ConnectionsGetAccessTokenResponses[keyof ConnectionsGetAccessTokenResponses];
|
|
3486
|
+
type ToolsListToolsData = {
|
|
3487
|
+
body?: never;
|
|
3488
|
+
headers?: {
|
|
3489
|
+
/**
|
|
3490
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3491
|
+
*/
|
|
3492
|
+
companytoken?: string;
|
|
3493
|
+
};
|
|
3494
|
+
path?: never;
|
|
3495
|
+
query?: {
|
|
3496
|
+
/**
|
|
3497
|
+
* Optional free-text search applied across tool fields.
|
|
3498
|
+
*/
|
|
3499
|
+
search?: string | null;
|
|
3500
|
+
/**
|
|
3501
|
+
* Optional exact-name filter.
|
|
3502
|
+
*/
|
|
3503
|
+
name?: string | null;
|
|
3504
|
+
/**
|
|
3505
|
+
* Optional filter limiting results to tools of a specific application.
|
|
3506
|
+
*/
|
|
3507
|
+
applicationSlug?: string | null;
|
|
3508
|
+
/**
|
|
3509
|
+
* Optional category filter.
|
|
3510
|
+
*/
|
|
3511
|
+
category?: string | null;
|
|
3512
|
+
/**
|
|
3513
|
+
* When true, returns only tools the caller can currently execute. Defaults to false.
|
|
3514
|
+
*/
|
|
3515
|
+
available?: boolean;
|
|
3516
|
+
/**
|
|
3517
|
+
* When true, includes deprecated tools in the results. Defaults to false.
|
|
3518
|
+
*/
|
|
3519
|
+
includeDeprecated?: boolean;
|
|
3520
|
+
/**
|
|
3521
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
3522
|
+
*/
|
|
3523
|
+
offset?: number;
|
|
3524
|
+
/**
|
|
3525
|
+
* Maximum number of items to return. Defaults to 100.
|
|
3526
|
+
*/
|
|
3527
|
+
top?: number;
|
|
3528
|
+
/**
|
|
3529
|
+
* Optional toolset id; when supplied, the caller's workflow tools in that toolset are included alongside activity tools.
|
|
3530
|
+
*/
|
|
3531
|
+
toolsetId?: string | null;
|
|
3532
|
+
};
|
|
3533
|
+
url: '/v1/tools';
|
|
3534
|
+
};
|
|
3535
|
+
type ToolsListToolsErrors = {
|
|
3536
|
+
400: ErrorResponse;
|
|
3537
|
+
401: ErrorResponse;
|
|
3538
|
+
/**
|
|
3539
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3540
|
+
*/
|
|
3541
|
+
403: ErrorResponse;
|
|
3542
|
+
/**
|
|
3543
|
+
* Not found — the resource does not exist.
|
|
3544
|
+
*/
|
|
3545
|
+
404: ErrorResponse;
|
|
3546
|
+
/**
|
|
3547
|
+
* Too many requests — rate limit exceeded.
|
|
3548
|
+
*/
|
|
3549
|
+
429: ErrorResponse;
|
|
3550
|
+
/**
|
|
3551
|
+
* Internal server error — an unexpected error occurred.
|
|
3552
|
+
*/
|
|
3553
|
+
500: ErrorResponse;
|
|
3554
|
+
};
|
|
3555
|
+
type ToolsListToolsError = ToolsListToolsErrors[keyof ToolsListToolsErrors];
|
|
3556
|
+
type ToolsListToolsResponses = {
|
|
3557
|
+
/**
|
|
3558
|
+
* A paginated list of tools.
|
|
3559
|
+
*/
|
|
3560
|
+
200: PaginatedResponseOfToolDto;
|
|
3561
|
+
};
|
|
3562
|
+
type ToolsListToolsResponse = ToolsListToolsResponses[keyof ToolsListToolsResponses];
|
|
3563
|
+
type ToolsGetToolData = {
|
|
3564
|
+
body?: never;
|
|
3565
|
+
headers?: {
|
|
3566
|
+
/**
|
|
3567
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3568
|
+
*/
|
|
3569
|
+
companytoken?: string;
|
|
3570
|
+
};
|
|
3571
|
+
path: {
|
|
3572
|
+
/**
|
|
3573
|
+
* The slug identifying the tool to retrieve.
|
|
3574
|
+
*/
|
|
3575
|
+
toolSlug: string;
|
|
3576
|
+
};
|
|
3577
|
+
query?: {
|
|
3578
|
+
/**
|
|
3579
|
+
* Optional parent-application slug used to disambiguate when the same tool slug exists across applications.
|
|
3580
|
+
*/
|
|
3581
|
+
applicationSlug?: string | null;
|
|
3582
|
+
/**
|
|
3583
|
+
* Optional toolset id; when supplied, a slug naming one of the caller's workflows in that toolset resolves to the workflow-tool detail.
|
|
3584
|
+
*/
|
|
3585
|
+
toolsetId?: string | null;
|
|
3586
|
+
};
|
|
3587
|
+
url: '/v1/tools/{toolSlug}';
|
|
3588
|
+
};
|
|
3589
|
+
type ToolsGetToolErrors = {
|
|
3590
|
+
400: ErrorResponse;
|
|
3591
|
+
401: ErrorResponse;
|
|
3592
|
+
/**
|
|
3593
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3594
|
+
*/
|
|
3595
|
+
403: ErrorResponse;
|
|
3596
|
+
404: ErrorResponse;
|
|
3597
|
+
/**
|
|
3598
|
+
* Too many requests — rate limit exceeded.
|
|
3599
|
+
*/
|
|
3600
|
+
429: ErrorResponse;
|
|
3601
|
+
/**
|
|
3602
|
+
* Internal server error — an unexpected error occurred.
|
|
3603
|
+
*/
|
|
3604
|
+
500: ErrorResponse;
|
|
3605
|
+
};
|
|
3606
|
+
type ToolsGetToolError = ToolsGetToolErrors[keyof ToolsGetToolErrors];
|
|
3607
|
+
type ToolsGetToolResponses = {
|
|
3608
|
+
/**
|
|
3609
|
+
* The detailed representation of the tool.
|
|
3610
|
+
*/
|
|
3611
|
+
200: ToolDetailDto;
|
|
3612
|
+
};
|
|
3613
|
+
type ToolsGetToolResponse = ToolsGetToolResponses[keyof ToolsGetToolResponses];
|
|
3614
|
+
type ToolsExecuteToolData = {
|
|
3615
|
+
/**
|
|
3616
|
+
* The execution request containing the tool's input arguments.
|
|
3617
|
+
*/
|
|
3618
|
+
body: ToolExecuteRequest;
|
|
3619
|
+
headers?: {
|
|
3620
|
+
/**
|
|
3621
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3622
|
+
*/
|
|
3623
|
+
companytoken?: string;
|
|
3624
|
+
};
|
|
3625
|
+
path: {
|
|
3626
|
+
/**
|
|
3627
|
+
* The slug identifying the tool to execute.
|
|
3628
|
+
*/
|
|
3629
|
+
toolSlug: string;
|
|
3630
|
+
};
|
|
3631
|
+
query?: {
|
|
3632
|
+
/**
|
|
3633
|
+
* Optional toolset identifier used to scope connection resolution.
|
|
3634
|
+
*/
|
|
3635
|
+
toolsetId?: string | null;
|
|
3636
|
+
/**
|
|
3637
|
+
* Optional explicit connection identifier to use instead of the implicitly resolved connection.
|
|
3638
|
+
*/
|
|
3639
|
+
connectionId?: number | null;
|
|
3640
|
+
};
|
|
3641
|
+
url: '/v1/tools/{toolSlug}/execute';
|
|
3642
|
+
};
|
|
3643
|
+
type ToolsExecuteToolErrors = {
|
|
3644
|
+
400: ErrorResponse;
|
|
3645
|
+
401: ErrorResponse;
|
|
3646
|
+
403: ErrorResponse;
|
|
3647
|
+
404: ErrorResponse;
|
|
3648
|
+
409: ErrorResponse;
|
|
3649
|
+
/**
|
|
3650
|
+
* Too many requests — rate limit exceeded.
|
|
3651
|
+
*/
|
|
3652
|
+
429: ErrorResponse;
|
|
3653
|
+
/**
|
|
3654
|
+
* Internal server error — an unexpected error occurred.
|
|
3655
|
+
*/
|
|
3656
|
+
500: ErrorResponse;
|
|
3657
|
+
};
|
|
3658
|
+
type ToolsExecuteToolError = ToolsExecuteToolErrors[keyof ToolsExecuteToolErrors];
|
|
3659
|
+
type ToolsExecuteToolResponses = {
|
|
3660
|
+
/**
|
|
3661
|
+
* The tool execution result, including success status and any output.
|
|
3662
|
+
*/
|
|
3663
|
+
200: ToolExecuteResponse;
|
|
3664
|
+
};
|
|
3665
|
+
type ToolsExecuteToolResponse = ToolsExecuteToolResponses[keyof ToolsExecuteToolResponses];
|
|
3666
|
+
type ToolsetsListToolsetsData = {
|
|
3667
|
+
body?: never;
|
|
3668
|
+
headers?: {
|
|
3669
|
+
/**
|
|
3670
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3671
|
+
*/
|
|
3672
|
+
companytoken?: string;
|
|
3673
|
+
};
|
|
3674
|
+
path?: never;
|
|
3675
|
+
query?: {
|
|
3676
|
+
/**
|
|
3677
|
+
* Zero-based index of the first item to return. Defaults to 0.
|
|
3678
|
+
*/
|
|
3679
|
+
offset?: number;
|
|
3680
|
+
/**
|
|
3681
|
+
* Maximum number of items to return (capped at 100). Defaults to 100.
|
|
3682
|
+
*/
|
|
3683
|
+
top?: number;
|
|
3684
|
+
};
|
|
3685
|
+
url: '/v1/toolsets';
|
|
3686
|
+
};
|
|
3687
|
+
type ToolsetsListToolsetsErrors = {
|
|
3688
|
+
/**
|
|
3689
|
+
* Bad request — malformed body or invalid parameters.
|
|
3690
|
+
*/
|
|
3691
|
+
400: ErrorResponse;
|
|
3692
|
+
/**
|
|
3693
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3694
|
+
*/
|
|
3695
|
+
401: ErrorResponse;
|
|
3696
|
+
/**
|
|
3697
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3698
|
+
*/
|
|
3699
|
+
403: ErrorResponse;
|
|
3700
|
+
/**
|
|
3701
|
+
* Not found — the resource does not exist.
|
|
3702
|
+
*/
|
|
3703
|
+
404: ErrorResponse;
|
|
3704
|
+
/**
|
|
3705
|
+
* Too many requests — rate limit exceeded.
|
|
3706
|
+
*/
|
|
3707
|
+
429: ErrorResponse;
|
|
3708
|
+
/**
|
|
3709
|
+
* Internal server error — an unexpected error occurred.
|
|
3710
|
+
*/
|
|
3711
|
+
500: ErrorResponse;
|
|
3712
|
+
};
|
|
3713
|
+
type ToolsetsListToolsetsError = ToolsetsListToolsetsErrors[keyof ToolsetsListToolsetsErrors];
|
|
3714
|
+
type ToolsetsListToolsetsResponses = {
|
|
3715
|
+
/**
|
|
3716
|
+
* A paginated list of toolsets.
|
|
3717
|
+
*/
|
|
3718
|
+
200: PaginatedResponseOfToolsetDto;
|
|
3719
|
+
};
|
|
3720
|
+
type ToolsetsListToolsetsResponse = ToolsetsListToolsetsResponses[keyof ToolsetsListToolsetsResponses];
|
|
3721
|
+
type ToolsetsCreateToolsetData = {
|
|
3722
|
+
/**
|
|
3723
|
+
* The toolset creation payload.
|
|
3724
|
+
*/
|
|
3725
|
+
body: CreateToolsetRequest;
|
|
3726
|
+
headers?: {
|
|
3727
|
+
/**
|
|
3728
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3729
|
+
*/
|
|
3730
|
+
companytoken?: string;
|
|
3731
|
+
};
|
|
3732
|
+
path?: never;
|
|
3733
|
+
query?: never;
|
|
3734
|
+
url: '/v1/toolsets';
|
|
3735
|
+
};
|
|
3736
|
+
type ToolsetsCreateToolsetErrors = {
|
|
3737
|
+
/**
|
|
3738
|
+
* Bad request — malformed body or invalid parameters.
|
|
3739
|
+
*/
|
|
3740
|
+
400: ErrorResponse;
|
|
3741
|
+
/**
|
|
3742
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3743
|
+
*/
|
|
3744
|
+
401: ErrorResponse;
|
|
3745
|
+
/**
|
|
3746
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3747
|
+
*/
|
|
3748
|
+
403: ErrorResponse;
|
|
3749
|
+
/**
|
|
3750
|
+
* Not found — the resource does not exist.
|
|
3751
|
+
*/
|
|
3752
|
+
404: ErrorResponse;
|
|
3753
|
+
/**
|
|
3754
|
+
* Too many requests — rate limit exceeded.
|
|
3755
|
+
*/
|
|
3756
|
+
429: ErrorResponse;
|
|
3757
|
+
/**
|
|
3758
|
+
* Internal server error — an unexpected error occurred.
|
|
3759
|
+
*/
|
|
3760
|
+
500: ErrorResponse;
|
|
3761
|
+
};
|
|
3762
|
+
type ToolsetsCreateToolsetError = ToolsetsCreateToolsetErrors[keyof ToolsetsCreateToolsetErrors];
|
|
3763
|
+
type ToolsetsCreateToolsetResponses = {
|
|
3764
|
+
/**
|
|
3765
|
+
* The newly created toolset.
|
|
3766
|
+
*/
|
|
3767
|
+
200: ToolsetDto;
|
|
3768
|
+
};
|
|
3769
|
+
type ToolsetsCreateToolsetResponse = ToolsetsCreateToolsetResponses[keyof ToolsetsCreateToolsetResponses];
|
|
3770
|
+
type ToolsetsDeleteToolsetData = {
|
|
3771
|
+
body?: never;
|
|
3772
|
+
headers?: {
|
|
3773
|
+
/**
|
|
3774
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3775
|
+
*/
|
|
3776
|
+
companytoken?: string;
|
|
3777
|
+
};
|
|
3778
|
+
path: {
|
|
3779
|
+
/**
|
|
3780
|
+
* The identifier of the toolset to delete.
|
|
3781
|
+
*/
|
|
3782
|
+
toolsetId: string;
|
|
3783
|
+
};
|
|
3784
|
+
query?: never;
|
|
3785
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
3786
|
+
};
|
|
3787
|
+
type ToolsetsDeleteToolsetErrors = {
|
|
3788
|
+
/**
|
|
3789
|
+
* Bad request — malformed body or invalid parameters.
|
|
3790
|
+
*/
|
|
3791
|
+
400: ErrorResponse;
|
|
3792
|
+
/**
|
|
3793
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3794
|
+
*/
|
|
3795
|
+
401: ErrorResponse;
|
|
3796
|
+
/**
|
|
3797
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3798
|
+
*/
|
|
3799
|
+
403: ErrorResponse;
|
|
3800
|
+
/**
|
|
3801
|
+
* Not found — the resource does not exist.
|
|
3802
|
+
*/
|
|
3803
|
+
404: ErrorResponse;
|
|
3804
|
+
/**
|
|
3805
|
+
* Too many requests — rate limit exceeded.
|
|
3806
|
+
*/
|
|
3807
|
+
429: ErrorResponse;
|
|
3808
|
+
/**
|
|
3809
|
+
* Internal server error — an unexpected error occurred.
|
|
3810
|
+
*/
|
|
3811
|
+
500: ErrorResponse;
|
|
3812
|
+
};
|
|
3813
|
+
type ToolsetsDeleteToolsetError = ToolsetsDeleteToolsetErrors[keyof ToolsetsDeleteToolsetErrors];
|
|
3814
|
+
type ToolsetsDeleteToolsetResponses = {
|
|
3815
|
+
/**
|
|
3816
|
+
* No content when the toolset is deleted successfully.
|
|
3817
|
+
*/
|
|
3818
|
+
200: Blob | File;
|
|
3819
|
+
};
|
|
3820
|
+
type ToolsetsDeleteToolsetResponse = ToolsetsDeleteToolsetResponses[keyof ToolsetsDeleteToolsetResponses];
|
|
3821
|
+
type ToolsetsGetToolsetData = {
|
|
3822
|
+
body?: never;
|
|
3823
|
+
headers?: {
|
|
3824
|
+
/**
|
|
3825
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3826
|
+
*/
|
|
3827
|
+
companytoken?: string;
|
|
3828
|
+
};
|
|
3829
|
+
path: {
|
|
3830
|
+
/**
|
|
3831
|
+
* The identifier of the toolset to retrieve.
|
|
3832
|
+
*/
|
|
3833
|
+
toolsetId: string;
|
|
3834
|
+
};
|
|
3835
|
+
query?: never;
|
|
3836
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
3837
|
+
};
|
|
3838
|
+
type ToolsetsGetToolsetErrors = {
|
|
3839
|
+
/**
|
|
3840
|
+
* Bad request — malformed body or invalid parameters.
|
|
3841
|
+
*/
|
|
3842
|
+
400: ErrorResponse;
|
|
3843
|
+
/**
|
|
3844
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3845
|
+
*/
|
|
3846
|
+
401: ErrorResponse;
|
|
3847
|
+
/**
|
|
3848
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3849
|
+
*/
|
|
3850
|
+
403: ErrorResponse;
|
|
3851
|
+
/**
|
|
3852
|
+
* Not found — the resource does not exist.
|
|
3853
|
+
*/
|
|
3854
|
+
404: ErrorResponse;
|
|
3855
|
+
/**
|
|
3856
|
+
* Too many requests — rate limit exceeded.
|
|
3857
|
+
*/
|
|
3858
|
+
429: ErrorResponse;
|
|
3859
|
+
/**
|
|
3860
|
+
* Internal server error — an unexpected error occurred.
|
|
3861
|
+
*/
|
|
3862
|
+
500: ErrorResponse;
|
|
3863
|
+
};
|
|
3864
|
+
type ToolsetsGetToolsetError = ToolsetsGetToolsetErrors[keyof ToolsetsGetToolsetErrors];
|
|
3865
|
+
type ToolsetsGetToolsetResponses = {
|
|
3866
|
+
/**
|
|
3867
|
+
* The requested toolset.
|
|
3868
|
+
*/
|
|
3869
|
+
200: ToolsetDto;
|
|
3870
|
+
};
|
|
3871
|
+
type ToolsetsGetToolsetResponse = ToolsetsGetToolsetResponses[keyof ToolsetsGetToolsetResponses];
|
|
3872
|
+
type ToolsetsUpdateToolsetData = {
|
|
3873
|
+
/**
|
|
3874
|
+
* The fields to update on the toolset.
|
|
3875
|
+
*/
|
|
3876
|
+
body: UpdateToolsetRequest;
|
|
3877
|
+
headers?: {
|
|
3878
|
+
/**
|
|
3879
|
+
* Account token. Optional — alternatively send the AccountToken JWT claim.
|
|
3880
|
+
*/
|
|
3881
|
+
companytoken?: string;
|
|
3882
|
+
};
|
|
3883
|
+
path: {
|
|
3884
|
+
/**
|
|
3885
|
+
* The identifier of the toolset to update.
|
|
3886
|
+
*/
|
|
3887
|
+
toolsetId: string;
|
|
3888
|
+
};
|
|
3889
|
+
query?: never;
|
|
3890
|
+
url: '/v1/toolsets/{toolsetId}';
|
|
3891
|
+
};
|
|
3892
|
+
type ToolsetsUpdateToolsetErrors = {
|
|
3893
|
+
/**
|
|
3894
|
+
* Bad request — malformed body or invalid parameters.
|
|
3895
|
+
*/
|
|
3896
|
+
400: ErrorResponse;
|
|
3897
|
+
/**
|
|
3898
|
+
* Unauthorized — missing or invalid bearer token.
|
|
3899
|
+
*/
|
|
3900
|
+
401: ErrorResponse;
|
|
3901
|
+
/**
|
|
3902
|
+
* Forbidden — the caller lacks access to the resource.
|
|
3903
|
+
*/
|
|
3904
|
+
403: ErrorResponse;
|
|
3905
|
+
/**
|
|
3906
|
+
* Not found — the resource does not exist.
|
|
3907
|
+
*/
|
|
3908
|
+
404: ErrorResponse;
|
|
3909
|
+
/**
|
|
3910
|
+
* Too many requests — rate limit exceeded.
|
|
3911
|
+
*/
|
|
3912
|
+
429: ErrorResponse;
|
|
3913
|
+
/**
|
|
3914
|
+
* Internal server error — an unexpected error occurred.
|
|
3915
|
+
*/
|
|
3916
|
+
500: ErrorResponse;
|
|
3917
|
+
};
|
|
3918
|
+
type ToolsetsUpdateToolsetError = ToolsetsUpdateToolsetErrors[keyof ToolsetsUpdateToolsetErrors];
|
|
3919
|
+
type ToolsetsUpdateToolsetResponses = {
|
|
3920
|
+
/**
|
|
3921
|
+
* The updated toolset.
|
|
3922
|
+
*/
|
|
3923
|
+
200: ToolsetDto;
|
|
3924
|
+
};
|
|
3925
|
+
type ToolsetsUpdateToolsetResponse = ToolsetsUpdateToolsetResponses[keyof ToolsetsUpdateToolsetResponses];
|
|
3926
|
+
|
|
3927
|
+
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
|
|
3928
|
+
/**
|
|
3929
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
3930
|
+
* individual options. This might be also useful if you want to implement a
|
|
3931
|
+
* custom client.
|
|
3932
|
+
*/
|
|
3933
|
+
client?: Client;
|
|
3934
|
+
/**
|
|
3935
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
3936
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
3937
|
+
*/
|
|
3938
|
+
meta?: Record<string, unknown>;
|
|
3939
|
+
};
|
|
3940
|
+
/**
|
|
3941
|
+
* Returns the identity of the principal the request is authenticated as: full name, email,
|
|
3942
|
+
* current company, role, and caller type. For x-api-key requests the identity is the
|
|
3943
|
+
* token's owner (the key acts as the owner) and the type is reported as apiuser.
|
|
3944
|
+
*/
|
|
3945
|
+
declare const authWhoAmI: <ThrowOnError extends boolean = false>(options?: Options<AuthWhoAmIData, ThrowOnError>) => RequestResult<AuthWhoAmIResponses, AuthWhoAmIErrors, ThrowOnError>;
|
|
3946
|
+
/**
|
|
3947
|
+
* Creates a new solution (Engini admin only). The request's build manifest is compiled into a
|
|
3948
|
+
* stored manifest, and the resulting solution is returned together with any build warnings.
|
|
3949
|
+
*/
|
|
3950
|
+
declare const solutionsCreateSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsCreateSolutionData, ThrowOnError>) => RequestResult<SolutionsCreateSolutionResponses, SolutionsCreateSolutionErrors, ThrowOnError>;
|
|
3951
|
+
/**
|
|
3952
|
+
* Archives the solution identified by its slug (Engini admin only), removing it from the published catalog.
|
|
3953
|
+
*/
|
|
3954
|
+
declare const solutionsArchiveSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsArchiveSolutionData, ThrowOnError>) => RequestResult<SolutionsArchiveSolutionResponses, SolutionsArchiveSolutionErrors, ThrowOnError>;
|
|
3955
|
+
/**
|
|
3956
|
+
* Updates an existing solution identified by its slug (Engini admin only). When a build manifest
|
|
3957
|
+
* is supplied, the manifest is rebuilt and persisted; otherwise only the solution metadata is updated.
|
|
3958
|
+
*/
|
|
3959
|
+
declare const solutionsUpdateSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsUpdateSolutionData, ThrowOnError>) => RequestResult<SolutionsUpdateSolutionResponses, SolutionsUpdateSolutionErrors, ThrowOnError>;
|
|
3960
|
+
/**
|
|
3961
|
+
* Publishes the solution identified by its slug (Engini admin only), making it available in the public catalog.
|
|
3962
|
+
*/
|
|
3963
|
+
declare const solutionsPublishSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsPublishSolutionData, ThrowOnError>) => RequestResult<SolutionsPublishSolutionResponses, SolutionsPublishSolutionErrors, ThrowOnError>;
|
|
3964
|
+
/**
|
|
3965
|
+
* Builds a solution manifest from the supplied workflows, tables, and connections (Engini admin only).
|
|
3966
|
+
* When a slug is provided, the freshly built manifest is also persisted onto the existing solution,
|
|
3967
|
+
* bumping its manifest version and notifying installations.
|
|
3968
|
+
*/
|
|
3969
|
+
declare const solutionsBuildManifest: <ThrowOnError extends boolean = false>(options: Options<SolutionsBuildManifestData, ThrowOnError>) => RequestResult<SolutionsBuildManifestResponses, SolutionsBuildManifestErrors, ThrowOnError>;
|
|
3970
|
+
/**
|
|
3971
|
+
* Returns a paginated list of published solutions from the public catalog.
|
|
3972
|
+
*/
|
|
3973
|
+
declare const solutionsGetPublishedSolutions: <ThrowOnError extends boolean = false>(options?: Options<SolutionsGetPublishedSolutionsData, ThrowOnError>) => RequestResult<SolutionsGetPublishedSolutionsResponses, SolutionsGetPublishedSolutionsErrors, ThrowOnError>;
|
|
3974
|
+
/**
|
|
3975
|
+
* Returns the detail of a single published solution identified by its slug.
|
|
3976
|
+
*/
|
|
3977
|
+
declare const solutionsGetSolutionBySlug: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetSolutionBySlugData, ThrowOnError>) => RequestResult<SolutionsGetSolutionBySlugResponses, SolutionsGetSolutionBySlugErrors, ThrowOnError>;
|
|
3978
|
+
/**
|
|
3979
|
+
* Returns the solution installations belonging to the calling account, optionally filtered by
|
|
3980
|
+
* solution slug and installation status.
|
|
3981
|
+
*/
|
|
3982
|
+
declare const solutionsGetInstallations: <ThrowOnError extends boolean = false>(options?: Options<SolutionsGetInstallationsData, ThrowOnError>) => RequestResult<SolutionsGetInstallationsResponses, SolutionsGetInstallationsErrors, ThrowOnError>;
|
|
3983
|
+
/**
|
|
3984
|
+
* Returns the detail of a single installation belonging to the calling account.
|
|
3985
|
+
*/
|
|
3986
|
+
declare const solutionsGetInstallationDetail: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetInstallationDetailData, ThrowOnError>) => RequestResult<SolutionsGetInstallationDetailResponses, SolutionsGetInstallationDetailErrors, ThrowOnError>;
|
|
3987
|
+
/**
|
|
3988
|
+
* Returns the provisioned resources for a given installation belonging to the calling account,
|
|
3989
|
+
* optionally filtered by resource key and resource type.
|
|
3990
|
+
*/
|
|
3991
|
+
declare const solutionsGetInstallationResources: <ThrowOnError extends boolean = false>(options: Options<SolutionsGetInstallationResourcesData, ThrowOnError>) => RequestResult<SolutionsGetInstallationResourcesResponses, SolutionsGetInstallationResourcesErrors, ThrowOnError>;
|
|
3992
|
+
/**
|
|
3993
|
+
* Installs the solution identified by its slug into the calling account's workspace, provisioning
|
|
3994
|
+
* the solution's resources. This endpoint is rate limited.
|
|
3995
|
+
*/
|
|
3996
|
+
declare const solutionsInstallSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsInstallSolutionData, ThrowOnError>) => RequestResult<SolutionsInstallSolutionResponses, SolutionsInstallSolutionErrors, ThrowOnError>;
|
|
3997
|
+
/**
|
|
3998
|
+
* Updates an existing installation to the latest solution manifest version, re-provisioning resources
|
|
3999
|
+
* as needed. Returns a 409 with the blocking conditions when the update is blocked and not forced.
|
|
4000
|
+
* This endpoint is rate limited.
|
|
4001
|
+
*/
|
|
4002
|
+
declare const solutionsUpdateInstallation: <ThrowOnError extends boolean = false>(options: Options<SolutionsUpdateInstallationData, ThrowOnError>) => RequestResult<SolutionsUpdateInstallationResponses, SolutionsUpdateInstallationErrors, ThrowOnError>;
|
|
4003
|
+
/**
|
|
4004
|
+
* Uninstalls a solution installation from the calling account's workspace, optionally deleting the
|
|
4005
|
+
* associated connections, workflows, and tables. This endpoint is rate limited.
|
|
4006
|
+
*/
|
|
4007
|
+
declare const solutionsUninstallSolution: <ThrowOnError extends boolean = false>(options: Options<SolutionsUninstallSolutionData, ThrowOnError>) => RequestResult<SolutionsUninstallSolutionResponses, SolutionsUninstallSolutionErrors, ThrowOnError>;
|
|
4008
|
+
/**
|
|
4009
|
+
* List the applications available to the caller, with optional filtering and pagination.
|
|
4010
|
+
*/
|
|
4011
|
+
declare const applicationsListApplications: <ThrowOnError extends boolean = false>(options?: Options<ApplicationsListApplicationsData, ThrowOnError>) => RequestResult<ApplicationsListApplicationsResponses, ApplicationsListApplicationsErrors, ThrowOnError>;
|
|
4012
|
+
/**
|
|
4013
|
+
* Get the full details of a single application identified by its slug.
|
|
4014
|
+
*/
|
|
4015
|
+
declare const applicationsGetApplication: <ThrowOnError extends boolean = false>(options: Options<ApplicationsGetApplicationData, ThrowOnError>) => RequestResult<ApplicationsGetApplicationResponses, ApplicationsGetApplicationErrors, ThrowOnError>;
|
|
4016
|
+
/**
|
|
4017
|
+
* List the connections available to the caller, with optional filtering and pagination.
|
|
4018
|
+
*/
|
|
4019
|
+
declare const connectionsGetConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionsResponses, ConnectionsGetConnectionsErrors, ThrowOnError>;
|
|
4020
|
+
/**
|
|
4021
|
+
* Create a new connection for the caller.
|
|
4022
|
+
*/
|
|
4023
|
+
declare const connectionsCreateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCreateConnectionData, ThrowOnError>) => RequestResult<ConnectionsCreateConnectionResponses, ConnectionsCreateConnectionErrors, ThrowOnError>;
|
|
4024
|
+
/**
|
|
4025
|
+
* Delete a connection owned by the caller.
|
|
4026
|
+
*/
|
|
4027
|
+
declare const connectionsDeleteConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsDeleteConnectionData, ThrowOnError>) => RequestResult<ConnectionsDeleteConnectionResponses, ConnectionsDeleteConnectionErrors, ThrowOnError>;
|
|
4028
|
+
/**
|
|
4029
|
+
* Get the full details of a single connection identified by its id.
|
|
4030
|
+
*/
|
|
4031
|
+
declare const connectionsGetConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionResponses, ConnectionsGetConnectionErrors, ThrowOnError>;
|
|
4032
|
+
/**
|
|
4033
|
+
* Update an existing connection owned by the caller.
|
|
4034
|
+
*/
|
|
4035
|
+
declare const connectionsUpdateConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsUpdateConnectionData, ThrowOnError>) => RequestResult<ConnectionsUpdateConnectionResponses, ConnectionsUpdateConnectionErrors, ThrowOnError>;
|
|
4036
|
+
/**
|
|
4037
|
+
* List the caller's default connections, one per application where a default is set.
|
|
4038
|
+
*/
|
|
4039
|
+
declare const connectionsGetDefaultConnections: <ThrowOnError extends boolean = false>(options?: Options<ConnectionsGetDefaultConnectionsData, ThrowOnError>) => RequestResult<ConnectionsGetDefaultConnectionsResponses, ConnectionsGetDefaultConnectionsErrors, ThrowOnError>;
|
|
4040
|
+
/**
|
|
4041
|
+
* Clear the default designation for the given connection.
|
|
4042
|
+
*/
|
|
4043
|
+
declare const connectionsClearDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsClearDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsClearDefaultConnectionResponses, ConnectionsClearDefaultConnectionErrors, ThrowOnError>;
|
|
4044
|
+
/**
|
|
4045
|
+
* Set the given connection as the caller's default for its application.
|
|
4046
|
+
*/
|
|
4047
|
+
declare const connectionsSetDefaultConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSetDefaultConnectionData, ThrowOnError>) => RequestResult<ConnectionsSetDefaultConnectionResponses, ConnectionsSetDefaultConnectionErrors, ThrowOnError>;
|
|
4048
|
+
/**
|
|
4049
|
+
* Replace one connection with another across the caller's usages.
|
|
4050
|
+
*/
|
|
4051
|
+
declare const connectionsReplaceConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsReplaceConnectionData, ThrowOnError>) => RequestResult<ConnectionsReplaceConnectionResponses, ConnectionsReplaceConnectionErrors, ThrowOnError>;
|
|
4052
|
+
/**
|
|
4053
|
+
* Trigger a refresh of the objects available through the given connection.
|
|
4054
|
+
*/
|
|
4055
|
+
declare const connectionsRefreshObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsRefreshObjectsData, ThrowOnError>) => RequestResult<ConnectionsRefreshObjectsResponses, ConnectionsRefreshObjectsErrors, ThrowOnError>;
|
|
4056
|
+
/**
|
|
4057
|
+
* Get the status of the most recent object refresh for the given connection.
|
|
4058
|
+
*/
|
|
4059
|
+
declare const connectionsGetRefreshStatus: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetRefreshStatusData, ThrowOnError>) => RequestResult<ConnectionsGetRefreshStatusResponses, ConnectionsGetRefreshStatusErrors, ThrowOnError>;
|
|
4060
|
+
/**
|
|
4061
|
+
* Select which objects from the given connection are active for the caller.
|
|
4062
|
+
*/
|
|
4063
|
+
declare const connectionsSelectObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsSelectObjectsData, ThrowOnError>) => RequestResult<ConnectionsSelectObjectsResponses, ConnectionsSelectObjectsErrors, ThrowOnError>;
|
|
4064
|
+
/**
|
|
4065
|
+
* List the objects available through the given connection, with optional filtering, sorting, and pagination.
|
|
4066
|
+
*/
|
|
4067
|
+
declare const connectionsGetConnectionObjects: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetConnectionObjectsData, ThrowOnError>) => RequestResult<ConnectionsGetConnectionObjectsResponses, ConnectionsGetConnectionObjectsErrors, ThrowOnError>;
|
|
4068
|
+
/**
|
|
4069
|
+
* Verify that the given connection is valid and currently usable.
|
|
4070
|
+
*/
|
|
4071
|
+
declare const connectionsCheckConnection: <ThrowOnError extends boolean = false>(options: Options<ConnectionsCheckConnectionData, ThrowOnError>) => RequestResult<ConnectionsCheckConnectionResponses, ConnectionsCheckConnectionErrors, ThrowOnError>;
|
|
4072
|
+
/**
|
|
4073
|
+
* Build an OAuth sign-in URL for an application so the caller can authorize a new connection.
|
|
4074
|
+
*/
|
|
4075
|
+
declare const connectionsGetSignInUrl: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetSignInUrlData, ThrowOnError>) => RequestResult<ConnectionsGetSignInUrlResponses, ConnectionsGetSignInUrlErrors, ThrowOnError>;
|
|
4076
|
+
/**
|
|
4077
|
+
* Retrieve the access token captured for a previously issued sign-in URL, identified by its state value.
|
|
4078
|
+
*/
|
|
4079
|
+
declare const connectionsGetAccessToken: <ThrowOnError extends boolean = false>(options: Options<ConnectionsGetAccessTokenData, ThrowOnError>) => RequestResult<ConnectionsGetAccessTokenResponses, ConnectionsGetAccessTokenErrors, ThrowOnError>;
|
|
4080
|
+
/**
|
|
4081
|
+
* List the tools available to the caller, with optional filtering and pagination.
|
|
4082
|
+
*/
|
|
4083
|
+
declare const toolsListTools: <ThrowOnError extends boolean = false>(options?: Options<ToolsListToolsData, ThrowOnError>) => RequestResult<ToolsListToolsResponses, ToolsListToolsErrors, ThrowOnError>;
|
|
4084
|
+
/**
|
|
4085
|
+
* Get the full details of a single tool identified by its slug.
|
|
4086
|
+
*/
|
|
4087
|
+
declare const toolsGetTool: <ThrowOnError extends boolean = false>(options: Options<ToolsGetToolData, ThrowOnError>) => RequestResult<ToolsGetToolResponses, ToolsGetToolErrors, ThrowOnError>;
|
|
4088
|
+
/**
|
|
4089
|
+
* Execute a tool. Connection is resolved implicitly from the caller's
|
|
4090
|
+
* account-user, the tool's parent application, and optional toolsetId.
|
|
4091
|
+
* Tool-runtime failures return 200 with isSuccess=false; all other failures
|
|
4092
|
+
* use the standard error envelope.
|
|
4093
|
+
*/
|
|
4094
|
+
declare const toolsExecuteTool: <ThrowOnError extends boolean = false>(options: Options<ToolsExecuteToolData, ThrowOnError>) => RequestResult<ToolsExecuteToolResponses, ToolsExecuteToolErrors, ThrowOnError>;
|
|
4095
|
+
/**
|
|
4096
|
+
* List the toolsets belonging to the caller, with pagination.
|
|
4097
|
+
*/
|
|
4098
|
+
declare const toolsetsListToolsets: <ThrowOnError extends boolean = false>(options?: Options<ToolsetsListToolsetsData, ThrowOnError>) => RequestResult<ToolsetsListToolsetsResponses, ToolsetsListToolsetsErrors, ThrowOnError>;
|
|
4099
|
+
/**
|
|
4100
|
+
* Create a new toolset for the caller.
|
|
4101
|
+
*/
|
|
4102
|
+
declare const toolsetsCreateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsCreateToolsetData, ThrowOnError>) => RequestResult<ToolsetsCreateToolsetResponses, ToolsetsCreateToolsetErrors, ThrowOnError>;
|
|
4103
|
+
/**
|
|
4104
|
+
* Delete a toolset owned by the caller.
|
|
4105
|
+
*/
|
|
4106
|
+
declare const toolsetsDeleteToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsDeleteToolsetData, ThrowOnError>) => RequestResult<ToolsetsDeleteToolsetResponses, ToolsetsDeleteToolsetErrors, ThrowOnError>;
|
|
4107
|
+
/**
|
|
4108
|
+
* Get a single toolset owned by the caller, identified by its id.
|
|
4109
|
+
*/
|
|
4110
|
+
declare const toolsetsGetToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsGetToolsetData, ThrowOnError>) => RequestResult<ToolsetsGetToolsetResponses, ToolsetsGetToolsetErrors, ThrowOnError>;
|
|
4111
|
+
/**
|
|
4112
|
+
* Update an existing toolset owned by the caller.
|
|
4113
|
+
*/
|
|
4114
|
+
declare const toolsetsUpdateToolset: <ThrowOnError extends boolean = false>(options: Options<ToolsetsUpdateToolsetData, ThrowOnError>) => RequestResult<ToolsetsUpdateToolsetResponses, ToolsetsUpdateToolsetErrors, ThrowOnError>;
|
|
4115
|
+
|
|
4116
|
+
/**
|
|
4117
|
+
* @engini/client — TypeScript REST client for the Engini Public API.
|
|
4118
|
+
*
|
|
4119
|
+
* The code under ./generated is produced by @hey-api/openapi-ts and committed.
|
|
4120
|
+
* DO NOT edit it by hand — regenerate via scripts/regen.sh. This file is the one
|
|
4121
|
+
* hand-written module in the package: it re-exports the generated SDK + types and
|
|
4122
|
+
* adds the Engini-named client factory.
|
|
4123
|
+
*/
|
|
4124
|
+
|
|
4125
|
+
interface EnginiClientOptions {
|
|
4126
|
+
/** API base URL. Requests append `/v1/...`. */
|
|
4127
|
+
baseUrl: string;
|
|
4128
|
+
/** Optional JWT. When set, bearer-secured operations send `Authorization: Bearer <token>`. */
|
|
4129
|
+
token?: string;
|
|
4130
|
+
}
|
|
4131
|
+
/**
|
|
4132
|
+
* Create a configured Engini API client to pass to the generated operation
|
|
4133
|
+
* functions, e.g. `await connectionsGetConnections({ client })`.
|
|
4134
|
+
*/
|
|
4135
|
+
declare function createEnginiClient(options: EnginiClientOptions): Client;
|
|
4136
|
+
|
|
4137
|
+
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 AuthWhoAmIData, type AuthWhoAmIError, type AuthWhoAmIErrors, type AuthWhoAmIResponse, type AuthWhoAmIResponses, 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, type WhoAmIResponse, applicationsGetApplication, applicationsListApplications, authWhoAmI, 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 };
|