Commit 5e9d302a authored by Rigel Kent's avatar Rigel Kent
Browse files

Minor update kotlin

parent fa61f962
This diff is collapsed.
# AccountSummary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**name** | **kotlin.String** | | [optional]
**displayName** | **kotlin.String** | | [optional]
**url** | **kotlin.String** | | [optional]
**host** | **kotlin.String** | | [optional]
**avatar** | [**Avatar**](Avatar.md) | | [optional]
......@@ -4,16 +4,18 @@ All URIs are relative to *https://peertube.cpy.re/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**accountsGet**](AccountsApi.md#accountsGet) | **GET** /accounts | Get all accounts
[**accountsNameGet**](AccountsApi.md#accountsNameGet) | **GET** /accounts/{name} | Get the account by name
[**accountsNameVideosGet**](AccountsApi.md#accountsNameVideosGet) | **GET** /accounts/{name}/videos | Get videos for an account, provided the name of that account
[**accountsGet**](AccountsApi.md#accountsGet) | **GET** /accounts | List accounts
[**accountsNameGet**](AccountsApi.md#accountsNameGet) | **GET** /accounts/{name} | Get an account
[**accountsNameRatingsGet**](AccountsApi.md#accountsNameRatingsGet) | **GET** /accounts/{name}/ratings | List ratings of an account
[**accountsNameVideoChannelsGet**](AccountsApi.md#accountsNameVideoChannelsGet) | **GET** /accounts/{name}/video-channels | List video channels of an account
[**accountsNameVideosGet**](AccountsApi.md#accountsNameVideosGet) | **GET** /accounts/{name}/videos | List videos of an account
<a name="accountsGet"></a>
# **accountsGet**
> kotlin.Array&lt;Account&gt; accountsGet(start, count, sort)
Get all accounts
List accounts
### Example
```kotlin
......@@ -62,7 +64,7 @@ No authorization required
# **accountsNameGet**
> Account accountsNameGet(name)
Get the account by name
Get an account
### Example
```kotlin
......@@ -98,6 +100,106 @@ Name | Type | Description | Notes
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="accountsNameRatingsGet"></a>
# **accountsNameRatingsGet**
> kotlin.Array&lt;VideoRating&gt; accountsNameRatingsGet(name, start, count, sort, rating)
List ratings of an account
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//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
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)
println(result)
} catch (e: ClientException) {
println("4xx response calling AccountsApi#accountsNameRatingsGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AccountsApi#accountsNameRatingsGet")
e.printStackTrace()
}
```
### Parameters
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 | [optional]
**sort** | **kotlin.String**| Sort column (-createdAt for example) | [optional]
**rating** | **kotlin.String**| Optionally filter which ratings to retrieve | [optional] [enum: like, dislike]
### Return type
[**kotlin.Array&lt;VideoRating&gt;**](VideoRating.md)
### Authorization
Configure OAuth2:
ApiClient.accessToken = ""
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="accountsNameVideoChannelsGet"></a>
# **accountsNameVideoChannelsGet**
> kotlin.Array&lt;VideoChannel&gt; accountsNameVideoChannelsGet(name)
List video channels of an account
### Example
```kotlin
// Import classes:
//import org.peertube.client.infrastructure.*
//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)
try {
val result : kotlin.Array<VideoChannel> = apiInstance.accountsNameVideoChannelsGet(name)
println(result)
} catch (e: ClientException) {
println("4xx response calling AccountsApi#accountsNameVideoChannelsGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AccountsApi#accountsNameVideoChannelsGet")
e.printStackTrace()
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **kotlin.String**| The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example) |
### Return type
[**kotlin.Array&lt;VideoChannel&gt;**](VideoChannel.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
......@@ -105,9 +207,9 @@ No authorization required
<a name="accountsNameVideosGet"></a>
# **accountsNameVideosGet**
> VideoListResponse accountsNameVideosGet(name)
> VideoListResponse accountsNameVideosGet(name, categoryOneOf, tagsOneOf, tagsAllOf, licenceOneOf, languageOneOf, nsfw, filter, skipCount, start, count, sort)
Get videos for an account, provided the name of that account
List videos of an account
### Example
```kotlin
......@@ -117,8 +219,19 @@ Get videos for an account, provided the name of that account
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 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 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
val sort : kotlin.String = sort_example // kotlin.String | Sort videos by criteria
try {
val result : VideoListResponse = apiInstance.accountsNameVideosGet(name)
val result : VideoListResponse = apiInstance.accountsNameVideosGet(name, categoryOneOf, tagsOneOf, tagsAllOf, licenceOneOf, languageOneOf, nsfw, filter, skipCount, start, count, sort)
println(result)
} catch (e: ClientException) {
println("4xx response calling AccountsApi#accountsNameVideosGet")
......@@ -134,6 +247,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]
**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]
**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 | [optional]
**sort** | **kotlin.String**| Sort videos by criteria | [optional] [enum: -name, -duration, -createdAt, -publishedAt, -views, -likes, -trending]
### Return type
......
......@@ -9,14 +9,7 @@ Name | Type | Description | Notes
**email** | **kotlin.String** | The user email |
**videoQuota** | **kotlin.String** | The user videoQuota |
**videoQuotaDaily** | **kotlin.String** | The user daily video quota |
**role** | [**inline**](#RoleEnum) | The user role (Admin &#x3D; 0, Moderator &#x3D; 1, User &#x3D; 2) |
<a name="RoleEnum"></a>
## Enum: role
Name | Value
---- | -----
role | 0, 1, 2
**role** | [**UserRole**](UserRole.md) | |
......@@ -4,18 +4,18 @@ All URIs are relative to *https://peertube.cpy.re/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**configAboutGet**](ConfigApi.md#configAboutGet) | **GET** /config/about | Get the instance about page content
[**configCustomDelete**](ConfigApi.md#configCustomDelete) | **DELETE** /config/custom | Delete the runtime configuration of the server
[**configCustomGet**](ConfigApi.md#configCustomGet) | **GET** /config/custom | Get the runtime configuration of the server
[**configCustomPut**](ConfigApi.md#configCustomPut) | **PUT** /config/custom | Set the runtime configuration of the server
[**configGet**](ConfigApi.md#configGet) | **GET** /config | Get the public configuration of the server
[**configAboutGet**](ConfigApi.md#configAboutGet) | **GET** /config/about | Get instance \&quot;About\&quot; information
[**configCustomDelete**](ConfigApi.md#configCustomDelete) | **DELETE** /config/custom | Delete instance runtime configuration
[**configCustomGet**](ConfigApi.md#configCustomGet) | **GET** /config/custom | Get instance runtime configuration
[**configCustomPut**](ConfigApi.md#configCustomPut) | **PUT** /config/custom | Set instance runtime configuration
[**configGet**](ConfigApi.md#configGet) | **GET** /config | Get instance public configuration
<a name="configAboutGet"></a>
# **configAboutGet**
> ServerConfigAbout configAboutGet()
Get the instance about page content
Get instance \&quot;About\&quot; information
### Example
```kotlin
......@@ -56,7 +56,7 @@ No authorization required
# **configCustomDelete**
> configCustomDelete()
Delete the runtime configuration of the server
Delete instance runtime configuration
### Example
```kotlin
......@@ -98,7 +98,7 @@ Configure OAuth2:
# **configCustomGet**
> ServerConfigCustom configCustomGet()
Get the runtime configuration of the server
Get instance runtime configuration
### Example
```kotlin
......@@ -141,7 +141,7 @@ Configure OAuth2:
# **configCustomPut**
> configCustomPut()
Set the runtime configuration of the server
Set instance runtime configuration
### Example
```kotlin
......@@ -183,7 +183,7 @@ Configure OAuth2:
# **configGet**
> ServerConfig configGet()
Get the public configuration of the server
Get instance public configuration
### Example
```kotlin
......
......@@ -4,20 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**thumbnailfile** | [**java.io.File**](java.io.File.md) | Video thumbnail file | [optional]
**previewfile** | [**java.io.File**](java.io.File.md) | Video preview file | [optional]
**category** | **kotlin.String** | Video category | [optional]
**licence** | **kotlin.String** | Video licence | [optional]
**language** | **kotlin.String** | Video language | [optional]
**description** | **kotlin.String** | Video description | [optional]
**waitTranscoding** | **kotlin.String** | Whether or not we wait transcoding before publish the video | [optional]
**support** | **kotlin.String** | Text describing how to support the video uploader | [optional]
**nsfw** | **kotlin.String** | Whether or not this video contains sensitive content | [optional]
**name** | **kotlin.String** | Video name | [optional]
**tags** | **kotlin.Array&lt;kotlin.String&gt;** | Video tags (maximum 5 tags each between 2 and 30 characters) | [optional]
**commentsEnabled** | **kotlin.String** | Enable or disable comments for this video | [optional]
**originallyPublishedAt** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date when the content was originally published | [optional]
**scheduleUpdate** | [**VideoScheduledUpdate**](VideoScheduledUpdate.md) | | [optional]
**username** | **kotlin.String** | |
# InlineObject10
## 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]
# InlineObject11
## 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]
# InlineObject12
## 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]
# InlineObject13
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **kotlin.String** | Text comment |
# InlineObject14
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **kotlin.String** | Text comment |
......@@ -4,7 +4,21 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **kotlin.String** | |
**thumbnailfile** | [**java.io.File**](java.io.File.md) | Video thumbnail file | [optional]
**previewfile** | [**java.io.File**](java.io.File.md) | Video preview file | [optional]
**category** | **kotlin.String** | Video category | [optional]
**licence** | **kotlin.String** | Video licence | [optional]
**language** | **kotlin.String** | Video language | [optional]
**privacy** | [**VideoPrivacySet**](VideoPrivacySet.md) | | [optional]
**description** | **kotlin.String** | Video description | [optional]
**waitTranscoding** | **kotlin.String** | Whether or not we wait transcoding before publish the video | [optional]
**support** | **kotlin.String** | Text describing how to support the video uploader | [optional]
**nsfw** | **kotlin.String** | Whether or not this video contains sensitive content | [optional]
**name** | **kotlin.String** | Video name | [optional]
**tags** | **kotlin.Array&lt;kotlin.String&gt;** | Video tags (maximum 5 tags each between 2 and 30 characters) | [optional]
**commentsEnabled** | **kotlin.String** | Enable or disable comments for this video | [optional]
**originallyPublishedAt** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date when the content was originally published | [optional]
**scheduleUpdate** | [**VideoScheduledUpdate**](VideoScheduledUpdate.md) | | [optional]
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**captionfile** | [**java.io.File**](java.io.File.md) | The file to upload. | [optional]
**reason** | **kotlin.String** | Reason why the user reports this video | [optional]
# InlineObject6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | [**VideoAbuseStateSet**](VideoAbuseStateSet.md) | | [optional]
**moderationComment** | **kotlin.String** | Update the comment of the video abuse for other admin/moderators | [optional]
# InlineObject7
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**captionfile** | [**java.io.File**](java.io.File.md) | The file to upload. | [optional]
# InlineObject8
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**displayName** | **kotlin.String** | Video playlist display name |
**thumbnailfile** | [**java.io.File**](java.io.File.md) | Video playlist thumbnail file | [optional]
**privacy** | [**VideoPlaylistPrivacySet**](VideoPlaylistPrivacySet.md) | | [optional]
**description** | **kotlin.String** | Video playlist description | [optional]
**videoChannelId** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Video channel in which the playlist will be published | [optional]
# InlineObject9
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**displayName** | **kotlin.String** | Video playlist display name | [optional]
**thumbnailfile** | [**java.io.File**](java.io.File.md) | Video playlist thumbnail file | [optional]
**privacy** | [**VideoPlaylistPrivacySet**](VideoPlaylistPrivacySet.md) | | [optional]
**description** | **kotlin.String** | Video playlist description | [optional]
**videoChannelId** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Video channel in which the playlist will be published | [optional]
# InlineResponse2001
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**videoPlaylist** | [**InlineResponse2001VideoPlaylist**](InlineResponse2001VideoPlaylist.md) | | [optional]
# InlineResponse2001VideoPlaylist
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | [optional]
**uuid** | **kotlin.String** | | [optional]
# InlineResponse2002
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**videoPlaylistElement** | [**InlineResponse2002VideoPlaylistElement**](InlineResponse2002VideoPlaylistElement.md) | | [optional]
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment