@zilfu/sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -0
- package/dist/index.cjs +1396 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +2848 -0
- package/dist/index.d.ts +2848 -0
- package/dist/index.js +1355 -0
- package/dist/index.js.map +1 -0
- package/openapi.json +3541 -0
- package/package.json +50 -0
- package/src/client.ts +38 -0
- package/src/generated/client/client.gen.ts +268 -0
- package/src/generated/client/index.ts +25 -0
- package/src/generated/client/types.gen.ts +268 -0
- package/src/generated/client/utils.gen.ts +331 -0
- package/src/generated/client.gen.ts +18 -0
- package/src/generated/core/auth.gen.ts +42 -0
- package/src/generated/core/bodySerializer.gen.ts +92 -0
- package/src/generated/core/params.gen.ts +153 -0
- package/src/generated/core/pathSerializer.gen.ts +181 -0
- package/src/generated/core/serverSentEvents.gen.ts +264 -0
- package/src/generated/core/types.gen.ts +118 -0
- package/src/generated/core/utils.gen.ts +143 -0
- package/src/generated/index.ts +4 -0
- package/src/generated/sdk.gen.ts +695 -0
- package/src/generated/types.gen.ts +2564 -0
- package/src/index.ts +5 -0
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,2848 @@
|
|
|
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
|
+
* Header or query parameter name.
|
|
11
|
+
*
|
|
12
|
+
* @default 'Authorization'
|
|
13
|
+
*/
|
|
14
|
+
name?: string;
|
|
15
|
+
scheme?: 'basic' | 'bearer';
|
|
16
|
+
type: 'apiKey' | 'http';
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
interface SerializerOptions<T> {
|
|
20
|
+
/**
|
|
21
|
+
* @default true
|
|
22
|
+
*/
|
|
23
|
+
explode: boolean;
|
|
24
|
+
style: T;
|
|
25
|
+
}
|
|
26
|
+
type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
|
|
27
|
+
type ObjectStyle = 'form' | 'deepObject';
|
|
28
|
+
|
|
29
|
+
type QuerySerializer = (query: Record<string, unknown>) => string;
|
|
30
|
+
type BodySerializer = (body: any) => any;
|
|
31
|
+
interface QuerySerializerOptions {
|
|
32
|
+
allowReserved?: boolean;
|
|
33
|
+
array?: SerializerOptions<ArrayStyle>;
|
|
34
|
+
object?: SerializerOptions<ObjectStyle>;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
|
|
38
|
+
type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
|
|
39
|
+
/**
|
|
40
|
+
* Returns the final request URL.
|
|
41
|
+
*/
|
|
42
|
+
buildUrl: BuildUrlFn;
|
|
43
|
+
getConfig: () => Config;
|
|
44
|
+
request: RequestFn;
|
|
45
|
+
setConfig: (config: Config) => Config;
|
|
46
|
+
} & {
|
|
47
|
+
[K in HttpMethod]: MethodFn;
|
|
48
|
+
} & ([SseFn] extends [never] ? {
|
|
49
|
+
sse?: never;
|
|
50
|
+
} : {
|
|
51
|
+
sse: {
|
|
52
|
+
[K in HttpMethod]: SseFn;
|
|
53
|
+
};
|
|
54
|
+
});
|
|
55
|
+
interface Config$1 {
|
|
56
|
+
/**
|
|
57
|
+
* Auth token or a function returning auth token. The resolved value will be
|
|
58
|
+
* added to the request payload as defined by its `security` array.
|
|
59
|
+
*/
|
|
60
|
+
auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
|
|
61
|
+
/**
|
|
62
|
+
* A function for serializing request body parameter. By default,
|
|
63
|
+
* {@link JSON.stringify()} will be used.
|
|
64
|
+
*/
|
|
65
|
+
bodySerializer?: BodySerializer | null;
|
|
66
|
+
/**
|
|
67
|
+
* An object containing any HTTP headers that you want to pre-populate your
|
|
68
|
+
* `Headers` object with.
|
|
69
|
+
*
|
|
70
|
+
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
|
71
|
+
*/
|
|
72
|
+
headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
|
|
73
|
+
/**
|
|
74
|
+
* The request method.
|
|
75
|
+
*
|
|
76
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
|
|
77
|
+
*/
|
|
78
|
+
method?: Uppercase<HttpMethod>;
|
|
79
|
+
/**
|
|
80
|
+
* A function for serializing request query parameters. By default, arrays
|
|
81
|
+
* will be exploded in form style, objects will be exploded in deepObject
|
|
82
|
+
* style, and reserved characters are percent-encoded.
|
|
83
|
+
*
|
|
84
|
+
* This method will have no effect if the native `paramsSerializer()` Axios
|
|
85
|
+
* API function is used.
|
|
86
|
+
*
|
|
87
|
+
* {@link https://swagger.io/docs/specification/serialization/#query View examples}
|
|
88
|
+
*/
|
|
89
|
+
querySerializer?: QuerySerializer | QuerySerializerOptions;
|
|
90
|
+
/**
|
|
91
|
+
* A function validating request data. This is useful if you want to ensure
|
|
92
|
+
* the request conforms to the desired shape, so it can be safely sent to
|
|
93
|
+
* the server.
|
|
94
|
+
*/
|
|
95
|
+
requestValidator?: (data: unknown) => Promise<unknown>;
|
|
96
|
+
/**
|
|
97
|
+
* A function transforming response data before it's returned. This is useful
|
|
98
|
+
* for post-processing data, e.g. converting ISO strings into Date objects.
|
|
99
|
+
*/
|
|
100
|
+
responseTransformer?: (data: unknown) => Promise<unknown>;
|
|
101
|
+
/**
|
|
102
|
+
* A function validating response data. This is useful if you want to ensure
|
|
103
|
+
* the response conforms to the desired shape, so it can be safely passed to
|
|
104
|
+
* the transformers and returned to the user.
|
|
105
|
+
*/
|
|
106
|
+
responseValidator?: (data: unknown) => Promise<unknown>;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
|
|
110
|
+
/**
|
|
111
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
112
|
+
* fetch instance.
|
|
113
|
+
*
|
|
114
|
+
* @default globalThis.fetch
|
|
115
|
+
*/
|
|
116
|
+
fetch?: typeof fetch;
|
|
117
|
+
/**
|
|
118
|
+
* Implementing clients can call request interceptors inside this hook.
|
|
119
|
+
*/
|
|
120
|
+
onRequest?: (url: string, init: RequestInit) => Promise<Request>;
|
|
121
|
+
/**
|
|
122
|
+
* Callback invoked when a network or parsing error occurs during streaming.
|
|
123
|
+
*
|
|
124
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
125
|
+
*
|
|
126
|
+
* @param error The error that occurred.
|
|
127
|
+
*/
|
|
128
|
+
onSseError?: (error: unknown) => void;
|
|
129
|
+
/**
|
|
130
|
+
* Callback invoked when an event is streamed from the server.
|
|
131
|
+
*
|
|
132
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
133
|
+
*
|
|
134
|
+
* @param event Event streamed from the server.
|
|
135
|
+
* @returns Nothing (void).
|
|
136
|
+
*/
|
|
137
|
+
onSseEvent?: (event: StreamEvent<TData>) => void;
|
|
138
|
+
serializedBody?: RequestInit['body'];
|
|
139
|
+
/**
|
|
140
|
+
* Default retry delay in milliseconds.
|
|
141
|
+
*
|
|
142
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
143
|
+
*
|
|
144
|
+
* @default 3000
|
|
145
|
+
*/
|
|
146
|
+
sseDefaultRetryDelay?: number;
|
|
147
|
+
/**
|
|
148
|
+
* Maximum number of retry attempts before giving up.
|
|
149
|
+
*/
|
|
150
|
+
sseMaxRetryAttempts?: number;
|
|
151
|
+
/**
|
|
152
|
+
* Maximum retry delay in milliseconds.
|
|
153
|
+
*
|
|
154
|
+
* Applies only when exponential backoff is used.
|
|
155
|
+
*
|
|
156
|
+
* This option applies only if the endpoint returns a stream of events.
|
|
157
|
+
*
|
|
158
|
+
* @default 30000
|
|
159
|
+
*/
|
|
160
|
+
sseMaxRetryDelay?: number;
|
|
161
|
+
/**
|
|
162
|
+
* Optional sleep function for retry backoff.
|
|
163
|
+
*
|
|
164
|
+
* Defaults to using `setTimeout`.
|
|
165
|
+
*/
|
|
166
|
+
sseSleepFn?: (ms: number) => Promise<void>;
|
|
167
|
+
url: string;
|
|
168
|
+
};
|
|
169
|
+
interface StreamEvent<TData = unknown> {
|
|
170
|
+
data: TData;
|
|
171
|
+
event?: string;
|
|
172
|
+
id?: string;
|
|
173
|
+
retry?: number;
|
|
174
|
+
}
|
|
175
|
+
type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
|
|
176
|
+
stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
|
|
177
|
+
};
|
|
178
|
+
|
|
179
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
|
|
180
|
+
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
181
|
+
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
182
|
+
declare class Interceptors<Interceptor> {
|
|
183
|
+
fns: Array<Interceptor | null>;
|
|
184
|
+
clear(): void;
|
|
185
|
+
eject(id: number | Interceptor): void;
|
|
186
|
+
exists(id: number | Interceptor): boolean;
|
|
187
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
188
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
189
|
+
use(fn: Interceptor): number;
|
|
190
|
+
}
|
|
191
|
+
interface Middleware<Req, Res, Err, Options> {
|
|
192
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
193
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
194
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
type ResponseStyle = 'data' | 'fields';
|
|
198
|
+
interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
|
|
199
|
+
/**
|
|
200
|
+
* Base URL for all requests made by this client.
|
|
201
|
+
*/
|
|
202
|
+
baseUrl?: T['baseUrl'];
|
|
203
|
+
/**
|
|
204
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
205
|
+
* fetch instance.
|
|
206
|
+
*
|
|
207
|
+
* @default globalThis.fetch
|
|
208
|
+
*/
|
|
209
|
+
fetch?: typeof fetch;
|
|
210
|
+
/**
|
|
211
|
+
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
212
|
+
* options won't have any effect.
|
|
213
|
+
*
|
|
214
|
+
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
215
|
+
*/
|
|
216
|
+
next?: never;
|
|
217
|
+
/**
|
|
218
|
+
* Return the response data parsed in a specified format. By default, `auto`
|
|
219
|
+
* will infer the appropriate method from the `Content-Type` response header.
|
|
220
|
+
* You can override this behavior with any of the {@link Body} methods.
|
|
221
|
+
* Select `stream` if you don't want to parse response data at all.
|
|
222
|
+
*
|
|
223
|
+
* @default 'auto'
|
|
224
|
+
*/
|
|
225
|
+
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
226
|
+
/**
|
|
227
|
+
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
228
|
+
*
|
|
229
|
+
* @default 'fields'
|
|
230
|
+
*/
|
|
231
|
+
responseStyle?: ResponseStyle;
|
|
232
|
+
/**
|
|
233
|
+
* Throw an error instead of returning it in the response?
|
|
234
|
+
*
|
|
235
|
+
* @default false
|
|
236
|
+
*/
|
|
237
|
+
throwOnError?: T['throwOnError'];
|
|
238
|
+
}
|
|
239
|
+
interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
240
|
+
responseStyle: TResponseStyle;
|
|
241
|
+
throwOnError: ThrowOnError;
|
|
242
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
243
|
+
/**
|
|
244
|
+
* Any body that you want to add to your request.
|
|
245
|
+
*
|
|
246
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
247
|
+
*/
|
|
248
|
+
body?: unknown;
|
|
249
|
+
path?: Record<string, unknown>;
|
|
250
|
+
query?: Record<string, unknown>;
|
|
251
|
+
/**
|
|
252
|
+
* Security mechanism(s) to use for the request.
|
|
253
|
+
*/
|
|
254
|
+
security?: ReadonlyArray<Auth>;
|
|
255
|
+
url: Url;
|
|
256
|
+
}
|
|
257
|
+
interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
258
|
+
serializedBody?: string;
|
|
259
|
+
}
|
|
260
|
+
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 : {
|
|
261
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
262
|
+
request: Request;
|
|
263
|
+
response: Response;
|
|
264
|
+
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
265
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
266
|
+
error: undefined;
|
|
267
|
+
} | {
|
|
268
|
+
data: undefined;
|
|
269
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
270
|
+
}) & {
|
|
271
|
+
request: Request;
|
|
272
|
+
response: Response;
|
|
273
|
+
}>;
|
|
274
|
+
interface ClientOptions$1 {
|
|
275
|
+
baseUrl?: string;
|
|
276
|
+
responseStyle?: ResponseStyle;
|
|
277
|
+
throwOnError?: boolean;
|
|
278
|
+
}
|
|
279
|
+
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>;
|
|
280
|
+
type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
|
|
281
|
+
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>;
|
|
282
|
+
type BuildUrlFn = <TData extends {
|
|
283
|
+
body?: unknown;
|
|
284
|
+
path?: Record<string, unknown>;
|
|
285
|
+
query?: Record<string, unknown>;
|
|
286
|
+
url: string;
|
|
287
|
+
}>(options: Pick<TData, 'url'> & Options$1<TData>) => string;
|
|
288
|
+
type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
289
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
290
|
+
};
|
|
291
|
+
interface TDataShape {
|
|
292
|
+
body?: unknown;
|
|
293
|
+
headers?: unknown;
|
|
294
|
+
path?: unknown;
|
|
295
|
+
query?: unknown;
|
|
296
|
+
url: string;
|
|
297
|
+
}
|
|
298
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
299
|
+
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'> & Omit<TData, 'url'>;
|
|
300
|
+
|
|
301
|
+
type ClientOptions = {
|
|
302
|
+
baseUrl: 'https://zilfu.app/api' | (string & {});
|
|
303
|
+
};
|
|
304
|
+
/**
|
|
305
|
+
* AccountResource
|
|
306
|
+
*/
|
|
307
|
+
type AccountResource = {
|
|
308
|
+
id: number;
|
|
309
|
+
social: string;
|
|
310
|
+
display_name: string;
|
|
311
|
+
handler: string;
|
|
312
|
+
avatar: string | null;
|
|
313
|
+
is_active: boolean;
|
|
314
|
+
disconnected_at: string;
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* BioBlockResource
|
|
318
|
+
*/
|
|
319
|
+
type BioBlockResource = {
|
|
320
|
+
id: number;
|
|
321
|
+
type: string;
|
|
322
|
+
content: Array<unknown>;
|
|
323
|
+
sort_order: number;
|
|
324
|
+
is_visible: boolean;
|
|
325
|
+
};
|
|
326
|
+
/**
|
|
327
|
+
* BioPageResource
|
|
328
|
+
*/
|
|
329
|
+
type BioPageResource = {
|
|
330
|
+
id: number;
|
|
331
|
+
slug: string;
|
|
332
|
+
title: string | null;
|
|
333
|
+
description: string | null;
|
|
334
|
+
theme: string;
|
|
335
|
+
avatar: string;
|
|
336
|
+
is_enabled: boolean;
|
|
337
|
+
public_url: string;
|
|
338
|
+
created_at: string | null;
|
|
339
|
+
updated_at: string | null;
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* MediaResource
|
|
343
|
+
*/
|
|
344
|
+
type MediaResource = {
|
|
345
|
+
id: string;
|
|
346
|
+
type: string;
|
|
347
|
+
url: string;
|
|
348
|
+
mime: string;
|
|
349
|
+
width: string;
|
|
350
|
+
height: string;
|
|
351
|
+
size: string;
|
|
352
|
+
alt: string;
|
|
353
|
+
order: string;
|
|
354
|
+
};
|
|
355
|
+
/**
|
|
356
|
+
* PostResource
|
|
357
|
+
*/
|
|
358
|
+
type PostResource = {
|
|
359
|
+
id: number;
|
|
360
|
+
content: string;
|
|
361
|
+
status: PostStatus;
|
|
362
|
+
order: number;
|
|
363
|
+
scheduled_at: string | null;
|
|
364
|
+
published_at: string | null;
|
|
365
|
+
metadata: Array<unknown> | null;
|
|
366
|
+
cluster_id: string;
|
|
367
|
+
parent_id: number | null;
|
|
368
|
+
user_id: number;
|
|
369
|
+
account_id: number;
|
|
370
|
+
created_at: string | null;
|
|
371
|
+
updated_at: string | null;
|
|
372
|
+
analytics: Array<unknown> | null;
|
|
373
|
+
account?: AccountResource;
|
|
374
|
+
children?: Array<PostResource>;
|
|
375
|
+
media?: Array<MediaResource>;
|
|
376
|
+
};
|
|
377
|
+
/**
|
|
378
|
+
* PostStatus
|
|
379
|
+
*/
|
|
380
|
+
type PostStatus = 0 | 1 | 2 | 3 | 4;
|
|
381
|
+
/**
|
|
382
|
+
* SlotResource
|
|
383
|
+
*/
|
|
384
|
+
type SlotResource = {
|
|
385
|
+
id: number;
|
|
386
|
+
day_of_week: number;
|
|
387
|
+
time: string;
|
|
388
|
+
};
|
|
389
|
+
/**
|
|
390
|
+
* SpaceResource
|
|
391
|
+
*/
|
|
392
|
+
type SpaceResource = {
|
|
393
|
+
id: number;
|
|
394
|
+
name: string;
|
|
395
|
+
created_at: string | null;
|
|
396
|
+
updated_at: string | null;
|
|
397
|
+
};
|
|
398
|
+
/**
|
|
399
|
+
* StoreBioBlockRequest
|
|
400
|
+
*/
|
|
401
|
+
type StoreBioBlockRequest = {
|
|
402
|
+
type: 'link' | 'header' | 'social_icons' | 'text';
|
|
403
|
+
content: Array<string>;
|
|
404
|
+
is_visible?: boolean;
|
|
405
|
+
};
|
|
406
|
+
/**
|
|
407
|
+
* StoreBioPageRequest
|
|
408
|
+
*/
|
|
409
|
+
type StoreBioPageRequest = {
|
|
410
|
+
slug: string;
|
|
411
|
+
title?: string | null;
|
|
412
|
+
description?: string | null;
|
|
413
|
+
theme: 'minimal' | 'bold' | 'neon' | 'soft' | 'classic';
|
|
414
|
+
};
|
|
415
|
+
/**
|
|
416
|
+
* StorePostRequest
|
|
417
|
+
*/
|
|
418
|
+
type StorePostRequest = {
|
|
419
|
+
at?: number | null;
|
|
420
|
+
is_draft?: boolean;
|
|
421
|
+
space_id: number;
|
|
422
|
+
items: Array<{
|
|
423
|
+
account_id: number;
|
|
424
|
+
social: string;
|
|
425
|
+
children?: Array<{
|
|
426
|
+
content: string;
|
|
427
|
+
media?: Array<{
|
|
428
|
+
id: number;
|
|
429
|
+
type: 'image' | 'video';
|
|
430
|
+
}> | null;
|
|
431
|
+
}> | null;
|
|
432
|
+
metadata?: {
|
|
433
|
+
topic_tag?: string | null;
|
|
434
|
+
post_type?: string | null;
|
|
435
|
+
link?: string | null;
|
|
436
|
+
privacy_level?: string | null;
|
|
437
|
+
allow_comments?: boolean | null;
|
|
438
|
+
allow_duet?: boolean | null;
|
|
439
|
+
allow_stitch?: boolean | null;
|
|
440
|
+
branded_content?: boolean | null;
|
|
441
|
+
brand_organic?: boolean | null;
|
|
442
|
+
board_id?: string | null;
|
|
443
|
+
title?: string | null;
|
|
444
|
+
cover_image_url?: string | null;
|
|
445
|
+
} | null;
|
|
446
|
+
main?: {
|
|
447
|
+
content: string;
|
|
448
|
+
media?: Array<{
|
|
449
|
+
id: number;
|
|
450
|
+
type: 'image' | 'video';
|
|
451
|
+
}> | null;
|
|
452
|
+
};
|
|
453
|
+
}>;
|
|
454
|
+
};
|
|
455
|
+
/**
|
|
456
|
+
* StoreSlotRequest
|
|
457
|
+
*/
|
|
458
|
+
type StoreSlotRequest = {
|
|
459
|
+
time: string;
|
|
460
|
+
days_of_week: Array<number>;
|
|
461
|
+
};
|
|
462
|
+
/**
|
|
463
|
+
* StoreSpaceRequest
|
|
464
|
+
*/
|
|
465
|
+
type StoreSpaceRequest = {
|
|
466
|
+
name: string;
|
|
467
|
+
};
|
|
468
|
+
/**
|
|
469
|
+
* StoreWebhookRequest
|
|
470
|
+
*/
|
|
471
|
+
type StoreWebhookRequest = {
|
|
472
|
+
url: string;
|
|
473
|
+
events: Array<'post.published' | 'post.failed' | 'post.scheduled' | 'account.connected' | 'account.disconnected'>;
|
|
474
|
+
};
|
|
475
|
+
/**
|
|
476
|
+
* UpdateBioBlockRequest
|
|
477
|
+
*/
|
|
478
|
+
type UpdateBioBlockRequest = {
|
|
479
|
+
content?: Array<string>;
|
|
480
|
+
is_visible?: boolean;
|
|
481
|
+
};
|
|
482
|
+
/**
|
|
483
|
+
* UpdateBioPageRequest
|
|
484
|
+
*/
|
|
485
|
+
type UpdateBioPageRequest = {
|
|
486
|
+
slug?: string;
|
|
487
|
+
title?: string | null;
|
|
488
|
+
description?: string | null;
|
|
489
|
+
theme?: 'minimal' | 'bold' | 'neon' | 'soft' | 'classic';
|
|
490
|
+
is_enabled?: boolean;
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* UpdateClusterRequest
|
|
494
|
+
*/
|
|
495
|
+
type UpdateClusterRequest = {
|
|
496
|
+
at?: number | null;
|
|
497
|
+
is_draft?: boolean;
|
|
498
|
+
space_id: number;
|
|
499
|
+
items: Array<{
|
|
500
|
+
account_id: number;
|
|
501
|
+
social: string;
|
|
502
|
+
children?: Array<{
|
|
503
|
+
content: string;
|
|
504
|
+
media?: Array<{
|
|
505
|
+
id: number;
|
|
506
|
+
type: 'image' | 'video';
|
|
507
|
+
}> | null;
|
|
508
|
+
}> | null;
|
|
509
|
+
metadata?: {
|
|
510
|
+
topic_tag?: string | null;
|
|
511
|
+
post_type?: string | null;
|
|
512
|
+
link?: string | null;
|
|
513
|
+
privacy_level?: string | null;
|
|
514
|
+
allow_comments?: boolean | null;
|
|
515
|
+
allow_duet?: boolean | null;
|
|
516
|
+
allow_stitch?: boolean | null;
|
|
517
|
+
branded_content?: boolean | null;
|
|
518
|
+
brand_organic?: boolean | null;
|
|
519
|
+
board_id?: string | null;
|
|
520
|
+
title?: string | null;
|
|
521
|
+
cover_image_url?: string | null;
|
|
522
|
+
} | null;
|
|
523
|
+
main?: {
|
|
524
|
+
content: string;
|
|
525
|
+
media?: Array<{
|
|
526
|
+
id: number;
|
|
527
|
+
type: 'image' | 'video';
|
|
528
|
+
}> | null;
|
|
529
|
+
};
|
|
530
|
+
}>;
|
|
531
|
+
};
|
|
532
|
+
/**
|
|
533
|
+
* UpdatePostRequest
|
|
534
|
+
*/
|
|
535
|
+
type UpdatePostRequest = {
|
|
536
|
+
content?: string;
|
|
537
|
+
status?: PostStatus;
|
|
538
|
+
scheduled_at?: string | null;
|
|
539
|
+
metadata?: Array<string> | null;
|
|
540
|
+
media_ids?: Array<number> | null;
|
|
541
|
+
};
|
|
542
|
+
/**
|
|
543
|
+
* UpdateSpaceRequest
|
|
544
|
+
*/
|
|
545
|
+
type UpdateSpaceRequest = {
|
|
546
|
+
name?: string;
|
|
547
|
+
timezone?: string;
|
|
548
|
+
};
|
|
549
|
+
/**
|
|
550
|
+
* UpdateWebhookRequest
|
|
551
|
+
*/
|
|
552
|
+
type UpdateWebhookRequest = {
|
|
553
|
+
url?: string;
|
|
554
|
+
is_active?: boolean;
|
|
555
|
+
events?: Array<'post.published' | 'post.failed' | 'post.scheduled' | 'account.connected' | 'account.disconnected'>;
|
|
556
|
+
};
|
|
557
|
+
/**
|
|
558
|
+
* WebhookResource
|
|
559
|
+
*/
|
|
560
|
+
type WebhookResource = {
|
|
561
|
+
id: number;
|
|
562
|
+
url: string;
|
|
563
|
+
events: Array<unknown>;
|
|
564
|
+
is_active: boolean;
|
|
565
|
+
created_at: string | null;
|
|
566
|
+
updated_at: string | null;
|
|
567
|
+
};
|
|
568
|
+
type AccountsDestroyManyData = {
|
|
569
|
+
body?: never;
|
|
570
|
+
path: {
|
|
571
|
+
/**
|
|
572
|
+
* The space ID
|
|
573
|
+
*/
|
|
574
|
+
space: number;
|
|
575
|
+
};
|
|
576
|
+
query?: {
|
|
577
|
+
'ids[]'?: Array<number>;
|
|
578
|
+
};
|
|
579
|
+
url: '/spaces/{space}/accounts';
|
|
580
|
+
};
|
|
581
|
+
type AccountsDestroyManyErrors = {
|
|
582
|
+
/**
|
|
583
|
+
* Unauthenticated
|
|
584
|
+
*/
|
|
585
|
+
401: {
|
|
586
|
+
/**
|
|
587
|
+
* Error overview.
|
|
588
|
+
*/
|
|
589
|
+
message: string;
|
|
590
|
+
};
|
|
591
|
+
/**
|
|
592
|
+
* Authorization error
|
|
593
|
+
*/
|
|
594
|
+
403: {
|
|
595
|
+
/**
|
|
596
|
+
* Error overview.
|
|
597
|
+
*/
|
|
598
|
+
message: string;
|
|
599
|
+
};
|
|
600
|
+
/**
|
|
601
|
+
* Not found
|
|
602
|
+
*/
|
|
603
|
+
404: {
|
|
604
|
+
/**
|
|
605
|
+
* Error overview.
|
|
606
|
+
*/
|
|
607
|
+
message: string;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* Validation error
|
|
611
|
+
*/
|
|
612
|
+
422: {
|
|
613
|
+
/**
|
|
614
|
+
* Errors overview.
|
|
615
|
+
*/
|
|
616
|
+
message: string;
|
|
617
|
+
/**
|
|
618
|
+
* A detailed description of each field that failed validation.
|
|
619
|
+
*/
|
|
620
|
+
errors: {
|
|
621
|
+
[key: string]: Array<string>;
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
type AccountsDestroyManyError = AccountsDestroyManyErrors[keyof AccountsDestroyManyErrors];
|
|
626
|
+
type AccountsDestroyManyResponses = {
|
|
627
|
+
200: {
|
|
628
|
+
[key: string]: unknown;
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
type AccountsDestroyManyResponse = AccountsDestroyManyResponses[keyof AccountsDestroyManyResponses];
|
|
632
|
+
type AccountsIndexData = {
|
|
633
|
+
body?: never;
|
|
634
|
+
path: {
|
|
635
|
+
/**
|
|
636
|
+
* The space ID
|
|
637
|
+
*/
|
|
638
|
+
space: number;
|
|
639
|
+
};
|
|
640
|
+
query?: never;
|
|
641
|
+
url: '/spaces/{space}/accounts';
|
|
642
|
+
};
|
|
643
|
+
type AccountsIndexErrors = {
|
|
644
|
+
/**
|
|
645
|
+
* Unauthenticated
|
|
646
|
+
*/
|
|
647
|
+
401: {
|
|
648
|
+
/**
|
|
649
|
+
* Error overview.
|
|
650
|
+
*/
|
|
651
|
+
message: string;
|
|
652
|
+
};
|
|
653
|
+
/**
|
|
654
|
+
* Authorization error
|
|
655
|
+
*/
|
|
656
|
+
403: {
|
|
657
|
+
/**
|
|
658
|
+
* Error overview.
|
|
659
|
+
*/
|
|
660
|
+
message: string;
|
|
661
|
+
};
|
|
662
|
+
/**
|
|
663
|
+
* Not found
|
|
664
|
+
*/
|
|
665
|
+
404: {
|
|
666
|
+
/**
|
|
667
|
+
* Error overview.
|
|
668
|
+
*/
|
|
669
|
+
message: string;
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
type AccountsIndexError = AccountsIndexErrors[keyof AccountsIndexErrors];
|
|
673
|
+
type AccountsIndexResponses = {
|
|
674
|
+
/**
|
|
675
|
+
* Array of `AccountResource`
|
|
676
|
+
*/
|
|
677
|
+
200: {
|
|
678
|
+
data: Array<AccountResource>;
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
type AccountsIndexResponse = AccountsIndexResponses[keyof AccountsIndexResponses];
|
|
682
|
+
type AccountsActivateData = {
|
|
683
|
+
body?: never;
|
|
684
|
+
path: {
|
|
685
|
+
/**
|
|
686
|
+
* The space ID
|
|
687
|
+
*/
|
|
688
|
+
space: number;
|
|
689
|
+
/**
|
|
690
|
+
* The account ID
|
|
691
|
+
*/
|
|
692
|
+
account: number;
|
|
693
|
+
};
|
|
694
|
+
query?: never;
|
|
695
|
+
url: '/spaces/{space}/accounts/{account}/activate';
|
|
696
|
+
};
|
|
697
|
+
type AccountsActivateErrors = {
|
|
698
|
+
/**
|
|
699
|
+
* Unauthenticated
|
|
700
|
+
*/
|
|
701
|
+
401: {
|
|
702
|
+
/**
|
|
703
|
+
* Error overview.
|
|
704
|
+
*/
|
|
705
|
+
message: string;
|
|
706
|
+
};
|
|
707
|
+
/**
|
|
708
|
+
* Authorization error
|
|
709
|
+
*/
|
|
710
|
+
403: {
|
|
711
|
+
/**
|
|
712
|
+
* Error overview.
|
|
713
|
+
*/
|
|
714
|
+
message: string;
|
|
715
|
+
};
|
|
716
|
+
/**
|
|
717
|
+
* Not found
|
|
718
|
+
*/
|
|
719
|
+
404: {
|
|
720
|
+
/**
|
|
721
|
+
* Error overview.
|
|
722
|
+
*/
|
|
723
|
+
message: string;
|
|
724
|
+
};
|
|
725
|
+
};
|
|
726
|
+
type AccountsActivateError = AccountsActivateErrors[keyof AccountsActivateErrors];
|
|
727
|
+
type AccountsActivateResponses = {
|
|
728
|
+
/**
|
|
729
|
+
* `AccountResource`
|
|
730
|
+
*/
|
|
731
|
+
200: {
|
|
732
|
+
data: AccountResource;
|
|
733
|
+
} | {
|
|
734
|
+
[key: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
type AccountsActivateResponse = AccountsActivateResponses[keyof AccountsActivateResponses];
|
|
738
|
+
type AccountsBoardsData = {
|
|
739
|
+
body?: never;
|
|
740
|
+
path: {
|
|
741
|
+
/**
|
|
742
|
+
* The space ID
|
|
743
|
+
*/
|
|
744
|
+
space: number;
|
|
745
|
+
/**
|
|
746
|
+
* The account ID
|
|
747
|
+
*/
|
|
748
|
+
account: number;
|
|
749
|
+
};
|
|
750
|
+
query?: never;
|
|
751
|
+
url: '/spaces/{space}/accounts/{account}/boards';
|
|
752
|
+
};
|
|
753
|
+
type AccountsBoardsErrors = {
|
|
754
|
+
/**
|
|
755
|
+
* Unauthenticated
|
|
756
|
+
*/
|
|
757
|
+
401: {
|
|
758
|
+
/**
|
|
759
|
+
* Error overview.
|
|
760
|
+
*/
|
|
761
|
+
message: string;
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* Authorization error
|
|
765
|
+
*/
|
|
766
|
+
403: {
|
|
767
|
+
/**
|
|
768
|
+
* Error overview.
|
|
769
|
+
*/
|
|
770
|
+
message: string;
|
|
771
|
+
};
|
|
772
|
+
/**
|
|
773
|
+
* Not found
|
|
774
|
+
*/
|
|
775
|
+
404: {
|
|
776
|
+
/**
|
|
777
|
+
* Error overview.
|
|
778
|
+
*/
|
|
779
|
+
message: string;
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
type AccountsBoardsError = AccountsBoardsErrors[keyof AccountsBoardsErrors];
|
|
783
|
+
type AccountsBoardsResponses = {
|
|
784
|
+
200: {
|
|
785
|
+
data: Array<{
|
|
786
|
+
id: string;
|
|
787
|
+
name: string;
|
|
788
|
+
description: string | null;
|
|
789
|
+
image: string | null;
|
|
790
|
+
}>;
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
type AccountsBoardsResponse = AccountsBoardsResponses[keyof AccountsBoardsResponses];
|
|
794
|
+
type AccountsDestroyData = {
|
|
795
|
+
body?: never;
|
|
796
|
+
path: {
|
|
797
|
+
/**
|
|
798
|
+
* The space ID
|
|
799
|
+
*/
|
|
800
|
+
space: number;
|
|
801
|
+
/**
|
|
802
|
+
* The account ID
|
|
803
|
+
*/
|
|
804
|
+
account: number;
|
|
805
|
+
};
|
|
806
|
+
query?: never;
|
|
807
|
+
url: '/spaces/{space}/accounts/{account}';
|
|
808
|
+
};
|
|
809
|
+
type AccountsDestroyErrors = {
|
|
810
|
+
/**
|
|
811
|
+
* Unauthenticated
|
|
812
|
+
*/
|
|
813
|
+
401: {
|
|
814
|
+
/**
|
|
815
|
+
* Error overview.
|
|
816
|
+
*/
|
|
817
|
+
message: string;
|
|
818
|
+
};
|
|
819
|
+
/**
|
|
820
|
+
* Authorization error
|
|
821
|
+
*/
|
|
822
|
+
403: {
|
|
823
|
+
/**
|
|
824
|
+
* Error overview.
|
|
825
|
+
*/
|
|
826
|
+
message: string;
|
|
827
|
+
};
|
|
828
|
+
/**
|
|
829
|
+
* Not found
|
|
830
|
+
*/
|
|
831
|
+
404: {
|
|
832
|
+
/**
|
|
833
|
+
* Error overview.
|
|
834
|
+
*/
|
|
835
|
+
message: string;
|
|
836
|
+
};
|
|
837
|
+
};
|
|
838
|
+
type AccountsDestroyError = AccountsDestroyErrors[keyof AccountsDestroyErrors];
|
|
839
|
+
type AccountsDestroyResponses = {
|
|
840
|
+
200: {
|
|
841
|
+
[key: string]: unknown;
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
type AccountsDestroyResponse = AccountsDestroyResponses[keyof AccountsDestroyResponses];
|
|
845
|
+
type ApiTokensStoreData = {
|
|
846
|
+
body: {
|
|
847
|
+
name: string;
|
|
848
|
+
};
|
|
849
|
+
path?: never;
|
|
850
|
+
query?: never;
|
|
851
|
+
url: '/api-tokens';
|
|
852
|
+
};
|
|
853
|
+
type ApiTokensStoreErrors = {
|
|
854
|
+
/**
|
|
855
|
+
* Unauthenticated
|
|
856
|
+
*/
|
|
857
|
+
401: {
|
|
858
|
+
/**
|
|
859
|
+
* Error overview.
|
|
860
|
+
*/
|
|
861
|
+
message: string;
|
|
862
|
+
};
|
|
863
|
+
/**
|
|
864
|
+
* Validation error
|
|
865
|
+
*/
|
|
866
|
+
422: {
|
|
867
|
+
/**
|
|
868
|
+
* Errors overview.
|
|
869
|
+
*/
|
|
870
|
+
message: string;
|
|
871
|
+
/**
|
|
872
|
+
* A detailed description of each field that failed validation.
|
|
873
|
+
*/
|
|
874
|
+
errors: {
|
|
875
|
+
[key: string]: Array<string>;
|
|
876
|
+
};
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
type ApiTokensStoreError = ApiTokensStoreErrors[keyof ApiTokensStoreErrors];
|
|
880
|
+
type ApiTokensStoreResponses = {
|
|
881
|
+
200: unknown;
|
|
882
|
+
};
|
|
883
|
+
type ApiTokensDestroyData = {
|
|
884
|
+
body?: never;
|
|
885
|
+
path: {
|
|
886
|
+
tokenId: string;
|
|
887
|
+
};
|
|
888
|
+
query?: never;
|
|
889
|
+
url: '/api-tokens/{tokenId}';
|
|
890
|
+
};
|
|
891
|
+
type ApiTokensDestroyErrors = {
|
|
892
|
+
/**
|
|
893
|
+
* Unauthenticated
|
|
894
|
+
*/
|
|
895
|
+
401: {
|
|
896
|
+
/**
|
|
897
|
+
* Error overview.
|
|
898
|
+
*/
|
|
899
|
+
message: string;
|
|
900
|
+
};
|
|
901
|
+
};
|
|
902
|
+
type ApiTokensDestroyError = ApiTokensDestroyErrors[keyof ApiTokensDestroyErrors];
|
|
903
|
+
type ApiTokensDestroyResponses = {
|
|
904
|
+
200: unknown;
|
|
905
|
+
};
|
|
906
|
+
type BioBlocksIndexData = {
|
|
907
|
+
body?: never;
|
|
908
|
+
path: {
|
|
909
|
+
/**
|
|
910
|
+
* The space ID
|
|
911
|
+
*/
|
|
912
|
+
space: number;
|
|
913
|
+
};
|
|
914
|
+
query?: never;
|
|
915
|
+
url: '/spaces/{space}/bio/blocks';
|
|
916
|
+
};
|
|
917
|
+
type BioBlocksIndexErrors = {
|
|
918
|
+
/**
|
|
919
|
+
* Unauthenticated
|
|
920
|
+
*/
|
|
921
|
+
401: {
|
|
922
|
+
/**
|
|
923
|
+
* Error overview.
|
|
924
|
+
*/
|
|
925
|
+
message: string;
|
|
926
|
+
};
|
|
927
|
+
/**
|
|
928
|
+
* Authorization error
|
|
929
|
+
*/
|
|
930
|
+
403: {
|
|
931
|
+
/**
|
|
932
|
+
* Error overview.
|
|
933
|
+
*/
|
|
934
|
+
message: string;
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* Not found
|
|
938
|
+
*/
|
|
939
|
+
404: {
|
|
940
|
+
/**
|
|
941
|
+
* Error overview.
|
|
942
|
+
*/
|
|
943
|
+
message: string;
|
|
944
|
+
};
|
|
945
|
+
};
|
|
946
|
+
type BioBlocksIndexError = BioBlocksIndexErrors[keyof BioBlocksIndexErrors];
|
|
947
|
+
type BioBlocksIndexResponses = {
|
|
948
|
+
/**
|
|
949
|
+
* Array of items
|
|
950
|
+
*/
|
|
951
|
+
200: {
|
|
952
|
+
data: Array<string>;
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
type BioBlocksIndexResponse = BioBlocksIndexResponses[keyof BioBlocksIndexResponses];
|
|
956
|
+
type BioBlocksStoreData = {
|
|
957
|
+
body: StoreBioBlockRequest;
|
|
958
|
+
path: {
|
|
959
|
+
/**
|
|
960
|
+
* The space ID
|
|
961
|
+
*/
|
|
962
|
+
space: number;
|
|
963
|
+
};
|
|
964
|
+
query?: never;
|
|
965
|
+
url: '/spaces/{space}/bio/blocks';
|
|
966
|
+
};
|
|
967
|
+
type BioBlocksStoreErrors = {
|
|
968
|
+
/**
|
|
969
|
+
* Unauthenticated
|
|
970
|
+
*/
|
|
971
|
+
401: {
|
|
972
|
+
/**
|
|
973
|
+
* Error overview.
|
|
974
|
+
*/
|
|
975
|
+
message: string;
|
|
976
|
+
};
|
|
977
|
+
/**
|
|
978
|
+
* Authorization error
|
|
979
|
+
*/
|
|
980
|
+
403: {
|
|
981
|
+
/**
|
|
982
|
+
* Error overview.
|
|
983
|
+
*/
|
|
984
|
+
message: string;
|
|
985
|
+
};
|
|
986
|
+
/**
|
|
987
|
+
* Not found
|
|
988
|
+
*/
|
|
989
|
+
404: {
|
|
990
|
+
/**
|
|
991
|
+
* Error overview.
|
|
992
|
+
*/
|
|
993
|
+
message: string;
|
|
994
|
+
};
|
|
995
|
+
/**
|
|
996
|
+
* Validation error
|
|
997
|
+
*/
|
|
998
|
+
422: {
|
|
999
|
+
/**
|
|
1000
|
+
* Errors overview.
|
|
1001
|
+
*/
|
|
1002
|
+
message: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* A detailed description of each field that failed validation.
|
|
1005
|
+
*/
|
|
1006
|
+
errors: {
|
|
1007
|
+
[key: string]: Array<string>;
|
|
1008
|
+
};
|
|
1009
|
+
};
|
|
1010
|
+
};
|
|
1011
|
+
type BioBlocksStoreError = BioBlocksStoreErrors[keyof BioBlocksStoreErrors];
|
|
1012
|
+
type BioBlocksStoreResponses = {
|
|
1013
|
+
200: {
|
|
1014
|
+
[key: string]: unknown;
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
type BioBlocksStoreResponse = BioBlocksStoreResponses[keyof BioBlocksStoreResponses];
|
|
1018
|
+
type BioBlocksDestroyData = {
|
|
1019
|
+
body?: never;
|
|
1020
|
+
path: {
|
|
1021
|
+
/**
|
|
1022
|
+
* The space ID
|
|
1023
|
+
*/
|
|
1024
|
+
space: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* The block ID
|
|
1027
|
+
*/
|
|
1028
|
+
block: number;
|
|
1029
|
+
};
|
|
1030
|
+
query?: never;
|
|
1031
|
+
url: '/spaces/{space}/bio/blocks/{block}';
|
|
1032
|
+
};
|
|
1033
|
+
type BioBlocksDestroyErrors = {
|
|
1034
|
+
/**
|
|
1035
|
+
* Unauthenticated
|
|
1036
|
+
*/
|
|
1037
|
+
401: {
|
|
1038
|
+
/**
|
|
1039
|
+
* Error overview.
|
|
1040
|
+
*/
|
|
1041
|
+
message: string;
|
|
1042
|
+
};
|
|
1043
|
+
/**
|
|
1044
|
+
* Authorization error
|
|
1045
|
+
*/
|
|
1046
|
+
403: {
|
|
1047
|
+
/**
|
|
1048
|
+
* Error overview.
|
|
1049
|
+
*/
|
|
1050
|
+
message: string;
|
|
1051
|
+
};
|
|
1052
|
+
/**
|
|
1053
|
+
* Not found
|
|
1054
|
+
*/
|
|
1055
|
+
404: {
|
|
1056
|
+
/**
|
|
1057
|
+
* Error overview.
|
|
1058
|
+
*/
|
|
1059
|
+
message: string;
|
|
1060
|
+
};
|
|
1061
|
+
};
|
|
1062
|
+
type BioBlocksDestroyError = BioBlocksDestroyErrors[keyof BioBlocksDestroyErrors];
|
|
1063
|
+
type BioBlocksDestroyResponses = {
|
|
1064
|
+
200: {
|
|
1065
|
+
[key: string]: unknown;
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
type BioBlocksDestroyResponse = BioBlocksDestroyResponses[keyof BioBlocksDestroyResponses];
|
|
1069
|
+
type BioBlocksUpdateData = {
|
|
1070
|
+
body?: UpdateBioBlockRequest;
|
|
1071
|
+
path: {
|
|
1072
|
+
/**
|
|
1073
|
+
* The space ID
|
|
1074
|
+
*/
|
|
1075
|
+
space: number;
|
|
1076
|
+
/**
|
|
1077
|
+
* The block ID
|
|
1078
|
+
*/
|
|
1079
|
+
block: number;
|
|
1080
|
+
};
|
|
1081
|
+
query?: never;
|
|
1082
|
+
url: '/spaces/{space}/bio/blocks/{block}';
|
|
1083
|
+
};
|
|
1084
|
+
type BioBlocksUpdateErrors = {
|
|
1085
|
+
/**
|
|
1086
|
+
* Unauthenticated
|
|
1087
|
+
*/
|
|
1088
|
+
401: {
|
|
1089
|
+
/**
|
|
1090
|
+
* Error overview.
|
|
1091
|
+
*/
|
|
1092
|
+
message: string;
|
|
1093
|
+
};
|
|
1094
|
+
/**
|
|
1095
|
+
* Authorization error
|
|
1096
|
+
*/
|
|
1097
|
+
403: {
|
|
1098
|
+
/**
|
|
1099
|
+
* Error overview.
|
|
1100
|
+
*/
|
|
1101
|
+
message: string;
|
|
1102
|
+
};
|
|
1103
|
+
/**
|
|
1104
|
+
* Not found
|
|
1105
|
+
*/
|
|
1106
|
+
404: {
|
|
1107
|
+
/**
|
|
1108
|
+
* Error overview.
|
|
1109
|
+
*/
|
|
1110
|
+
message: string;
|
|
1111
|
+
};
|
|
1112
|
+
/**
|
|
1113
|
+
* Validation error
|
|
1114
|
+
*/
|
|
1115
|
+
422: {
|
|
1116
|
+
/**
|
|
1117
|
+
* Errors overview.
|
|
1118
|
+
*/
|
|
1119
|
+
message: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* A detailed description of each field that failed validation.
|
|
1122
|
+
*/
|
|
1123
|
+
errors: {
|
|
1124
|
+
[key: string]: Array<string>;
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
};
|
|
1128
|
+
type BioBlocksUpdateError = BioBlocksUpdateErrors[keyof BioBlocksUpdateErrors];
|
|
1129
|
+
type BioBlocksUpdateResponses = {
|
|
1130
|
+
/**
|
|
1131
|
+
* `BioBlockResource`
|
|
1132
|
+
*/
|
|
1133
|
+
200: {
|
|
1134
|
+
data: BioBlockResource;
|
|
1135
|
+
} | {
|
|
1136
|
+
[key: string]: unknown;
|
|
1137
|
+
};
|
|
1138
|
+
};
|
|
1139
|
+
type BioBlocksUpdateResponse = BioBlocksUpdateResponses[keyof BioBlocksUpdateResponses];
|
|
1140
|
+
type BioBlocksReorderData = {
|
|
1141
|
+
body: {
|
|
1142
|
+
direction: 'up' | 'down';
|
|
1143
|
+
};
|
|
1144
|
+
path: {
|
|
1145
|
+
/**
|
|
1146
|
+
* The space ID
|
|
1147
|
+
*/
|
|
1148
|
+
space: number;
|
|
1149
|
+
/**
|
|
1150
|
+
* The block ID
|
|
1151
|
+
*/
|
|
1152
|
+
block: number;
|
|
1153
|
+
};
|
|
1154
|
+
query?: never;
|
|
1155
|
+
url: '/spaces/{space}/bio/blocks/{block}/reorder';
|
|
1156
|
+
};
|
|
1157
|
+
type BioBlocksReorderErrors = {
|
|
1158
|
+
/**
|
|
1159
|
+
* Unauthenticated
|
|
1160
|
+
*/
|
|
1161
|
+
401: {
|
|
1162
|
+
/**
|
|
1163
|
+
* Error overview.
|
|
1164
|
+
*/
|
|
1165
|
+
message: string;
|
|
1166
|
+
};
|
|
1167
|
+
/**
|
|
1168
|
+
* Authorization error
|
|
1169
|
+
*/
|
|
1170
|
+
403: {
|
|
1171
|
+
/**
|
|
1172
|
+
* Error overview.
|
|
1173
|
+
*/
|
|
1174
|
+
message: string;
|
|
1175
|
+
};
|
|
1176
|
+
/**
|
|
1177
|
+
* Not found
|
|
1178
|
+
*/
|
|
1179
|
+
404: {
|
|
1180
|
+
/**
|
|
1181
|
+
* Error overview.
|
|
1182
|
+
*/
|
|
1183
|
+
message: string;
|
|
1184
|
+
};
|
|
1185
|
+
/**
|
|
1186
|
+
* Validation error
|
|
1187
|
+
*/
|
|
1188
|
+
422: {
|
|
1189
|
+
/**
|
|
1190
|
+
* Errors overview.
|
|
1191
|
+
*/
|
|
1192
|
+
message: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* A detailed description of each field that failed validation.
|
|
1195
|
+
*/
|
|
1196
|
+
errors: {
|
|
1197
|
+
[key: string]: Array<string>;
|
|
1198
|
+
};
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
type BioBlocksReorderError = BioBlocksReorderErrors[keyof BioBlocksReorderErrors];
|
|
1202
|
+
type BioBlocksReorderResponses = {
|
|
1203
|
+
200: {
|
|
1204
|
+
[key: string]: unknown;
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
type BioBlocksReorderResponse = BioBlocksReorderResponses[keyof BioBlocksReorderResponses];
|
|
1208
|
+
type BioShowData = {
|
|
1209
|
+
body?: never;
|
|
1210
|
+
path: {
|
|
1211
|
+
/**
|
|
1212
|
+
* The space ID
|
|
1213
|
+
*/
|
|
1214
|
+
space: number;
|
|
1215
|
+
};
|
|
1216
|
+
query?: never;
|
|
1217
|
+
url: '/spaces/{space}/bio';
|
|
1218
|
+
};
|
|
1219
|
+
type BioShowErrors = {
|
|
1220
|
+
/**
|
|
1221
|
+
* Unauthenticated
|
|
1222
|
+
*/
|
|
1223
|
+
401: {
|
|
1224
|
+
/**
|
|
1225
|
+
* Error overview.
|
|
1226
|
+
*/
|
|
1227
|
+
message: string;
|
|
1228
|
+
};
|
|
1229
|
+
/**
|
|
1230
|
+
* Authorization error
|
|
1231
|
+
*/
|
|
1232
|
+
403: {
|
|
1233
|
+
/**
|
|
1234
|
+
* Error overview.
|
|
1235
|
+
*/
|
|
1236
|
+
message: string;
|
|
1237
|
+
};
|
|
1238
|
+
/**
|
|
1239
|
+
* Not found
|
|
1240
|
+
*/
|
|
1241
|
+
404: {
|
|
1242
|
+
/**
|
|
1243
|
+
* Error overview.
|
|
1244
|
+
*/
|
|
1245
|
+
message: string;
|
|
1246
|
+
};
|
|
1247
|
+
};
|
|
1248
|
+
type BioShowError = BioShowErrors[keyof BioShowErrors];
|
|
1249
|
+
type BioShowResponses = {
|
|
1250
|
+
/**
|
|
1251
|
+
* `BioPageResource`
|
|
1252
|
+
*/
|
|
1253
|
+
200: {
|
|
1254
|
+
data: BioPageResource;
|
|
1255
|
+
};
|
|
1256
|
+
};
|
|
1257
|
+
type BioShowResponse = BioShowResponses[keyof BioShowResponses];
|
|
1258
|
+
type BioStoreData = {
|
|
1259
|
+
body: StoreBioPageRequest;
|
|
1260
|
+
path: {
|
|
1261
|
+
/**
|
|
1262
|
+
* The space ID
|
|
1263
|
+
*/
|
|
1264
|
+
space: number;
|
|
1265
|
+
};
|
|
1266
|
+
query?: never;
|
|
1267
|
+
url: '/spaces/{space}/bio';
|
|
1268
|
+
};
|
|
1269
|
+
type BioStoreErrors = {
|
|
1270
|
+
/**
|
|
1271
|
+
* Unauthenticated
|
|
1272
|
+
*/
|
|
1273
|
+
401: {
|
|
1274
|
+
/**
|
|
1275
|
+
* Error overview.
|
|
1276
|
+
*/
|
|
1277
|
+
message: string;
|
|
1278
|
+
};
|
|
1279
|
+
/**
|
|
1280
|
+
* Authorization error
|
|
1281
|
+
*/
|
|
1282
|
+
403: {
|
|
1283
|
+
/**
|
|
1284
|
+
* Error overview.
|
|
1285
|
+
*/
|
|
1286
|
+
message: string;
|
|
1287
|
+
};
|
|
1288
|
+
/**
|
|
1289
|
+
* Not found
|
|
1290
|
+
*/
|
|
1291
|
+
404: {
|
|
1292
|
+
/**
|
|
1293
|
+
* Error overview.
|
|
1294
|
+
*/
|
|
1295
|
+
message: string;
|
|
1296
|
+
};
|
|
1297
|
+
/**
|
|
1298
|
+
* Validation error
|
|
1299
|
+
*/
|
|
1300
|
+
422: {
|
|
1301
|
+
/**
|
|
1302
|
+
* Errors overview.
|
|
1303
|
+
*/
|
|
1304
|
+
message: string;
|
|
1305
|
+
/**
|
|
1306
|
+
* A detailed description of each field that failed validation.
|
|
1307
|
+
*/
|
|
1308
|
+
errors: {
|
|
1309
|
+
[key: string]: Array<string>;
|
|
1310
|
+
};
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
type BioStoreError = BioStoreErrors[keyof BioStoreErrors];
|
|
1314
|
+
type BioStoreResponses = {
|
|
1315
|
+
200: {
|
|
1316
|
+
[key: string]: unknown;
|
|
1317
|
+
};
|
|
1318
|
+
};
|
|
1319
|
+
type BioStoreResponse = BioStoreResponses[keyof BioStoreResponses];
|
|
1320
|
+
type BioUpdateData = {
|
|
1321
|
+
body?: UpdateBioPageRequest;
|
|
1322
|
+
path: {
|
|
1323
|
+
/**
|
|
1324
|
+
* The space ID
|
|
1325
|
+
*/
|
|
1326
|
+
space: number;
|
|
1327
|
+
};
|
|
1328
|
+
query?: never;
|
|
1329
|
+
url: '/spaces/{space}/bio';
|
|
1330
|
+
};
|
|
1331
|
+
type BioUpdateErrors = {
|
|
1332
|
+
/**
|
|
1333
|
+
* Unauthenticated
|
|
1334
|
+
*/
|
|
1335
|
+
401: {
|
|
1336
|
+
/**
|
|
1337
|
+
* Error overview.
|
|
1338
|
+
*/
|
|
1339
|
+
message: string;
|
|
1340
|
+
};
|
|
1341
|
+
/**
|
|
1342
|
+
* Authorization error
|
|
1343
|
+
*/
|
|
1344
|
+
403: {
|
|
1345
|
+
/**
|
|
1346
|
+
* Error overview.
|
|
1347
|
+
*/
|
|
1348
|
+
message: string;
|
|
1349
|
+
};
|
|
1350
|
+
/**
|
|
1351
|
+
* Not found
|
|
1352
|
+
*/
|
|
1353
|
+
404: {
|
|
1354
|
+
/**
|
|
1355
|
+
* Error overview.
|
|
1356
|
+
*/
|
|
1357
|
+
message: string;
|
|
1358
|
+
};
|
|
1359
|
+
/**
|
|
1360
|
+
* Validation error
|
|
1361
|
+
*/
|
|
1362
|
+
422: {
|
|
1363
|
+
/**
|
|
1364
|
+
* Errors overview.
|
|
1365
|
+
*/
|
|
1366
|
+
message: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* A detailed description of each field that failed validation.
|
|
1369
|
+
*/
|
|
1370
|
+
errors: {
|
|
1371
|
+
[key: string]: Array<string>;
|
|
1372
|
+
};
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
type BioUpdateError = BioUpdateErrors[keyof BioUpdateErrors];
|
|
1376
|
+
type BioUpdateResponses = {
|
|
1377
|
+
/**
|
|
1378
|
+
* `BioPageResource`
|
|
1379
|
+
*/
|
|
1380
|
+
200: {
|
|
1381
|
+
data: BioPageResource;
|
|
1382
|
+
} | {
|
|
1383
|
+
[key: string]: unknown;
|
|
1384
|
+
};
|
|
1385
|
+
};
|
|
1386
|
+
type BioUpdateResponse = BioUpdateResponses[keyof BioUpdateResponses];
|
|
1387
|
+
type BioAvatarData = {
|
|
1388
|
+
body: {
|
|
1389
|
+
file: Blob | File;
|
|
1390
|
+
};
|
|
1391
|
+
path: {
|
|
1392
|
+
/**
|
|
1393
|
+
* The space ID
|
|
1394
|
+
*/
|
|
1395
|
+
space: number;
|
|
1396
|
+
};
|
|
1397
|
+
query?: never;
|
|
1398
|
+
url: '/spaces/{space}/bio/avatar';
|
|
1399
|
+
};
|
|
1400
|
+
type BioAvatarErrors = {
|
|
1401
|
+
/**
|
|
1402
|
+
* Unauthenticated
|
|
1403
|
+
*/
|
|
1404
|
+
401: {
|
|
1405
|
+
/**
|
|
1406
|
+
* Error overview.
|
|
1407
|
+
*/
|
|
1408
|
+
message: string;
|
|
1409
|
+
};
|
|
1410
|
+
/**
|
|
1411
|
+
* Authorization error
|
|
1412
|
+
*/
|
|
1413
|
+
403: {
|
|
1414
|
+
/**
|
|
1415
|
+
* Error overview.
|
|
1416
|
+
*/
|
|
1417
|
+
message: string;
|
|
1418
|
+
};
|
|
1419
|
+
/**
|
|
1420
|
+
* Not found
|
|
1421
|
+
*/
|
|
1422
|
+
404: {
|
|
1423
|
+
/**
|
|
1424
|
+
* Error overview.
|
|
1425
|
+
*/
|
|
1426
|
+
message: string;
|
|
1427
|
+
};
|
|
1428
|
+
/**
|
|
1429
|
+
* Validation error
|
|
1430
|
+
*/
|
|
1431
|
+
422: {
|
|
1432
|
+
/**
|
|
1433
|
+
* Errors overview.
|
|
1434
|
+
*/
|
|
1435
|
+
message: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* A detailed description of each field that failed validation.
|
|
1438
|
+
*/
|
|
1439
|
+
errors: {
|
|
1440
|
+
[key: string]: Array<string>;
|
|
1441
|
+
};
|
|
1442
|
+
};
|
|
1443
|
+
};
|
|
1444
|
+
type BioAvatarError = BioAvatarErrors[keyof BioAvatarErrors];
|
|
1445
|
+
type BioAvatarResponses = {
|
|
1446
|
+
200: {
|
|
1447
|
+
[key: string]: unknown;
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
type BioAvatarResponse = BioAvatarResponses[keyof BioAvatarResponses];
|
|
1451
|
+
type MediaStoreData = {
|
|
1452
|
+
body: {
|
|
1453
|
+
file: Blob | File;
|
|
1454
|
+
};
|
|
1455
|
+
path?: never;
|
|
1456
|
+
query?: never;
|
|
1457
|
+
url: '/media';
|
|
1458
|
+
};
|
|
1459
|
+
type MediaStoreErrors = {
|
|
1460
|
+
/**
|
|
1461
|
+
* Unauthenticated
|
|
1462
|
+
*/
|
|
1463
|
+
401: {
|
|
1464
|
+
/**
|
|
1465
|
+
* Error overview.
|
|
1466
|
+
*/
|
|
1467
|
+
message: string;
|
|
1468
|
+
};
|
|
1469
|
+
/**
|
|
1470
|
+
* Validation error
|
|
1471
|
+
*/
|
|
1472
|
+
422: {
|
|
1473
|
+
/**
|
|
1474
|
+
* Errors overview.
|
|
1475
|
+
*/
|
|
1476
|
+
message: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* A detailed description of each field that failed validation.
|
|
1479
|
+
*/
|
|
1480
|
+
errors: {
|
|
1481
|
+
[key: string]: Array<string>;
|
|
1482
|
+
};
|
|
1483
|
+
};
|
|
1484
|
+
};
|
|
1485
|
+
type MediaStoreError = MediaStoreErrors[keyof MediaStoreErrors];
|
|
1486
|
+
type MediaStoreResponses = {
|
|
1487
|
+
/**
|
|
1488
|
+
* `MediaResource`
|
|
1489
|
+
*/
|
|
1490
|
+
201: {
|
|
1491
|
+
data: MediaResource;
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1494
|
+
type MediaStoreResponse = MediaStoreResponses[keyof MediaStoreResponses];
|
|
1495
|
+
type MediaDestroyData = {
|
|
1496
|
+
body?: never;
|
|
1497
|
+
path: {
|
|
1498
|
+
/**
|
|
1499
|
+
* The media ID
|
|
1500
|
+
*/
|
|
1501
|
+
media: number;
|
|
1502
|
+
};
|
|
1503
|
+
query?: never;
|
|
1504
|
+
url: '/media/{media}';
|
|
1505
|
+
};
|
|
1506
|
+
type MediaDestroyErrors = {
|
|
1507
|
+
/**
|
|
1508
|
+
* Unauthenticated
|
|
1509
|
+
*/
|
|
1510
|
+
401: {
|
|
1511
|
+
/**
|
|
1512
|
+
* Error overview.
|
|
1513
|
+
*/
|
|
1514
|
+
message: string;
|
|
1515
|
+
};
|
|
1516
|
+
/**
|
|
1517
|
+
* Authorization error
|
|
1518
|
+
*/
|
|
1519
|
+
403: {
|
|
1520
|
+
/**
|
|
1521
|
+
* Error overview.
|
|
1522
|
+
*/
|
|
1523
|
+
message: string;
|
|
1524
|
+
};
|
|
1525
|
+
/**
|
|
1526
|
+
* Not found
|
|
1527
|
+
*/
|
|
1528
|
+
404: {
|
|
1529
|
+
/**
|
|
1530
|
+
* Error overview.
|
|
1531
|
+
*/
|
|
1532
|
+
message: string;
|
|
1533
|
+
};
|
|
1534
|
+
};
|
|
1535
|
+
type MediaDestroyError = MediaDestroyErrors[keyof MediaDestroyErrors];
|
|
1536
|
+
type MediaDestroyResponses = {
|
|
1537
|
+
200: {
|
|
1538
|
+
[key: string]: unknown;
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
type MediaDestroyResponse = MediaDestroyResponses[keyof MediaDestroyResponses];
|
|
1542
|
+
type PostsIndexData = {
|
|
1543
|
+
body?: never;
|
|
1544
|
+
path: {
|
|
1545
|
+
/**
|
|
1546
|
+
* The space ID
|
|
1547
|
+
*/
|
|
1548
|
+
space: number;
|
|
1549
|
+
};
|
|
1550
|
+
query?: {
|
|
1551
|
+
status?: string;
|
|
1552
|
+
account_id?: string;
|
|
1553
|
+
from?: string;
|
|
1554
|
+
to?: string;
|
|
1555
|
+
};
|
|
1556
|
+
url: '/spaces/{space}/posts';
|
|
1557
|
+
};
|
|
1558
|
+
type PostsIndexErrors = {
|
|
1559
|
+
/**
|
|
1560
|
+
* Unauthenticated
|
|
1561
|
+
*/
|
|
1562
|
+
401: {
|
|
1563
|
+
/**
|
|
1564
|
+
* Error overview.
|
|
1565
|
+
*/
|
|
1566
|
+
message: string;
|
|
1567
|
+
};
|
|
1568
|
+
/**
|
|
1569
|
+
* Authorization error
|
|
1570
|
+
*/
|
|
1571
|
+
403: {
|
|
1572
|
+
/**
|
|
1573
|
+
* Error overview.
|
|
1574
|
+
*/
|
|
1575
|
+
message: string;
|
|
1576
|
+
};
|
|
1577
|
+
/**
|
|
1578
|
+
* Not found
|
|
1579
|
+
*/
|
|
1580
|
+
404: {
|
|
1581
|
+
/**
|
|
1582
|
+
* Error overview.
|
|
1583
|
+
*/
|
|
1584
|
+
message: string;
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
type PostsIndexError = PostsIndexErrors[keyof PostsIndexErrors];
|
|
1588
|
+
type PostsIndexResponses = {
|
|
1589
|
+
/**
|
|
1590
|
+
* Paginated set of `PostResource`
|
|
1591
|
+
*/
|
|
1592
|
+
200: {
|
|
1593
|
+
data: Array<PostResource>;
|
|
1594
|
+
links: {
|
|
1595
|
+
first: string | null;
|
|
1596
|
+
last: string | null;
|
|
1597
|
+
prev: string | null;
|
|
1598
|
+
next: string | null;
|
|
1599
|
+
};
|
|
1600
|
+
meta: {
|
|
1601
|
+
current_page: number;
|
|
1602
|
+
from: number | null;
|
|
1603
|
+
last_page: number;
|
|
1604
|
+
/**
|
|
1605
|
+
* Generated paginator links.
|
|
1606
|
+
*/
|
|
1607
|
+
links: Array<{
|
|
1608
|
+
url: string | null;
|
|
1609
|
+
label: string;
|
|
1610
|
+
active: boolean;
|
|
1611
|
+
}>;
|
|
1612
|
+
/**
|
|
1613
|
+
* Base path for paginator generated URLs.
|
|
1614
|
+
*/
|
|
1615
|
+
path: string | null;
|
|
1616
|
+
/**
|
|
1617
|
+
* Number of items shown per page.
|
|
1618
|
+
*/
|
|
1619
|
+
per_page: number;
|
|
1620
|
+
/**
|
|
1621
|
+
* Number of the last item in the slice.
|
|
1622
|
+
*/
|
|
1623
|
+
to: number | null;
|
|
1624
|
+
/**
|
|
1625
|
+
* Total number of items being paginated.
|
|
1626
|
+
*/
|
|
1627
|
+
total: number;
|
|
1628
|
+
};
|
|
1629
|
+
};
|
|
1630
|
+
};
|
|
1631
|
+
type PostsIndexResponse = PostsIndexResponses[keyof PostsIndexResponses];
|
|
1632
|
+
type PostsStoreData = {
|
|
1633
|
+
body: StorePostRequest;
|
|
1634
|
+
path: {
|
|
1635
|
+
space: string;
|
|
1636
|
+
};
|
|
1637
|
+
query?: never;
|
|
1638
|
+
url: '/spaces/{space}/posts';
|
|
1639
|
+
};
|
|
1640
|
+
type PostsStoreErrors = {
|
|
1641
|
+
/**
|
|
1642
|
+
* Unauthenticated
|
|
1643
|
+
*/
|
|
1644
|
+
401: {
|
|
1645
|
+
/**
|
|
1646
|
+
* Error overview.
|
|
1647
|
+
*/
|
|
1648
|
+
message: string;
|
|
1649
|
+
};
|
|
1650
|
+
/**
|
|
1651
|
+
* Authorization error
|
|
1652
|
+
*/
|
|
1653
|
+
403: {
|
|
1654
|
+
/**
|
|
1655
|
+
* Error overview.
|
|
1656
|
+
*/
|
|
1657
|
+
message: string;
|
|
1658
|
+
};
|
|
1659
|
+
/**
|
|
1660
|
+
* Validation error
|
|
1661
|
+
*/
|
|
1662
|
+
422: {
|
|
1663
|
+
/**
|
|
1664
|
+
* Errors overview.
|
|
1665
|
+
*/
|
|
1666
|
+
message: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* A detailed description of each field that failed validation.
|
|
1669
|
+
*/
|
|
1670
|
+
errors: {
|
|
1671
|
+
[key: string]: Array<string>;
|
|
1672
|
+
};
|
|
1673
|
+
};
|
|
1674
|
+
};
|
|
1675
|
+
type PostsStoreError = PostsStoreErrors[keyof PostsStoreErrors];
|
|
1676
|
+
type PostsStoreResponses = {
|
|
1677
|
+
200: {
|
|
1678
|
+
[key: string]: unknown;
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1681
|
+
type PostsStoreResponse = PostsStoreResponses[keyof PostsStoreResponses];
|
|
1682
|
+
type PostsDestroyData = {
|
|
1683
|
+
body?: never;
|
|
1684
|
+
path: {
|
|
1685
|
+
/**
|
|
1686
|
+
* The space ID
|
|
1687
|
+
*/
|
|
1688
|
+
space: number;
|
|
1689
|
+
/**
|
|
1690
|
+
* The post ID
|
|
1691
|
+
*/
|
|
1692
|
+
post: number;
|
|
1693
|
+
};
|
|
1694
|
+
query?: never;
|
|
1695
|
+
url: '/spaces/{space}/posts/{post}';
|
|
1696
|
+
};
|
|
1697
|
+
type PostsDestroyErrors = {
|
|
1698
|
+
/**
|
|
1699
|
+
* Unauthenticated
|
|
1700
|
+
*/
|
|
1701
|
+
401: {
|
|
1702
|
+
/**
|
|
1703
|
+
* Error overview.
|
|
1704
|
+
*/
|
|
1705
|
+
message: string;
|
|
1706
|
+
};
|
|
1707
|
+
/**
|
|
1708
|
+
* Authorization error
|
|
1709
|
+
*/
|
|
1710
|
+
403: {
|
|
1711
|
+
/**
|
|
1712
|
+
* Error overview.
|
|
1713
|
+
*/
|
|
1714
|
+
message: string;
|
|
1715
|
+
};
|
|
1716
|
+
/**
|
|
1717
|
+
* Not found
|
|
1718
|
+
*/
|
|
1719
|
+
404: {
|
|
1720
|
+
/**
|
|
1721
|
+
* Error overview.
|
|
1722
|
+
*/
|
|
1723
|
+
message: string;
|
|
1724
|
+
};
|
|
1725
|
+
};
|
|
1726
|
+
type PostsDestroyError = PostsDestroyErrors[keyof PostsDestroyErrors];
|
|
1727
|
+
type PostsDestroyResponses = {
|
|
1728
|
+
200: {
|
|
1729
|
+
[key: string]: unknown;
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
type PostsDestroyResponse = PostsDestroyResponses[keyof PostsDestroyResponses];
|
|
1733
|
+
type PostsShowData = {
|
|
1734
|
+
body?: never;
|
|
1735
|
+
path: {
|
|
1736
|
+
/**
|
|
1737
|
+
* The space ID
|
|
1738
|
+
*/
|
|
1739
|
+
space: number;
|
|
1740
|
+
/**
|
|
1741
|
+
* The post ID
|
|
1742
|
+
*/
|
|
1743
|
+
post: number;
|
|
1744
|
+
};
|
|
1745
|
+
query?: never;
|
|
1746
|
+
url: '/spaces/{space}/posts/{post}';
|
|
1747
|
+
};
|
|
1748
|
+
type PostsShowErrors = {
|
|
1749
|
+
/**
|
|
1750
|
+
* Unauthenticated
|
|
1751
|
+
*/
|
|
1752
|
+
401: {
|
|
1753
|
+
/**
|
|
1754
|
+
* Error overview.
|
|
1755
|
+
*/
|
|
1756
|
+
message: string;
|
|
1757
|
+
};
|
|
1758
|
+
/**
|
|
1759
|
+
* Authorization error
|
|
1760
|
+
*/
|
|
1761
|
+
403: {
|
|
1762
|
+
/**
|
|
1763
|
+
* Error overview.
|
|
1764
|
+
*/
|
|
1765
|
+
message: string;
|
|
1766
|
+
};
|
|
1767
|
+
/**
|
|
1768
|
+
* Not found
|
|
1769
|
+
*/
|
|
1770
|
+
404: {
|
|
1771
|
+
/**
|
|
1772
|
+
* Error overview.
|
|
1773
|
+
*/
|
|
1774
|
+
message: string;
|
|
1775
|
+
};
|
|
1776
|
+
};
|
|
1777
|
+
type PostsShowError = PostsShowErrors[keyof PostsShowErrors];
|
|
1778
|
+
type PostsShowResponses = {
|
|
1779
|
+
/**
|
|
1780
|
+
* `PostResource`
|
|
1781
|
+
*/
|
|
1782
|
+
200: {
|
|
1783
|
+
data: PostResource;
|
|
1784
|
+
};
|
|
1785
|
+
};
|
|
1786
|
+
type PostsShowResponse = PostsShowResponses[keyof PostsShowResponses];
|
|
1787
|
+
type PostsUpdateData = {
|
|
1788
|
+
body?: UpdatePostRequest;
|
|
1789
|
+
path: {
|
|
1790
|
+
/**
|
|
1791
|
+
* The space ID
|
|
1792
|
+
*/
|
|
1793
|
+
space: number;
|
|
1794
|
+
/**
|
|
1795
|
+
* The post ID
|
|
1796
|
+
*/
|
|
1797
|
+
post: number;
|
|
1798
|
+
};
|
|
1799
|
+
query?: never;
|
|
1800
|
+
url: '/spaces/{space}/posts/{post}';
|
|
1801
|
+
};
|
|
1802
|
+
type PostsUpdateErrors = {
|
|
1803
|
+
/**
|
|
1804
|
+
* Unauthenticated
|
|
1805
|
+
*/
|
|
1806
|
+
401: {
|
|
1807
|
+
/**
|
|
1808
|
+
* Error overview.
|
|
1809
|
+
*/
|
|
1810
|
+
message: string;
|
|
1811
|
+
};
|
|
1812
|
+
/**
|
|
1813
|
+
* Authorization error
|
|
1814
|
+
*/
|
|
1815
|
+
403: {
|
|
1816
|
+
/**
|
|
1817
|
+
* Error overview.
|
|
1818
|
+
*/
|
|
1819
|
+
message: string;
|
|
1820
|
+
};
|
|
1821
|
+
/**
|
|
1822
|
+
* Not found
|
|
1823
|
+
*/
|
|
1824
|
+
404: {
|
|
1825
|
+
/**
|
|
1826
|
+
* Error overview.
|
|
1827
|
+
*/
|
|
1828
|
+
message: string;
|
|
1829
|
+
};
|
|
1830
|
+
/**
|
|
1831
|
+
* Validation error
|
|
1832
|
+
*/
|
|
1833
|
+
422: {
|
|
1834
|
+
/**
|
|
1835
|
+
* Errors overview.
|
|
1836
|
+
*/
|
|
1837
|
+
message: string;
|
|
1838
|
+
/**
|
|
1839
|
+
* A detailed description of each field that failed validation.
|
|
1840
|
+
*/
|
|
1841
|
+
errors: {
|
|
1842
|
+
[key: string]: Array<string>;
|
|
1843
|
+
};
|
|
1844
|
+
};
|
|
1845
|
+
};
|
|
1846
|
+
type PostsUpdateError = PostsUpdateErrors[keyof PostsUpdateErrors];
|
|
1847
|
+
type PostsUpdateResponses = {
|
|
1848
|
+
/**
|
|
1849
|
+
* `PostResource`
|
|
1850
|
+
*/
|
|
1851
|
+
200: {
|
|
1852
|
+
data: PostResource;
|
|
1853
|
+
} | {
|
|
1854
|
+
[key: string]: unknown;
|
|
1855
|
+
};
|
|
1856
|
+
};
|
|
1857
|
+
type PostsUpdateResponse = PostsUpdateResponses[keyof PostsUpdateResponses];
|
|
1858
|
+
type ClustersUpdateData = {
|
|
1859
|
+
body: UpdateClusterRequest;
|
|
1860
|
+
path: {
|
|
1861
|
+
/**
|
|
1862
|
+
* The space ID
|
|
1863
|
+
*/
|
|
1864
|
+
space: number;
|
|
1865
|
+
cluster_id: string;
|
|
1866
|
+
};
|
|
1867
|
+
query?: never;
|
|
1868
|
+
url: '/spaces/{space}/clusters/{cluster_id}';
|
|
1869
|
+
};
|
|
1870
|
+
type ClustersUpdateErrors = {
|
|
1871
|
+
/**
|
|
1872
|
+
* Unauthenticated
|
|
1873
|
+
*/
|
|
1874
|
+
401: {
|
|
1875
|
+
/**
|
|
1876
|
+
* Error overview.
|
|
1877
|
+
*/
|
|
1878
|
+
message: string;
|
|
1879
|
+
};
|
|
1880
|
+
/**
|
|
1881
|
+
* Authorization error
|
|
1882
|
+
*/
|
|
1883
|
+
403: {
|
|
1884
|
+
/**
|
|
1885
|
+
* Error overview.
|
|
1886
|
+
*/
|
|
1887
|
+
message: string;
|
|
1888
|
+
};
|
|
1889
|
+
/**
|
|
1890
|
+
* Not found
|
|
1891
|
+
*/
|
|
1892
|
+
404: {
|
|
1893
|
+
/**
|
|
1894
|
+
* Error overview.
|
|
1895
|
+
*/
|
|
1896
|
+
message: string;
|
|
1897
|
+
};
|
|
1898
|
+
/**
|
|
1899
|
+
* Validation error
|
|
1900
|
+
*/
|
|
1901
|
+
422: {
|
|
1902
|
+
/**
|
|
1903
|
+
* Errors overview.
|
|
1904
|
+
*/
|
|
1905
|
+
message: string;
|
|
1906
|
+
/**
|
|
1907
|
+
* A detailed description of each field that failed validation.
|
|
1908
|
+
*/
|
|
1909
|
+
errors: {
|
|
1910
|
+
[key: string]: Array<string>;
|
|
1911
|
+
};
|
|
1912
|
+
};
|
|
1913
|
+
};
|
|
1914
|
+
type ClustersUpdateError = ClustersUpdateErrors[keyof ClustersUpdateErrors];
|
|
1915
|
+
type ClustersUpdateResponses = {
|
|
1916
|
+
/**
|
|
1917
|
+
* Array of items
|
|
1918
|
+
*/
|
|
1919
|
+
200: {
|
|
1920
|
+
data: Array<string>;
|
|
1921
|
+
} | {
|
|
1922
|
+
[key: string]: unknown;
|
|
1923
|
+
};
|
|
1924
|
+
};
|
|
1925
|
+
type ClustersUpdateResponse = ClustersUpdateResponses[keyof ClustersUpdateResponses];
|
|
1926
|
+
type QueueIndexData = {
|
|
1927
|
+
body?: never;
|
|
1928
|
+
path: {
|
|
1929
|
+
/**
|
|
1930
|
+
* The space ID
|
|
1931
|
+
*/
|
|
1932
|
+
space: number;
|
|
1933
|
+
};
|
|
1934
|
+
query?: never;
|
|
1935
|
+
url: '/spaces/{space}/queue';
|
|
1936
|
+
};
|
|
1937
|
+
type QueueIndexErrors = {
|
|
1938
|
+
/**
|
|
1939
|
+
* Unauthenticated
|
|
1940
|
+
*/
|
|
1941
|
+
401: {
|
|
1942
|
+
/**
|
|
1943
|
+
* Error overview.
|
|
1944
|
+
*/
|
|
1945
|
+
message: string;
|
|
1946
|
+
};
|
|
1947
|
+
/**
|
|
1948
|
+
* Authorization error
|
|
1949
|
+
*/
|
|
1950
|
+
403: {
|
|
1951
|
+
/**
|
|
1952
|
+
* Error overview.
|
|
1953
|
+
*/
|
|
1954
|
+
message: string;
|
|
1955
|
+
};
|
|
1956
|
+
/**
|
|
1957
|
+
* Not found
|
|
1958
|
+
*/
|
|
1959
|
+
404: {
|
|
1960
|
+
/**
|
|
1961
|
+
* Error overview.
|
|
1962
|
+
*/
|
|
1963
|
+
message: string;
|
|
1964
|
+
};
|
|
1965
|
+
};
|
|
1966
|
+
type QueueIndexError = QueueIndexErrors[keyof QueueIndexErrors];
|
|
1967
|
+
type QueueIndexResponses = {
|
|
1968
|
+
200: {
|
|
1969
|
+
data: Array<{
|
|
1970
|
+
datetime: string;
|
|
1971
|
+
timestamp_ms: string;
|
|
1972
|
+
label: string;
|
|
1973
|
+
}>;
|
|
1974
|
+
} | {
|
|
1975
|
+
data: Array<string>;
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
type QueueIndexResponse = QueueIndexResponses[keyof QueueIndexResponses];
|
|
1979
|
+
type SlotsIndexData = {
|
|
1980
|
+
body?: never;
|
|
1981
|
+
path: {
|
|
1982
|
+
/**
|
|
1983
|
+
* The space ID
|
|
1984
|
+
*/
|
|
1985
|
+
space: number;
|
|
1986
|
+
};
|
|
1987
|
+
query?: never;
|
|
1988
|
+
url: '/spaces/{space}/slots';
|
|
1989
|
+
};
|
|
1990
|
+
type SlotsIndexErrors = {
|
|
1991
|
+
/**
|
|
1992
|
+
* Unauthenticated
|
|
1993
|
+
*/
|
|
1994
|
+
401: {
|
|
1995
|
+
/**
|
|
1996
|
+
* Error overview.
|
|
1997
|
+
*/
|
|
1998
|
+
message: string;
|
|
1999
|
+
};
|
|
2000
|
+
/**
|
|
2001
|
+
* Authorization error
|
|
2002
|
+
*/
|
|
2003
|
+
403: {
|
|
2004
|
+
/**
|
|
2005
|
+
* Error overview.
|
|
2006
|
+
*/
|
|
2007
|
+
message: string;
|
|
2008
|
+
};
|
|
2009
|
+
/**
|
|
2010
|
+
* Not found
|
|
2011
|
+
*/
|
|
2012
|
+
404: {
|
|
2013
|
+
/**
|
|
2014
|
+
* Error overview.
|
|
2015
|
+
*/
|
|
2016
|
+
message: string;
|
|
2017
|
+
};
|
|
2018
|
+
};
|
|
2019
|
+
type SlotsIndexError = SlotsIndexErrors[keyof SlotsIndexErrors];
|
|
2020
|
+
type SlotsIndexResponses = {
|
|
2021
|
+
/**
|
|
2022
|
+
* Array of `SlotResource`
|
|
2023
|
+
*/
|
|
2024
|
+
200: {
|
|
2025
|
+
data: Array<SlotResource>;
|
|
2026
|
+
};
|
|
2027
|
+
};
|
|
2028
|
+
type SlotsIndexResponse = SlotsIndexResponses[keyof SlotsIndexResponses];
|
|
2029
|
+
type SlotsStoreData = {
|
|
2030
|
+
body: StoreSlotRequest;
|
|
2031
|
+
path: {
|
|
2032
|
+
/**
|
|
2033
|
+
* The space ID
|
|
2034
|
+
*/
|
|
2035
|
+
space: number;
|
|
2036
|
+
};
|
|
2037
|
+
query?: never;
|
|
2038
|
+
url: '/spaces/{space}/slots';
|
|
2039
|
+
};
|
|
2040
|
+
type SlotsStoreErrors = {
|
|
2041
|
+
/**
|
|
2042
|
+
* Unauthenticated
|
|
2043
|
+
*/
|
|
2044
|
+
401: {
|
|
2045
|
+
/**
|
|
2046
|
+
* Error overview.
|
|
2047
|
+
*/
|
|
2048
|
+
message: string;
|
|
2049
|
+
};
|
|
2050
|
+
/**
|
|
2051
|
+
* Authorization error
|
|
2052
|
+
*/
|
|
2053
|
+
403: {
|
|
2054
|
+
/**
|
|
2055
|
+
* Error overview.
|
|
2056
|
+
*/
|
|
2057
|
+
message: string;
|
|
2058
|
+
};
|
|
2059
|
+
/**
|
|
2060
|
+
* Not found
|
|
2061
|
+
*/
|
|
2062
|
+
404: {
|
|
2063
|
+
/**
|
|
2064
|
+
* Error overview.
|
|
2065
|
+
*/
|
|
2066
|
+
message: string;
|
|
2067
|
+
};
|
|
2068
|
+
/**
|
|
2069
|
+
* Validation error
|
|
2070
|
+
*/
|
|
2071
|
+
422: {
|
|
2072
|
+
/**
|
|
2073
|
+
* Errors overview.
|
|
2074
|
+
*/
|
|
2075
|
+
message: string;
|
|
2076
|
+
/**
|
|
2077
|
+
* A detailed description of each field that failed validation.
|
|
2078
|
+
*/
|
|
2079
|
+
errors: {
|
|
2080
|
+
[key: string]: Array<string>;
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
};
|
|
2084
|
+
type SlotsStoreError = SlotsStoreErrors[keyof SlotsStoreErrors];
|
|
2085
|
+
type SlotsStoreResponses = {
|
|
2086
|
+
200: {
|
|
2087
|
+
[key: string]: unknown;
|
|
2088
|
+
};
|
|
2089
|
+
};
|
|
2090
|
+
type SlotsStoreResponse = SlotsStoreResponses[keyof SlotsStoreResponses];
|
|
2091
|
+
type SlotsDestroyData = {
|
|
2092
|
+
body?: never;
|
|
2093
|
+
path: {
|
|
2094
|
+
/**
|
|
2095
|
+
* The space ID
|
|
2096
|
+
*/
|
|
2097
|
+
space: number;
|
|
2098
|
+
/**
|
|
2099
|
+
* The slot ID
|
|
2100
|
+
*/
|
|
2101
|
+
slot: number;
|
|
2102
|
+
};
|
|
2103
|
+
query?: never;
|
|
2104
|
+
url: '/spaces/{space}/slots/{slot}';
|
|
2105
|
+
};
|
|
2106
|
+
type SlotsDestroyErrors = {
|
|
2107
|
+
/**
|
|
2108
|
+
* Unauthenticated
|
|
2109
|
+
*/
|
|
2110
|
+
401: {
|
|
2111
|
+
/**
|
|
2112
|
+
* Error overview.
|
|
2113
|
+
*/
|
|
2114
|
+
message: string;
|
|
2115
|
+
};
|
|
2116
|
+
/**
|
|
2117
|
+
* Authorization error
|
|
2118
|
+
*/
|
|
2119
|
+
403: {
|
|
2120
|
+
/**
|
|
2121
|
+
* Error overview.
|
|
2122
|
+
*/
|
|
2123
|
+
message: string;
|
|
2124
|
+
};
|
|
2125
|
+
/**
|
|
2126
|
+
* Not found
|
|
2127
|
+
*/
|
|
2128
|
+
404: {
|
|
2129
|
+
/**
|
|
2130
|
+
* Error overview.
|
|
2131
|
+
*/
|
|
2132
|
+
message: string;
|
|
2133
|
+
};
|
|
2134
|
+
};
|
|
2135
|
+
type SlotsDestroyError = SlotsDestroyErrors[keyof SlotsDestroyErrors];
|
|
2136
|
+
type SlotsDestroyResponses = {
|
|
2137
|
+
200: {
|
|
2138
|
+
[key: string]: unknown;
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
2141
|
+
type SlotsDestroyResponse = SlotsDestroyResponses[keyof SlotsDestroyResponses];
|
|
2142
|
+
type SpacesIndexData = {
|
|
2143
|
+
body?: never;
|
|
2144
|
+
path?: never;
|
|
2145
|
+
query?: never;
|
|
2146
|
+
url: '/spaces';
|
|
2147
|
+
};
|
|
2148
|
+
type SpacesIndexErrors = {
|
|
2149
|
+
/**
|
|
2150
|
+
* Unauthenticated
|
|
2151
|
+
*/
|
|
2152
|
+
401: {
|
|
2153
|
+
/**
|
|
2154
|
+
* Error overview.
|
|
2155
|
+
*/
|
|
2156
|
+
message: string;
|
|
2157
|
+
};
|
|
2158
|
+
};
|
|
2159
|
+
type SpacesIndexError = SpacesIndexErrors[keyof SpacesIndexErrors];
|
|
2160
|
+
type SpacesIndexResponses = {
|
|
2161
|
+
/**
|
|
2162
|
+
* Array of `SpaceResource`
|
|
2163
|
+
*/
|
|
2164
|
+
200: {
|
|
2165
|
+
data: Array<SpaceResource>;
|
|
2166
|
+
};
|
|
2167
|
+
};
|
|
2168
|
+
type SpacesIndexResponse = SpacesIndexResponses[keyof SpacesIndexResponses];
|
|
2169
|
+
type SpacesStoreData = {
|
|
2170
|
+
body: StoreSpaceRequest;
|
|
2171
|
+
path?: never;
|
|
2172
|
+
query?: never;
|
|
2173
|
+
url: '/spaces';
|
|
2174
|
+
};
|
|
2175
|
+
type SpacesStoreErrors = {
|
|
2176
|
+
/**
|
|
2177
|
+
* Unauthenticated
|
|
2178
|
+
*/
|
|
2179
|
+
401: {
|
|
2180
|
+
/**
|
|
2181
|
+
* Error overview.
|
|
2182
|
+
*/
|
|
2183
|
+
message: string;
|
|
2184
|
+
};
|
|
2185
|
+
/**
|
|
2186
|
+
* Authorization error
|
|
2187
|
+
*/
|
|
2188
|
+
403: {
|
|
2189
|
+
/**
|
|
2190
|
+
* Error overview.
|
|
2191
|
+
*/
|
|
2192
|
+
message: string;
|
|
2193
|
+
};
|
|
2194
|
+
/**
|
|
2195
|
+
* Validation error
|
|
2196
|
+
*/
|
|
2197
|
+
422: {
|
|
2198
|
+
/**
|
|
2199
|
+
* Errors overview.
|
|
2200
|
+
*/
|
|
2201
|
+
message: string;
|
|
2202
|
+
/**
|
|
2203
|
+
* A detailed description of each field that failed validation.
|
|
2204
|
+
*/
|
|
2205
|
+
errors: {
|
|
2206
|
+
[key: string]: Array<string>;
|
|
2207
|
+
};
|
|
2208
|
+
};
|
|
2209
|
+
};
|
|
2210
|
+
type SpacesStoreError = SpacesStoreErrors[keyof SpacesStoreErrors];
|
|
2211
|
+
type SpacesStoreResponses = {
|
|
2212
|
+
200: {
|
|
2213
|
+
[key: string]: unknown;
|
|
2214
|
+
};
|
|
2215
|
+
};
|
|
2216
|
+
type SpacesStoreResponse = SpacesStoreResponses[keyof SpacesStoreResponses];
|
|
2217
|
+
type SpacesDestroyData = {
|
|
2218
|
+
body?: never;
|
|
2219
|
+
path: {
|
|
2220
|
+
/**
|
|
2221
|
+
* The space ID
|
|
2222
|
+
*/
|
|
2223
|
+
space: number;
|
|
2224
|
+
};
|
|
2225
|
+
query?: never;
|
|
2226
|
+
url: '/spaces/{space}';
|
|
2227
|
+
};
|
|
2228
|
+
type SpacesDestroyErrors = {
|
|
2229
|
+
/**
|
|
2230
|
+
* Unauthenticated
|
|
2231
|
+
*/
|
|
2232
|
+
401: {
|
|
2233
|
+
/**
|
|
2234
|
+
* Error overview.
|
|
2235
|
+
*/
|
|
2236
|
+
message: string;
|
|
2237
|
+
};
|
|
2238
|
+
/**
|
|
2239
|
+
* Authorization error
|
|
2240
|
+
*/
|
|
2241
|
+
403: {
|
|
2242
|
+
/**
|
|
2243
|
+
* Error overview.
|
|
2244
|
+
*/
|
|
2245
|
+
message: string;
|
|
2246
|
+
};
|
|
2247
|
+
/**
|
|
2248
|
+
* Not found
|
|
2249
|
+
*/
|
|
2250
|
+
404: {
|
|
2251
|
+
/**
|
|
2252
|
+
* Error overview.
|
|
2253
|
+
*/
|
|
2254
|
+
message: string;
|
|
2255
|
+
};
|
|
2256
|
+
};
|
|
2257
|
+
type SpacesDestroyError = SpacesDestroyErrors[keyof SpacesDestroyErrors];
|
|
2258
|
+
type SpacesDestroyResponses = {
|
|
2259
|
+
200: {
|
|
2260
|
+
[key: string]: unknown;
|
|
2261
|
+
};
|
|
2262
|
+
};
|
|
2263
|
+
type SpacesDestroyResponse = SpacesDestroyResponses[keyof SpacesDestroyResponses];
|
|
2264
|
+
type SpacesShowData = {
|
|
2265
|
+
body?: never;
|
|
2266
|
+
path: {
|
|
2267
|
+
/**
|
|
2268
|
+
* The space ID
|
|
2269
|
+
*/
|
|
2270
|
+
space: number;
|
|
2271
|
+
};
|
|
2272
|
+
query?: never;
|
|
2273
|
+
url: '/spaces/{space}';
|
|
2274
|
+
};
|
|
2275
|
+
type SpacesShowErrors = {
|
|
2276
|
+
/**
|
|
2277
|
+
* Unauthenticated
|
|
2278
|
+
*/
|
|
2279
|
+
401: {
|
|
2280
|
+
/**
|
|
2281
|
+
* Error overview.
|
|
2282
|
+
*/
|
|
2283
|
+
message: string;
|
|
2284
|
+
};
|
|
2285
|
+
/**
|
|
2286
|
+
* Authorization error
|
|
2287
|
+
*/
|
|
2288
|
+
403: {
|
|
2289
|
+
/**
|
|
2290
|
+
* Error overview.
|
|
2291
|
+
*/
|
|
2292
|
+
message: string;
|
|
2293
|
+
};
|
|
2294
|
+
/**
|
|
2295
|
+
* Not found
|
|
2296
|
+
*/
|
|
2297
|
+
404: {
|
|
2298
|
+
/**
|
|
2299
|
+
* Error overview.
|
|
2300
|
+
*/
|
|
2301
|
+
message: string;
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
type SpacesShowError = SpacesShowErrors[keyof SpacesShowErrors];
|
|
2305
|
+
type SpacesShowResponses = {
|
|
2306
|
+
/**
|
|
2307
|
+
* `SpaceResource`
|
|
2308
|
+
*/
|
|
2309
|
+
200: {
|
|
2310
|
+
data: SpaceResource;
|
|
2311
|
+
};
|
|
2312
|
+
};
|
|
2313
|
+
type SpacesShowResponse = SpacesShowResponses[keyof SpacesShowResponses];
|
|
2314
|
+
type SpacesUpdateData = {
|
|
2315
|
+
body?: UpdateSpaceRequest;
|
|
2316
|
+
path: {
|
|
2317
|
+
/**
|
|
2318
|
+
* The space ID
|
|
2319
|
+
*/
|
|
2320
|
+
space: number;
|
|
2321
|
+
};
|
|
2322
|
+
query?: never;
|
|
2323
|
+
url: '/spaces/{space}';
|
|
2324
|
+
};
|
|
2325
|
+
type SpacesUpdateErrors = {
|
|
2326
|
+
/**
|
|
2327
|
+
* Unauthenticated
|
|
2328
|
+
*/
|
|
2329
|
+
401: {
|
|
2330
|
+
/**
|
|
2331
|
+
* Error overview.
|
|
2332
|
+
*/
|
|
2333
|
+
message: string;
|
|
2334
|
+
};
|
|
2335
|
+
/**
|
|
2336
|
+
* Authorization error
|
|
2337
|
+
*/
|
|
2338
|
+
403: {
|
|
2339
|
+
/**
|
|
2340
|
+
* Error overview.
|
|
2341
|
+
*/
|
|
2342
|
+
message: string;
|
|
2343
|
+
};
|
|
2344
|
+
/**
|
|
2345
|
+
* Not found
|
|
2346
|
+
*/
|
|
2347
|
+
404: {
|
|
2348
|
+
/**
|
|
2349
|
+
* Error overview.
|
|
2350
|
+
*/
|
|
2351
|
+
message: string;
|
|
2352
|
+
};
|
|
2353
|
+
/**
|
|
2354
|
+
* Validation error
|
|
2355
|
+
*/
|
|
2356
|
+
422: {
|
|
2357
|
+
/**
|
|
2358
|
+
* Errors overview.
|
|
2359
|
+
*/
|
|
2360
|
+
message: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* A detailed description of each field that failed validation.
|
|
2363
|
+
*/
|
|
2364
|
+
errors: {
|
|
2365
|
+
[key: string]: Array<string>;
|
|
2366
|
+
};
|
|
2367
|
+
};
|
|
2368
|
+
};
|
|
2369
|
+
type SpacesUpdateError = SpacesUpdateErrors[keyof SpacesUpdateErrors];
|
|
2370
|
+
type SpacesUpdateResponses = {
|
|
2371
|
+
/**
|
|
2372
|
+
* `SpaceResource`
|
|
2373
|
+
*/
|
|
2374
|
+
200: {
|
|
2375
|
+
data: SpaceResource;
|
|
2376
|
+
} | {
|
|
2377
|
+
[key: string]: unknown;
|
|
2378
|
+
};
|
|
2379
|
+
};
|
|
2380
|
+
type SpacesUpdateResponse = SpacesUpdateResponses[keyof SpacesUpdateResponses];
|
|
2381
|
+
type SubscriptionShowData = {
|
|
2382
|
+
body?: never;
|
|
2383
|
+
path?: never;
|
|
2384
|
+
query?: never;
|
|
2385
|
+
url: '/subscription';
|
|
2386
|
+
};
|
|
2387
|
+
type SubscriptionShowErrors = {
|
|
2388
|
+
/**
|
|
2389
|
+
* Unauthenticated
|
|
2390
|
+
*/
|
|
2391
|
+
401: {
|
|
2392
|
+
/**
|
|
2393
|
+
* Error overview.
|
|
2394
|
+
*/
|
|
2395
|
+
message: string;
|
|
2396
|
+
};
|
|
2397
|
+
};
|
|
2398
|
+
type SubscriptionShowError = SubscriptionShowErrors[keyof SubscriptionShowErrors];
|
|
2399
|
+
type SubscriptionShowResponses = {
|
|
2400
|
+
200: {
|
|
2401
|
+
plan: string;
|
|
2402
|
+
is_gifted: boolean;
|
|
2403
|
+
limits: {
|
|
2404
|
+
max_spaces: 2 | 10 | 50;
|
|
2405
|
+
max_posts_per_month: 20 | 200;
|
|
2406
|
+
has_analytics: boolean;
|
|
2407
|
+
remaining_spaces: number | null;
|
|
2408
|
+
remaining_posts: number | null;
|
|
2409
|
+
posts_this_month: number;
|
|
2410
|
+
};
|
|
2411
|
+
trial: {
|
|
2412
|
+
on_trial: string | boolean;
|
|
2413
|
+
ends_at: string;
|
|
2414
|
+
};
|
|
2415
|
+
cancelled: string | boolean;
|
|
2416
|
+
ends_at: string;
|
|
2417
|
+
};
|
|
2418
|
+
};
|
|
2419
|
+
type SubscriptionShowResponse = SubscriptionShowResponses[keyof SubscriptionShowResponses];
|
|
2420
|
+
type WebhooksIndexData = {
|
|
2421
|
+
body?: never;
|
|
2422
|
+
path: {
|
|
2423
|
+
/**
|
|
2424
|
+
* The space ID
|
|
2425
|
+
*/
|
|
2426
|
+
space: number;
|
|
2427
|
+
};
|
|
2428
|
+
query?: never;
|
|
2429
|
+
url: '/spaces/{space}/webhooks';
|
|
2430
|
+
};
|
|
2431
|
+
type WebhooksIndexErrors = {
|
|
2432
|
+
/**
|
|
2433
|
+
* Unauthenticated
|
|
2434
|
+
*/
|
|
2435
|
+
401: {
|
|
2436
|
+
/**
|
|
2437
|
+
* Error overview.
|
|
2438
|
+
*/
|
|
2439
|
+
message: string;
|
|
2440
|
+
};
|
|
2441
|
+
/**
|
|
2442
|
+
* Authorization error
|
|
2443
|
+
*/
|
|
2444
|
+
403: {
|
|
2445
|
+
/**
|
|
2446
|
+
* Error overview.
|
|
2447
|
+
*/
|
|
2448
|
+
message: string;
|
|
2449
|
+
};
|
|
2450
|
+
/**
|
|
2451
|
+
* Not found
|
|
2452
|
+
*/
|
|
2453
|
+
404: {
|
|
2454
|
+
/**
|
|
2455
|
+
* Error overview.
|
|
2456
|
+
*/
|
|
2457
|
+
message: string;
|
|
2458
|
+
};
|
|
2459
|
+
};
|
|
2460
|
+
type WebhooksIndexError = WebhooksIndexErrors[keyof WebhooksIndexErrors];
|
|
2461
|
+
type WebhooksIndexResponses = {
|
|
2462
|
+
/**
|
|
2463
|
+
* Array of `WebhookResource`
|
|
2464
|
+
*/
|
|
2465
|
+
200: {
|
|
2466
|
+
data: Array<WebhookResource>;
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
type WebhooksIndexResponse = WebhooksIndexResponses[keyof WebhooksIndexResponses];
|
|
2470
|
+
type WebhooksStoreData = {
|
|
2471
|
+
body: StoreWebhookRequest;
|
|
2472
|
+
path: {
|
|
2473
|
+
/**
|
|
2474
|
+
* The space ID
|
|
2475
|
+
*/
|
|
2476
|
+
space: number;
|
|
2477
|
+
};
|
|
2478
|
+
query?: never;
|
|
2479
|
+
url: '/spaces/{space}/webhooks';
|
|
2480
|
+
};
|
|
2481
|
+
type WebhooksStoreErrors = {
|
|
2482
|
+
/**
|
|
2483
|
+
* Unauthenticated
|
|
2484
|
+
*/
|
|
2485
|
+
401: {
|
|
2486
|
+
/**
|
|
2487
|
+
* Error overview.
|
|
2488
|
+
*/
|
|
2489
|
+
message: string;
|
|
2490
|
+
};
|
|
2491
|
+
/**
|
|
2492
|
+
* Authorization error
|
|
2493
|
+
*/
|
|
2494
|
+
403: {
|
|
2495
|
+
/**
|
|
2496
|
+
* Error overview.
|
|
2497
|
+
*/
|
|
2498
|
+
message: string;
|
|
2499
|
+
};
|
|
2500
|
+
/**
|
|
2501
|
+
* Not found
|
|
2502
|
+
*/
|
|
2503
|
+
404: {
|
|
2504
|
+
/**
|
|
2505
|
+
* Error overview.
|
|
2506
|
+
*/
|
|
2507
|
+
message: string;
|
|
2508
|
+
};
|
|
2509
|
+
/**
|
|
2510
|
+
* Validation error
|
|
2511
|
+
*/
|
|
2512
|
+
422: {
|
|
2513
|
+
/**
|
|
2514
|
+
* Errors overview.
|
|
2515
|
+
*/
|
|
2516
|
+
message: string;
|
|
2517
|
+
/**
|
|
2518
|
+
* A detailed description of each field that failed validation.
|
|
2519
|
+
*/
|
|
2520
|
+
errors: {
|
|
2521
|
+
[key: string]: Array<string>;
|
|
2522
|
+
};
|
|
2523
|
+
};
|
|
2524
|
+
};
|
|
2525
|
+
type WebhooksStoreError = WebhooksStoreErrors[keyof WebhooksStoreErrors];
|
|
2526
|
+
type WebhooksStoreResponses = {
|
|
2527
|
+
200: {
|
|
2528
|
+
[key: string]: unknown;
|
|
2529
|
+
};
|
|
2530
|
+
};
|
|
2531
|
+
type WebhooksStoreResponse = WebhooksStoreResponses[keyof WebhooksStoreResponses];
|
|
2532
|
+
type WebhooksDestroyData = {
|
|
2533
|
+
body?: never;
|
|
2534
|
+
path: {
|
|
2535
|
+
/**
|
|
2536
|
+
* The space ID
|
|
2537
|
+
*/
|
|
2538
|
+
space: number;
|
|
2539
|
+
/**
|
|
2540
|
+
* The webhook ID
|
|
2541
|
+
*/
|
|
2542
|
+
webhook: number;
|
|
2543
|
+
};
|
|
2544
|
+
query?: never;
|
|
2545
|
+
url: '/spaces/{space}/webhooks/{webhook}';
|
|
2546
|
+
};
|
|
2547
|
+
type WebhooksDestroyErrors = {
|
|
2548
|
+
/**
|
|
2549
|
+
* Unauthenticated
|
|
2550
|
+
*/
|
|
2551
|
+
401: {
|
|
2552
|
+
/**
|
|
2553
|
+
* Error overview.
|
|
2554
|
+
*/
|
|
2555
|
+
message: string;
|
|
2556
|
+
};
|
|
2557
|
+
/**
|
|
2558
|
+
* Authorization error
|
|
2559
|
+
*/
|
|
2560
|
+
403: {
|
|
2561
|
+
/**
|
|
2562
|
+
* Error overview.
|
|
2563
|
+
*/
|
|
2564
|
+
message: string;
|
|
2565
|
+
};
|
|
2566
|
+
/**
|
|
2567
|
+
* Not found
|
|
2568
|
+
*/
|
|
2569
|
+
404: {
|
|
2570
|
+
/**
|
|
2571
|
+
* Error overview.
|
|
2572
|
+
*/
|
|
2573
|
+
message: string;
|
|
2574
|
+
};
|
|
2575
|
+
};
|
|
2576
|
+
type WebhooksDestroyError = WebhooksDestroyErrors[keyof WebhooksDestroyErrors];
|
|
2577
|
+
type WebhooksDestroyResponses = {
|
|
2578
|
+
200: {
|
|
2579
|
+
[key: string]: unknown;
|
|
2580
|
+
};
|
|
2581
|
+
};
|
|
2582
|
+
type WebhooksDestroyResponse = WebhooksDestroyResponses[keyof WebhooksDestroyResponses];
|
|
2583
|
+
type WebhooksUpdateData = {
|
|
2584
|
+
body?: UpdateWebhookRequest;
|
|
2585
|
+
path: {
|
|
2586
|
+
/**
|
|
2587
|
+
* The space ID
|
|
2588
|
+
*/
|
|
2589
|
+
space: number;
|
|
2590
|
+
/**
|
|
2591
|
+
* The webhook ID
|
|
2592
|
+
*/
|
|
2593
|
+
webhook: number;
|
|
2594
|
+
};
|
|
2595
|
+
query?: never;
|
|
2596
|
+
url: '/spaces/{space}/webhooks/{webhook}';
|
|
2597
|
+
};
|
|
2598
|
+
type WebhooksUpdateErrors = {
|
|
2599
|
+
/**
|
|
2600
|
+
* Unauthenticated
|
|
2601
|
+
*/
|
|
2602
|
+
401: {
|
|
2603
|
+
/**
|
|
2604
|
+
* Error overview.
|
|
2605
|
+
*/
|
|
2606
|
+
message: string;
|
|
2607
|
+
};
|
|
2608
|
+
/**
|
|
2609
|
+
* Authorization error
|
|
2610
|
+
*/
|
|
2611
|
+
403: {
|
|
2612
|
+
/**
|
|
2613
|
+
* Error overview.
|
|
2614
|
+
*/
|
|
2615
|
+
message: string;
|
|
2616
|
+
};
|
|
2617
|
+
/**
|
|
2618
|
+
* Not found
|
|
2619
|
+
*/
|
|
2620
|
+
404: {
|
|
2621
|
+
/**
|
|
2622
|
+
* Error overview.
|
|
2623
|
+
*/
|
|
2624
|
+
message: string;
|
|
2625
|
+
};
|
|
2626
|
+
/**
|
|
2627
|
+
* Validation error
|
|
2628
|
+
*/
|
|
2629
|
+
422: {
|
|
2630
|
+
/**
|
|
2631
|
+
* Errors overview.
|
|
2632
|
+
*/
|
|
2633
|
+
message: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* A detailed description of each field that failed validation.
|
|
2636
|
+
*/
|
|
2637
|
+
errors: {
|
|
2638
|
+
[key: string]: Array<string>;
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
type WebhooksUpdateError = WebhooksUpdateErrors[keyof WebhooksUpdateErrors];
|
|
2643
|
+
type WebhooksUpdateResponses = {
|
|
2644
|
+
/**
|
|
2645
|
+
* `WebhookResource`
|
|
2646
|
+
*/
|
|
2647
|
+
200: {
|
|
2648
|
+
data: WebhookResource;
|
|
2649
|
+
} | {
|
|
2650
|
+
[key: string]: unknown;
|
|
2651
|
+
};
|
|
2652
|
+
};
|
|
2653
|
+
type WebhooksUpdateResponse = WebhooksUpdateResponses[keyof WebhooksUpdateResponses];
|
|
2654
|
+
|
|
2655
|
+
declare const client: Client;
|
|
2656
|
+
|
|
2657
|
+
interface CreateClientOptions {
|
|
2658
|
+
/**
|
|
2659
|
+
* Base URL of the Zilfu API, e.g. `https://zilfu.com/api`.
|
|
2660
|
+
*/
|
|
2661
|
+
baseUrl: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* Sanctum personal access token. May be a string or a (possibly async)
|
|
2664
|
+
* function that returns one — useful for refreshing tokens or reading
|
|
2665
|
+
* from a secret manager.
|
|
2666
|
+
*/
|
|
2667
|
+
token: AuthToken | ((auth: Auth) => Promise<AuthToken> | AuthToken);
|
|
2668
|
+
/**
|
|
2669
|
+
* Custom `fetch` implementation. Defaults to `globalThis.fetch`.
|
|
2670
|
+
* Pass a bound fetch in edge runtimes if needed.
|
|
2671
|
+
*/
|
|
2672
|
+
fetch?: typeof fetch;
|
|
2673
|
+
}
|
|
2674
|
+
/**
|
|
2675
|
+
* Configures the shared SDK client. Call once before invoking any
|
|
2676
|
+
* generated SDK method.
|
|
2677
|
+
*/
|
|
2678
|
+
declare function createZilfuClient(options: CreateClientOptions): void;
|
|
2679
|
+
|
|
2680
|
+
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
|
|
2681
|
+
/**
|
|
2682
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
2683
|
+
* individual options. This might be also useful if you want to implement a
|
|
2684
|
+
* custom client.
|
|
2685
|
+
*/
|
|
2686
|
+
client?: Client;
|
|
2687
|
+
/**
|
|
2688
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
2689
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
2690
|
+
*/
|
|
2691
|
+
meta?: Record<string, unknown>;
|
|
2692
|
+
};
|
|
2693
|
+
/**
|
|
2694
|
+
* Disconnect multiple accounts
|
|
2695
|
+
* Removes several social account connections in a single request and dispatches a webhook event for each.
|
|
2696
|
+
*/
|
|
2697
|
+
declare const accountsDestroyMany: <ThrowOnError extends boolean = false>(options: Options<AccountsDestroyManyData, ThrowOnError>) => RequestResult<AccountsDestroyManyResponses, AccountsDestroyManyErrors, ThrowOnError, "fields">;
|
|
2698
|
+
/**
|
|
2699
|
+
* List accounts
|
|
2700
|
+
* Returns all connected social accounts for the given space.
|
|
2701
|
+
*/
|
|
2702
|
+
declare const accountsIndex: <ThrowOnError extends boolean = false>(options: Options<AccountsIndexData, ThrowOnError>) => RequestResult<AccountsIndexResponses, AccountsIndexErrors, ThrowOnError, "fields">;
|
|
2703
|
+
/**
|
|
2704
|
+
* Activate an account
|
|
2705
|
+
* Activates the given account and deactivates all other accounts on the same platform within the space.
|
|
2706
|
+
*/
|
|
2707
|
+
declare const accountsActivate: <ThrowOnError extends boolean = false>(options: Options<AccountsActivateData, ThrowOnError>) => RequestResult<AccountsActivateResponses, AccountsActivateErrors, ThrowOnError, "fields">;
|
|
2708
|
+
/**
|
|
2709
|
+
* List Pinterest boards
|
|
2710
|
+
* Returns the Pinterest boards available for the given account.
|
|
2711
|
+
*/
|
|
2712
|
+
declare const accountsBoards: <ThrowOnError extends boolean = false>(options: Options<AccountsBoardsData, ThrowOnError>) => RequestResult<AccountsBoardsResponses, AccountsBoardsErrors, ThrowOnError, "fields">;
|
|
2713
|
+
/**
|
|
2714
|
+
* Disconnect an account
|
|
2715
|
+
* Removes the social account connection and dispatches a webhook event.
|
|
2716
|
+
*/
|
|
2717
|
+
declare const accountsDestroy: <ThrowOnError extends boolean = false>(options: Options<AccountsDestroyData, ThrowOnError>) => RequestResult<AccountsDestroyResponses, AccountsDestroyErrors, ThrowOnError, "fields">;
|
|
2718
|
+
/**
|
|
2719
|
+
* Create an API token
|
|
2720
|
+
* Generates a new personal access token for the authenticated user.
|
|
2721
|
+
*/
|
|
2722
|
+
declare const apiTokensStore: <ThrowOnError extends boolean = false>(options: Options<ApiTokensStoreData, ThrowOnError>) => RequestResult<ApiTokensStoreResponses, ApiTokensStoreErrors, ThrowOnError, "fields">;
|
|
2723
|
+
/**
|
|
2724
|
+
* Revoke an API token
|
|
2725
|
+
* Deletes the specified personal access token.
|
|
2726
|
+
*/
|
|
2727
|
+
declare const apiTokensDestroy: <ThrowOnError extends boolean = false>(options: Options<ApiTokensDestroyData, ThrowOnError>) => RequestResult<ApiTokensDestroyResponses, ApiTokensDestroyErrors, ThrowOnError, "fields">;
|
|
2728
|
+
declare const bioBlocksIndex: <ThrowOnError extends boolean = false>(options: Options<BioBlocksIndexData, ThrowOnError>) => RequestResult<BioBlocksIndexResponses, BioBlocksIndexErrors, ThrowOnError, "fields">;
|
|
2729
|
+
declare const bioBlocksStore: <ThrowOnError extends boolean = false>(options: Options<BioBlocksStoreData, ThrowOnError>) => RequestResult<BioBlocksStoreResponses, BioBlocksStoreErrors, ThrowOnError, "fields">;
|
|
2730
|
+
declare const bioBlocksDestroy: <ThrowOnError extends boolean = false>(options: Options<BioBlocksDestroyData, ThrowOnError>) => RequestResult<BioBlocksDestroyResponses, BioBlocksDestroyErrors, ThrowOnError, "fields">;
|
|
2731
|
+
declare const bioBlocksUpdate: <ThrowOnError extends boolean = false>(options: Options<BioBlocksUpdateData, ThrowOnError>) => RequestResult<BioBlocksUpdateResponses, BioBlocksUpdateErrors, ThrowOnError, "fields">;
|
|
2732
|
+
declare const bioBlocksReorder: <ThrowOnError extends boolean = false>(options: Options<BioBlocksReorderData, ThrowOnError>) => RequestResult<BioBlocksReorderResponses, BioBlocksReorderErrors, ThrowOnError, "fields">;
|
|
2733
|
+
declare const bioShow: <ThrowOnError extends boolean = false>(options: Options<BioShowData, ThrowOnError>) => RequestResult<BioShowResponses, BioShowErrors, ThrowOnError, "fields">;
|
|
2734
|
+
declare const bioStore: <ThrowOnError extends boolean = false>(options: Options<BioStoreData, ThrowOnError>) => RequestResult<BioStoreResponses, BioStoreErrors, ThrowOnError, "fields">;
|
|
2735
|
+
declare const bioUpdate: <ThrowOnError extends boolean = false>(options: Options<BioUpdateData, ThrowOnError>) => RequestResult<BioUpdateResponses, BioUpdateErrors, ThrowOnError, "fields">;
|
|
2736
|
+
declare const bioAvatar: <ThrowOnError extends boolean = false>(options: Options<BioAvatarData, ThrowOnError>) => RequestResult<BioAvatarResponses, BioAvatarErrors, ThrowOnError, "fields">;
|
|
2737
|
+
/**
|
|
2738
|
+
* Upload a media file
|
|
2739
|
+
* Accepts images (JPEG, PNG, WebP) and videos (MP4, QuickTime). Images are auto-optimized.
|
|
2740
|
+
*/
|
|
2741
|
+
declare const mediaStore: <ThrowOnError extends boolean = false>(options: Options<MediaStoreData, ThrowOnError>) => RequestResult<MediaStoreResponses, MediaStoreErrors, ThrowOnError, "fields">;
|
|
2742
|
+
/**
|
|
2743
|
+
* Delete a media file
|
|
2744
|
+
* Removes the media file from storage and deletes the record.
|
|
2745
|
+
*/
|
|
2746
|
+
declare const mediaDestroy: <ThrowOnError extends boolean = false>(options: Options<MediaDestroyData, ThrowOnError>) => RequestResult<MediaDestroyResponses, MediaDestroyErrors, ThrowOnError, "fields">;
|
|
2747
|
+
/**
|
|
2748
|
+
* List posts
|
|
2749
|
+
* Returns paginated posts for the space. Filterable by status, account, and date range via query parameters.
|
|
2750
|
+
*/
|
|
2751
|
+
declare const postsIndex: <ThrowOnError extends boolean = false>(options: Options<PostsIndexData, ThrowOnError>) => RequestResult<PostsIndexResponses, PostsIndexErrors, ThrowOnError, "fields">;
|
|
2752
|
+
/**
|
|
2753
|
+
* Create posts
|
|
2754
|
+
* Creates one or more posts as a cluster. Supports draft, scheduled, or immediate publishing modes.
|
|
2755
|
+
*/
|
|
2756
|
+
declare const postsStore: <ThrowOnError extends boolean = false>(options: Options<PostsStoreData, ThrowOnError>) => RequestResult<PostsStoreResponses, PostsStoreErrors, ThrowOnError, "fields">;
|
|
2757
|
+
/**
|
|
2758
|
+
* Delete a post
|
|
2759
|
+
* Permanently deletes the given post.
|
|
2760
|
+
*/
|
|
2761
|
+
declare const postsDestroy: <ThrowOnError extends boolean = false>(options: Options<PostsDestroyData, ThrowOnError>) => RequestResult<PostsDestroyResponses, PostsDestroyErrors, ThrowOnError, "fields">;
|
|
2762
|
+
/**
|
|
2763
|
+
* Get a post
|
|
2764
|
+
* Returns a single post with its account, children, and media.
|
|
2765
|
+
*/
|
|
2766
|
+
declare const postsShow: <ThrowOnError extends boolean = false>(options: Options<PostsShowData, ThrowOnError>) => RequestResult<PostsShowResponses, PostsShowErrors, ThrowOnError, "fields">;
|
|
2767
|
+
/**
|
|
2768
|
+
* Update a post
|
|
2769
|
+
* Updates a single post's content, schedule, and media attachments.
|
|
2770
|
+
*/
|
|
2771
|
+
declare const postsUpdate: <ThrowOnError extends boolean = false>(options: Options<PostsUpdateData, ThrowOnError>) => RequestResult<PostsUpdateResponses, PostsUpdateErrors, ThrowOnError, "fields">;
|
|
2772
|
+
/**
|
|
2773
|
+
* Update a cluster of posts
|
|
2774
|
+
* Updates all posts sharing the given cluster ID. Handles adding/removing accounts and re-scheduling.
|
|
2775
|
+
*/
|
|
2776
|
+
declare const clustersUpdate: <ThrowOnError extends boolean = false>(options: Options<ClustersUpdateData, ThrowOnError>) => RequestResult<ClustersUpdateResponses, ClustersUpdateErrors, ThrowOnError, "fields">;
|
|
2777
|
+
/**
|
|
2778
|
+
* Get next available queue slots
|
|
2779
|
+
* Returns up to 9 upcoming available time slots based on the space's scheduling configuration.
|
|
2780
|
+
*/
|
|
2781
|
+
declare const queueIndex: <ThrowOnError extends boolean = false>(options: Options<QueueIndexData, ThrowOnError>) => RequestResult<QueueIndexResponses, QueueIndexErrors, ThrowOnError, "fields">;
|
|
2782
|
+
/**
|
|
2783
|
+
* List slots
|
|
2784
|
+
* Returns all scheduling slots for the space, ordered by day and time.
|
|
2785
|
+
*/
|
|
2786
|
+
declare const slotsIndex: <ThrowOnError extends boolean = false>(options: Options<SlotsIndexData, ThrowOnError>) => RequestResult<SlotsIndexResponses, SlotsIndexErrors, ThrowOnError, "fields">;
|
|
2787
|
+
/**
|
|
2788
|
+
* Create slots
|
|
2789
|
+
* Creates scheduling slots for the given days of the week and time.
|
|
2790
|
+
*/
|
|
2791
|
+
declare const slotsStore: <ThrowOnError extends boolean = false>(options: Options<SlotsStoreData, ThrowOnError>) => RequestResult<SlotsStoreResponses, SlotsStoreErrors, ThrowOnError, "fields">;
|
|
2792
|
+
/**
|
|
2793
|
+
* Delete a slot
|
|
2794
|
+
* Removes a scheduling slot from the space.
|
|
2795
|
+
*/
|
|
2796
|
+
declare const slotsDestroy: <ThrowOnError extends boolean = false>(options: Options<SlotsDestroyData, ThrowOnError>) => RequestResult<SlotsDestroyResponses, SlotsDestroyErrors, ThrowOnError, "fields">;
|
|
2797
|
+
/**
|
|
2798
|
+
* List spaces
|
|
2799
|
+
* Returns all spaces belonging to the authenticated user, ordered by most recent.
|
|
2800
|
+
*/
|
|
2801
|
+
declare const spacesIndex: <ThrowOnError extends boolean = false>(options?: Options<SpacesIndexData, ThrowOnError>) => RequestResult<SpacesIndexResponses, SpacesIndexErrors, ThrowOnError, "fields">;
|
|
2802
|
+
/**
|
|
2803
|
+
* Create a space
|
|
2804
|
+
* Creates a new space for the authenticated user.
|
|
2805
|
+
*/
|
|
2806
|
+
declare const spacesStore: <ThrowOnError extends boolean = false>(options: Options<SpacesStoreData, ThrowOnError>) => RequestResult<SpacesStoreResponses, SpacesStoreErrors, ThrowOnError, "fields">;
|
|
2807
|
+
/**
|
|
2808
|
+
* Delete a space
|
|
2809
|
+
* Permanently deletes the given space and all associated data.
|
|
2810
|
+
*/
|
|
2811
|
+
declare const spacesDestroy: <ThrowOnError extends boolean = false>(options: Options<SpacesDestroyData, ThrowOnError>) => RequestResult<SpacesDestroyResponses, SpacesDestroyErrors, ThrowOnError, "fields">;
|
|
2812
|
+
/**
|
|
2813
|
+
* Get a space
|
|
2814
|
+
* Returns a single space by ID.
|
|
2815
|
+
*/
|
|
2816
|
+
declare const spacesShow: <ThrowOnError extends boolean = false>(options: Options<SpacesShowData, ThrowOnError>) => RequestResult<SpacesShowResponses, SpacesShowErrors, ThrowOnError, "fields">;
|
|
2817
|
+
/**
|
|
2818
|
+
* Update a space
|
|
2819
|
+
* Updates the given space's settings.
|
|
2820
|
+
*/
|
|
2821
|
+
declare const spacesUpdate: <ThrowOnError extends boolean = false>(options: Options<SpacesUpdateData, ThrowOnError>) => RequestResult<SpacesUpdateResponses, SpacesUpdateErrors, ThrowOnError, "fields">;
|
|
2822
|
+
/**
|
|
2823
|
+
* Get subscription details
|
|
2824
|
+
* Returns the current plan, usage limits, trial status, and cancellation state.
|
|
2825
|
+
*/
|
|
2826
|
+
declare const subscriptionShow: <ThrowOnError extends boolean = false>(options?: Options<SubscriptionShowData, ThrowOnError>) => RequestResult<SubscriptionShowResponses, SubscriptionShowErrors, ThrowOnError, "fields">;
|
|
2827
|
+
/**
|
|
2828
|
+
* List webhooks
|
|
2829
|
+
* Returns all webhooks configured for the given space.
|
|
2830
|
+
*/
|
|
2831
|
+
declare const webhooksIndex: <ThrowOnError extends boolean = false>(options: Options<WebhooksIndexData, ThrowOnError>) => RequestResult<WebhooksIndexResponses, WebhooksIndexErrors, ThrowOnError, "fields">;
|
|
2832
|
+
/**
|
|
2833
|
+
* Create a webhook
|
|
2834
|
+
* Registers a new webhook endpoint with an auto-generated signing secret.
|
|
2835
|
+
*/
|
|
2836
|
+
declare const webhooksStore: <ThrowOnError extends boolean = false>(options: Options<WebhooksStoreData, ThrowOnError>) => RequestResult<WebhooksStoreResponses, WebhooksStoreErrors, ThrowOnError, "fields">;
|
|
2837
|
+
/**
|
|
2838
|
+
* Delete a webhook
|
|
2839
|
+
* Permanently removes the webhook endpoint.
|
|
2840
|
+
*/
|
|
2841
|
+
declare const webhooksDestroy: <ThrowOnError extends boolean = false>(options: Options<WebhooksDestroyData, ThrowOnError>) => RequestResult<WebhooksDestroyResponses, WebhooksDestroyErrors, ThrowOnError, "fields">;
|
|
2842
|
+
/**
|
|
2843
|
+
* Update a webhook
|
|
2844
|
+
* Updates the webhook's URL, events, or active status.
|
|
2845
|
+
*/
|
|
2846
|
+
declare const webhooksUpdate: <ThrowOnError extends boolean = false>(options: Options<WebhooksUpdateData, ThrowOnError>) => RequestResult<WebhooksUpdateResponses, WebhooksUpdateErrors, ThrowOnError, "fields">;
|
|
2847
|
+
|
|
2848
|
+
export { type AccountResource, type AccountsActivateData, type AccountsActivateError, type AccountsActivateErrors, type AccountsActivateResponse, type AccountsActivateResponses, type AccountsBoardsData, type AccountsBoardsError, type AccountsBoardsErrors, type AccountsBoardsResponse, type AccountsBoardsResponses, type AccountsDestroyData, type AccountsDestroyError, type AccountsDestroyErrors, type AccountsDestroyManyData, type AccountsDestroyManyError, type AccountsDestroyManyErrors, type AccountsDestroyManyResponse, type AccountsDestroyManyResponses, type AccountsDestroyResponse, type AccountsDestroyResponses, type AccountsIndexData, type AccountsIndexError, type AccountsIndexErrors, type AccountsIndexResponse, type AccountsIndexResponses, type ApiTokensDestroyData, type ApiTokensDestroyError, type ApiTokensDestroyErrors, type ApiTokensDestroyResponses, type ApiTokensStoreData, type ApiTokensStoreError, type ApiTokensStoreErrors, type ApiTokensStoreResponses, type BioAvatarData, type BioAvatarError, type BioAvatarErrors, type BioAvatarResponse, type BioAvatarResponses, type BioBlockResource, type BioBlocksDestroyData, type BioBlocksDestroyError, type BioBlocksDestroyErrors, type BioBlocksDestroyResponse, type BioBlocksDestroyResponses, type BioBlocksIndexData, type BioBlocksIndexError, type BioBlocksIndexErrors, type BioBlocksIndexResponse, type BioBlocksIndexResponses, type BioBlocksReorderData, type BioBlocksReorderError, type BioBlocksReorderErrors, type BioBlocksReorderResponse, type BioBlocksReorderResponses, type BioBlocksStoreData, type BioBlocksStoreError, type BioBlocksStoreErrors, type BioBlocksStoreResponse, type BioBlocksStoreResponses, type BioBlocksUpdateData, type BioBlocksUpdateError, type BioBlocksUpdateErrors, type BioBlocksUpdateResponse, type BioBlocksUpdateResponses, type BioPageResource, type BioShowData, type BioShowError, type BioShowErrors, type BioShowResponse, type BioShowResponses, type BioStoreData, type BioStoreError, type BioStoreErrors, type BioStoreResponse, type BioStoreResponses, type BioUpdateData, type BioUpdateError, type BioUpdateErrors, type BioUpdateResponse, type BioUpdateResponses, type ClientOptions, type ClustersUpdateData, type ClustersUpdateError, type ClustersUpdateErrors, type ClustersUpdateResponse, type ClustersUpdateResponses, type CreateClientOptions, type MediaDestroyData, type MediaDestroyError, type MediaDestroyErrors, type MediaDestroyResponse, type MediaDestroyResponses, type MediaResource, type MediaStoreData, type MediaStoreError, type MediaStoreErrors, type MediaStoreResponse, type MediaStoreResponses, type Options, type PostResource, type PostStatus, type PostsDestroyData, type PostsDestroyError, type PostsDestroyErrors, type PostsDestroyResponse, type PostsDestroyResponses, type PostsIndexData, type PostsIndexError, type PostsIndexErrors, type PostsIndexResponse, type PostsIndexResponses, type PostsShowData, type PostsShowError, type PostsShowErrors, type PostsShowResponse, type PostsShowResponses, type PostsStoreData, type PostsStoreError, type PostsStoreErrors, type PostsStoreResponse, type PostsStoreResponses, type PostsUpdateData, type PostsUpdateError, type PostsUpdateErrors, type PostsUpdateResponse, type PostsUpdateResponses, type QueueIndexData, type QueueIndexError, type QueueIndexErrors, type QueueIndexResponse, type QueueIndexResponses, type SlotResource, type SlotsDestroyData, type SlotsDestroyError, type SlotsDestroyErrors, type SlotsDestroyResponse, type SlotsDestroyResponses, type SlotsIndexData, type SlotsIndexError, type SlotsIndexErrors, type SlotsIndexResponse, type SlotsIndexResponses, type SlotsStoreData, type SlotsStoreError, type SlotsStoreErrors, type SlotsStoreResponse, type SlotsStoreResponses, type SpaceResource, type SpacesDestroyData, type SpacesDestroyError, type SpacesDestroyErrors, type SpacesDestroyResponse, type SpacesDestroyResponses, type SpacesIndexData, type SpacesIndexError, type SpacesIndexErrors, type SpacesIndexResponse, type SpacesIndexResponses, type SpacesShowData, type SpacesShowError, type SpacesShowErrors, type SpacesShowResponse, type SpacesShowResponses, type SpacesStoreData, type SpacesStoreError, type SpacesStoreErrors, type SpacesStoreResponse, type SpacesStoreResponses, type SpacesUpdateData, type SpacesUpdateError, type SpacesUpdateErrors, type SpacesUpdateResponse, type SpacesUpdateResponses, type StoreBioBlockRequest, type StoreBioPageRequest, type StorePostRequest, type StoreSlotRequest, type StoreSpaceRequest, type StoreWebhookRequest, type SubscriptionShowData, type SubscriptionShowError, type SubscriptionShowErrors, type SubscriptionShowResponse, type SubscriptionShowResponses, type UpdateBioBlockRequest, type UpdateBioPageRequest, type UpdateClusterRequest, type UpdatePostRequest, type UpdateSpaceRequest, type UpdateWebhookRequest, type WebhookResource, type WebhooksDestroyData, type WebhooksDestroyError, type WebhooksDestroyErrors, type WebhooksDestroyResponse, type WebhooksDestroyResponses, type WebhooksIndexData, type WebhooksIndexError, type WebhooksIndexErrors, type WebhooksIndexResponse, type WebhooksIndexResponses, type WebhooksStoreData, type WebhooksStoreError, type WebhooksStoreErrors, type WebhooksStoreResponse, type WebhooksStoreResponses, type WebhooksUpdateData, type WebhooksUpdateError, type WebhooksUpdateErrors, type WebhooksUpdateResponse, type WebhooksUpdateResponses, accountsActivate, accountsBoards, accountsDestroy, accountsDestroyMany, accountsIndex, apiTokensDestroy, apiTokensStore, bioAvatar, bioBlocksDestroy, bioBlocksIndex, bioBlocksReorder, bioBlocksStore, bioBlocksUpdate, bioShow, bioStore, bioUpdate, client, clustersUpdate, createZilfuClient, mediaDestroy, mediaStore, postsDestroy, postsIndex, postsShow, postsStore, postsUpdate, queueIndex, slotsDestroy, slotsIndex, slotsStore, spacesDestroy, spacesIndex, spacesShow, spacesStore, spacesUpdate, subscriptionShow, webhooksDestroy, webhooksIndex, webhooksStore, webhooksUpdate };
|