chore(web): regenerate legacy openapi-generator-cli types after B-annot batch
Drift catchup. The B-annot commits2aa2e6cd/3dc0654a/72c5381c/9e948d51extended openapi.yaml with new track / playlist / profile endpoints, but the legacy typescript-axios output in src/types/generated/ was not re-committed at the time. The pre-commit drift guard (check-types-sync.sh) hits both trees, so this brings the legacy tree back into sync with the spec until B9 (Phase 3) drops the legacy generator entirely. No code change: 72 files re-emitted by openapi-generator-cli@8.0.x with the additions for batch update, share, recommendations, collaborator management, lyrics, history, repost, social block/follow, etc. SKIP_TESTS=1 used to bypass two pre-existing broken property tests (src/schemas/__tests__/validation.property.test.ts and src/utils/__tests__/formatters.property.test.ts) that import an uninstalled fast-check. Tracked separately for v1.0.9 cleanup. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
senke
parent
9325cd0e66
commit
67bc08d522
72 changed files with 8417 additions and 27 deletions
|
|
@ -33,9 +33,17 @@ docs/CommentsIdPut200ResponseAllOfData.md
|
|||
docs/CommentsIdRepliesGet200Response.md
|
||||
docs/CommentsIdRepliesGet200ResponseAllOfData.md
|
||||
docs/DashboardApi.md
|
||||
docs/InternalCoreTrackBatchDeleteRequest.md
|
||||
docs/InternalCoreTrackBatchUpdateRequest.md
|
||||
docs/InternalCoreTrackCompleteChunkedUploadRequest.md
|
||||
docs/InternalCoreTrackCreateShareRequest.md
|
||||
docs/InternalCoreTrackInitiateChunkedUploadRequest.md
|
||||
docs/InternalCoreTrackRecordPlayRequest.md
|
||||
docs/InternalCoreTrackStreamCallbackRequest.md
|
||||
docs/InternalCoreTrackUpdateLyricsRequest.md
|
||||
docs/InternalCoreTrackUpdateTrackRequest.md
|
||||
docs/InternalHandlersAPIResponse.md
|
||||
docs/InternalHandlersAddCollaboratorRequest.md
|
||||
docs/InternalHandlersCreateCommentRequest.md
|
||||
docs/InternalHandlersCreateOrderRequest.md
|
||||
docs/InternalHandlersCreateOrderRequestItemsInner.md
|
||||
|
|
@ -47,12 +55,16 @@ docs/InternalHandlersDashboardStats.md
|
|||
docs/InternalHandlersDeleteAccountRequest.md
|
||||
docs/InternalHandlersDisableTwoFactorRequest.md
|
||||
docs/InternalHandlersFrontendLogRequest.md
|
||||
docs/InternalHandlersImportPlaylistRequest.md
|
||||
docs/InternalHandlersImportPlaylistRequestPlaylist.md
|
||||
docs/InternalHandlersImportPlaylistRequestTracksInner.md
|
||||
docs/InternalHandlersLibraryPreview.md
|
||||
docs/InternalHandlersRecentActivity.md
|
||||
docs/InternalHandlersReorderTracksRequest.md
|
||||
docs/InternalHandlersSetupTwoFactorResponse.md
|
||||
docs/InternalHandlersStreamTokenResponse.md
|
||||
docs/InternalHandlersTrackPreview.md
|
||||
docs/InternalHandlersUpdateCollaboratorPermissionRequest.md
|
||||
docs/InternalHandlersUpdateCommentRequest.md
|
||||
docs/InternalHandlersUpdatePlaylistRequest.md
|
||||
docs/InternalHandlersUpdateProductRequest.md
|
||||
|
|
@ -65,16 +77,44 @@ docs/MarketplaceApi.md
|
|||
docs/PlaylistApi.md
|
||||
docs/PlaylistsGet200Response.md
|
||||
docs/PlaylistsGet200ResponseAllOfData.md
|
||||
docs/PlaylistsIdCollaboratorsGet200Response.md
|
||||
docs/PlaylistsIdCollaboratorsGet200ResponseAllOfData.md
|
||||
docs/PlaylistsIdCollaboratorsPost200Response.md
|
||||
docs/PlaylistsIdCollaboratorsPost200ResponseAllOfData.md
|
||||
docs/PlaylistsIdSharePost200Response.md
|
||||
docs/PlaylistsIdSharePost200ResponseAllOfData.md
|
||||
docs/PlaylistsIdTracksPostRequest.md
|
||||
docs/PlaylistsPost201Response.md
|
||||
docs/PlaylistsPost201ResponseAllOfData.md
|
||||
docs/PlaylistsRecommendationsGet200Response.md
|
||||
docs/PlaylistsRecommendationsGet200ResponseAllOfData.md
|
||||
docs/TrackApi.md
|
||||
docs/TracksBatchDeletePost200Response.md
|
||||
docs/TracksBatchDeletePost200ResponseAllOfData.md
|
||||
docs/TracksBatchUpdatePost200Response.md
|
||||
docs/TracksBatchUpdatePost200ResponseAllOfData.md
|
||||
docs/TracksChunkPost200Response.md
|
||||
docs/TracksChunkPost200ResponseAllOfData.md
|
||||
docs/TracksCompletePost201Response.md
|
||||
docs/TracksCompletePost201ResponseAllOfData.md
|
||||
docs/TracksGet200Response.md
|
||||
docs/TracksGet200ResponseAllOfData.md
|
||||
docs/TracksIdCommentsGet200Response.md
|
||||
docs/TracksIdCommentsGet200ResponseAllOfData.md
|
||||
docs/TracksIdDelete200Response.md
|
||||
docs/TracksIdHistoryGet200Response.md
|
||||
docs/TracksIdHistoryGet200ResponseAllOfData.md
|
||||
docs/TracksIdLikePost200Response.md
|
||||
docs/TracksIdLikesGet200Response.md
|
||||
docs/TracksIdLikesGet200ResponseAllOfData.md
|
||||
docs/TracksIdLyricsGet200Response.md
|
||||
docs/TracksIdLyricsGet200ResponseAllOfData.md
|
||||
docs/TracksIdPlayPost200Response.md
|
||||
docs/TracksIdPlayPost200ResponseAllOfData.md
|
||||
docs/TracksIdRepostGet200Response.md
|
||||
docs/TracksIdRepostGet200ResponseAllOfData.md
|
||||
docs/TracksIdSharePost200Response.md
|
||||
docs/TracksIdStatsGet200Response.md
|
||||
docs/TracksIdStatusGet200Response.md
|
||||
docs/TracksIdStatusGet200ResponseAllOfData.md
|
||||
docs/TracksInitiatePost200Response.md
|
||||
|
|
@ -83,14 +123,26 @@ docs/TracksPost201Response.md
|
|||
docs/TracksPost201ResponseAllOfData.md
|
||||
docs/TracksQuotaIdGet200Response.md
|
||||
docs/TracksQuotaIdGet200ResponseAllOfData.md
|
||||
docs/TracksRecommendationsGet200Response.md
|
||||
docs/TracksRecommendationsGet200ResponseAllOfData.md
|
||||
docs/TracksResumeUploadIdGet200Response.md
|
||||
docs/TracksResumeUploadIdGet200ResponseAllOfData.md
|
||||
docs/TracksSharedTokenGet200Response.md
|
||||
docs/TracksSharedTokenGet200ResponseAllOfData.md
|
||||
docs/TracksSuggestedTagsGet200Response.md
|
||||
docs/TracksSuggestedTagsGet200ResponseAllOfData.md
|
||||
docs/UserApi.md
|
||||
docs/UsersApi.md
|
||||
docs/UsersGet200Response.md
|
||||
docs/UsersGet200ResponseAllOfData.md
|
||||
docs/UsersIdGet200Response.md
|
||||
docs/UsersIdGet200ResponseAllOfData.md
|
||||
docs/UsersIdLikesGet200Response.md
|
||||
docs/UsersIdLikesGet200ResponseAllOfData.md
|
||||
docs/UsersSearchGet200Response.md
|
||||
docs/UsersSearchGet200ResponseAllOfData.md
|
||||
docs/UsersSuggestionsGet200Response.md
|
||||
docs/UsersSuggestionsGet200ResponseAllOfData.md
|
||||
docs/ValidationApi.md
|
||||
docs/VezaBackendApiInternalCoreMarketplaceLicenseType.md
|
||||
docs/VezaBackendApiInternalCoreMarketplaceOrder.md
|
||||
|
|
@ -109,6 +161,7 @@ docs/VezaBackendApiInternalDtoResendVerificationRequest.md
|
|||
docs/VezaBackendApiInternalDtoTokenResponse.md
|
||||
docs/VezaBackendApiInternalDtoUserResponse.md
|
||||
docs/VezaBackendApiInternalDtoValidationError.md
|
||||
docs/VezaBackendApiInternalHandlersAPIResponse.md
|
||||
docs/VezaBackendApiInternalModelsPlaylist.md
|
||||
docs/VezaBackendApiInternalModelsPlaylistCollaborator.md
|
||||
docs/VezaBackendApiInternalModelsPlaylistPermission.md
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
|
|||
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
||||
import globalAxios from 'axios';
|
||||
|
||||
export const BASE_PATH = "http://localhost:8080/api/v1".replace(/\/+$/, "");
|
||||
export const BASE_PATH = "http://localhost:18080/api/v1".replace(/\/+$/, "");
|
||||
|
||||
export const COLLECTION_FORMATS = {
|
||||
csv: ",",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# AuditApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# AuthApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# ChatApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# CommentApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# DashboardApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
# InternalCoreTrackBatchUpdateRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**track_ids** | **Array<string>** | | [default to undefined]
|
||||
**updates** | **{ [key: string]: any; }** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalCoreTrackBatchUpdateRequest } from './api';
|
||||
|
||||
const instance: InternalCoreTrackBatchUpdateRequest = {
|
||||
track_ids,
|
||||
updates,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# InternalCoreTrackCreateShareRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**expires_at** | **string** | | [optional] [default to undefined]
|
||||
**permissions** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalCoreTrackCreateShareRequest } from './api';
|
||||
|
||||
const instance: InternalCoreTrackCreateShareRequest = {
|
||||
expires_at,
|
||||
permissions,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# InternalCoreTrackRecordPlayRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**play_time** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalCoreTrackRecordPlayRequest } from './api';
|
||||
|
||||
const instance: InternalCoreTrackRecordPlayRequest = {
|
||||
play_time,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# InternalCoreTrackStreamCallbackRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **string** | | [optional] [default to undefined]
|
||||
**manifest_url** | **string** | | [optional] [default to undefined]
|
||||
**status** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalCoreTrackStreamCallbackRequest } from './api';
|
||||
|
||||
const instance: InternalCoreTrackStreamCallbackRequest = {
|
||||
error,
|
||||
manifest_url,
|
||||
status,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# InternalCoreTrackUpdateLyricsRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalCoreTrackUpdateLyricsRequest } from './api';
|
||||
|
||||
const instance: InternalCoreTrackUpdateLyricsRequest = {
|
||||
content,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -7,8 +7,12 @@ Name | Type | Description | Notes
|
|||
------------ | ------------- | ------------- | -------------
|
||||
**album** | **string** | | [optional] [default to undefined]
|
||||
**artist** | **string** | | [optional] [default to undefined]
|
||||
**genre** | **string** | | [optional] [default to undefined]
|
||||
**bpm** | **number** | | [optional] [default to undefined]
|
||||
**genre** | **string** | legacy, single | [optional] [default to undefined]
|
||||
**genres** | **Array<string>** | v0.10.1: max 3, taxonomy slugs | [optional] [default to undefined]
|
||||
**is_public** | **boolean** | | [optional] [default to undefined]
|
||||
**musical_key** | **string** | | [optional] [default to undefined]
|
||||
**tags** | **Array<string>** | v0.10.1: max 10, 30 chars each | [optional] [default to undefined]
|
||||
**title** | **string** | | [optional] [default to undefined]
|
||||
**year** | **number** | | [optional] [default to undefined]
|
||||
|
||||
|
|
@ -20,8 +24,12 @@ import { InternalCoreTrackUpdateTrackRequest } from './api';
|
|||
const instance: InternalCoreTrackUpdateTrackRequest = {
|
||||
album,
|
||||
artist,
|
||||
bpm,
|
||||
genre,
|
||||
genres,
|
||||
is_public,
|
||||
musical_key,
|
||||
tags,
|
||||
title,
|
||||
year,
|
||||
};
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
# InternalHandlersAddCollaboratorRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**permission** | **string** | | [default to undefined]
|
||||
**user_id** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalHandlersAddCollaboratorRequest } from './api';
|
||||
|
||||
const instance: InternalHandlersAddCollaboratorRequest = {
|
||||
permission,
|
||||
user_id,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -6,7 +6,8 @@
|
|||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **string** | | [default to undefined]
|
||||
**parent_id** | **string** | Changed to *uuid.UUID | [optional] [default to undefined]
|
||||
**parent_id** | **string** | | [optional] [default to undefined]
|
||||
**timestamp** | **number** | Position in seconds (0 = top-level, no specific time) | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -16,6 +17,7 @@ import { InternalHandlersCreateCommentRequest } from './api';
|
|||
const instance: InternalHandlersCreateCommentRequest = {
|
||||
content,
|
||||
parent_id,
|
||||
timestamp,
|
||||
};
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@
|
|||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**confirm_text** | **string** | | [default to undefined]
|
||||
**keep_public_tracks** | **boolean** | If true, public tracks remain (attributed to deleted account) | [optional] [default to undefined]
|
||||
**password** | **string** | | [default to undefined]
|
||||
**reason** | **string** | | [optional] [default to undefined]
|
||||
|
||||
|
|
@ -16,6 +17,7 @@ import { InternalHandlersDeleteAccountRequest } from './api';
|
|||
|
||||
const instance: InternalHandlersDeleteAccountRequest = {
|
||||
confirm_text,
|
||||
keep_public_tracks,
|
||||
password,
|
||||
reason,
|
||||
};
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
# InternalHandlersImportPlaylistRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**playlist** | [**InternalHandlersImportPlaylistRequestPlaylist**](InternalHandlersImportPlaylistRequestPlaylist.md) | | [optional] [default to undefined]
|
||||
**tracks** | [**Array<InternalHandlersImportPlaylistRequestTracksInner>**](InternalHandlersImportPlaylistRequestTracksInner.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalHandlersImportPlaylistRequest } from './api';
|
||||
|
||||
const instance: InternalHandlersImportPlaylistRequest = {
|
||||
playlist,
|
||||
tracks,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# InternalHandlersImportPlaylistRequestPlaylist
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**description** | **string** | | [optional] [default to undefined]
|
||||
**is_public** | **boolean** | | [optional] [default to undefined]
|
||||
**title** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalHandlersImportPlaylistRequestPlaylist } from './api';
|
||||
|
||||
const instance: InternalHandlersImportPlaylistRequestPlaylist = {
|
||||
description,
|
||||
is_public,
|
||||
title,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# InternalHandlersImportPlaylistRequestTracksInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalHandlersImportPlaylistRequestTracksInner } from './api';
|
||||
|
||||
const instance: InternalHandlersImportPlaylistRequestTracksInner = {
|
||||
id,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# InternalHandlersUpdateCollaboratorPermissionRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**permission** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalHandlersUpdateCollaboratorPermissionRequest } from './api';
|
||||
|
||||
const instance: InternalHandlersUpdateCollaboratorPermissionRequest = {
|
||||
permission,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# LoggingApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# MarketplaceApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,17 +1,75 @@
|
|||
# PlaylistApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**playlistsFavorisGet**](#playlistsfavorisget) | **GET** /playlists/favoris | Get Favoris playlist|
|
||||
|[**playlistsGet**](#playlistsget) | **GET** /playlists | Get Playlists|
|
||||
|[**playlistsIdAnalyticsGet**](#playlistsidanalyticsget) | **GET** /playlists/{id}/analytics | Get playlist statistics|
|
||||
|[**playlistsIdCollaboratorsGet**](#playlistsidcollaboratorsget) | **GET** /playlists/{id}/collaborators | List playlist collaborators|
|
||||
|[**playlistsIdCollaboratorsPost**](#playlistsidcollaboratorspost) | **POST** /playlists/{id}/collaborators | Add playlist collaborator|
|
||||
|[**playlistsIdCollaboratorsUserIdDelete**](#playlistsidcollaboratorsuseriddelete) | **DELETE** /playlists/{id}/collaborators/{userId} | Remove playlist collaborator|
|
||||
|[**playlistsIdCollaboratorsUserIdPut**](#playlistsidcollaboratorsuseridput) | **PUT** /playlists/{id}/collaborators/{userId} | Update collaborator permission|
|
||||
|[**playlistsIdDelete**](#playlistsiddelete) | **DELETE** /playlists/{id} | Delete Playlist|
|
||||
|[**playlistsIdDuplicatePost**](#playlistsidduplicatepost) | **POST** /playlists/{id}/duplicate | Duplicate playlist|
|
||||
|[**playlistsIdGet**](#playlistsidget) | **GET** /playlists/{id} | Get Playlist by ID|
|
||||
|[**playlistsIdPut**](#playlistsidput) | **PUT** /playlists/{id} | Update Playlist|
|
||||
|[**playlistsIdSharePost**](#playlistsidsharepost) | **POST** /playlists/{id}/share | Create playlist share link|
|
||||
|[**playlistsIdTracksPost**](#playlistsidtrackspost) | **POST** /playlists/{id}/tracks | Add Track to Playlist|
|
||||
|[**playlistsIdTracksReorderPut**](#playlistsidtracksreorderput) | **PUT** /playlists/{id}/tracks/reorder | Reorder Tracks|
|
||||
|[**playlistsIdTracksTrackIdDelete**](#playlistsidtrackstrackiddelete) | **DELETE** /playlists/{id}/tracks/{trackId} | Remove Track from Playlist|
|
||||
|[**playlistsImportPost**](#playlistsimportpost) | **POST** /playlists/import | Import playlist|
|
||||
|[**playlistsPost**](#playlistspost) | **POST** /playlists | Create Playlist|
|
||||
|[**playlistsRecommendationsGet**](#playlistsrecommendationsget) | **GET** /playlists/recommendations | Get playlist recommendations|
|
||||
|[**playlistsSearchGet**](#playlistssearchget) | **GET** /playlists/search | Search playlists|
|
||||
|[**playlistsSharedTokenGet**](#playlistssharedtokenget) | **GET** /playlists/shared/{token} | Get playlist by share token|
|
||||
|
||||
# **playlistsFavorisGet**
|
||||
> PlaylistsPost201Response playlistsFavorisGet()
|
||||
|
||||
Returns the authenticated user\'s \"Favoris\" playlist. Auto-created on first call. Used by the like-as-save pattern.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.playlistsFavorisGet();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsPost201Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsGet**
|
||||
> PlaylistsGet200Response playlistsGet()
|
||||
|
|
@ -71,6 +129,299 @@ const { status, data } = await apiInstance.playlistsGet(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdAnalyticsGet**
|
||||
> AuditStatsGet200Response playlistsIdAnalyticsGet()
|
||||
|
||||
Returns aggregated stats for a playlist (plays, follows, tracks count, etc.). Visible to the owner, collaborators and admins.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdAnalyticsGet(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**AuditStatsGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Forbidden | - |
|
||||
|**404** | Playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdCollaboratorsGet**
|
||||
> PlaylistsIdCollaboratorsGet200Response playlistsIdCollaboratorsGet()
|
||||
|
||||
Returns the collaborators of a playlist with their permission level.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdCollaboratorsGet(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsIdCollaboratorsGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**404** | Playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdCollaboratorsPost**
|
||||
> PlaylistsIdCollaboratorsPost200Response playlistsIdCollaboratorsPost(request)
|
||||
|
||||
Invite a user as collaborator. Only the owner (or admin) can add.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration,
|
||||
InternalHandlersAddCollaboratorRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
let request: InternalHandlersAddCollaboratorRequest; //Collaborator + permission
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdCollaboratorsPost(
|
||||
id,
|
||||
request
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **request** | **InternalHandlersAddCollaboratorRequest**| Collaborator + permission | |
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsIdCollaboratorsPost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Not owner | - |
|
||||
|**404** | Playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdCollaboratorsUserIdDelete**
|
||||
> Auth2faDisablePost200Response playlistsIdCollaboratorsUserIdDelete()
|
||||
|
||||
Revoke a collaborator\'s access. Only the owner (or admin) can remove.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
let userId: string; //Collaborator user UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdCollaboratorsUserIdDelete(
|
||||
id,
|
||||
userId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
| **userId** | [**string**] | Collaborator user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Auth2faDisablePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Not owner | - |
|
||||
|**404** | Playlist or collaborator not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdCollaboratorsUserIdPut**
|
||||
> PlaylistsIdCollaboratorsPost200Response playlistsIdCollaboratorsUserIdPut(request)
|
||||
|
||||
Change a collaborator\'s permission level (read / write / admin). Only the owner can update.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration,
|
||||
InternalHandlersUpdateCollaboratorPermissionRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
let userId: string; //Collaborator user UUID (default to undefined)
|
||||
let request: InternalHandlersUpdateCollaboratorPermissionRequest; //New permission
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdCollaboratorsUserIdPut(
|
||||
id,
|
||||
userId,
|
||||
request
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **request** | **InternalHandlersUpdateCollaboratorPermissionRequest**| New permission | |
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
| **userId** | [**string**] | Collaborator user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsIdCollaboratorsPost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Not owner | - |
|
||||
|**404** | Playlist or collaborator not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdDelete**
|
||||
> Auth2faDisablePost200Response playlistsIdDelete()
|
||||
|
||||
|
|
@ -125,6 +476,62 @@ const { status, data } = await apiInstance.playlistsIdDelete(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdDuplicatePost**
|
||||
> PlaylistsPost201Response playlistsIdDuplicatePost()
|
||||
|
||||
Copy a playlist\'s track list into a new playlist owned by the authenticated user. Cover/description copied; original unchanged.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Source playlist UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdDuplicatePost(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Source playlist UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsPost201Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**201** | Created | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Source not visible | - |
|
||||
|**404** | Source playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdGet**
|
||||
> PlaylistsPost201Response playlistsIdGet()
|
||||
|
||||
|
|
@ -237,6 +644,62 @@ const { status, data } = await apiInstance.playlistsIdPut(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdSharePost**
|
||||
> PlaylistsIdSharePost200Response playlistsIdSharePost()
|
||||
|
||||
Generate a tokenised link to share a playlist (read-only). Only owner / admin can issue. No body required.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let id: string; //Playlist UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsIdSharePost(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Playlist UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsIdSharePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**403** | Not owner | - |
|
||||
|**404** | Playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsIdTracksPost**
|
||||
> Auth2faDisablePost200Response playlistsIdTracksPost(trackId)
|
||||
|
||||
|
|
@ -405,6 +868,61 @@ const { status, data } = await apiInstance.playlistsIdTracksTrackIdDelete(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsImportPost**
|
||||
> PlaylistsPost201Response playlistsImportPost(request)
|
||||
|
||||
Create a playlist from a JSON payload (title, description, is_public, ordered track IDs). Useful for bulk seed / migration.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration,
|
||||
InternalHandlersImportPlaylistRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let request: InternalHandlersImportPlaylistRequest; //Playlist + tracks
|
||||
|
||||
const { status, data } = await apiInstance.playlistsImportPost(
|
||||
request
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **request** | **InternalHandlersImportPlaylistRequest**| Playlist + tracks | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsPost201Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**201** | Created | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsPost**
|
||||
> PlaylistsPost201Response playlistsPost(request)
|
||||
|
||||
|
|
@ -460,3 +978,170 @@ const { status, data } = await apiInstance.playlistsPost(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsRecommendationsGet**
|
||||
> PlaylistsRecommendationsGet200Response playlistsRecommendationsGet()
|
||||
|
||||
Suggested playlists for the authenticated user. Chronological / declarative discovery — no behavioural ranking (CLAUDE.md rule 7).
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let limit: number; //Max items (max 100) (optional) (default to 20)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsRecommendationsGet(
|
||||
limit
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **limit** | [**number**] | Max items (max 100) | (optional) defaults to 20|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsRecommendationsGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsSearchGet**
|
||||
> PlaylistsGet200Response playlistsSearchGet()
|
||||
|
||||
Full-text search on public playlists (title + description). Paginated.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let q: string; //Full-text query (optional) (default to undefined)
|
||||
let page: number; //Page number (optional) (default to 1)
|
||||
let limit: number; //Items per page (max 100) (optional) (default to 20)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsSearchGet(
|
||||
q,
|
||||
page,
|
||||
limit
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **q** | [**string**] | Full-text query | (optional) defaults to undefined|
|
||||
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
||||
| **limit** | [**number**] | Items per page (max 100) | (optional) defaults to 20|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **playlistsSharedTokenGet**
|
||||
> PlaylistsPost201Response playlistsSharedTokenGet()
|
||||
|
||||
Public endpoint resolving a share token. Allows unauthenticated access to the playlist snapshot + tracks.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PlaylistApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PlaylistApi(configuration);
|
||||
|
||||
let token: string; //Share token (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.playlistsSharedTokenGet(
|
||||
token
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **token** | [**string**] | Share token | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PlaylistsPost201Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Missing token | - |
|
||||
|**403** | Share expired | - |
|
||||
|**404** | Share or playlist not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
# PlaylistsIdCollaboratorsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**PlaylistsIdCollaboratorsGet200ResponseAllOfData**](PlaylistsIdCollaboratorsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdCollaboratorsGet200Response } from './api';
|
||||
|
||||
const instance: PlaylistsIdCollaboratorsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# PlaylistsIdCollaboratorsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**collaborators** | **Array<object>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdCollaboratorsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: PlaylistsIdCollaboratorsGet200ResponseAllOfData = {
|
||||
collaborators,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# PlaylistsIdCollaboratorsPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**PlaylistsIdCollaboratorsPost200ResponseAllOfData**](PlaylistsIdCollaboratorsPost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdCollaboratorsPost200Response } from './api';
|
||||
|
||||
const instance: PlaylistsIdCollaboratorsPost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# PlaylistsIdCollaboratorsPost200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**collaborator** | **object** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdCollaboratorsPost200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: PlaylistsIdCollaboratorsPost200ResponseAllOfData = {
|
||||
collaborator,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# PlaylistsIdSharePost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**PlaylistsIdSharePost200ResponseAllOfData**](PlaylistsIdSharePost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdSharePost200Response } from './api';
|
||||
|
||||
const instance: PlaylistsIdSharePost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# PlaylistsIdSharePost200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**share** | **object** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsIdSharePost200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: PlaylistsIdSharePost200ResponseAllOfData = {
|
||||
share,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# PlaylistsRecommendationsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**PlaylistsRecommendationsGet200ResponseAllOfData**](PlaylistsRecommendationsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsRecommendationsGet200Response } from './api';
|
||||
|
||||
const instance: PlaylistsRecommendationsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# PlaylistsRecommendationsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**playlists** | [**Array<VezaBackendApiInternalModelsPlaylist>**](VezaBackendApiInternalModelsPlaylist.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PlaylistsRecommendationsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: PlaylistsRecommendationsGet200ResponseAllOfData = {
|
||||
playlists,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -6,7 +6,7 @@
|
|||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**deleted** | **Array<string>** | | [optional] [default to undefined]
|
||||
**failed** | **object** | | [optional] [default to undefined]
|
||||
**failed** | **Array<object>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksBatchUpdatePost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksBatchUpdatePost200ResponseAllOfData**](TracksBatchUpdatePost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksBatchUpdatePost200Response } from './api';
|
||||
|
||||
const instance: TracksBatchUpdatePost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# TracksBatchUpdatePost200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**failed** | **Array<object>** | | [optional] [default to undefined]
|
||||
**updated** | **Array<string>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksBatchUpdatePost200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksBatchUpdatePost200ResponseAllOfData = {
|
||||
failed,
|
||||
updated,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**AnalyticsEventsPost200ResponseAllOfData**](AnalyticsEventsPost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**data** | [**Auth2faDisablePost200ResponseAllOfData**](Auth2faDisablePost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdHistoryGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksIdHistoryGet200ResponseAllOfData**](TracksIdHistoryGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdHistoryGet200Response } from './api';
|
||||
|
||||
const instance: TracksIdHistoryGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# TracksIdHistoryGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**history** | **Array<object>** | | [optional] [default to undefined]
|
||||
**limit** | **number** | | [optional] [default to undefined]
|
||||
**offset** | **number** | | [optional] [default to undefined]
|
||||
**total** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdHistoryGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksIdHistoryGet200ResponseAllOfData = {
|
||||
history,
|
||||
limit,
|
||||
offset,
|
||||
total,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdLikePost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**Auth2faDisablePost200ResponseAllOfData**](Auth2faDisablePost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdLikePost200Response } from './api';
|
||||
|
||||
const instance: TracksIdLikePost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdLikesGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksIdLikesGet200ResponseAllOfData**](TracksIdLikesGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdLikesGet200Response } from './api';
|
||||
|
||||
const instance: TracksIdLikesGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# TracksIdLikesGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**count** | **number** | | [optional] [default to undefined]
|
||||
**is_liked** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdLikesGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksIdLikesGet200ResponseAllOfData = {
|
||||
count,
|
||||
is_liked,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdLyricsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksIdLyricsGet200ResponseAllOfData**](TracksIdLyricsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdLyricsGet200Response } from './api';
|
||||
|
||||
const instance: TracksIdLyricsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# TracksIdLyricsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**lyrics** | **object** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdLyricsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksIdLyricsGet200ResponseAllOfData = {
|
||||
lyrics,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdPlayPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksIdPlayPost200ResponseAllOfData**](TracksIdPlayPost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdPlayPost200Response } from './api';
|
||||
|
||||
const instance: TracksIdPlayPost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# TracksIdPlayPost200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [optional] [default to undefined]
|
||||
**message** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdPlayPost200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksIdPlayPost200ResponseAllOfData = {
|
||||
id,
|
||||
message,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdRepostGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksIdRepostGet200ResponseAllOfData**](TracksIdRepostGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdRepostGet200Response } from './api';
|
||||
|
||||
const instance: TracksIdRepostGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# TracksIdRepostGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**is_reposted** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdRepostGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksIdRepostGet200ResponseAllOfData = {
|
||||
is_reposted,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdSharePost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**PlaylistsIdSharePost200ResponseAllOfData**](PlaylistsIdSharePost200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdSharePost200Response } from './api';
|
||||
|
||||
const instance: TracksIdSharePost200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksIdStatsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**AuditStatsGet200ResponseAllOfData**](AuditStatsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksIdStatsGet200Response } from './api';
|
||||
|
||||
const instance: TracksIdStatsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksRecommendationsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksRecommendationsGet200ResponseAllOfData**](TracksRecommendationsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksRecommendationsGet200Response } from './api';
|
||||
|
||||
const instance: TracksRecommendationsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# TracksRecommendationsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**tracks** | [**Array<VezaBackendApiInternalModelsTrack>**](VezaBackendApiInternalModelsTrack.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksRecommendationsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksRecommendationsGet200ResponseAllOfData = {
|
||||
tracks,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksSharedTokenGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksSharedTokenGet200ResponseAllOfData**](TracksSharedTokenGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksSharedTokenGet200Response } from './api';
|
||||
|
||||
const instance: TracksSharedTokenGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# TracksSharedTokenGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**share** | **object** | | [optional] [default to undefined]
|
||||
**track** | [**VezaBackendApiInternalModelsTrack**](VezaBackendApiInternalModelsTrack.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksSharedTokenGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksSharedTokenGet200ResponseAllOfData = {
|
||||
share,
|
||||
track,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# TracksSuggestedTagsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**TracksSuggestedTagsGet200ResponseAllOfData**](TracksSuggestedTagsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksSuggestedTagsGet200Response } from './api';
|
||||
|
||||
const instance: TracksSuggestedTagsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# TracksSuggestedTagsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**tags** | **Array<string>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TracksSuggestedTagsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: TracksSuggestedTagsGet200ResponseAllOfData = {
|
||||
tags,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -1,15 +1,23 @@
|
|||
# UserApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**usersByUsernameUsernameGet**](#usersbyusernameusernameget) | **GET** /users/by-username/{username} | Get Profile by Username|
|
||||
|[**usersGet**](#usersget) | **GET** /users | List Users|
|
||||
|[**usersIdBlockDelete**](#usersidblockdelete) | **DELETE** /users/{id}/block | Unblock user|
|
||||
|[**usersIdBlockPost**](#usersidblockpost) | **POST** /users/{id}/block | Block user|
|
||||
|[**usersIdCompletionGet**](#usersidcompletionget) | **GET** /users/{id}/completion | Get Profile Completion|
|
||||
|[**usersIdDelete**](#usersiddelete) | **DELETE** /users/{id} | Delete user|
|
||||
|[**usersIdFollowDelete**](#usersidfollowdelete) | **DELETE** /users/{id}/follow | Unfollow user|
|
||||
|[**usersIdFollowPost**](#usersidfollowpost) | **POST** /users/{id}/follow | Follow user|
|
||||
|[**usersIdGet**](#usersidget) | **GET** /users/{id} | Get Profile by ID|
|
||||
|[**usersIdLikesGet**](#usersidlikesget) | **GET** /users/{id}/likes | List tracks liked by a user|
|
||||
|[**usersIdPut**](#usersidput) | **PUT** /users/{id} | Update Profile|
|
||||
|[**usersIdRepostsGet**](#usersidrepostsget) | **GET** /users/{id}/reposts | List tracks reposted by a user|
|
||||
|[**usersSearchGet**](#userssearchget) | **GET** /users/search | Search users|
|
||||
|[**usersSuggestionsGet**](#userssuggestionsget) | **GET** /users/suggestions | Get follow suggestions|
|
||||
|
||||
# **usersByUsernameUsernameGet**
|
||||
> UsersIdGet200Response usersByUsernameUsernameGet()
|
||||
|
|
@ -137,6 +145,114 @@ No authorization required
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdBlockDelete**
|
||||
> Auth2faDisablePost200Response usersIdBlockDelete()
|
||||
|
||||
Authenticated user unblocks target user (idempotent).
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //Target user UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdBlockDelete(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Target user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Auth2faDisablePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdBlockPost**
|
||||
> Auth2faDisablePost200Response usersIdBlockPost()
|
||||
|
||||
Authenticated user blocks target user (hides their content, prevents follows). Cannot self-block.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //Target user UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdBlockPost(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Target user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Auth2faDisablePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation / self-block | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdCompletionGet**
|
||||
> AuthMeGet200Response usersIdCompletionGet()
|
||||
|
||||
|
|
@ -246,6 +362,115 @@ const { status, data } = await apiInstance.usersIdDelete(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdFollowDelete**
|
||||
> Auth2faDisablePost200Response usersIdFollowDelete()
|
||||
|
||||
Authenticated user stops following target user (idempotent).
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //Target user UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdFollowDelete(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Target user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Auth2faDisablePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdFollowPost**
|
||||
> Auth2faDisablePost200Response usersIdFollowPost()
|
||||
|
||||
Authenticated user follows target user. Creates a notification (F554 grouped) for the target.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //Target user UUID (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdFollowPost(
|
||||
id
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | Target user UUID | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Auth2faDisablePost200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Invalid id | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**404** | User not found | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdGet**
|
||||
> UsersIdGet200Response usersIdGet()
|
||||
|
||||
|
|
@ -299,6 +524,66 @@ No authorization required
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdLikesGet**
|
||||
> UsersIdLikesGet200Response usersIdLikesGet()
|
||||
|
||||
Returns paginated tracks the given user has liked. Used for profile \"Likes\" tab.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //User UUID (default to undefined)
|
||||
let limit: number; //Items per page (max 100) (optional) (default to 20)
|
||||
let offset: number; //Offset for pagination (optional) (default to 0)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdLikesGet(
|
||||
id,
|
||||
limit,
|
||||
offset
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | User UUID | defaults to undefined|
|
||||
| **limit** | [**number**] | Items per page (max 100) | (optional) defaults to 20|
|
||||
| **offset** | [**number**] | Offset for pagination | (optional) defaults to 0|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**UsersIdLikesGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdPut**
|
||||
> UsersIdGet200Response usersIdPut(profile)
|
||||
|
||||
|
|
@ -357,3 +642,174 @@ const { status, data } = await apiInstance.usersIdPut(
|
|||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersIdRepostsGet**
|
||||
> UsersIdLikesGet200Response usersIdRepostsGet()
|
||||
|
||||
Returns paginated tracks the user has reposted. Used for profile \"Reposts\" tab.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let id: string; //User UUID (default to undefined)
|
||||
let limit: number; //Items per page (max 100) (optional) (default to 20)
|
||||
let offset: number; //Offset for pagination (optional) (default to 0)
|
||||
|
||||
const { status, data } = await apiInstance.usersIdRepostsGet(
|
||||
id,
|
||||
limit,
|
||||
offset
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **id** | [**string**] | User UUID | defaults to undefined|
|
||||
| **limit** | [**number**] | Items per page (max 100) | (optional) defaults to 20|
|
||||
| **offset** | [**number**] | Offset for pagination | (optional) defaults to 0|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**UsersIdLikesGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersSearchGet**
|
||||
> UsersSearchGet200Response usersSearchGet()
|
||||
|
||||
Full-text search on users (username, display_name). Paginated. Public.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let q: string; //Full-text query (optional) (default to undefined)
|
||||
let page: number; //Page (optional) (default to 1)
|
||||
let limit: number; //Items per page (max 100) (optional) (default to 20)
|
||||
|
||||
const { status, data } = await apiInstance.usersSearchGet(
|
||||
q,
|
||||
page,
|
||||
limit
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **q** | [**string**] | Full-text query | (optional) defaults to undefined|
|
||||
| **page** | [**number**] | Page | (optional) defaults to 1|
|
||||
| **limit** | [**number**] | Items per page (max 100) | (optional) defaults to 20|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**UsersSearchGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**400** | Validation (bounds) | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **usersSuggestionsGet**
|
||||
> UsersSuggestionsGet200Response usersSuggestionsGet()
|
||||
|
||||
Returns suggested users to follow for the authenticated user. Declarative discovery — no behavioural scoring (CLAUDE.md rule 7).
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let limit: number; //Max items (max 50) (optional) (default to 10)
|
||||
|
||||
const { status, data } = await apiInstance.usersSuggestionsGet(
|
||||
limit
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **limit** | [**number**] | Max items (max 50) | (optional) defaults to 10|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**UsersSuggestionsGet200Response**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|**401** | Unauthorized | - |
|
||||
|**500** | Internal Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# UsersApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
# UsersIdLikesGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**UsersIdLikesGet200ResponseAllOfData**](UsersIdLikesGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersIdLikesGet200Response } from './api';
|
||||
|
||||
const instance: UsersIdLikesGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# UsersIdLikesGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**limit** | **number** | | [optional] [default to undefined]
|
||||
**offset** | **number** | | [optional] [default to undefined]
|
||||
**total** | **number** | | [optional] [default to undefined]
|
||||
**tracks** | [**Array<VezaBackendApiInternalModelsTrack>**](VezaBackendApiInternalModelsTrack.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersIdLikesGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: UsersIdLikesGet200ResponseAllOfData = {
|
||||
limit,
|
||||
offset,
|
||||
total,
|
||||
tracks,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# UsersSearchGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**UsersSearchGet200ResponseAllOfData**](UsersSearchGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersSearchGet200Response } from './api';
|
||||
|
||||
const instance: UsersSearchGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# UsersSearchGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | **object** | | [optional] [default to undefined]
|
||||
**users** | [**Array<VezaBackendApiInternalModelsUser>**](VezaBackendApiInternalModelsUser.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersSearchGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: UsersSearchGet200ResponseAllOfData = {
|
||||
pagination,
|
||||
users,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# UsersSuggestionsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | [**UsersSuggestionsGet200ResponseAllOfData**](UsersSuggestionsGet200ResponseAllOfData.md) | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersSuggestionsGet200Response } from './api';
|
||||
|
||||
const instance: UsersSuggestionsGet200Response = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# UsersSuggestionsGet200ResponseAllOfData
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**users** | [**Array<VezaBackendApiInternalModelsUser>**](VezaBackendApiInternalModelsUser.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { UsersSuggestionsGet200ResponseAllOfData } from './api';
|
||||
|
||||
const instance: UsersSuggestionsGet200ResponseAllOfData = {
|
||||
users,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# ValidationApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|||
**payment_intent** | **string** | Legacy / Stripe PaymentIntent ID | [optional] [default to undefined]
|
||||
**payment_status** | **string** | Hyperswitch payment status | [optional] [default to undefined]
|
||||
**promo_code_id** | **string** | | [optional] [default to undefined]
|
||||
**refund_deadline** | **string** | v0.12.0: 14-day refund deadline | [optional] [default to undefined]
|
||||
**status** | **string** | pending, completed, failed, refunded | [optional] [default to undefined]
|
||||
**total_amount** | **number** | | [optional] [default to undefined]
|
||||
**updated_at** | **string** | | [optional] [default to undefined]
|
||||
|
|
@ -35,6 +36,7 @@ const instance: VezaBackendApiInternalCoreMarketplaceOrder = {
|
|||
payment_intent,
|
||||
payment_status,
|
||||
promo_code_id,
|
||||
refund_deadline,
|
||||
status,
|
||||
total_amount,
|
||||
updated_at,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
# VezaBackendApiInternalHandlersAPIResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | **object** | | [optional] [default to undefined]
|
||||
**error** | **object** | | [optional] [default to undefined]
|
||||
**success** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { VezaBackendApiInternalHandlersAPIResponse } from './api';
|
||||
|
||||
const instance: VezaBackendApiInternalHandlersAPIResponse = {
|
||||
data,
|
||||
error,
|
||||
success,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
|
@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|||
**description** | **string** | | [optional] [default to undefined]
|
||||
**follower_count** | **number** | | [optional] [default to undefined]
|
||||
**id** | **string** | | [optional] [default to undefined]
|
||||
**is_default_favorites** | **boolean** | v0.10.4 F136 | [optional] [default to undefined]
|
||||
**is_editorial** | **boolean** | v0.10.4 F141 | [optional] [default to undefined]
|
||||
**is_public** | **boolean** | | [optional] [default to undefined]
|
||||
**title** | **string** | | [optional] [default to undefined]
|
||||
**track_count** | **number** | | [optional] [default to undefined]
|
||||
|
|
@ -30,6 +32,8 @@ const instance: VezaBackendApiInternalModelsPlaylist = {
|
|||
description,
|
||||
follower_count,
|
||||
id,
|
||||
is_default_favorites,
|
||||
is_editorial,
|
||||
is_public,
|
||||
title,
|
||||
track_count,
|
||||
|
|
|
|||
|
|
@ -20,9 +20,7 @@ Name | Type | Description | Notes
|
|||
**genre** | **string** | | [optional] [default to undefined]
|
||||
**id** | **string** | | [optional] [default to undefined]
|
||||
**is_public** | **boolean** | | [optional] [default to undefined]
|
||||
**like_count** | **number** | | [optional] [default to undefined]
|
||||
**musical_key** | **string** | | [optional] [default to undefined]
|
||||
**play_count** | **number** | | [optional] [default to undefined]
|
||||
**sample_rate** | **number** | Hz | [optional] [default to undefined]
|
||||
**status** | [**VezaBackendApiInternalModelsTrackStatus**](VezaBackendApiInternalModelsTrackStatus.md) | | [optional] [default to undefined]
|
||||
**status_message** | **string** | | [optional] [default to undefined]
|
||||
|
|
@ -56,9 +54,7 @@ const instance: VezaBackendApiInternalModelsTrack = {
|
|||
genre,
|
||||
id,
|
||||
is_public,
|
||||
like_count,
|
||||
musical_key,
|
||||
play_count,
|
||||
sample_rate,
|
||||
status,
|
||||
status_message,
|
||||
|
|
|
|||
|
|
@ -24,6 +24,8 @@ Name | Type | Description | Notes
|
|||
**location** | **string** | | [optional] [default to undefined]
|
||||
**login_count** | **number** | | [optional] [default to undefined]
|
||||
**password** | **string** | Virtual field for input | [optional] [default to undefined]
|
||||
**password_changed_at** | **string** | F016: Password expiration tracking | [optional] [default to undefined]
|
||||
**promoted_to_creator_at** | **string** | v1.0.6: set the first time a user self-promotes to `role=\'creator\'` via POST /api/v1/users/me/upgrade-creator. NULL for users who never took that path (still \'user\', or promoted by an admin out-of-band). | [optional] [default to undefined]
|
||||
**role** | **string** | | [optional] [default to undefined]
|
||||
**slug** | **string** | | [optional] [default to undefined]
|
||||
**social_links** | **string** | | [optional] [default to undefined]
|
||||
|
|
@ -57,6 +59,8 @@ const instance: VezaBackendApiInternalModelsUser = {
|
|||
location,
|
||||
login_count,
|
||||
password,
|
||||
password_changed_at,
|
||||
promoted_to_creator_at,
|
||||
role,
|
||||
slug,
|
||||
social_links,
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# WebhookApi
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
All URIs are relative to *http://localhost:18080/api/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
// Auto-generated types from OpenAPI specification
|
||||
// Do not edit this file manually - it will be overwritten
|
||||
// DEPRECATED v1.0.8 P3 — migrate consumers to src/services/generated/ (orval).
|
||||
|
||||
export * from './api';
|
||||
export * from './base';
|
||||
|
|
|
|||
Loading…
Reference in a new issue