Commit ac91e581 authored by Rigel Kent's avatar Rigel Kent
Browse files

Minor update kotlin

parent d945f2ac
......@@ -30,6 +30,9 @@ All URIs are relative to *https://peertube.cpy.re/api/v1*. Change it when instan
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountBlocksApi* | [**blocklistAccountsAccountNameDelete**](docs/AccountBlocksApi.md#blocklistaccountsaccountnamedelete) | **DELETE** /blocklist/accounts/{accountName} | Unblock an account by its handle
*AccountBlocksApi* | [**blocklistAccountsGet**](docs/AccountBlocksApi.md#blocklistaccountsget) | **GET** /blocklist/accounts | List account blocks
*AccountBlocksApi* | [**blocklistAccountsPost**](docs/AccountBlocksApi.md#blocklistaccountspost) | **POST** /blocklist/accounts | Block an account
*AccountsApi* | [**accountsGet**](docs/AccountsApi.md#accountsget) | **GET** /accounts | List accounts
*AccountsApi* | [**accountsNameGet**](docs/AccountsApi.md#accountsnameget) | **GET** /accounts/{name} | Get an account
*AccountsApi* | [**accountsNameRatingsGet**](docs/AccountsApi.md#accountsnameratingsget) | **GET** /accounts/{name}/ratings | List ratings of an account
......@@ -40,6 +43,8 @@ Class | Method | HTTP request | Description
*ConfigApi* | [**configCustomGet**](docs/ConfigApi.md#configcustomget) | **GET** /config/custom | Get instance runtime configuration
*ConfigApi* | [**configCustomPut**](docs/ConfigApi.md#configcustomput) | **PUT** /config/custom | Set instance runtime configuration
*ConfigApi* | [**configGet**](docs/ConfigApi.md#configget) | **GET** /config | Get instance public configuration
*FeedsApi* | [**feedsVideoCommentsFormatGet**](docs/FeedsApi.md#feedsvideocommentsformatget) | **GET** /feeds/video-comments.{format} | List comments on videos
*FeedsApi* | [**feedsVideosFormatGet**](docs/FeedsApi.md#feedsvideosformatget) | **GET** /feeds/videos.{format} | List videos
*InstanceFollowsApi* | [**serverFollowersGet**](docs/InstanceFollowsApi.md#serverfollowersget) | **GET** /server/followers | List instance followers
*InstanceFollowsApi* | [**serverFollowingGet**](docs/InstanceFollowsApi.md#serverfollowingget) | **GET** /server/following | List instance followings
*InstanceFollowsApi* | [**serverFollowingHostDelete**](docs/InstanceFollowsApi.md#serverfollowinghostdelete) | **DELETE** /server/following/{host} | Unfollow a server
......@@ -60,6 +65,9 @@ Class | Method | HTTP request | Description
*MyUserApi* | [**usersMeVideosVideoIdRatingGet**](docs/MyUserApi.md#usersmevideosvideoidratingget) | **GET** /users/me/videos/{videoId}/rating | Get rate of my user for a video
*SearchApi* | [**searchVideoChannelsGet**](docs/SearchApi.md#searchvideochannelsget) | **GET** /search/video-channels | Search channels
*SearchApi* | [**searchVideosGet**](docs/SearchApi.md#searchvideosget) | **GET** /search/videos | Search videos
*ServerBlocksApi* | [**blocklistServersGet**](docs/ServerBlocksApi.md#blocklistserversget) | **GET** /blocklist/servers | List server blocks
*ServerBlocksApi* | [**blocklistServersHostDelete**](docs/ServerBlocksApi.md#blocklistservershostdelete) | **DELETE** /blocklist/servers/{host} | Unblock a server by its domain
*ServerBlocksApi* | [**blocklistServersPost**](docs/ServerBlocksApi.md#blocklistserverspost) | **POST** /blocklist/servers | Block a server
*UsersApi* | [**usersGet**](docs/UsersApi.md#usersget) | **GET** /users | List users
*UsersApi* | [**usersIdDelete**](docs/UsersApi.md#usersiddelete) | **DELETE** /users/{id} | Delete a user
*UsersApi* | [**usersIdGet**](docs/UsersApi.md#usersidget) | **GET** /users/{id} | Get a user
......@@ -85,9 +93,9 @@ Class | Method | HTTP request | Description
*VideoAbusesApi* | [**videosIdAbuseAbuseIdDelete**](docs/VideoAbusesApi.md#videosidabuseabuseiddelete) | **DELETE** /videos/{id}/abuse/{abuseId} | Delete an abuse
*VideoAbusesApi* | [**videosIdAbuseAbuseIdPut**](docs/VideoAbusesApi.md#videosidabuseabuseidput) | **PUT** /videos/{id}/abuse/{abuseId} | Update an abuse
*VideoAbusesApi* | [**videosIdAbusePost**](docs/VideoAbusesApi.md#videosidabusepost) | **POST** /videos/{id}/abuse | Report an abuse
*VideoBlacklistApi* | [**videosBlacklistGet**](docs/VideoBlacklistApi.md#videosblacklistget) | **GET** /videos/blacklist | List blacklisted videos
*VideoBlacklistApi* | [**videosIdBlacklistDelete**](docs/VideoBlacklistApi.md#videosidblacklistdelete) | **DELETE** /videos/{id}/blacklist | Delete an entry of the blacklist of a video by its id
*VideoBlacklistApi* | [**videosIdBlacklistPost**](docs/VideoBlacklistApi.md#videosidblacklistpost) | **POST** /videos/{id}/blacklist | Blacklist a video
*VideoBlocksApi* | [**videosBlacklistGet**](docs/VideoBlocksApi.md#videosblacklistget) | **GET** /videos/blacklist | List blocked videos
*VideoBlocksApi* | [**videosIdBlacklistDelete**](docs/VideoBlocksApi.md#videosidblacklistdelete) | **DELETE** /videos/{id}/blacklist | Unblock a video by its id
*VideoBlocksApi* | [**videosIdBlacklistPost**](docs/VideoBlocksApi.md#videosidblacklistpost) | **POST** /videos/{id}/blacklist | Block a video
*VideoCaptionApi* | [**videosIdCaptionsCaptionLanguageDelete**](docs/VideoCaptionApi.md#videosidcaptionscaptionlanguagedelete) | **DELETE** /videos/{id}/captions/{captionLanguage} | Delete a video caption
*VideoCaptionApi* | [**videosIdCaptionsCaptionLanguagePut**](docs/VideoCaptionApi.md#videosidcaptionscaptionlanguageput) | **PUT** /videos/{id}/captions/{captionLanguage} | Add or replace a video caption
*VideoCaptionApi* | [**videosIdCaptionsGet**](docs/VideoCaptionApi.md#videosidcaptionsget) | **GET** /videos/{id}/captions | List captions of a video
......@@ -150,6 +158,8 @@ Class | Method | HTTP request | Description
- [org.peertube.client.models.InlineObject12](docs/InlineObject12.md)
- [org.peertube.client.models.InlineObject13](docs/InlineObject13.md)
- [org.peertube.client.models.InlineObject14](docs/InlineObject14.md)
- [org.peertube.client.models.InlineObject15](docs/InlineObject15.md)
- [org.peertube.client.models.InlineObject16](docs/InlineObject16.md)
- [org.peertube.client.models.InlineObject2](docs/InlineObject2.md)
- [org.peertube.client.models.InlineObject3](docs/InlineObject3.md)
- [org.peertube.client.models.InlineObject4](docs/InlineObject4.md)
......@@ -166,6 +176,8 @@ Class | Method | HTTP request | Description
- [org.peertube.client.models.InlineResponse2003](docs/InlineResponse2003.md)
- [org.peertube.client.models.InlineResponse2003VideoId](docs/InlineResponse2003VideoId.md)
- [org.peertube.client.models.Job](docs/Job.md)
- [org.peertube.client.models.MRSSGroupContent](docs/MRSSGroupContent.md)
- [org.peertube.client.models.MRSSPeerLink](docs/MRSSPeerLink.md)
- [org.peertube.client.models.NSFWPolicy](docs/NSFWPolicy.md)
- [org.peertube.client.models.PlaylistElement](docs/PlaylistElement.md)
- [org.peertube.client.models.RegisterUser](docs/RegisterUser.md)
......
......@@ -4,12 +4,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**id** | **kotlin.Int** | | [optional]
**url** | **kotlin.String** | | [optional]
**name** | **kotlin.String** | | [optional]
**host** | **kotlin.String** | | [optional]
**followingCount** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**followersCount** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**followingCount** | **kotlin.Int** | | [optional]
**followersCount** | **kotlin.Int** | | [optional]
**createdAt** | **kotlin.String** | | [optional]
**updatedAt** | **kotlin.String** | | [optional]
**avatar** | [**Avatar**](Avatar.md) | | [optional]
......
# AccountBlocksApi
All URIs are relative to *https://peertube.cpy.re/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**blocklistAccountsAccountNameDelete**](AccountBlocksApi.md#blocklistAccountsAccountNameDelete) | **DELETE** /blocklist/accounts/{accountName} | Unblock an account by its handle
[**blocklistAccountsGet**](AccountBlocksApi.md#blocklistAccountsGet) | **GET** /blocklist/accounts | List account blocks
[**blocklistAccountsPost**](AccountBlocksApi.md#blocklistAccountsPost) | **POST** /blocklist/accounts | Block an account
<a name="blocklistAccountsAccountNameDelete"></a>
# **blocklistAccountsAccountNameDelete**
> blocklistAccountsAccountNameDelete(accountName)
Unblock an account by its handle
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//import org.peertube.client.models.*
val apiInstance = AccountBlocksApi()
val accountName : kotlin.String = accountName_example // kotlin.String | account to unblock, in the form `username@domain`
try {
apiInstance.blocklistAccountsAccountNameDelete(accountName)
} catch (e: ClientException) {
println("4xx response calling AccountBlocksApi#blocklistAccountsAccountNameDelete")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AccountBlocksApi#blocklistAccountsAccountNameDelete")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**accountName** | **kotlin.String**| account to unblock, in the form &#x60;username@domain&#x60; |
### Return type
null (empty response body)
### Authorization
Configure OAuth2:
ApiClient.accessToken = ""
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="blocklistAccountsGet"></a>
# **blocklistAccountsGet**
> blocklistAccountsGet(start, count, sort)
List account blocks
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//import org.peertube.client.models.*
val apiInstance = AccountBlocksApi()
val start : kotlin.Int = 56 // kotlin.Int | Offset used to paginate results
val count : kotlin.Int = 56 // kotlin.Int | Number of items to return
val sort : kotlin.String = sort_example // kotlin.String | Sort column (`-createdAt` for example)
try {
apiInstance.blocklistAccountsGet(start, count, sort)
} catch (e: ClientException) {
println("4xx response calling AccountBlocksApi#blocklistAccountsGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AccountBlocksApi#blocklistAccountsGet")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start** | **kotlin.Int**| Offset used to paginate results | [optional]
**count** | **kotlin.Int**| Number of items to return | [optional]
**sort** | **kotlin.String**| Sort column (&#x60;-createdAt&#x60; for example) | [optional]
### Return type
null (empty response body)
### Authorization
Configure OAuth2:
ApiClient.accessToken = ""
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="blocklistAccountsPost"></a>
# **blocklistAccountsPost**
> blocklistAccountsPost(inlineObject15)
Block an account
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//import org.peertube.client.models.*
val apiInstance = AccountBlocksApi()
val inlineObject15 : InlineObject15 = // InlineObject15 |
try {
apiInstance.blocklistAccountsPost(inlineObject15)
} catch (e: ClientException) {
println("4xx response calling AccountBlocksApi#blocklistAccountsPost")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AccountBlocksApi#blocklistAccountsPost")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**inlineObject15** | [**InlineObject15**](InlineObject15.md)| | [optional]
### Return type
null (empty response body)
### Authorization
Configure OAuth2:
ApiClient.accessToken = ""
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**id** | **kotlin.Int** | | [optional]
**name** | **kotlin.String** | | [optional]
**displayName** | **kotlin.String** | | [optional]
**url** | **kotlin.String** | | [optional]
......
......@@ -24,9 +24,9 @@ List accounts
//import org.peertube.client.models.*
val apiInstance = AccountsApi()
val start : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Offset
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Number of items (max: 100)
val sort : kotlin.String = sort_example // kotlin.String | Sort column (-createdAt for example)
val start : kotlin.Int = 56 // kotlin.Int | Offset used to paginate results
val count : kotlin.Int = 56 // kotlin.Int | Number of items to return
val sort : kotlin.String = sort_example // kotlin.String | Sort column (`-createdAt` for example)
try {
val result : kotlin.Array<Account> = apiInstance.accountsGet(start, count, sort)
println(result)
......@@ -43,9 +43,9 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start** | **java.math.BigDecimal**| Offset | [optional]
**count** | **java.math.BigDecimal**| Number of items (max: 100) | [optional]
**sort** | **kotlin.String**| Sort column (-createdAt for example) | [optional]
**start** | **kotlin.Int**| Offset used to paginate results | [optional]
**count** | **kotlin.Int**| Number of items to return | [optional]
**sort** | **kotlin.String**| Sort column (&#x60;-createdAt&#x60; for example) | [optional]
### Return type
......@@ -73,7 +73,7 @@ Get an account
//import org.peertube.client.models.*
val apiInstance = AccountsApi()
val name : kotlin.String = name_example // kotlin.String | The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)
val name : kotlin.String = name_example // kotlin.String | The name of the account (`chocobozzz` or `chocobozzz@example.org` for example)
try {
val result : Account = apiInstance.accountsNameGet(name)
println(result)
......@@ -90,7 +90,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **kotlin.String**| The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example) |
**name** | **kotlin.String**| The name of the account (&#x60;chocobozzz&#x60; or &#x60;chocobozzz@example.org&#x60; for example) |
### Return type
......@@ -118,10 +118,10 @@ List ratings of an account
//import org.peertube.client.models.*
val apiInstance = AccountsApi()
val name : kotlin.String = name_example // kotlin.String | The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)
val start : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Offset
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Number of items (max: 100)
val sort : kotlin.String = sort_example // kotlin.String | Sort column (-createdAt for example)
val name : kotlin.String = name_example // kotlin.String | The name of the account (`chocobozzz` or `chocobozzz@example.org` for example)
val start : kotlin.Int = 56 // kotlin.Int | Offset used to paginate results
val count : kotlin.Int = 56 // kotlin.Int | Number of items to return
val sort : kotlin.String = sort_example // kotlin.String | Sort column (`-createdAt` for example)
val rating : kotlin.String = rating_example // kotlin.String | Optionally filter which ratings to retrieve
try {
val result : kotlin.Array<VideoRating> = apiInstance.accountsNameRatingsGet(name, start, count, sort, rating)
......@@ -139,10 +139,10 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **kotlin.String**| The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example) |
**start** | **java.math.BigDecimal**| Offset | [optional]
**count** | **java.math.BigDecimal**| Number of items (max: 100) | [optional]
**sort** | **kotlin.String**| Sort column (-createdAt for example) | [optional]
**name** | **kotlin.String**| The name of the account (&#x60;chocobozzz&#x60; or &#x60;chocobozzz@example.org&#x60; for example) |
**start** | **kotlin.Int**| Offset used to paginate results | [optional]
**count** | **kotlin.Int**| Number of items to return | [optional]
**sort** | **kotlin.String**| Sort column (&#x60;-createdAt&#x60; for example) | [optional]
**rating** | **kotlin.String**| Optionally filter which ratings to retrieve | [optional] [enum: like, dislike]
### Return type
......@@ -173,7 +173,7 @@ List video channels of an account
//import org.peertube.client.models.*
val apiInstance = AccountsApi()
val name : kotlin.String = name_example // kotlin.String | The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)
val name : kotlin.String = name_example // kotlin.String | The name of the account (`chocobozzz` or `chocobozzz@example.org` for example)
try {
val result : kotlin.Array<VideoChannel> = apiInstance.accountsNameVideoChannelsGet(name)
println(result)
......@@ -190,7 +190,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **kotlin.String**| The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example) |
**name** | **kotlin.String**| The name of the account (&#x60;chocobozzz&#x60; or &#x60;chocobozzz@example.org&#x60; for example) |
### Return type
......@@ -218,17 +218,17 @@ List videos of an account
//import org.peertube.client.models.*
val apiInstance = AccountsApi()
val name : kotlin.String = name_example // kotlin.String | The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)
val categoryOneOf : OneOfLessThanNumberCommaArrayGreaterThan = // OneOfLessThanNumberCommaArrayGreaterThan | category id of the video (see /videos/categories)
val name : kotlin.String = name_example // kotlin.String | The name of the account (`chocobozzz` or `chocobozzz@example.org` for example)
val categoryOneOf : OneOfLessThanIntegerCommaArrayGreaterThan = // OneOfLessThanIntegerCommaArrayGreaterThan | category id of the video (see /videos/categories)
val tagsOneOf : OneOfLessThanStringCommaArrayGreaterThan = // OneOfLessThanStringCommaArrayGreaterThan | tag(s) of the video
val tagsAllOf : OneOfLessThanStringCommaArrayGreaterThan = // OneOfLessThanStringCommaArrayGreaterThan | tag(s) of the video, where all should be present in the video
val licenceOneOf : OneOfLessThanNumberCommaArrayGreaterThan = // OneOfLessThanNumberCommaArrayGreaterThan | licence id of the video (see /videos/licences)
val languageOneOf : OneOfLessThanStringCommaArrayGreaterThan = // OneOfLessThanStringCommaArrayGreaterThan | language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language
val licenceOneOf : OneOfLessThanIntegerCommaArrayGreaterThan = // OneOfLessThanIntegerCommaArrayGreaterThan | licence id of the video (see /videos/licences)
val languageOneOf : OneOfLessThanStringCommaArrayGreaterThan = // OneOfLessThanStringCommaArrayGreaterThan | language id of the video (see /videos/languages). Use `_unknown` to filter on videos that don't have a video language
val nsfw : kotlin.String = nsfw_example // kotlin.String | whether to include nsfw videos, if any
val filter : kotlin.String = filter_example // kotlin.String | Special filters (local for instance) which might require special rights: * `local` - only videos local to the instance * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
val skipCount : kotlin.String = skipCount_example // kotlin.String | if you don't need the `total` in the response
val start : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Offset
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Number of items (max: 100)
val start : kotlin.Int = 56 // kotlin.Int | Offset used to paginate results
val count : kotlin.Int = 56 // kotlin.Int | Number of items to return
val sort : kotlin.String = sort_example // kotlin.String | Sort videos by criteria
try {
val result : VideoListResponse = apiInstance.accountsNameVideosGet(name, categoryOneOf, tagsOneOf, tagsAllOf, licenceOneOf, languageOneOf, nsfw, filter, skipCount, start, count, sort)
......@@ -246,17 +246,17 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **kotlin.String**| The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example) |
**categoryOneOf** | [**OneOfLessThanNumberCommaArrayGreaterThan**](.md)| category id of the video (see /videos/categories) | [optional]
**name** | **kotlin.String**| The name of the account (&#x60;chocobozzz&#x60; or &#x60;chocobozzz@example.org&#x60; for example) |
**categoryOneOf** | [**OneOfLessThanIntegerCommaArrayGreaterThan**](.md)| category id of the video (see /videos/categories) | [optional]
**tagsOneOf** | [**OneOfLessThanStringCommaArrayGreaterThan**](.md)| tag(s) of the video | [optional]
**tagsAllOf** | [**OneOfLessThanStringCommaArrayGreaterThan**](.md)| tag(s) of the video, where all should be present in the video | [optional]
**licenceOneOf** | [**OneOfLessThanNumberCommaArrayGreaterThan**](.md)| licence id of the video (see /videos/licences) | [optional]
**languageOneOf** | [**OneOfLessThanStringCommaArrayGreaterThan**](.md)| language id of the video (see /videos/languages). Use _unknown to filter on videos that don&#39;t have a video language | [optional]
**licenceOneOf** | [**OneOfLessThanIntegerCommaArrayGreaterThan**](.md)| licence id of the video (see /videos/licences) | [optional]
**languageOneOf** | [**OneOfLessThanStringCommaArrayGreaterThan**](.md)| language id of the video (see /videos/languages). Use &#x60;_unknown&#x60; to filter on videos that don&#39;t have a video language | [optional]
**nsfw** | **kotlin.String**| whether to include nsfw videos, if any | [optional] [enum: true, false]
**filter** | **kotlin.String**| Special filters (local for instance) which might require special rights: * &#x60;local&#x60; - only videos local to the instance * &#x60;all-local&#x60; - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges) | [optional] [enum: local, all-local]
**skipCount** | **kotlin.String**| if you don&#39;t need the &#x60;total&#x60; in the response | [optional] [enum: true, false]
**start** | **java.math.BigDecimal**| Offset | [optional]
**count** | **java.math.BigDecimal**| Number of items (max: 100) | [optional]
**skipCount** | **kotlin.String**| if you don&#39;t need the &#x60;total&#x60; in the response | [optional] [default to &quot;false&quot;] [enum: true, false]
**start** | **kotlin.Int**| Offset used to paginate results | [optional]
**count** | **kotlin.Int**| Number of items to return | [optional]
**sort** | **kotlin.String**| Sort videos by criteria | [optional] [enum: -name, -duration, -createdAt, -publishedAt, -views, -likes, -trending]
### Return type
......
......@@ -4,12 +4,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**id** | **kotlin.Int** | | [optional]
**url** | **kotlin.String** | | [optional]
**name** | **kotlin.String** | | [optional]
**host** | **kotlin.String** | | [optional]
**followingCount** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**followersCount** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**followingCount** | **kotlin.Int** | | [optional]
**followersCount** | **kotlin.Int** | | [optional]
**createdAt** | **kotlin.String** | | [optional]
**updatedAt** | **kotlin.String** | | [optional]
**avatar** | [**Avatar**](Avatar.md) | | [optional]
......
......@@ -4,11 +4,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **kotlin.String** | The user username |
**password** | **kotlin.String** | The user password. If the smtp server is configured, you can leave empty and an email will be sent |
**email** | **kotlin.String** | The user email |
**videoQuota** | **kotlin.String** | The user videoQuota |
**videoQuotaDaily** | **kotlin.String** | The user daily video quota |
**username** | **kotlin.String** | The user username |
**password** | **kotlin.String** | The user password. If the smtp server is configured, you can leave empty and an email will be sent |
**email** | **kotlin.String** | The user email. MUST be in the format of an email address. |
**videoQuota** | **kotlin.String** | The user video quota |
**videoQuotaDaily** | **kotlin.String** | The user daily video quota |
**role** | [**UserRole**](UserRole.md) | |
......
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**id** | **kotlin.Int** | | [optional]
**uuid** | **kotlin.String** | | [optional]
......
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**total** | **kotlin.Int** | | [optional]
**data** | [**kotlin.Array&lt;VideoComment&gt;**](VideoComment.md) | | [optional]
......
# FeedsApi
All URIs are relative to *https://peertube.cpy.re/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**feedsVideoCommentsFormatGet**](FeedsApi.md#feedsVideoCommentsFormatGet) | **GET** /feeds/video-comments.{format} | List comments on videos
[**feedsVideosFormatGet**](FeedsApi.md#feedsVideosFormatGet) | **GET** /feeds/videos.{format} | List videos
<a name="feedsVideoCommentsFormatGet"></a>
# **feedsVideoCommentsFormatGet**
> kotlin.Array&lt;kotlin.Any&gt; feedsVideoCommentsFormatGet(format, videoId)
List comments on videos
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//import org.peertube.client.models.*
val apiInstance = FeedsApi()
val format : kotlin.String = format_example // kotlin.String | format expected (we focus on making `rss` the most featureful ; it serves Media RSS)
val videoId : kotlin.String = videoId_example // kotlin.String | limit listing to a specific video
try {
val result : kotlin.Array<kotlin.Any> = apiInstance.feedsVideoCommentsFormatGet(format, videoId)
println(result)
} catch (e: ClientException) {
println("4xx response calling FeedsApi#feedsVideoCommentsFormatGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FeedsApi#feedsVideoCommentsFormatGet")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**format** | **kotlin.String**| format expected (we focus on making &#x60;rss&#x60; the most featureful ; it serves Media RSS) | [enum: xml, rss, rss2, atom, atom1, json, json1]
**videoId** | **kotlin.String**| limit listing to a specific video | [optional]
### Return type
[**kotlin.Array&lt;kotlin.Any&gt;**](kotlin.Any.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/rss+xml, text/xml, application/atom+xml, application/json
<a name="feedsVideosFormatGet"></a>
# **feedsVideosFormatGet**
> kotlin.Array&lt;kotlin.Any&gt; feedsVideosFormatGet(format, accountId, accountName, videoChannelId, videoChannelName)
List videos
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//import org.peertube.client.models.*
val apiInstance = FeedsApi()
val format : kotlin.String = format_example // kotlin.String | format expected (we focus on making `rss` the most featureful ; it serves Media RSS)
val accountId : kotlin.String = accountId_example // kotlin.String | limit listing to a specific account
val accountName : kotlin.String = accountName_example // kotlin.String | limit listing to a specific account
val videoChannelId : kotlin.String = videoChannelId_example // kotlin.String | limit listing to a specific video channel
val videoChannelName : kotlin.String = videoChannelName_example // kotlin.String | limit listing to a specific video channel
try {
val result : kotlin.Array<kotlin.Any> = apiInstance.feedsVideosFormatGet(format, accountId, accountName, videoChannelId, videoChannelName)
println(result)
} catch (e: ClientException) {
println("4xx response calling FeedsApi#feedsVideosFormatGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FeedsApi#feedsVideosFormatGet")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**format** | **kotlin.String**| format expected (we focus on making &#x60;rss&#x60; the most featureful ; it serves Media RSS) | [enum: xml, rss, rss2, atom, atom1, json, json1]
**accountId** | **kotlin.String**| limit listing to a specific account | [optional]
**accountName** | **kotlin.String**| limit listing to a specific account | [optional]
**videoChannelId** | **kotlin.String**| limit listing to a specific video channel | [optional]
**videoChannelName** | **kotlin.String**| limit listing to a specific video channel | [optional]
### Return type
[**kotlin.Array&lt;kotlin.Any&gt;**](kotlin.Any.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/rss+xml, text/xml, application/atom+xml, application/json
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**id** | **kotlin.Int** | | [optional]
**follower** | [**Actor**](Actor.md) | | [optional]
**following** | [**Actor**](Actor.md) | | [optional]
**score** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
......
......@@ -4,8 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **kotlin.String** | Id of the video |
**rating** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Rating of the video |
**id** | **kotlin.String** | Id of the video |
**rating** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Rating of the video |
......@@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**videoId** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Video to add in the playlist |
**startTimestamp** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Start the video at this specific timestamp (in seconds) | [optional]
**stopTimestamp** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Stop the video at this specific timestamp (in seconds) | [optional]
**videoId** | **kotlin.Int** | Video to add in the playlist |
**startTimestamp** | **kotlin.Int** | Start the video at this specific timestamp (in seconds) | [optional]
**stopTimestamp** | **kotlin.Int** | Stop the video at this specific timestamp (in seconds) | [optional]
......@@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**startPosition** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Start position of the element to reorder (starts from 1) |
**insertAfterPosition** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | New position for the block to reorder (starts from 0, to add the block before the first element) |
**reorderLength** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | How many element from startPosition to reorder (minimum length is 1) | [optional]
**startPosition** | **kotlin.Int** | Start position of the element to reorder |
**insertAfterPosition** | **kotlin.Int** | New position for the block to reorder, to add the block before the first element |
**reorderLength** | **kotlin.Int** | How many element from &#x60;startPosition&#x60; to reorder | [optional]
......@@ -4,8 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**startTimestamp** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Start the video at this specific timestamp (in seconds) | [optional]
**stopTimestamp** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Stop the video at this specific timestamp (in seconds) | [optional]
**startTimestamp** | **kotlin.Int** | Start the video at this specific timestamp (in seconds) | [optional]
**stopTimestamp** | **kotlin.Int** | Stop the video at this specific timestamp (in seconds) | [optional]
# InlineObject15
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountName** | **kotlin.String** | account to block, in the form &#x60;username@domain&#x60; |