Newer
Older
/* eslint-disable */
/*
* This file was auto-generated by `make update-types` at 2024-01-25 00:54:34.794Z.
* DO NOT make changes to this file.
*/
export interface paths {
'/api/v1/categories/': {
/** List all categories. */
get: operations['categories_list']
/** Create a new category. */
post: operations['categories_create']
}
'/api/v1/categories/{id}/': {
/** Retrieve a single category. */
get: operations['categories_retrieve']
/** Update an existing category. */
put: operations['categories_update']
/** Delete an existing category. */
delete: operations['categories_destroy']
/** Partially update an existing category. */
patch: operations['categories_partial_update']
}
/** List all funding categories. */
get: operations['funding_categories_list']
/** Create a new funding category. */
post: operations['funding_categories_create']
/** Retrieve a single funding category. */
get: operations['funding_categories_retrieve']
/** Update an existing funding category. */
put: operations['funding_categories_update']
/** Delete an existing funding category. */
delete: operations['funding_categories_destroy']
/** Partially update an existing funding category. */
patch: operations['funding_categories_partial_update']
}
'/api/v1/hosts/': {
/** List all hosts. */
get: operations['hosts_list']
/** Create a new host. */
post: operations['hosts_create']
}
'/api/v1/hosts/{id}/': {
/** Retrieve a single host. */
get: operations['hosts_retrieve']
/** Update an existing host. */
put: operations['hosts_update']
/** Delete an existing host. */
delete: operations['hosts_destroy']
/** Partially update an existing host. */
patch: operations['hosts_partial_update']
}
/**
* Create a new image.
* @description Create an Image instance. Any user can create an image.
*/
post: operations['images_create']
}
'/api/v1/images/{id}/': {
/** Retrieve a single image. */
/**
* Update an existing image.
* @description Only `alt_text`, `credits`, and `ppoi` can be updated.
*/
/**
* Delete an existing image.
* @description Destroy an Image instance. Only the owner can delete an image.
*/
/**
* Partially update an existing image.
* @description Only `alt_text`, `credits`, and `ppoi` can be updated.
*/
patch: operations['images_partial_update']
}
'/api/v1/languages/': {
/** List all languages. */
get: operations['languages_list']
/** Create a new language. */
post: operations['languages_create']
}
'/api/v1/languages/{id}/': {
/** Retrieve a single language. */
get: operations['languages_retrieve']
/** Update an existing language. */
put: operations['languages_update']
/** Delete an existing language. */
delete: operations['languages_destroy']
/** Partially update an existing language. */
patch: operations['languages_partial_update']
}
/** Partially update an existing license type. */
patch: operations['licenses_partial_update']
}
'/api/v1/link-types/': {
/** List all link types. */
get: operations['link_types_list']
/** Create a new link type. */
post: operations['link_types_create']
}
'/api/v1/link-types/{id}/': {
/** Retrieve a single link type. */
get: operations['link_types_retrieve']
/** Update an existing link type. */
put: operations['link_types_update']
/** Delete an existing link type. */
delete: operations['link_types_destroy']
/** Partially update an existing link type. */
patch: operations['link_types_partial_update']
}
'/api/v1/music-focus/': {
/** List all music focuses. */
/** Create a new music focus. */
/** Retrieve a single music focus. */
/** Update an existing music focus. */
/** Delete an existing music focus. */
delete: operations['music_focus_destroy']
/** Partially update an existing music focus. */
patch: operations['music_focus_partial_update']
}
'/api/v1/notes/': {
/** List all notes. */
get: operations['notes_list']
/** Create a new note. */
post: operations['notes_create']
}
'/api/v1/notes/{id}/': {
/** Retrieve a single note. */
get: operations['notes_retrieve']
/** Update an existing note. */
put: operations['notes_update']
/** Delete an existing note. */
delete: operations['notes_destroy']
/**
* Partially update an existing note.
* @description Only admins can partially update existing notes.
*/
patch: operations['notes_partial_update']
}
'/api/v1/rrules/': {
/** List all rrule. */
get: operations['rrules_list']
post: operations['rrules_create']
}
'/api/v1/rrules/{id}/': {
/** Retrieve a single rrule. */
get: operations['rrules_retrieve']
put: operations['rrules_update']
delete: operations['rrules_destroy']
patch: operations['rrules_partial_update']
}
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
'/api/v1/schedules/': {
/** List all schedules. */
get: operations['schedules_list']
/**
* Create a new schedule.
* @description Create a schedule, generate timeslots, test for collisions and resolve them
* (including notes).
*
* Note that creating or updating a schedule is the only way to create timeslots.
*
* Only admins may add schedules.
*
* The projected timeslots defined by the schedule are matched against existing
* timeslots. The API will return an object that contains
*
* * the schedule's data,
* * projected timeslots,
* * detected collisions,
* * and possible solutions.
*
* As long as no `solutions` object has been set or unresolved collisions exist,
* no data is written to the database. A schedule is only created if at least
* one timeslot was generated by it.
*
* In order to resolve any possible conflicts, the client must submit a new request with
* a solution for each conflict. Possible solutions are listed as part of the projected
* timeslot in the `solution_choices` array. In a best-case scenario with no detected
* conflicts an empty solutions object will suffice. For more details on the individual
* types of solutions see the SolutionChoicesEnum.
*
* **Please note**:
* If there's more than one collision for a projected timeslot, only `theirs` and `ours`
* are currently supported as solutions.
*/
post: operations['schedules_create']
}
'/api/v1/schedules/{id}/': {
/** Retrieve a single schedule. */
get: operations['schedules_retrieve']
/**
* Update an existing schedule.
* @description Update a schedule, generate timeslots, test for collisions and resolve
* them including notes.
*
* Only admins may update schedules.
*/
put: operations['schedules_update']
/**
* Delete an existing schedule.
* @description Only admins may delete schedules.
*/
delete: operations['schedules_destroy']
/** Partially update an existing schedule. */
patch: operations['schedules_partial_update']
}
'/api/v1/schema/': {
/**
* @description OpenApi3 schema for this API. Format can be selected via content negotiation.
*
* - YAML: application/vnd.oai.openapi
* - JSON: application/vnd.oai.openapi+json
*/
get: operations['schema_retrieve']
}
'/api/v1/shows/': {
/** List all shows. */
get: operations['shows_list']
/**
* Create a new show.
* @description Only admins may create a show.
*/
post: operations['shows_create']
}
'/api/v1/shows/{id}/': {
/** Retrieve a single show. */
get: operations['shows_retrieve']
/**
* Update an existing show.
* @description Non-admin users may only update shows they own.
*/
put: operations['shows_update']
/**
* Delete an existing show.
* @description Only admins may delete shows.
*/
delete: operations['shows_destroy']
/** Partially update an existing show. */
patch: operations['shows_partial_update']
}
'/api/v1/shows/{show_pk}/notes/': {
/** List all notes. */
get: operations['shows_notes_list']
/** Create a new note. */
post: operations['shows_notes_create']
}
'/api/v1/shows/{show_pk}/notes/{id}/': {
/** Retrieve a single note. */
get: operations['shows_notes_retrieve']
/** Update an existing note. */
put: operations['shows_notes_update']
/** Delete an existing note. */
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
delete: operations['shows_notes_destroy']
/**
* Partially update an existing note.
* @description Only admins can partially update existing notes.
*/
patch: operations['shows_notes_partial_update']
}
'/api/v1/shows/{show_pk}/schedules/': {
/** List all schedules. */
get: operations['shows_schedules_list']
/**
* Create a new schedule.
* @description Create a schedule, generate timeslots, test for collisions and resolve them
* (including notes).
*
* Note that creating or updating a schedule is the only way to create timeslots.
*
* Only admins may add schedules.
*
* The projected timeslots defined by the schedule are matched against existing
* timeslots. The API will return an object that contains
*
* * the schedule's data,
* * projected timeslots,
* * detected collisions,
* * and possible solutions.
*
* As long as no `solutions` object has been set or unresolved collisions exist,
* no data is written to the database. A schedule is only created if at least
* one timeslot was generated by it.
*
* In order to resolve any possible conflicts, the client must submit a new request with
* a solution for each conflict. Possible solutions are listed as part of the projected
* timeslot in the `solution_choices` array. In a best-case scenario with no detected
* conflicts an empty solutions object will suffice. For more details on the individual
* types of solutions see the SolutionChoicesEnum.
*
* **Please note**:
* If there's more than one collision for a projected timeslot, only `theirs` and `ours`
* are currently supported as solutions.
*/
post: operations['shows_schedules_create']
}
'/api/v1/shows/{show_pk}/schedules/{id}/': {
/** Retrieve a single schedule. */
get: operations['shows_schedules_retrieve']
/**
* Update an existing schedule.
* @description Update a schedule, generate timeslots, test for collisions and resolve
* them including notes.
*
* Only admins may update schedules.
*/
put: operations['shows_schedules_update']
/**
* Delete an existing schedule.
* @description Only admins may delete schedules.
*/
delete: operations['shows_schedules_destroy']
/** Partially update an existing schedule. */
patch: operations['shows_schedules_partial_update']
}
'/api/v1/shows/{show_pk}/schedules/{schedule_pk}/timeslots/': {
/**
* List all timeslots.
* @description
* By default, only timeslots ranging from now + 60 days will be displayed.
* You may override this default overriding start and/or end parameter.
*/
get: operations['shows_schedules_timeslots_list']
}
'/api/v1/shows/{show_pk}/schedules/{schedule_pk}/timeslots/{id}/': {
/** Retrieve a single timeslot. */
get: operations['shows_schedules_timeslots_retrieve']
/** Update an existing timeslot. */
put: operations['shows_schedules_timeslots_update']
/**
* Delete an existing timeslot.
* @description Only admins may delete timeslots.
*/
delete: operations['shows_schedules_timeslots_destroy']
/** Partially update an existing timeslot. */
patch: operations['shows_schedules_timeslots_partial_update']
}
'/api/v1/shows/{show_pk}/schedules/{schedule_pk}/timeslots/{timeslot_pk}/note/': {
/** List all notes. */
get: operations['shows_schedules_timeslots_note_list']
/** Create a new note. */
post: operations['shows_schedules_timeslots_note_create']
}
'/api/v1/shows/{show_pk}/schedules/{schedule_pk}/timeslots/{timeslot_pk}/note/{id}/': {
/** Retrieve a single note. */
get: operations['shows_schedules_timeslots_note_retrieve']
/** Update an existing note. */
put: operations['shows_schedules_timeslots_note_update']
/** Delete an existing note. */
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
delete: operations['shows_schedules_timeslots_note_destroy']
/**
* Partially update an existing note.
* @description Only admins can partially update existing notes.
*/
patch: operations['shows_schedules_timeslots_note_partial_update']
}
'/api/v1/shows/{show_pk}/timeslots/': {
/**
* List all timeslots.
* @description
* By default, only timeslots ranging from now + 60 days will be displayed.
* You may override this default overriding start and/or end parameter.
*/
get: operations['shows_timeslots_list']
}
'/api/v1/shows/{show_pk}/timeslots/{id}/': {
/** Retrieve a single timeslot. */
get: operations['shows_timeslots_retrieve']
/** Update an existing timeslot. */
put: operations['shows_timeslots_update']
/**
* Delete an existing timeslot.
* @description Only admins may delete timeslots.
*/
delete: operations['shows_timeslots_destroy']
/** Partially update an existing timeslot. */
patch: operations['shows_timeslots_partial_update']
}
'/api/v1/shows/{show_pk}/timeslots/{timeslot_pk}/note/': {
/** List all notes. */
get: operations['shows_timeslots_note_list']
/** Create a new note. */
post: operations['shows_timeslots_note_create']
}
'/api/v1/shows/{show_pk}/timeslots/{timeslot_pk}/note/{id}/': {
/** Retrieve a single note. */
get: operations['shows_timeslots_note_retrieve']
/** Update an existing note. */
put: operations['shows_timeslots_note_update']
/** Delete an existing note. */
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
delete: operations['shows_timeslots_note_destroy']
/**
* Partially update an existing note.
* @description Only admins can partially update existing notes.
*/
patch: operations['shows_timeslots_note_partial_update']
}
'/api/v1/timeslots/': {
/**
* List all timeslots.
* @description
* By default, only timeslots ranging from now + 60 days will be displayed.
* You may override this default overriding start and/or end parameter.
*/
get: operations['timeslots_list']
}
'/api/v1/timeslots/{id}/': {
/** Retrieve a single timeslot. */
get: operations['timeslots_retrieve']
/** Update an existing timeslot. */
put: operations['timeslots_update']
/**
* Delete an existing timeslot.
* @description Only admins may delete timeslots.
*/
delete: operations['timeslots_destroy']
/** Partially update an existing timeslot. */
patch: operations['timeslots_partial_update']
}
'/api/v1/topics/': {
/** List all topics. */
get: operations['topics_list']
/** Create a new topic. */
post: operations['topics_create']
}
'/api/v1/topics/{id}/': {
/** Retrieve a single topic. */
get: operations['topics_retrieve']
/** Update an existing topic. */
put: operations['topics_update']
/** Delete an existing topic. */
delete: operations['topics_destroy']
/** Partially update an existing topic. */
patch: operations['topics_partial_update']
}
'/api/v1/types/': {
/** List all types. */
get: operations['types_list']
/** Create a new type. */
post: operations['types_create']
}
'/api/v1/types/{id}/': {
/** Retrieve a single type. */
get: operations['types_retrieve']
/** Update an existing type. */
put: operations['types_update']
/** Delete an existing type. */
delete: operations['types_destroy']
/** Partially update an existing type. */
patch: operations['types_partial_update']
}
'/api/v1/users/': {
/**
* List all users.
* @description The returned list of records will only contain a single record for non-admin users which is their own user account.
*/
get: operations['users_list']
/**
* Create a new user.
* @description Only admins may create users.
*/
post: operations['users_create']
}
'/api/v1/users/{id}/': {
/**
* Retrieve a single user.
* @description Non-admin users may only retrieve their own user record.
*/
get: operations['users_retrieve']
/**
* Update an existing user.
* @description Non-admin users may only update their own user record.
*/
put: operations['users_update']
/**
* Partially update an existing user.
* @description Non-admin users may only update their own user record.
*/
patch: operations['users_partial_update']
}
}
export type webhooks = Record<string, never>
export interface components {
schemas: {
/**
* @description * `1` - first
* * `2` - second
* * `3` - third
* * `4` - fourth
* * `5` - fifth
* * `-1` - last
* @enum {integer}
*/
BySetPosEnum: 1 | 2 | 3 | 4 | 5 | -1
/**
* @description **0**: Monday
*
*
* **1**: Tuesday
*
*
* **2**: Wednesday
*
*
* **3**: Thursday
*
*
* **4**: Friday
*
*
* **5**: Saturday
*
*
* **6**: Sunday
* @enum {integer}
*/
ByWeekdayEnum: 0 | 1 | 2 | 3 | 4 | 5 | 6
/**
* @description * `None` -
* * `0,1,2,3,4` - business days
* * `5,6` - weekends
* @enum {unknown}
*/
ByWeekdaysEnum: '0,1,2,3,4' | '5,6'
Category: {
}
Collision: {
id: number
/** Format: date-time */
start: string
/** Format: date-time */
end: string
playlistId: number | null
showId: number
showName: string
repetitionOfId: number | null
scheduleId: number
memo: string
}
DryRunTimeSlot: {
id: number | null
scheduleId: number | null
playlistId: number | null
/** Format: date */
start: string
/** Format: date */
end: string
repetitionOfId: number | null
memo: string
}
Error: {
message: string
code: string | null
}
/**
* @description * `0` - once
* * `1` - monthly
* * `2` - weekly
* * `3` - daily
* @enum {integer}
*/
FreqEnum: 0 | 1 | 2 | 3
FundingCategory: {
id: number
}
Host: {
imageId?: number | null
isActive?: boolean
links?: components['schemas']['HostLink'][]
name: string
createdAt: string
createdBy: string
updatedAt: string | null
updatedBy: string
}
HostLink: {
/** Format: uri */
url: string
}
altText?: string
credits?: string
/** Format: uri */
image?: string | null
thumbnails: readonly {
/** Format: double */
width: number
/** Format: double */
height: number
url: string
}[]
Language: {
id: number
License: {
id: number
/** @description Identifier of the license */
identifier: string
/** @description Name of the license */
needsAuthor?: boolean
requiresExpressPermissionForPublication?: boolean
/** Format: uri */
url?: string
/** @description Name of the link type */
name: string
/** @description Type of the link */
type: string
}
MusicFocus: {
id: number
}
Note: {
id: number
imageId?: number | null
links?: components['schemas']['NoteLink'][]
ownerId: number
playlistId?: number
summary?: string
/** Format: date-time */
createdAt: string
createdBy: string
updatedAt: string | null
updatedBy: string
}
NoteLink: {
/** Format: uri */
url: string
}
PaginatedHostList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['Host'][]
}
PaginatedImageList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['Image'][]
}
PaginatedNoteList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['Note'][]
}
PaginatedScheduleList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['Schedule'][]
}
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
PaginatedShowList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['Show'][]
}
PaginatedTimeSlotList: {
/** @example 123 */
count?: number
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=400&limit=100
*/
next?: string | null
/**
* Format: uri
* @example http://api.example.org/accounts/?offset=200&limit=100
*/
previous?: string | null
results?: components['schemas']['TimeSlot'][]
}
PatchedCategory: {
id?: number
}
PatchedFundingCategory: {
id?: number
}
PatchedHost: {
id?: number
imageId?: number | null
isActive?: boolean
links?: components['schemas']['HostLink'][]
name?: string
createdAt?: string
createdBy?: string
updatedAt?: string | null
updatedBy?: string
altText?: string
credits?: string
/** Format: uri */
height?: number | null
thumbnails?: readonly {
/** Format: double */
width: number
/** Format: double */
height: number
url: string
}[]
width?: number | null
}
PatchedLanguage: {
id?: number
PatchedLicense: {
id?: number
/** @description Identifier of the license */
identifier?: string
/** @description Name of the license */
needsAuthor?: boolean
requiresExpressPermissionForPublication?: boolean
/** Format: uri */
url?: string
/** @description Name of the link type */
name?: string
/** @description Type of the link */
type?: string
}
PatchedMusicFocus: {
id?: number
}
PatchedNote: {
contributorIds?: number[]
id?: number
imageId?: number | null
links?: components['schemas']['NoteLink'][]
ownerId?: number
playlistId?: number
slug?: string
summary?: string
tags?: string
timeslotId?: number
/** Format: date-time */
createdAt?: string
createdBy?: string
updatedAt?: string | null
updatedBy?: string
bySetPos?: components['schemas']['BySetPosEnum'] | components['schemas']['NullEnum'] | null
byWeekdays?:
| components['schemas']['ByWeekdaysEnum']
| components['schemas']['NullEnum']
| null
/** @description How many occurrences should be generated. */
count?: number | null
freq?: components['schemas']['FreqEnum']
/**
* @description The interval between each freq iteration.
* @default 1
*/
interval?: number
}
PatchedScheduleCreateUpdateRequest: {
schedule?: components['schemas']['ScheduleInRequest']
solutions?: {
[key: string]:
| 'theirs'
| 'ours'
| 'theirs-start'
| 'ours-start'
| 'theirs-end'
| 'ours-end'
| 'theirs-both'
| 'ours-both'
}
notes?: {
}
playlists?: {
}
}
PatchedShow: {
categoryIds?: number[]
cbaSeriesId?: number | null
defaultPlaylistId?: number | null
description?: string
/** Format: email */
email?: string | null
fundingCategoryId?: number
hostIds?: number[]
imageId?: number | null
internalNote?: string
isActive?: boolean
isPublic?: boolean
languageIds?: number[]
links?: components['schemas']['HostLink'][]
logoId?: number | null
musicFocusIds?: number[]
ownerIds?: number[]
predecessorId?: number | null
shortDescription?: string
topicIds?: number[]
typeId?: number
createdAt?: string
createdBy?: string
updatedAt?: string | null
updatedBy?: string
}
PatchedTimeSlot: {
memo?: string
playlistId?: number | null
repetitionOfId?: number | null
/** Format: date-time */
end?: string
/** Format: date-time */
start?: string
}
PatchedTopic: {
id?: number
}
PatchedType: {
id?: number
}
PatchedUser: {
/**
* Format: email
*/
email?: string
* Active
* @description Designates whether this user should be treated as active. Unselect this instead of deleting accounts.