Initial commit
This commit is contained in:
commit
57ec505421
38
.github/workflows/python.yml
vendored
Normal file
38
.github/workflows/python.yml
vendored
Normal file
@ -0,0 +1,38 @@
|
||||
# NOTE: This file is auto generated by OpenAPI Generator.
|
||||
# URL: https://openapi-generator.tech
|
||||
#
|
||||
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
|
||||
|
||||
name: peertube Python package
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install flake8 pytest
|
||||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
||||
if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
|
||||
- name: Lint with flake8
|
||||
run: |
|
||||
# stop the build if there are Python syntax errors or undefined names
|
||||
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
|
||||
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
|
||||
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
||||
- name: Test with pytest
|
||||
run: |
|
||||
pytest
|
||||
66
.gitignore
vendored
Normal file
66
.gitignore
vendored
Normal file
@ -0,0 +1,66 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
venv/
|
||||
.venv/
|
||||
.python-version
|
||||
.pytest_cache
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
#Ipython Notebook
|
||||
.ipynb_checkpoints
|
||||
31
.gitlab-ci.yml
Normal file
31
.gitlab-ci.yml
Normal file
@ -0,0 +1,31 @@
|
||||
# NOTE: This file is auto generated by OpenAPI Generator.
|
||||
# URL: https://openapi-generator.tech
|
||||
#
|
||||
# ref: https://docs.gitlab.com/ee/ci/README.html
|
||||
# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
|
||||
|
||||
stages:
|
||||
- test
|
||||
|
||||
.pytest:
|
||||
stage: test
|
||||
script:
|
||||
- pip install -r requirements.txt
|
||||
- pip install -r test-requirements.txt
|
||||
- pytest --cov=peertube
|
||||
|
||||
pytest-3.7:
|
||||
extends: .pytest
|
||||
image: python:3.7-alpine
|
||||
pytest-3.8:
|
||||
extends: .pytest
|
||||
image: python:3.8-alpine
|
||||
pytest-3.9:
|
||||
extends: .pytest
|
||||
image: python:3.9-alpine
|
||||
pytest-3.10:
|
||||
extends: .pytest
|
||||
image: python:3.10-alpine
|
||||
pytest-3.11:
|
||||
extends: .pytest
|
||||
image: python:3.11-alpine
|
||||
23
.openapi-generator-ignore
Normal file
23
.openapi-generator-ignore
Normal file
@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
1028
.openapi-generator/FILES
Normal file
1028
.openapi-generator/FILES
Normal file
File diff suppressed because it is too large
Load Diff
1
.openapi-generator/VERSION
Normal file
1
.openapi-generator/VERSION
Normal file
@ -0,0 +1 @@
|
||||
7.3.0-SNAPSHOT
|
||||
17
.travis.yml
Normal file
17
.travis.yml
Normal file
@ -0,0 +1,17 @@
|
||||
# ref: https://docs.travis-ci.com/user/languages/python
|
||||
language: python
|
||||
python:
|
||||
- "3.7"
|
||||
- "3.8"
|
||||
- "3.9"
|
||||
- "3.10"
|
||||
- "3.11"
|
||||
# uncomment the following if needed
|
||||
#- "3.11-dev" # 3.11 development branch
|
||||
#- "nightly" # nightly build
|
||||
# command to install dependencies
|
||||
install:
|
||||
- "pip install -r requirements.txt"
|
||||
- "pip install -r test-requirements.txt"
|
||||
# command to run tests
|
||||
script: pytest --cov=peertube
|
||||
788
README.md
Normal file
788
README.md
Normal file
@ -0,0 +1,788 @@
|
||||
# peertube
|
||||
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
|
||||
HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
|
||||
[openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
|
||||
which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
|
||||
|
||||
- [Python](https://framagit.org/framasoft/peertube/clients/python)
|
||||
- [Go](https://framagit.org/framasoft/peertube/clients/go)
|
||||
- [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
|
||||
|
||||
See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few
|
||||
examples of using the PeerTube API.
|
||||
|
||||
# Authentication
|
||||
|
||||
When you sign up for an account on a PeerTube instance, you are given the possibility
|
||||
to generate sessions on it, and authenticate there using an access token. Only __one
|
||||
access token can currently be used at a time__.
|
||||
|
||||
## Roles
|
||||
|
||||
Accounts are given permissions based on their role. There are three roles on
|
||||
PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users#roles) for a detail of their permissions.
|
||||
|
||||
# Errors
|
||||
|
||||
The API uses standard HTTP status codes to indicate the success or failure
|
||||
of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.
|
||||
|
||||
```
|
||||
HTTP 1.1 404 Not Found
|
||||
Content-Type: application/problem+json; charset=utf-8
|
||||
|
||||
{
|
||||
\"detail\": \"Video not found\",
|
||||
\"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\",
|
||||
\"status\": 404,
|
||||
\"title\": \"Not Found\",
|
||||
\"type\": \"about:blank\"
|
||||
}
|
||||
```
|
||||
|
||||
We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/core-error-code.enum.ts),
|
||||
but it is still optional. Types are used to disambiguate errors that bear the same status code
|
||||
and are non-obvious:
|
||||
|
||||
```
|
||||
HTTP 1.1 403 Forbidden
|
||||
Content-Type: application/problem+json; charset=utf-8
|
||||
|
||||
{
|
||||
\"detail\": \"Cannot get this video regarding follow constraints\",
|
||||
\"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\",
|
||||
\"status\": 403,
|
||||
\"title\": \"Forbidden\",
|
||||
\"type\": \"https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints\"
|
||||
}
|
||||
```
|
||||
|
||||
Here a 403 error could otherwise mean that the video is private or blocklisted.
|
||||
|
||||
### Validation errors
|
||||
|
||||
Each parameter is evaluated on its own against a set of rules before the route validator
|
||||
proceeds with potential testing involving parameter combinations. Errors coming from validation
|
||||
errors appear earlier and benefit from a more detailed error description:
|
||||
|
||||
```
|
||||
HTTP 1.1 400 Bad Request
|
||||
Content-Type: application/problem+json; charset=utf-8
|
||||
|
||||
{
|
||||
\"detail\": \"Incorrect request parameters: id\",
|
||||
\"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\",
|
||||
\"instance\": \"/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180\",
|
||||
\"invalid-params\": {
|
||||
\"id\": {
|
||||
\"location\": \"params\",
|
||||
\"msg\": \"Invalid value\",
|
||||
\"param\": \"id\",
|
||||
\"value\": \"9c9de5e8-0a1e-484a-b099-e80766180\"
|
||||
}
|
||||
},
|
||||
\"status\": 400,
|
||||
\"title\": \"Bad Request\",
|
||||
\"type\": \"about:blank\"
|
||||
}
|
||||
```
|
||||
|
||||
Where `id` is the name of the field concerned by the error, within the route definition.
|
||||
`invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and
|
||||
`invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg`
|
||||
is about.
|
||||
|
||||
### Deprecated error fields
|
||||
|
||||
Some fields could be included with previous versions. They are still included but their use is deprecated:
|
||||
- `error`: superseded by `detail`
|
||||
- `code`: superseded by `type` (which is now an URI)
|
||||
|
||||
# Rate limits
|
||||
|
||||
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
|
||||
|
||||
| Endpoint (prefix: `/api/v1`) | Calls | Time frame |
|
||||
|------------------------------|---------------|--------------|
|
||||
| `/*` | 50 | 10 seconds |
|
||||
| `POST /users/token` | 15 | 5 minutes |
|
||||
| `POST /users/register` | 2<sup>*</sup> | 5 minutes |
|
||||
| `POST /users/ask-send-verify-email` | 3 | 5 minutes |
|
||||
|
||||
Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
|
||||
limit is announced by a `429 Too Many Requests` status code.
|
||||
|
||||
You can get details about the current state of your rate limit by reading the
|
||||
following headers:
|
||||
|
||||
| Header | Description |
|
||||
|-------------------------|------------------------------------------------------------|
|
||||
| `X-RateLimit-Limit` | Number of max requests allowed in the current time period |
|
||||
| `X-RateLimit-Remaining` | Number of remaining requests in the current time period |
|
||||
| `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp |
|
||||
| `Retry-After` | Seconds to delay after the first `429` is received |
|
||||
|
||||
# CORS
|
||||
|
||||
This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
|
||||
allowing cross-domain communication from the browser for some routes:
|
||||
|
||||
| Endpoint |
|
||||
|------------------------- ---|
|
||||
| `/api/*` |
|
||||
| `/download/*` |
|
||||
| `/lazy-static/*` |
|
||||
| `/.well-known/webfinger` |
|
||||
|
||||
In addition, all routes serving ActivityPub are CORS-enabled for all origins.
|
||||
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 5.2.0
|
||||
- Package version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
For more information, please visit [https://joinpeertube.org](https://joinpeertube.org)
|
||||
|
||||
## Requirements.
|
||||
|
||||
Python 3.7+
|
||||
|
||||
## Installation & Usage
|
||||
### pip install
|
||||
|
||||
If the python package is hosted on a repository, you can install directly using:
|
||||
|
||||
```sh
|
||||
pip install git+https://git.lolxd.fi/TmxPro/peertube_python_api.git
|
||||
```
|
||||
(you may need to run `pip` with root permission: `sudo pip install git+https://git.lolxd.fi/TmxPro/peertube_python_api.git`)
|
||||
|
||||
Then import the package:
|
||||
```python
|
||||
import peertube
|
||||
```
|
||||
|
||||
### Setuptools
|
||||
|
||||
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
||||
|
||||
```sh
|
||||
python setup.py install --user
|
||||
```
|
||||
(or `sudo python setup.py install` to install the package for all users)
|
||||
|
||||
Then import the package:
|
||||
```python
|
||||
import peertube
|
||||
```
|
||||
|
||||
### Tests
|
||||
|
||||
Execute `pytest` to run the tests.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```python
|
||||
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
|
||||
try:
|
||||
# Delete an abuse
|
||||
api_instance.api_v1_abuses_abuse_id_delete(abuse_id)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_delete: %s\n" % e)
|
||||
|
||||
```
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*AbusesApi* | [**api_v1_abuses_abuse_id_delete**](docs/AbusesApi.md#api_v1_abuses_abuse_id_delete) | **DELETE** /api/v1/abuses/{abuseId} | Delete an abuse
|
||||
*AbusesApi* | [**api_v1_abuses_abuse_id_messages_abuse_message_id_delete**](docs/AbusesApi.md#api_v1_abuses_abuse_id_messages_abuse_message_id_delete) | **DELETE** /api/v1/abuses/{abuseId}/messages/{abuseMessageId} | Delete an abuse message
|
||||
*AbusesApi* | [**api_v1_abuses_abuse_id_messages_get**](docs/AbusesApi.md#api_v1_abuses_abuse_id_messages_get) | **GET** /api/v1/abuses/{abuseId}/messages | List messages of an abuse
|
||||
*AbusesApi* | [**api_v1_abuses_abuse_id_messages_post**](docs/AbusesApi.md#api_v1_abuses_abuse_id_messages_post) | **POST** /api/v1/abuses/{abuseId}/messages | Add message to an abuse
|
||||
*AbusesApi* | [**api_v1_abuses_abuse_id_put**](docs/AbusesApi.md#api_v1_abuses_abuse_id_put) | **PUT** /api/v1/abuses/{abuseId} | Update an abuse
|
||||
*AbusesApi* | [**api_v1_abuses_post**](docs/AbusesApi.md#api_v1_abuses_post) | **POST** /api/v1/abuses | Report an abuse
|
||||
*AbusesApi* | [**get_abuses**](docs/AbusesApi.md#get_abuses) | **GET** /api/v1/abuses | List abuses
|
||||
*AbusesApi* | [**get_my_abuses**](docs/AbusesApi.md#get_my_abuses) | **GET** /api/v1/users/me/abuses | List my abuses
|
||||
*AccountBlocksApi* | [**api_v1_blocklist_status_get**](docs/AccountBlocksApi.md#api_v1_blocklist_status_get) | **GET** /api/v1/blocklist/status | Get block status of accounts/hosts
|
||||
*AccountBlocksApi* | [**api_v1_server_blocklist_accounts_account_name_delete**](docs/AccountBlocksApi.md#api_v1_server_blocklist_accounts_account_name_delete) | **DELETE** /api/v1/server/blocklist/accounts/{accountName} | Unblock an account by its handle
|
||||
*AccountBlocksApi* | [**api_v1_server_blocklist_accounts_get**](docs/AccountBlocksApi.md#api_v1_server_blocklist_accounts_get) | **GET** /api/v1/server/blocklist/accounts | List account blocks
|
||||
*AccountBlocksApi* | [**api_v1_server_blocklist_accounts_post**](docs/AccountBlocksApi.md#api_v1_server_blocklist_accounts_post) | **POST** /api/v1/server/blocklist/accounts | Block an account
|
||||
*AccountsApi* | [**api_v1_accounts_name_ratings_get**](docs/AccountsApi.md#api_v1_accounts_name_ratings_get) | **GET** /api/v1/accounts/{name}/ratings | List ratings of an account
|
||||
*AccountsApi* | [**api_v1_accounts_name_video_channel_syncs_get**](docs/AccountsApi.md#api_v1_accounts_name_video_channel_syncs_get) | **GET** /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account
|
||||
*AccountsApi* | [**api_v1_accounts_name_video_channels_get**](docs/AccountsApi.md#api_v1_accounts_name_video_channels_get) | **GET** /api/v1/accounts/{name}/video-channels | List video channels of an account
|
||||
*AccountsApi* | [**api_v1_accounts_name_video_playlists_get**](docs/AccountsApi.md#api_v1_accounts_name_video_playlists_get) | **GET** /api/v1/accounts/{name}/video-playlists | List playlists of an account
|
||||
*AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /api/v1/accounts/{name} | Get an account
|
||||
*AccountsApi* | [**get_account_followers**](docs/AccountsApi.md#get_account_followers) | **GET** /api/v1/accounts/{name}/followers | List followers of an account
|
||||
*AccountsApi* | [**get_account_videos**](docs/AccountsApi.md#get_account_videos) | **GET** /api/v1/accounts/{name}/videos | List videos of an account
|
||||
*AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /api/v1/accounts | List accounts
|
||||
*ChannelsSyncApi* | [**add_video_channel_sync**](docs/ChannelsSyncApi.md#add_video_channel_sync) | **POST** /api/v1/video-channel-syncs | Create a synchronization for a video channel
|
||||
*ChannelsSyncApi* | [**api_v1_accounts_name_video_channel_syncs_get**](docs/ChannelsSyncApi.md#api_v1_accounts_name_video_channel_syncs_get) | **GET** /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account
|
||||
*ChannelsSyncApi* | [**api_v1_video_channels_channel_handle_import_videos_post**](docs/ChannelsSyncApi.md#api_v1_video_channels_channel_handle_import_videos_post) | **POST** /api/v1/video-channels/{channelHandle}/import-videos | Import videos in channel
|
||||
*ChannelsSyncApi* | [**del_video_channel_sync**](docs/ChannelsSyncApi.md#del_video_channel_sync) | **DELETE** /api/v1/video-channel-syncs/{channelSyncId} | Delete a video channel synchronization
|
||||
*ChannelsSyncApi* | [**trigger_video_channel_sync**](docs/ChannelsSyncApi.md#trigger_video_channel_sync) | **POST** /api/v1/video-channel-syncs/{channelSyncId}/sync | Triggers the channel synchronization job, fetching all the videos from the remote channel
|
||||
*ConfigApi* | [**del_custom_config**](docs/ConfigApi.md#del_custom_config) | **DELETE** /api/v1/config/custom | Delete instance runtime configuration
|
||||
*ConfigApi* | [**get_about**](docs/ConfigApi.md#get_about) | **GET** /api/v1/config/about | Get instance \"About\" information
|
||||
*ConfigApi* | [**get_config**](docs/ConfigApi.md#get_config) | **GET** /api/v1/config | Get instance public configuration
|
||||
*ConfigApi* | [**get_custom_config**](docs/ConfigApi.md#get_custom_config) | **GET** /api/v1/config/custom | Get instance runtime configuration
|
||||
*ConfigApi* | [**put_custom_config**](docs/ConfigApi.md#put_custom_config) | **PUT** /api/v1/config/custom | Set instance runtime configuration
|
||||
*HomepageApi* | [**api_v1_custom_pages_homepage_instance_get**](docs/HomepageApi.md#api_v1_custom_pages_homepage_instance_get) | **GET** /api/v1/custom-pages/homepage/instance | Get instance custom homepage
|
||||
*HomepageApi* | [**api_v1_custom_pages_homepage_instance_put**](docs/HomepageApi.md#api_v1_custom_pages_homepage_instance_put) | **PUT** /api/v1/custom-pages/homepage/instance | Set instance custom homepage
|
||||
*InstanceFollowsApi* | [**api_v1_server_followers_get**](docs/InstanceFollowsApi.md#api_v1_server_followers_get) | **GET** /api/v1/server/followers | List instances following the server
|
||||
*InstanceFollowsApi* | [**api_v1_server_followers_name_with_host_accept_post**](docs/InstanceFollowsApi.md#api_v1_server_followers_name_with_host_accept_post) | **POST** /api/v1/server/followers/{nameWithHost}/accept | Accept a pending follower to your server
|
||||
*InstanceFollowsApi* | [**api_v1_server_followers_name_with_host_delete**](docs/InstanceFollowsApi.md#api_v1_server_followers_name_with_host_delete) | **DELETE** /api/v1/server/followers/{nameWithHost} | Remove or reject a follower to your server
|
||||
*InstanceFollowsApi* | [**api_v1_server_followers_name_with_host_reject_post**](docs/InstanceFollowsApi.md#api_v1_server_followers_name_with_host_reject_post) | **POST** /api/v1/server/followers/{nameWithHost}/reject | Reject a pending follower to your server
|
||||
*InstanceFollowsApi* | [**api_v1_server_following_get**](docs/InstanceFollowsApi.md#api_v1_server_following_get) | **GET** /api/v1/server/following | List instances followed by the server
|
||||
*InstanceFollowsApi* | [**api_v1_server_following_host_or_handle_delete**](docs/InstanceFollowsApi.md#api_v1_server_following_host_or_handle_delete) | **DELETE** /api/v1/server/following/{hostOrHandle} | Unfollow an actor (PeerTube instance, channel or account)
|
||||
*InstanceFollowsApi* | [**api_v1_server_following_post**](docs/InstanceFollowsApi.md#api_v1_server_following_post) | **POST** /api/v1/server/following | Follow a list of actors (PeerTube instance, channel or account)
|
||||
*InstanceRedundancyApi* | [**api_v1_server_redundancy_host_put**](docs/InstanceRedundancyApi.md#api_v1_server_redundancy_host_put) | **PUT** /api/v1/server/redundancy/{host} | Update a server redundancy policy
|
||||
*JobApi* | [**api_v1_jobs_pause_post**](docs/JobApi.md#api_v1_jobs_pause_post) | **POST** /api/v1/jobs/pause | Pause job queue
|
||||
*JobApi* | [**api_v1_jobs_resume_post**](docs/JobApi.md#api_v1_jobs_resume_post) | **POST** /api/v1/jobs/resume | Resume job queue
|
||||
*JobApi* | [**get_jobs**](docs/JobApi.md#get_jobs) | **GET** /api/v1/jobs/{state} | List instance jobs
|
||||
*LiveVideosApi* | [**add_live**](docs/LiveVideosApi.md#add_live) | **POST** /api/v1/videos/live | Create a live
|
||||
*LiveVideosApi* | [**api_v1_videos_id_live_session_get**](docs/LiveVideosApi.md#api_v1_videos_id_live_session_get) | **GET** /api/v1/videos/{id}/live-session | Get live session of a replay
|
||||
*LiveVideosApi* | [**api_v1_videos_live_id_sessions_get**](docs/LiveVideosApi.md#api_v1_videos_live_id_sessions_get) | **GET** /api/v1/videos/live/{id}/sessions | List live sessions
|
||||
*LiveVideosApi* | [**get_live_id**](docs/LiveVideosApi.md#get_live_id) | **GET** /api/v1/videos/live/{id} | Get information about a live
|
||||
*LiveVideosApi* | [**update_live_id**](docs/LiveVideosApi.md#update_live_id) | **PUT** /api/v1/videos/live/{id} | Update information about a live
|
||||
*LogsApi* | [**get_instance_audit_logs**](docs/LogsApi.md#get_instance_audit_logs) | **GET** /api/v1/server/audit-logs | Get instance audit logs
|
||||
*LogsApi* | [**get_instance_logs**](docs/LogsApi.md#get_instance_logs) | **GET** /api/v1/server/logs | Get instance logs
|
||||
*LogsApi* | [**send_client_log**](docs/LogsApi.md#send_client_log) | **POST** /api/v1/server/logs/client | Send client log
|
||||
*MyHistoryApi* | [**api_v1_users_me_history_videos_get**](docs/MyHistoryApi.md#api_v1_users_me_history_videos_get) | **GET** /api/v1/users/me/history/videos | List watched videos history
|
||||
*MyHistoryApi* | [**api_v1_users_me_history_videos_remove_post**](docs/MyHistoryApi.md#api_v1_users_me_history_videos_remove_post) | **POST** /api/v1/users/me/history/videos/remove | Clear video history
|
||||
*MyHistoryApi* | [**api_v1_users_me_history_videos_video_id_delete**](docs/MyHistoryApi.md#api_v1_users_me_history_videos_video_id_delete) | **DELETE** /api/v1/users/me/history/videos/{videoId} | Delete history element
|
||||
*MyNotificationsApi* | [**api_v1_users_me_notification_settings_put**](docs/MyNotificationsApi.md#api_v1_users_me_notification_settings_put) | **PUT** /api/v1/users/me/notification-settings | Update my notification settings
|
||||
*MyNotificationsApi* | [**api_v1_users_me_notifications_get**](docs/MyNotificationsApi.md#api_v1_users_me_notifications_get) | **GET** /api/v1/users/me/notifications | List my notifications
|
||||
*MyNotificationsApi* | [**api_v1_users_me_notifications_read_all_post**](docs/MyNotificationsApi.md#api_v1_users_me_notifications_read_all_post) | **POST** /api/v1/users/me/notifications/read-all | Mark all my notification as read
|
||||
*MyNotificationsApi* | [**api_v1_users_me_notifications_read_post**](docs/MyNotificationsApi.md#api_v1_users_me_notifications_read_post) | **POST** /api/v1/users/me/notifications/read | Mark notifications as read by their id
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_exist_get**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_exist_get) | **GET** /api/v1/users/me/subscriptions/exist | Get if subscriptions exist for my user
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_get**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_get) | **GET** /api/v1/users/me/subscriptions | Get my user subscriptions
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_post**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_post) | **POST** /api/v1/users/me/subscriptions | Add subscription to my user
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_subscription_handle_delete**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_subscription_handle_delete) | **DELETE** /api/v1/users/me/subscriptions/{subscriptionHandle} | Delete subscription of my user
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_subscription_handle_get**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_subscription_handle_get) | **GET** /api/v1/users/me/subscriptions/{subscriptionHandle} | Get subscription of my user
|
||||
*MySubscriptionsApi* | [**api_v1_users_me_subscriptions_videos_get**](docs/MySubscriptionsApi.md#api_v1_users_me_subscriptions_videos_get) | **GET** /api/v1/users/me/subscriptions/videos | List videos of subscriptions of my user
|
||||
*MyUserApi* | [**api_v1_users_me_avatar_delete**](docs/MyUserApi.md#api_v1_users_me_avatar_delete) | **DELETE** /api/v1/users/me/avatar | Delete my avatar
|
||||
*MyUserApi* | [**api_v1_users_me_avatar_pick_post**](docs/MyUserApi.md#api_v1_users_me_avatar_pick_post) | **POST** /api/v1/users/me/avatar/pick | Update my user avatar
|
||||
*MyUserApi* | [**api_v1_users_me_video_quota_used_get**](docs/MyUserApi.md#api_v1_users_me_video_quota_used_get) | **GET** /api/v1/users/me/video-quota-used | Get my user used quota
|
||||
*MyUserApi* | [**api_v1_users_me_videos_get**](docs/MyUserApi.md#api_v1_users_me_videos_get) | **GET** /api/v1/users/me/videos | Get videos of my user
|
||||
*MyUserApi* | [**api_v1_users_me_videos_imports_get**](docs/MyUserApi.md#api_v1_users_me_videos_imports_get) | **GET** /api/v1/users/me/videos/imports | Get video imports of my user
|
||||
*MyUserApi* | [**api_v1_users_me_videos_video_id_rating_get**](docs/MyUserApi.md#api_v1_users_me_videos_video_id_rating_get) | **GET** /api/v1/users/me/videos/{videoId}/rating | Get rate of my user for a video
|
||||
*MyUserApi* | [**get_my_abuses**](docs/MyUserApi.md#get_my_abuses) | **GET** /api/v1/users/me/abuses | List my abuses
|
||||
*MyUserApi* | [**get_user_info**](docs/MyUserApi.md#get_user_info) | **GET** /api/v1/users/me | Get my user information
|
||||
*MyUserApi* | [**put_user_info**](docs/MyUserApi.md#put_user_info) | **PUT** /api/v1/users/me | Update my user information
|
||||
*PluginsApi* | [**add_plugin**](docs/PluginsApi.md#add_plugin) | **POST** /api/v1/plugins/install | Install a plugin
|
||||
*PluginsApi* | [**api_v1_plugins_npm_name_public_settings_get**](docs/PluginsApi.md#api_v1_plugins_npm_name_public_settings_get) | **GET** /api/v1/plugins/{npmName}/public-settings | Get a plugin's public settings
|
||||
*PluginsApi* | [**api_v1_plugins_npm_name_registered_settings_get**](docs/PluginsApi.md#api_v1_plugins_npm_name_registered_settings_get) | **GET** /api/v1/plugins/{npmName}/registered-settings | Get a plugin's registered settings
|
||||
*PluginsApi* | [**api_v1_plugins_npm_name_settings_put**](docs/PluginsApi.md#api_v1_plugins_npm_name_settings_put) | **PUT** /api/v1/plugins/{npmName}/settings | Set a plugin's settings
|
||||
*PluginsApi* | [**get_available_plugins**](docs/PluginsApi.md#get_available_plugins) | **GET** /api/v1/plugins/available | List available plugins
|
||||
*PluginsApi* | [**get_plugin**](docs/PluginsApi.md#get_plugin) | **GET** /api/v1/plugins/{npmName} | Get a plugin
|
||||
*PluginsApi* | [**get_plugins**](docs/PluginsApi.md#get_plugins) | **GET** /api/v1/plugins | List plugins
|
||||
*PluginsApi* | [**uninstall_plugin**](docs/PluginsApi.md#uninstall_plugin) | **POST** /api/v1/plugins/uninstall | Uninstall a plugin
|
||||
*PluginsApi* | [**update_plugin**](docs/PluginsApi.md#update_plugin) | **POST** /api/v1/plugins/update | Update a plugin
|
||||
*RegisterApi* | [**accept_registration**](docs/RegisterApi.md#accept_registration) | **POST** /api/v1/users/registrations/{registrationId}/accept | Accept registration
|
||||
*RegisterApi* | [**delete_registration**](docs/RegisterApi.md#delete_registration) | **DELETE** /api/v1/users/registrations/{registrationId} | Delete registration
|
||||
*RegisterApi* | [**list_registrations**](docs/RegisterApi.md#list_registrations) | **GET** /api/v1/users/registrations | List registrations
|
||||
*RegisterApi* | [**register_user**](docs/RegisterApi.md#register_user) | **POST** /api/v1/users/register | Register a user
|
||||
*RegisterApi* | [**reject_registration**](docs/RegisterApi.md#reject_registration) | **POST** /api/v1/users/registrations/{registrationId}/reject | Reject registration
|
||||
*RegisterApi* | [**request_registration**](docs/RegisterApi.md#request_registration) | **POST** /api/v1/users/registrations/request | Request registration
|
||||
*RegisterApi* | [**resend_email_to_verify_registration**](docs/RegisterApi.md#resend_email_to_verify_registration) | **POST** /api/v1/users/registrations/ask-send-verify-email | Resend verification link to registration email
|
||||
*RegisterApi* | [**resend_email_to_verify_user**](docs/RegisterApi.md#resend_email_to_verify_user) | **POST** /api/v1/users/ask-send-verify-email | Resend user verification link
|
||||
*RegisterApi* | [**verify_registration_email**](docs/RegisterApi.md#verify_registration_email) | **POST** /api/v1/users/registrations/{registrationId}/verify-email | Verify a registration email
|
||||
*RegisterApi* | [**verify_user**](docs/RegisterApi.md#verify_user) | **POST** /api/v1/users/{id}/verify-email | Verify a user
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_get**](docs/RunnerJobsApi.md#api_v1_runners_jobs_get) | **GET** /api/v1/runners/jobs | List jobs
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_abort_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_abort_post) | **POST** /api/v1/runners/jobs/{jobUUID}/abort | Abort job
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_accept_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_accept_post) | **POST** /api/v1/runners/jobs/{jobUUID}/accept | Accept job
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_cancel_get**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_cancel_get) | **GET** /api/v1/runners/jobs/{jobUUID}/cancel | Cancel a job
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_delete**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_delete) | **DELETE** /api/v1/runners/jobs/{jobUUID} | Delete a job
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_error_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_error_post) | **POST** /api/v1/runners/jobs/{jobUUID}/error | Post job error
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_success_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_success_post) | **POST** /api/v1/runners/jobs/{jobUUID}/success | Post job success
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_job_uuid_update_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_job_uuid_update_post) | **POST** /api/v1/runners/jobs/{jobUUID}/update | Update job
|
||||
*RunnerJobsApi* | [**api_v1_runners_jobs_request_post**](docs/RunnerJobsApi.md#api_v1_runners_jobs_request_post) | **POST** /api/v1/runners/jobs/request | Request a new job
|
||||
*RunnerRegistrationTokenApi* | [**api_v1_runners_registration_tokens_generate_post**](docs/RunnerRegistrationTokenApi.md#api_v1_runners_registration_tokens_generate_post) | **POST** /api/v1/runners/registration-tokens/generate | Generate registration token
|
||||
*RunnerRegistrationTokenApi* | [**api_v1_runners_registration_tokens_get**](docs/RunnerRegistrationTokenApi.md#api_v1_runners_registration_tokens_get) | **GET** /api/v1/runners/registration-tokens | List registration tokens
|
||||
*RunnerRegistrationTokenApi* | [**api_v1_runners_registration_tokens_registration_token_id_delete**](docs/RunnerRegistrationTokenApi.md#api_v1_runners_registration_tokens_registration_token_id_delete) | **DELETE** /api/v1/runners/registration-tokens/{registrationTokenId} | Remove registration token
|
||||
*RunnersApi* | [**api_v1_runners_get**](docs/RunnersApi.md#api_v1_runners_get) | **GET** /api/v1/runners | List runners
|
||||
*RunnersApi* | [**api_v1_runners_register_post**](docs/RunnersApi.md#api_v1_runners_register_post) | **POST** /api/v1/runners/register | Register a new runner
|
||||
*RunnersApi* | [**api_v1_runners_runner_id_delete**](docs/RunnersApi.md#api_v1_runners_runner_id_delete) | **DELETE** /api/v1/runners/{runnerId} | Delete a runner
|
||||
*RunnersApi* | [**api_v1_runners_unregister_post**](docs/RunnersApi.md#api_v1_runners_unregister_post) | **POST** /api/v1/runners/unregister | Unregister a runner
|
||||
*SearchApi* | [**search_channels**](docs/SearchApi.md#search_channels) | **GET** /api/v1/search/video-channels | Search channels
|
||||
*SearchApi* | [**search_playlists**](docs/SearchApi.md#search_playlists) | **GET** /api/v1/search/video-playlists | Search playlists
|
||||
*SearchApi* | [**search_videos**](docs/SearchApi.md#search_videos) | **GET** /api/v1/search/videos | Search videos
|
||||
*ServerBlocksApi* | [**api_v1_blocklist_status_get**](docs/ServerBlocksApi.md#api_v1_blocklist_status_get) | **GET** /api/v1/blocklist/status | Get block status of accounts/hosts
|
||||
*ServerBlocksApi* | [**api_v1_server_blocklist_servers_get**](docs/ServerBlocksApi.md#api_v1_server_blocklist_servers_get) | **GET** /api/v1/server/blocklist/servers | List server blocks
|
||||
*ServerBlocksApi* | [**api_v1_server_blocklist_servers_host_delete**](docs/ServerBlocksApi.md#api_v1_server_blocklist_servers_host_delete) | **DELETE** /api/v1/server/blocklist/servers/{host} | Unblock a server by its domain
|
||||
*ServerBlocksApi* | [**api_v1_server_blocklist_servers_post**](docs/ServerBlocksApi.md#api_v1_server_blocklist_servers_post) | **POST** /api/v1/server/blocklist/servers | Block a server
|
||||
*SessionApi* | [**get_o_auth_client**](docs/SessionApi.md#get_o_auth_client) | **GET** /api/v1/oauth-clients/local | Login prerequisite
|
||||
*SessionApi* | [**get_o_auth_token**](docs/SessionApi.md#get_o_auth_token) | **POST** /api/v1/users/token | Login
|
||||
*SessionApi* | [**revoke_o_auth_token**](docs/SessionApi.md#revoke_o_auth_token) | **POST** /api/v1/users/revoke-token | Logout
|
||||
*StaticVideoFilesApi* | [**static_streaming_playlists_hls_filename_get**](docs/StaticVideoFilesApi.md#static_streaming_playlists_hls_filename_get) | **GET** /static/streaming-playlists/hls/{filename} | Get public HLS video file
|
||||
*StaticVideoFilesApi* | [**static_streaming_playlists_hls_private_filename_get**](docs/StaticVideoFilesApi.md#static_streaming_playlists_hls_private_filename_get) | **GET** /static/streaming-playlists/hls/private/{filename} | Get private HLS video file
|
||||
*StaticVideoFilesApi* | [**static_web_videos_filename_get**](docs/StaticVideoFilesApi.md#static_web_videos_filename_get) | **GET** /static/web-videos/{filename} | Get public Web Video file
|
||||
*StaticVideoFilesApi* | [**static_web_videos_private_filename_get**](docs/StaticVideoFilesApi.md#static_web_videos_private_filename_get) | **GET** /static/web-videos/private/{filename} | Get private Web Video file
|
||||
*StatsApi* | [**api_v1_metrics_playback_post**](docs/StatsApi.md#api_v1_metrics_playback_post) | **POST** /api/v1/metrics/playback | Create playback metrics
|
||||
*StatsApi* | [**get_instance_stats**](docs/StatsApi.md#get_instance_stats) | **GET** /api/v1/server/stats | Get instance stats
|
||||
*UsersApi* | [**add_user**](docs/UsersApi.md#add_user) | **POST** /api/v1/users | Create a user
|
||||
*UsersApi* | [**confirm_two_factor_request**](docs/UsersApi.md#confirm_two_factor_request) | **POST** /api/v1/users/{id}/two-factor/confirm-request | Confirm two factor auth
|
||||
*UsersApi* | [**del_user**](docs/UsersApi.md#del_user) | **DELETE** /api/v1/users/{id} | Delete a user
|
||||
*UsersApi* | [**disable_two_factor**](docs/UsersApi.md#disable_two_factor) | **POST** /api/v1/users/{id}/two-factor/disable | Disable two factor auth
|
||||
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /api/v1/users/{id} | Get a user
|
||||
*UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /api/v1/users | List users
|
||||
*UsersApi* | [**put_user**](docs/UsersApi.md#put_user) | **PUT** /api/v1/users/{id} | Update a user
|
||||
*UsersApi* | [**request_two_factor**](docs/UsersApi.md#request_two_factor) | **POST** /api/v1/users/{id}/two-factor/request | Request two factor auth
|
||||
*UsersApi* | [**resend_email_to_verify_user**](docs/UsersApi.md#resend_email_to_verify_user) | **POST** /api/v1/users/ask-send-verify-email | Resend user verification link
|
||||
*UsersApi* | [**verify_user**](docs/UsersApi.md#verify_user) | **POST** /api/v1/users/{id}/verify-email | Verify a user
|
||||
*VideoApi* | [**add_live**](docs/VideoApi.md#add_live) | **POST** /api/v1/videos/live | Create a live
|
||||
*VideoApi* | [**add_view**](docs/VideoApi.md#add_view) | **POST** /api/v1/videos/{id}/views | Notify user is watching a video
|
||||
*VideoApi* | [**api_v1_videos_id_studio_edit_post**](docs/VideoApi.md#api_v1_videos_id_studio_edit_post) | **POST** /api/v1/videos/{id}/studio/edit | Create a studio task
|
||||
*VideoApi* | [**api_v1_videos_id_watching_put**](docs/VideoApi.md#api_v1_videos_id_watching_put) | **PUT** /api/v1/videos/{id}/watching | Set watching progress of a video
|
||||
*VideoApi* | [**del_video**](docs/VideoApi.md#del_video) | **DELETE** /api/v1/videos/{id} | Delete a video
|
||||
*VideoApi* | [**get_account_videos**](docs/VideoApi.md#get_account_videos) | **GET** /api/v1/accounts/{name}/videos | List videos of an account
|
||||
*VideoApi* | [**get_categories**](docs/VideoApi.md#get_categories) | **GET** /api/v1/videos/categories | List available video categories
|
||||
*VideoApi* | [**get_languages**](docs/VideoApi.md#get_languages) | **GET** /api/v1/videos/languages | List available video languages
|
||||
*VideoApi* | [**get_licences**](docs/VideoApi.md#get_licences) | **GET** /api/v1/videos/licences | List available video licences
|
||||
*VideoApi* | [**get_live_id**](docs/VideoApi.md#get_live_id) | **GET** /api/v1/videos/live/{id} | Get information about a live
|
||||
*VideoApi* | [**get_video**](docs/VideoApi.md#get_video) | **GET** /api/v1/videos/{id} | Get a video
|
||||
*VideoApi* | [**get_video_channel_videos**](docs/VideoApi.md#get_video_channel_videos) | **GET** /api/v1/video-channels/{channelHandle}/videos | List videos of a video channel
|
||||
*VideoApi* | [**get_video_desc**](docs/VideoApi.md#get_video_desc) | **GET** /api/v1/videos/{id}/description | Get complete video description
|
||||
*VideoApi* | [**get_video_privacy_policies**](docs/VideoApi.md#get_video_privacy_policies) | **GET** /api/v1/videos/privacies | List available video privacy policies
|
||||
*VideoApi* | [**get_video_source**](docs/VideoApi.md#get_video_source) | **GET** /api/v1/videos/{id}/source | Get video source file metadata
|
||||
*VideoApi* | [**get_videos**](docs/VideoApi.md#get_videos) | **GET** /api/v1/videos | List videos
|
||||
*VideoApi* | [**list_video_storyboards**](docs/VideoApi.md#list_video_storyboards) | **GET** /api/v1/videos/{id}/storyboards | List storyboards of a video
|
||||
*VideoApi* | [**put_video**](docs/VideoApi.md#put_video) | **PUT** /api/v1/videos/{id} | Update a video
|
||||
*VideoApi* | [**replace_video_source_resumable**](docs/VideoApi.md#replace_video_source_resumable) | **PUT** /api/v1/videos/{id}/source/replace-resumable | Send chunk for the resumable replacement of a video
|
||||
*VideoApi* | [**replace_video_source_resumable_cancel**](docs/VideoApi.md#replace_video_source_resumable_cancel) | **DELETE** /api/v1/videos/{id}/source/replace-resumable | Cancel the resumable replacement of a video
|
||||
*VideoApi* | [**replace_video_source_resumable_init**](docs/VideoApi.md#replace_video_source_resumable_init) | **POST** /api/v1/videos/{id}/source/replace-resumable | Initialize the resumable replacement of a video
|
||||
*VideoApi* | [**request_video_token**](docs/VideoApi.md#request_video_token) | **POST** /api/v1/videos/{id}/token | Request video token
|
||||
*VideoApi* | [**update_live_id**](docs/VideoApi.md#update_live_id) | **PUT** /api/v1/videos/live/{id} | Update information about a live
|
||||
*VideoApi* | [**upload_legacy**](docs/VideoApi.md#upload_legacy) | **POST** /api/v1/videos/upload | Upload a video
|
||||
*VideoApi* | [**upload_resumable**](docs/VideoApi.md#upload_resumable) | **PUT** /api/v1/videos/upload-resumable | Send chunk for the resumable upload of a video
|
||||
*VideoApi* | [**upload_resumable_cancel**](docs/VideoApi.md#upload_resumable_cancel) | **DELETE** /api/v1/videos/upload-resumable | Cancel the resumable upload of a video, deleting any data uploaded so far
|
||||
*VideoApi* | [**upload_resumable_init**](docs/VideoApi.md#upload_resumable_init) | **POST** /api/v1/videos/upload-resumable | Initialize the resumable upload of a video
|
||||
*VideoBlocksApi* | [**add_video_block**](docs/VideoBlocksApi.md#add_video_block) | **POST** /api/v1/videos/{id}/blacklist | Block a video
|
||||
*VideoBlocksApi* | [**del_video_block**](docs/VideoBlocksApi.md#del_video_block) | **DELETE** /api/v1/videos/{id}/blacklist | Unblock a video by its id
|
||||
*VideoBlocksApi* | [**get_video_blocks**](docs/VideoBlocksApi.md#get_video_blocks) | **GET** /api/v1/videos/blacklist | List video blocks
|
||||
*VideoCaptionsApi* | [**add_video_caption**](docs/VideoCaptionsApi.md#add_video_caption) | **PUT** /api/v1/videos/{id}/captions/{captionLanguage} | Add or replace a video caption
|
||||
*VideoCaptionsApi* | [**del_video_caption**](docs/VideoCaptionsApi.md#del_video_caption) | **DELETE** /api/v1/videos/{id}/captions/{captionLanguage} | Delete a video caption
|
||||
*VideoCaptionsApi* | [**get_video_captions**](docs/VideoCaptionsApi.md#get_video_captions) | **GET** /api/v1/videos/{id}/captions | List captions of a video
|
||||
*VideoChannelsApi* | [**add_video_channel**](docs/VideoChannelsApi.md#add_video_channel) | **POST** /api/v1/video-channels | Create a video channel
|
||||
*VideoChannelsApi* | [**api_v1_accounts_name_video_channel_syncs_get**](docs/VideoChannelsApi.md#api_v1_accounts_name_video_channel_syncs_get) | **GET** /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account
|
||||
*VideoChannelsApi* | [**api_v1_accounts_name_video_channels_get**](docs/VideoChannelsApi.md#api_v1_accounts_name_video_channels_get) | **GET** /api/v1/accounts/{name}/video-channels | List video channels of an account
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_avatar_delete**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_avatar_delete) | **DELETE** /api/v1/video-channels/{channelHandle}/avatar | Delete channel avatar
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_avatar_pick_post**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_avatar_pick_post) | **POST** /api/v1/video-channels/{channelHandle}/avatar/pick | Update channel avatar
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_banner_delete**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_banner_delete) | **DELETE** /api/v1/video-channels/{channelHandle}/banner | Delete channel banner
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_banner_pick_post**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_banner_pick_post) | **POST** /api/v1/video-channels/{channelHandle}/banner/pick | Update channel banner
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_import_videos_post**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_import_videos_post) | **POST** /api/v1/video-channels/{channelHandle}/import-videos | Import videos in channel
|
||||
*VideoChannelsApi* | [**api_v1_video_channels_channel_handle_video_playlists_get**](docs/VideoChannelsApi.md#api_v1_video_channels_channel_handle_video_playlists_get) | **GET** /api/v1/video-channels/{channelHandle}/video-playlists | List playlists of a channel
|
||||
*VideoChannelsApi* | [**del_video_channel**](docs/VideoChannelsApi.md#del_video_channel) | **DELETE** /api/v1/video-channels/{channelHandle} | Delete a video channel
|
||||
*VideoChannelsApi* | [**get_video_channel**](docs/VideoChannelsApi.md#get_video_channel) | **GET** /api/v1/video-channels/{channelHandle} | Get a video channel
|
||||
*VideoChannelsApi* | [**get_video_channel_followers**](docs/VideoChannelsApi.md#get_video_channel_followers) | **GET** /api/v1/video-channels/{channelHandle}/followers | List followers of a video channel
|
||||
*VideoChannelsApi* | [**get_video_channel_videos**](docs/VideoChannelsApi.md#get_video_channel_videos) | **GET** /api/v1/video-channels/{channelHandle}/videos | List videos of a video channel
|
||||
*VideoChannelsApi* | [**get_video_channels**](docs/VideoChannelsApi.md#get_video_channels) | **GET** /api/v1/video-channels | List video channels
|
||||
*VideoChannelsApi* | [**put_video_channel**](docs/VideoChannelsApi.md#put_video_channel) | **PUT** /api/v1/video-channels/{channelHandle} | Update a video channel
|
||||
*VideoChaptersApi* | [**get_video_chapters**](docs/VideoChaptersApi.md#get_video_chapters) | **GET** /api/v1/videos/{id}/chapters | Get chapters of a video
|
||||
*VideoChaptersApi* | [**replace_video_chapters**](docs/VideoChaptersApi.md#replace_video_chapters) | **PUT** /api/v1/videos/{id}/chapters | Replace video chapters
|
||||
*VideoCommentsApi* | [**api_v1_videos_id_comment_threads_get**](docs/VideoCommentsApi.md#api_v1_videos_id_comment_threads_get) | **GET** /api/v1/videos/{id}/comment-threads | List threads of a video
|
||||
*VideoCommentsApi* | [**api_v1_videos_id_comment_threads_post**](docs/VideoCommentsApi.md#api_v1_videos_id_comment_threads_post) | **POST** /api/v1/videos/{id}/comment-threads | Create a thread
|
||||
*VideoCommentsApi* | [**api_v1_videos_id_comment_threads_thread_id_get**](docs/VideoCommentsApi.md#api_v1_videos_id_comment_threads_thread_id_get) | **GET** /api/v1/videos/{id}/comment-threads/{threadId} | Get a thread
|
||||
*VideoCommentsApi* | [**api_v1_videos_id_comments_comment_id_delete**](docs/VideoCommentsApi.md#api_v1_videos_id_comments_comment_id_delete) | **DELETE** /api/v1/videos/{id}/comments/{commentId} | Delete a comment or a reply
|
||||
*VideoCommentsApi* | [**api_v1_videos_id_comments_comment_id_post**](docs/VideoCommentsApi.md#api_v1_videos_id_comments_comment_id_post) | **POST** /api/v1/videos/{id}/comments/{commentId} | Reply to a thread of a video
|
||||
*VideoFeedsApi* | [**get_syndicated_comments**](docs/VideoFeedsApi.md#get_syndicated_comments) | **GET** /feeds/video-comments.{format} | Comments on videos feeds
|
||||
*VideoFeedsApi* | [**get_syndicated_subscription_videos**](docs/VideoFeedsApi.md#get_syndicated_subscription_videos) | **GET** /feeds/subscriptions.{format} | Videos of subscriptions feeds
|
||||
*VideoFeedsApi* | [**get_syndicated_videos**](docs/VideoFeedsApi.md#get_syndicated_videos) | **GET** /feeds/videos.{format} | Common videos feeds
|
||||
*VideoFeedsApi* | [**get_videos_podcast_feed**](docs/VideoFeedsApi.md#get_videos_podcast_feed) | **GET** /feeds/podcast/videos.xml | Videos podcast feed
|
||||
*VideoFilesApi* | [**del_video_hls**](docs/VideoFilesApi.md#del_video_hls) | **DELETE** /api/v1/videos/{id}/hls | Delete video HLS files
|
||||
*VideoFilesApi* | [**del_video_web_videos**](docs/VideoFilesApi.md#del_video_web_videos) | **DELETE** /api/v1/videos/{id}/web-videos | Delete video Web Video files
|
||||
*VideoImportsApi* | [**api_v1_videos_imports_id_cancel_post**](docs/VideoImportsApi.md#api_v1_videos_imports_id_cancel_post) | **POST** /api/v1/videos/imports/{id}/cancel | Cancel video import
|
||||
*VideoImportsApi* | [**api_v1_videos_imports_id_delete**](docs/VideoImportsApi.md#api_v1_videos_imports_id_delete) | **DELETE** /api/v1/videos/imports/{id} | Delete video import
|
||||
*VideoImportsApi* | [**import_video**](docs/VideoImportsApi.md#import_video) | **POST** /api/v1/videos/imports | Import a video
|
||||
*VideoMirroringApi* | [**del_mirrored_video**](docs/VideoMirroringApi.md#del_mirrored_video) | **DELETE** /api/v1/server/redundancy/videos/{redundancyId} | Delete a mirror done on a video
|
||||
*VideoMirroringApi* | [**get_mirrored_videos**](docs/VideoMirroringApi.md#get_mirrored_videos) | **GET** /api/v1/server/redundancy/videos | List videos being mirrored
|
||||
*VideoMirroringApi* | [**put_mirrored_video**](docs/VideoMirroringApi.md#put_mirrored_video) | **POST** /api/v1/server/redundancy/videos | Mirror a video
|
||||
*VideoOwnershipChangeApi* | [**api_v1_videos_id_give_ownership_post**](docs/VideoOwnershipChangeApi.md#api_v1_videos_id_give_ownership_post) | **POST** /api/v1/videos/{id}/give-ownership | Request ownership change
|
||||
*VideoOwnershipChangeApi* | [**api_v1_videos_ownership_get**](docs/VideoOwnershipChangeApi.md#api_v1_videos_ownership_get) | **GET** /api/v1/videos/ownership | List video ownership changes
|
||||
*VideoOwnershipChangeApi* | [**api_v1_videos_ownership_id_accept_post**](docs/VideoOwnershipChangeApi.md#api_v1_videos_ownership_id_accept_post) | **POST** /api/v1/videos/ownership/{id}/accept | Accept ownership change request
|
||||
*VideoOwnershipChangeApi* | [**api_v1_videos_ownership_id_refuse_post**](docs/VideoOwnershipChangeApi.md#api_v1_videos_ownership_id_refuse_post) | **POST** /api/v1/videos/ownership/{id}/refuse | Refuse ownership change request
|
||||
*VideoPasswordsApi* | [**api_v1_videos_id_passwords_get**](docs/VideoPasswordsApi.md#api_v1_videos_id_passwords_get) | **GET** /api/v1/videos/{id}/passwords | List video passwords
|
||||
*VideoPasswordsApi* | [**api_v1_videos_id_passwords_put**](docs/VideoPasswordsApi.md#api_v1_videos_id_passwords_put) | **PUT** /api/v1/videos/{id}/passwords | Update video passwords
|
||||
*VideoPasswordsApi* | [**api_v1_videos_id_passwords_video_password_id_delete**](docs/VideoPasswordsApi.md#api_v1_videos_id_passwords_video_password_id_delete) | **DELETE** /api/v1/videos/{id}/passwords/{videoPasswordId} | Delete a video password
|
||||
*VideoPlaylistsApi* | [**add_playlist**](docs/VideoPlaylistsApi.md#add_playlist) | **POST** /api/v1/video-playlists | Create a video playlist
|
||||
*VideoPlaylistsApi* | [**add_video_playlist_video**](docs/VideoPlaylistsApi.md#add_video_playlist_video) | **POST** /api/v1/video-playlists/{playlistId}/videos | Add a video in a playlist
|
||||
*VideoPlaylistsApi* | [**api_v1_accounts_name_video_playlists_get**](docs/VideoPlaylistsApi.md#api_v1_accounts_name_video_playlists_get) | **GET** /api/v1/accounts/{name}/video-playlists | List playlists of an account
|
||||
*VideoPlaylistsApi* | [**api_v1_users_me_video_playlists_videos_exist_get**](docs/VideoPlaylistsApi.md#api_v1_users_me_video_playlists_videos_exist_get) | **GET** /api/v1/users/me/video-playlists/videos-exist | Check video exists in my playlists
|
||||
*VideoPlaylistsApi* | [**api_v1_video_channels_channel_handle_video_playlists_get**](docs/VideoPlaylistsApi.md#api_v1_video_channels_channel_handle_video_playlists_get) | **GET** /api/v1/video-channels/{channelHandle}/video-playlists | List playlists of a channel
|
||||
*VideoPlaylistsApi* | [**api_v1_video_playlists_playlist_id_delete**](docs/VideoPlaylistsApi.md#api_v1_video_playlists_playlist_id_delete) | **DELETE** /api/v1/video-playlists/{playlistId} | Delete a video playlist
|
||||
*VideoPlaylistsApi* | [**api_v1_video_playlists_playlist_id_get**](docs/VideoPlaylistsApi.md#api_v1_video_playlists_playlist_id_get) | **GET** /api/v1/video-playlists/{playlistId} | Get a video playlist
|
||||
*VideoPlaylistsApi* | [**api_v1_video_playlists_playlist_id_put**](docs/VideoPlaylistsApi.md#api_v1_video_playlists_playlist_id_put) | **PUT** /api/v1/video-playlists/{playlistId} | Update a video playlist
|
||||
*VideoPlaylistsApi* | [**del_video_playlist_video**](docs/VideoPlaylistsApi.md#del_video_playlist_video) | **DELETE** /api/v1/video-playlists/{playlistId}/videos/{playlistElementId} | Delete an element from a playlist
|
||||
*VideoPlaylistsApi* | [**get_playlist_privacy_policies**](docs/VideoPlaylistsApi.md#get_playlist_privacy_policies) | **GET** /api/v1/video-playlists/privacies | List available playlist privacy policies
|
||||
*VideoPlaylistsApi* | [**get_playlists**](docs/VideoPlaylistsApi.md#get_playlists) | **GET** /api/v1/video-playlists | List video playlists
|
||||
*VideoPlaylistsApi* | [**get_video_playlist_videos**](docs/VideoPlaylistsApi.md#get_video_playlist_videos) | **GET** /api/v1/video-playlists/{playlistId}/videos | List videos of a playlist
|
||||
*VideoPlaylistsApi* | [**put_video_playlist_video**](docs/VideoPlaylistsApi.md#put_video_playlist_video) | **PUT** /api/v1/video-playlists/{playlistId}/videos/{playlistElementId} | Update a playlist element
|
||||
*VideoPlaylistsApi* | [**reorder_video_playlist**](docs/VideoPlaylistsApi.md#reorder_video_playlist) | **POST** /api/v1/video-playlists/{playlistId}/videos/reorder | Reorder a playlist
|
||||
*VideoRatesApi* | [**api_v1_users_me_videos_video_id_rating_get**](docs/VideoRatesApi.md#api_v1_users_me_videos_video_id_rating_get) | **GET** /api/v1/users/me/videos/{videoId}/rating | Get rate of my user for a video
|
||||
*VideoRatesApi* | [**api_v1_videos_id_rate_put**](docs/VideoRatesApi.md#api_v1_videos_id_rate_put) | **PUT** /api/v1/videos/{id}/rate | Like/dislike a video
|
||||
*VideoStatsApi* | [**api_v1_videos_id_stats_overall_get**](docs/VideoStatsApi.md#api_v1_videos_id_stats_overall_get) | **GET** /api/v1/videos/{id}/stats/overall | Get overall stats of a video
|
||||
*VideoStatsApi* | [**api_v1_videos_id_stats_retention_get**](docs/VideoStatsApi.md#api_v1_videos_id_stats_retention_get) | **GET** /api/v1/videos/{id}/stats/retention | Get retention stats of a video
|
||||
*VideoStatsApi* | [**api_v1_videos_id_stats_timeseries_metric_get**](docs/VideoStatsApi.md#api_v1_videos_id_stats_timeseries_metric_get) | **GET** /api/v1/videos/{id}/stats/timeseries/{metric} | Get timeserie stats of a video
|
||||
*VideoTranscodingApi* | [**api_v1_videos_id_studio_edit_post**](docs/VideoTranscodingApi.md#api_v1_videos_id_studio_edit_post) | **POST** /api/v1/videos/{id}/studio/edit | Create a studio task
|
||||
*VideoTranscodingApi* | [**create_video_transcoding**](docs/VideoTranscodingApi.md#create_video_transcoding) | **POST** /api/v1/videos/{id}/transcoding | Create a transcoding job
|
||||
*VideoUploadApi* | [**import_video**](docs/VideoUploadApi.md#import_video) | **POST** /api/v1/videos/imports | Import a video
|
||||
*VideoUploadApi* | [**replace_video_source_resumable**](docs/VideoUploadApi.md#replace_video_source_resumable) | **PUT** /api/v1/videos/{id}/source/replace-resumable | Send chunk for the resumable replacement of a video
|
||||
*VideoUploadApi* | [**replace_video_source_resumable_cancel**](docs/VideoUploadApi.md#replace_video_source_resumable_cancel) | **DELETE** /api/v1/videos/{id}/source/replace-resumable | Cancel the resumable replacement of a video
|
||||
*VideoUploadApi* | [**replace_video_source_resumable_init**](docs/VideoUploadApi.md#replace_video_source_resumable_init) | **POST** /api/v1/videos/{id}/source/replace-resumable | Initialize the resumable replacement of a video
|
||||
*VideoUploadApi* | [**upload_legacy**](docs/VideoUploadApi.md#upload_legacy) | **POST** /api/v1/videos/upload | Upload a video
|
||||
*VideoUploadApi* | [**upload_resumable**](docs/VideoUploadApi.md#upload_resumable) | **PUT** /api/v1/videos/upload-resumable | Send chunk for the resumable upload of a video
|
||||
*VideoUploadApi* | [**upload_resumable_cancel**](docs/VideoUploadApi.md#upload_resumable_cancel) | **DELETE** /api/v1/videos/upload-resumable | Cancel the resumable upload of a video, deleting any data uploaded so far
|
||||
*VideoUploadApi* | [**upload_resumable_init**](docs/VideoUploadApi.md#upload_resumable_init) | **POST** /api/v1/videos/upload-resumable | Initialize the resumable upload of a video
|
||||
*VideosApi* | [**add_video_playlist_video**](docs/VideosApi.md#add_video_playlist_video) | **POST** /api/v1/video-playlists/{playlistId}/videos | Add a video in a playlist
|
||||
*VideosApi* | [**api_v1_users_me_subscriptions_videos_get**](docs/VideosApi.md#api_v1_users_me_subscriptions_videos_get) | **GET** /api/v1/users/me/subscriptions/videos | List videos of subscriptions of my user
|
||||
*VideosApi* | [**api_v1_users_me_videos_get**](docs/VideosApi.md#api_v1_users_me_videos_get) | **GET** /api/v1/users/me/videos | Get videos of my user
|
||||
*VideosApi* | [**api_v1_users_me_videos_imports_get**](docs/VideosApi.md#api_v1_users_me_videos_imports_get) | **GET** /api/v1/users/me/videos/imports | Get video imports of my user
|
||||
*VideosApi* | [**get_video_playlist_videos**](docs/VideosApi.md#get_video_playlist_videos) | **GET** /api/v1/video-playlists/{playlistId}/videos | List videos of a playlist
|
||||
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [Abuse](docs/Abuse.md)
|
||||
- [AbuseMessage](docs/AbuseMessage.md)
|
||||
- [AbuseStateConstant](docs/AbuseStateConstant.md)
|
||||
- [AbuseStateSet](docs/AbuseStateSet.md)
|
||||
- [Account](docs/Account.md)
|
||||
- [AccountSummary](docs/AccountSummary.md)
|
||||
- [Actor](docs/Actor.md)
|
||||
- [ActorImage](docs/ActorImage.md)
|
||||
- [ActorInfo](docs/ActorInfo.md)
|
||||
- [AddIntroOptions](docs/AddIntroOptions.md)
|
||||
- [AddPlaylist200Response](docs/AddPlaylist200Response.md)
|
||||
- [AddPlaylist200ResponseVideoPlaylist](docs/AddPlaylist200ResponseVideoPlaylist.md)
|
||||
- [AddPluginRequest](docs/AddPluginRequest.md)
|
||||
- [AddPluginRequestOneOf](docs/AddPluginRequestOneOf.md)
|
||||
- [AddPluginRequestOneOf1](docs/AddPluginRequestOneOf1.md)
|
||||
- [AddUser](docs/AddUser.md)
|
||||
- [AddUserResponse](docs/AddUserResponse.md)
|
||||
- [AddUserResponseUser](docs/AddUserResponseUser.md)
|
||||
- [AddVideoChannel200Response](docs/AddVideoChannel200Response.md)
|
||||
- [AddVideoChannelSync200Response](docs/AddVideoChannelSync200Response.md)
|
||||
- [AddVideoPlaylistVideo200Response](docs/AddVideoPlaylistVideo200Response.md)
|
||||
- [AddVideoPlaylistVideo200ResponseVideoPlaylistElement](docs/AddVideoPlaylistVideo200ResponseVideoPlaylistElement.md)
|
||||
- [AddVideoPlaylistVideoRequest](docs/AddVideoPlaylistVideoRequest.md)
|
||||
- [AddVideoPlaylistVideoRequestVideoId](docs/AddVideoPlaylistVideoRequestVideoId.md)
|
||||
- [ApiV1AbusesAbuseIdMessagesGet200Response](docs/ApiV1AbusesAbuseIdMessagesGet200Response.md)
|
||||
- [ApiV1AbusesAbuseIdMessagesPostRequest](docs/ApiV1AbusesAbuseIdMessagesPostRequest.md)
|
||||
- [ApiV1AbusesAbuseIdPutRequest](docs/ApiV1AbusesAbuseIdPutRequest.md)
|
||||
- [ApiV1AbusesPost200Response](docs/ApiV1AbusesPost200Response.md)
|
||||
- [ApiV1AbusesPost200ResponseAbuse](docs/ApiV1AbusesPost200ResponseAbuse.md)
|
||||
- [ApiV1AbusesPostRequest](docs/ApiV1AbusesPostRequest.md)
|
||||
- [ApiV1AbusesPostRequestAccount](docs/ApiV1AbusesPostRequestAccount.md)
|
||||
- [ApiV1AbusesPostRequestComment](docs/ApiV1AbusesPostRequestComment.md)
|
||||
- [ApiV1AbusesPostRequestVideo](docs/ApiV1AbusesPostRequestVideo.md)
|
||||
- [ApiV1CustomPagesHomepageInstancePutRequest](docs/ApiV1CustomPagesHomepageInstancePutRequest.md)
|
||||
- [ApiV1PluginsNpmNameSettingsPutRequest](docs/ApiV1PluginsNpmNameSettingsPutRequest.md)
|
||||
- [ApiV1RunnersGet200Response](docs/ApiV1RunnersGet200Response.md)
|
||||
- [ApiV1RunnersJobsGet200Response](docs/ApiV1RunnersJobsGet200Response.md)
|
||||
- [ApiV1RunnersJobsJobUUIDAbortPostRequest](docs/ApiV1RunnersJobsJobUUIDAbortPostRequest.md)
|
||||
- [ApiV1RunnersJobsJobUUIDAcceptPost200Response](docs/ApiV1RunnersJobsJobUUIDAcceptPost200Response.md)
|
||||
- [ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob](docs/ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.md)
|
||||
- [ApiV1RunnersJobsJobUUIDErrorPostRequest](docs/ApiV1RunnersJobsJobUUIDErrorPostRequest.md)
|
||||
- [ApiV1RunnersJobsJobUUIDSuccessPostRequest](docs/ApiV1RunnersJobsJobUUIDSuccessPostRequest.md)
|
||||
- [ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload](docs/ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.md)
|
||||
- [ApiV1RunnersJobsJobUUIDUpdatePostRequest](docs/ApiV1RunnersJobsJobUUIDUpdatePostRequest.md)
|
||||
- [ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload](docs/ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.md)
|
||||
- [ApiV1RunnersJobsRequestPost200Response](docs/ApiV1RunnersJobsRequestPost200Response.md)
|
||||
- [ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner](docs/ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner.md)
|
||||
- [ApiV1RunnersRegisterPost200Response](docs/ApiV1RunnersRegisterPost200Response.md)
|
||||
- [ApiV1RunnersRegisterPostRequest](docs/ApiV1RunnersRegisterPostRequest.md)
|
||||
- [ApiV1RunnersRegistrationTokensGet200Response](docs/ApiV1RunnersRegistrationTokensGet200Response.md)
|
||||
- [ApiV1RunnersUnregisterPostRequest](docs/ApiV1RunnersUnregisterPostRequest.md)
|
||||
- [ApiV1ServerBlocklistAccountsPostRequest](docs/ApiV1ServerBlocklistAccountsPostRequest.md)
|
||||
- [ApiV1ServerBlocklistServersPostRequest](docs/ApiV1ServerBlocklistServersPostRequest.md)
|
||||
- [ApiV1ServerFollowingPostRequest](docs/ApiV1ServerFollowingPostRequest.md)
|
||||
- [ApiV1ServerRedundancyHostPutRequest](docs/ApiV1ServerRedundancyHostPutRequest.md)
|
||||
- [ApiV1UsersMeAvatarPickPost200Response](docs/ApiV1UsersMeAvatarPickPost200Response.md)
|
||||
- [ApiV1UsersMeNotificationSettingsPutRequest](docs/ApiV1UsersMeNotificationSettingsPutRequest.md)
|
||||
- [ApiV1UsersMeNotificationsReadPostRequest](docs/ApiV1UsersMeNotificationsReadPostRequest.md)
|
||||
- [ApiV1UsersMeSubscriptionsPostRequest](docs/ApiV1UsersMeSubscriptionsPostRequest.md)
|
||||
- [ApiV1UsersMeVideoPlaylistsVideosExistGet200Response](docs/ApiV1UsersMeVideoPlaylistsVideosExistGet200Response.md)
|
||||
- [ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner](docs/ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner.md)
|
||||
- [ApiV1UsersMeVideoQuotaUsedGet200Response](docs/ApiV1UsersMeVideoQuotaUsedGet200Response.md)
|
||||
- [ApiV1VideoChannelsChannelHandleBannerPickPost200Response](docs/ApiV1VideoChannelsChannelHandleBannerPickPost200Response.md)
|
||||
- [ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response](docs/ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response.md)
|
||||
- [ApiV1VideosIdCommentThreadsPostRequest](docs/ApiV1VideosIdCommentThreadsPostRequest.md)
|
||||
- [ApiV1VideosIdPasswordsPutRequest](docs/ApiV1VideosIdPasswordsPutRequest.md)
|
||||
- [ApiV1VideosIdRatePutRequest](docs/ApiV1VideosIdRatePutRequest.md)
|
||||
- [ApiV1VideosLiveIdSessionsGet200Response](docs/ApiV1VideosLiveIdSessionsGet200Response.md)
|
||||
- [ApiV1VideosOwnershipIdAcceptPostIdParameter](docs/ApiV1VideosOwnershipIdAcceptPostIdParameter.md)
|
||||
- [BlockStatus](docs/BlockStatus.md)
|
||||
- [BlockStatusAccountsValue](docs/BlockStatusAccountsValue.md)
|
||||
- [BlockStatusHostsValue](docs/BlockStatusHostsValue.md)
|
||||
- [CommentThreadPostResponse](docs/CommentThreadPostResponse.md)
|
||||
- [CommentThreadResponse](docs/CommentThreadResponse.md)
|
||||
- [ConfirmTwoFactorRequestRequest](docs/ConfirmTwoFactorRequestRequest.md)
|
||||
- [CreateVideoTranscodingRequest](docs/CreateVideoTranscodingRequest.md)
|
||||
- [CustomHomepage](docs/CustomHomepage.md)
|
||||
- [CutOptions](docs/CutOptions.md)
|
||||
- [FileRedundancyInformation](docs/FileRedundancyInformation.md)
|
||||
- [Follow](docs/Follow.md)
|
||||
- [GetAccountFollowers200Response](docs/GetAccountFollowers200Response.md)
|
||||
- [GetAccountVideosCategoryOneOfParameter](docs/GetAccountVideosCategoryOneOfParameter.md)
|
||||
- [GetAccountVideosLanguageOneOfParameter](docs/GetAccountVideosLanguageOneOfParameter.md)
|
||||
- [GetAccountVideosLicenceOneOfParameter](docs/GetAccountVideosLicenceOneOfParameter.md)
|
||||
- [GetAccountVideosTagsAllOfParameter](docs/GetAccountVideosTagsAllOfParameter.md)
|
||||
- [GetAccountVideosTagsOneOfParameter](docs/GetAccountVideosTagsOneOfParameter.md)
|
||||
- [GetAccounts200Response](docs/GetAccounts200Response.md)
|
||||
- [GetJobs200Response](docs/GetJobs200Response.md)
|
||||
- [GetMeVideoRating](docs/GetMeVideoRating.md)
|
||||
- [GetMyAbuses200Response](docs/GetMyAbuses200Response.md)
|
||||
- [GetOAuthToken200Response](docs/GetOAuthToken200Response.md)
|
||||
- [GetUser200Response](docs/GetUser200Response.md)
|
||||
- [GetVideoBlocks200Response](docs/GetVideoBlocks200Response.md)
|
||||
- [GetVideoCaptions200Response](docs/GetVideoCaptions200Response.md)
|
||||
- [ImportVideosInChannelCreate](docs/ImportVideosInChannelCreate.md)
|
||||
- [Job](docs/Job.md)
|
||||
- [ListRegistrations200Response](docs/ListRegistrations200Response.md)
|
||||
- [ListVideoStoryboards200Response](docs/ListVideoStoryboards200Response.md)
|
||||
- [LiveVideoLatencyMode](docs/LiveVideoLatencyMode.md)
|
||||
- [LiveVideoReplaySettings](docs/LiveVideoReplaySettings.md)
|
||||
- [LiveVideoResponse](docs/LiveVideoResponse.md)
|
||||
- [LiveVideoSessionResponse](docs/LiveVideoSessionResponse.md)
|
||||
- [LiveVideoSessionResponseReplayVideo](docs/LiveVideoSessionResponseReplayVideo.md)
|
||||
- [LiveVideoUpdate](docs/LiveVideoUpdate.md)
|
||||
- [MRSSGroupContent](docs/MRSSGroupContent.md)
|
||||
- [MRSSPeerLink](docs/MRSSPeerLink.md)
|
||||
- [NSFWPolicy](docs/NSFWPolicy.md)
|
||||
- [Notification](docs/Notification.md)
|
||||
- [NotificationActorFollow](docs/NotificationActorFollow.md)
|
||||
- [NotificationActorFollowFollowing](docs/NotificationActorFollowFollowing.md)
|
||||
- [NotificationComment](docs/NotificationComment.md)
|
||||
- [NotificationListResponse](docs/NotificationListResponse.md)
|
||||
- [NotificationVideo](docs/NotificationVideo.md)
|
||||
- [NotificationVideoAbuse](docs/NotificationVideoAbuse.md)
|
||||
- [NotificationVideoImport](docs/NotificationVideoImport.md)
|
||||
- [OAuthClient](docs/OAuthClient.md)
|
||||
- [PlaybackMetricCreate](docs/PlaybackMetricCreate.md)
|
||||
- [PlaylistElement](docs/PlaylistElement.md)
|
||||
- [Plugin](docs/Plugin.md)
|
||||
- [PluginResponse](docs/PluginResponse.md)
|
||||
- [PutMirroredVideoRequest](docs/PutMirroredVideoRequest.md)
|
||||
- [PutVideoPlaylistVideoRequest](docs/PutVideoPlaylistVideoRequest.md)
|
||||
- [RegisterUser](docs/RegisterUser.md)
|
||||
- [RegisterUserChannel](docs/RegisterUserChannel.md)
|
||||
- [ReorderVideoPlaylistRequest](docs/ReorderVideoPlaylistRequest.md)
|
||||
- [ReplaceVideoChaptersRequest](docs/ReplaceVideoChaptersRequest.md)
|
||||
- [ReplaceVideoChaptersRequestChaptersInner](docs/ReplaceVideoChaptersRequestChaptersInner.md)
|
||||
- [RequestTwoFactorRequest](docs/RequestTwoFactorRequest.md)
|
||||
- [RequestTwoFactorResponse](docs/RequestTwoFactorResponse.md)
|
||||
- [RequestTwoFactorResponseOtpRequest](docs/RequestTwoFactorResponseOtpRequest.md)
|
||||
- [ResendEmailToVerifyRegistrationRequest](docs/ResendEmailToVerifyRegistrationRequest.md)
|
||||
- [ResendEmailToVerifyUserRequest](docs/ResendEmailToVerifyUserRequest.md)
|
||||
- [Runner](docs/Runner.md)
|
||||
- [RunnerJob](docs/RunnerJob.md)
|
||||
- [RunnerJobAdmin](docs/RunnerJobAdmin.md)
|
||||
- [RunnerJobParent](docs/RunnerJobParent.md)
|
||||
- [RunnerJobPayload](docs/RunnerJobPayload.md)
|
||||
- [RunnerJobRunner](docs/RunnerJobRunner.md)
|
||||
- [RunnerJobState](docs/RunnerJobState.md)
|
||||
- [RunnerJobStateConstant](docs/RunnerJobStateConstant.md)
|
||||
- [RunnerJobType](docs/RunnerJobType.md)
|
||||
- [RunnerRegistrationToken](docs/RunnerRegistrationToken.md)
|
||||
- [SendClientLog](docs/SendClientLog.md)
|
||||
- [ServerConfig](docs/ServerConfig.md)
|
||||
- [ServerConfigAbout](docs/ServerConfigAbout.md)
|
||||
- [ServerConfigAboutInstance](docs/ServerConfigAboutInstance.md)
|
||||
- [ServerConfigAutoBlacklist](docs/ServerConfigAutoBlacklist.md)
|
||||
- [ServerConfigAutoBlacklistVideos](docs/ServerConfigAutoBlacklistVideos.md)
|
||||
- [ServerConfigAvatar](docs/ServerConfigAvatar.md)
|
||||
- [ServerConfigAvatarFile](docs/ServerConfigAvatarFile.md)
|
||||
- [ServerConfigAvatarFileSize](docs/ServerConfigAvatarFileSize.md)
|
||||
- [ServerConfigCustom](docs/ServerConfigCustom.md)
|
||||
- [ServerConfigCustomAdmin](docs/ServerConfigCustomAdmin.md)
|
||||
- [ServerConfigCustomCache](docs/ServerConfigCustomCache.md)
|
||||
- [ServerConfigCustomCachePreviews](docs/ServerConfigCustomCachePreviews.md)
|
||||
- [ServerConfigCustomFollowers](docs/ServerConfigCustomFollowers.md)
|
||||
- [ServerConfigCustomFollowersInstance](docs/ServerConfigCustomFollowersInstance.md)
|
||||
- [ServerConfigCustomImport](docs/ServerConfigCustomImport.md)
|
||||
- [ServerConfigCustomInstance](docs/ServerConfigCustomInstance.md)
|
||||
- [ServerConfigCustomServices](docs/ServerConfigCustomServices.md)
|
||||
- [ServerConfigCustomServicesTwitter](docs/ServerConfigCustomServicesTwitter.md)
|
||||
- [ServerConfigCustomSignup](docs/ServerConfigCustomSignup.md)
|
||||
- [ServerConfigCustomTheme](docs/ServerConfigCustomTheme.md)
|
||||
- [ServerConfigCustomTranscoding](docs/ServerConfigCustomTranscoding.md)
|
||||
- [ServerConfigCustomTranscodingHls](docs/ServerConfigCustomTranscodingHls.md)
|
||||
- [ServerConfigCustomTranscodingResolutions](docs/ServerConfigCustomTranscodingResolutions.md)
|
||||
- [ServerConfigCustomTranscodingWebVideos](docs/ServerConfigCustomTranscodingWebVideos.md)
|
||||
- [ServerConfigCustomUser](docs/ServerConfigCustomUser.md)
|
||||
- [ServerConfigEmail](docs/ServerConfigEmail.md)
|
||||
- [ServerConfigFollowings](docs/ServerConfigFollowings.md)
|
||||
- [ServerConfigFollowingsInstance](docs/ServerConfigFollowingsInstance.md)
|
||||
- [ServerConfigFollowingsInstanceAutoFollowIndex](docs/ServerConfigFollowingsInstanceAutoFollowIndex.md)
|
||||
- [ServerConfigImport](docs/ServerConfigImport.md)
|
||||
- [ServerConfigImportVideos](docs/ServerConfigImportVideos.md)
|
||||
- [ServerConfigInstance](docs/ServerConfigInstance.md)
|
||||
- [ServerConfigInstanceCustomizations](docs/ServerConfigInstanceCustomizations.md)
|
||||
- [ServerConfigOpenTelemetry](docs/ServerConfigOpenTelemetry.md)
|
||||
- [ServerConfigOpenTelemetryMetrics](docs/ServerConfigOpenTelemetryMetrics.md)
|
||||
- [ServerConfigPlugin](docs/ServerConfigPlugin.md)
|
||||
- [ServerConfigSearch](docs/ServerConfigSearch.md)
|
||||
- [ServerConfigSearchRemoteUri](docs/ServerConfigSearchRemoteUri.md)
|
||||
- [ServerConfigSignup](docs/ServerConfigSignup.md)
|
||||
- [ServerConfigTranscoding](docs/ServerConfigTranscoding.md)
|
||||
- [ServerConfigTrending](docs/ServerConfigTrending.md)
|
||||
- [ServerConfigTrendingVideos](docs/ServerConfigTrendingVideos.md)
|
||||
- [ServerConfigUser](docs/ServerConfigUser.md)
|
||||
- [ServerConfigVideo](docs/ServerConfigVideo.md)
|
||||
- [ServerConfigVideoCaption](docs/ServerConfigVideoCaption.md)
|
||||
- [ServerConfigVideoCaptionFile](docs/ServerConfigVideoCaptionFile.md)
|
||||
- [ServerConfigVideoFile](docs/ServerConfigVideoFile.md)
|
||||
- [ServerConfigVideoImage](docs/ServerConfigVideoImage.md)
|
||||
- [ServerConfigViews](docs/ServerConfigViews.md)
|
||||
- [ServerConfigViewsViews](docs/ServerConfigViewsViews.md)
|
||||
- [ServerConfigViewsViewsWatchingInterval](docs/ServerConfigViewsViewsWatchingInterval.md)
|
||||
- [ServerStats](docs/ServerStats.md)
|
||||
- [ServerStatsVideosRedundancyInner](docs/ServerStatsVideosRedundancyInner.md)
|
||||
- [Storyboard](docs/Storyboard.md)
|
||||
- [UninstallPluginRequest](docs/UninstallPluginRequest.md)
|
||||
- [UpdateMe](docs/UpdateMe.md)
|
||||
- [UpdateUser](docs/UpdateUser.md)
|
||||
- [User](docs/User.md)
|
||||
- [UserAdminFlags](docs/UserAdminFlags.md)
|
||||
- [UserRegistration](docs/UserRegistration.md)
|
||||
- [UserRegistrationAcceptOrReject](docs/UserRegistrationAcceptOrReject.md)
|
||||
- [UserRegistrationRequest](docs/UserRegistrationRequest.md)
|
||||
- [UserRegistrationState](docs/UserRegistrationState.md)
|
||||
- [UserRegistrationUser](docs/UserRegistrationUser.md)
|
||||
- [UserRole](docs/UserRole.md)
|
||||
- [UserViewingVideo](docs/UserViewingVideo.md)
|
||||
- [UserWithStats](docs/UserWithStats.md)
|
||||
- [VODAudioMergeTranscoding](docs/VODAudioMergeTranscoding.md)
|
||||
- [VODAudioMergeTranscoding1](docs/VODAudioMergeTranscoding1.md)
|
||||
- [VODAudioMergeTranscoding1Input](docs/VODAudioMergeTranscoding1Input.md)
|
||||
- [VODHLSTranscoding](docs/VODHLSTranscoding.md)
|
||||
- [VODHLSTranscoding1](docs/VODHLSTranscoding1.md)
|
||||
- [VODWebVideoTranscoding](docs/VODWebVideoTranscoding.md)
|
||||
- [VODWebVideoTranscoding1](docs/VODWebVideoTranscoding1.md)
|
||||
- [VODWebVideoTranscoding1Input](docs/VODWebVideoTranscoding1Input.md)
|
||||
- [VODWebVideoTranscoding1Output](docs/VODWebVideoTranscoding1Output.md)
|
||||
- [VerifyRegistrationEmailRequest](docs/VerifyRegistrationEmailRequest.md)
|
||||
- [VerifyUserRequest](docs/VerifyUserRequest.md)
|
||||
- [Video](docs/Video.md)
|
||||
- [VideoBlacklist](docs/VideoBlacklist.md)
|
||||
- [VideoCaption](docs/VideoCaption.md)
|
||||
- [VideoChannel](docs/VideoChannel.md)
|
||||
- [VideoChannelAllOfOwnerAccount](docs/VideoChannelAllOfOwnerAccount.md)
|
||||
- [VideoChannelCreate](docs/VideoChannelCreate.md)
|
||||
- [VideoChannelEdit](docs/VideoChannelEdit.md)
|
||||
- [VideoChannelList](docs/VideoChannelList.md)
|
||||
- [VideoChannelListDataInner](docs/VideoChannelListDataInner.md)
|
||||
- [VideoChannelSummary](docs/VideoChannelSummary.md)
|
||||
- [VideoChannelSync](docs/VideoChannelSync.md)
|
||||
- [VideoChannelSyncCreate](docs/VideoChannelSyncCreate.md)
|
||||
- [VideoChannelSyncList](docs/VideoChannelSyncList.md)
|
||||
- [VideoChannelSyncState](docs/VideoChannelSyncState.md)
|
||||
- [VideoChannelUpdate](docs/VideoChannelUpdate.md)
|
||||
- [VideoChapters](docs/VideoChapters.md)
|
||||
- [VideoComment](docs/VideoComment.md)
|
||||
- [VideoCommentThreadTree](docs/VideoCommentThreadTree.md)
|
||||
- [VideoCommentsForXMLInner](docs/VideoCommentsForXMLInner.md)
|
||||
- [VideoConstantNumberCategory](docs/VideoConstantNumberCategory.md)
|
||||
- [VideoConstantNumberLicence](docs/VideoConstantNumberLicence.md)
|
||||
- [VideoConstantStringLanguage](docs/VideoConstantStringLanguage.md)
|
||||
- [VideoDetails](docs/VideoDetails.md)
|
||||
- [VideoFile](docs/VideoFile.md)
|
||||
- [VideoImport](docs/VideoImport.md)
|
||||
- [VideoImportStateConstant](docs/VideoImportStateConstant.md)
|
||||
- [VideoImportsList](docs/VideoImportsList.md)
|
||||
- [VideoInfo](docs/VideoInfo.md)
|
||||
- [VideoListResponse](docs/VideoListResponse.md)
|
||||
- [VideoPassword](docs/VideoPassword.md)
|
||||
- [VideoPasswordList](docs/VideoPasswordList.md)
|
||||
- [VideoPlaylist](docs/VideoPlaylist.md)
|
||||
- [VideoPlaylistPrivacyConstant](docs/VideoPlaylistPrivacyConstant.md)
|
||||
- [VideoPlaylistPrivacySet](docs/VideoPlaylistPrivacySet.md)
|
||||
- [VideoPlaylistTypeConstant](docs/VideoPlaylistTypeConstant.md)
|
||||
- [VideoPlaylistTypeSet](docs/VideoPlaylistTypeSet.md)
|
||||
- [VideoPrivacyConstant](docs/VideoPrivacyConstant.md)
|
||||
- [VideoPrivacySet](docs/VideoPrivacySet.md)
|
||||
- [VideoRating](docs/VideoRating.md)
|
||||
- [VideoRedundancy](docs/VideoRedundancy.md)
|
||||
- [VideoRedundancyRedundancies](docs/VideoRedundancyRedundancies.md)
|
||||
- [VideoReplaceSourceRequestResumable](docs/VideoReplaceSourceRequestResumable.md)
|
||||
- [VideoResolutionConstant](docs/VideoResolutionConstant.md)
|
||||
- [VideoScheduledUpdate](docs/VideoScheduledUpdate.md)
|
||||
- [VideoSource](docs/VideoSource.md)
|
||||
- [VideoStateConstant](docs/VideoStateConstant.md)
|
||||
- [VideoStatsOverall](docs/VideoStatsOverall.md)
|
||||
- [VideoStatsOverallCountriesInner](docs/VideoStatsOverallCountriesInner.md)
|
||||
- [VideoStatsRetention](docs/VideoStatsRetention.md)
|
||||
- [VideoStatsRetentionDataInner](docs/VideoStatsRetentionDataInner.md)
|
||||
- [VideoStatsTimeserie](docs/VideoStatsTimeserie.md)
|
||||
- [VideoStatsTimeserieDataInner](docs/VideoStatsTimeserieDataInner.md)
|
||||
- [VideoStreamingPlaylists](docs/VideoStreamingPlaylists.md)
|
||||
- [VideoStreamingPlaylistsHLS](docs/VideoStreamingPlaylistsHLS.md)
|
||||
- [VideoStreamingPlaylistsHLSRedundanciesInner](docs/VideoStreamingPlaylistsHLSRedundanciesInner.md)
|
||||
- [VideoTokenResponse](docs/VideoTokenResponse.md)
|
||||
- [VideoTokenResponseFiles](docs/VideoTokenResponseFiles.md)
|
||||
- [VideoUploadRequestCommon](docs/VideoUploadRequestCommon.md)
|
||||
- [VideoUploadRequestResumable](docs/VideoUploadRequestResumable.md)
|
||||
- [VideoUploadResponse](docs/VideoUploadResponse.md)
|
||||
- [VideoUploadResponseVideo](docs/VideoUploadResponseVideo.md)
|
||||
- [VideoUserHistory](docs/VideoUserHistory.md)
|
||||
- [VideosForXMLInner](docs/VideosForXMLInner.md)
|
||||
- [VideosForXMLInnerEnclosure](docs/VideosForXMLInnerEnclosure.md)
|
||||
- [VideosForXMLInnerMediaCommunity](docs/VideosForXMLInnerMediaCommunity.md)
|
||||
- [VideosForXMLInnerMediaCommunityMediaStatistics](docs/VideosForXMLInnerMediaCommunityMediaStatistics.md)
|
||||
- [VideosForXMLInnerMediaEmbed](docs/VideosForXMLInnerMediaEmbed.md)
|
||||
- [VideosForXMLInnerMediaGroupInner](docs/VideosForXMLInnerMediaGroupInner.md)
|
||||
- [VideosForXMLInnerMediaPlayer](docs/VideosForXMLInnerMediaPlayer.md)
|
||||
- [VideosForXMLInnerMediaThumbnail](docs/VideosForXMLInnerMediaThumbnail.md)
|
||||
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="OAuth2"></a>
|
||||
### OAuth2
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: password
|
||||
- **Authorization URL**:
|
||||
- **Scopes**:
|
||||
- **admin**: Admin scope
|
||||
- **moderator**: Moderator scope
|
||||
- **user**: User scope
|
||||
|
||||
|
||||
## Author
|
||||
|
||||
|
||||
|
||||
|
||||
36
docs/Abuse.md
Normal file
36
docs/Abuse.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Abuse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**reason** | **str** | | [optional]
|
||||
**predefined_reasons** | **List[str]** | | [optional]
|
||||
**reporter_account** | [**Account**](Account.md) | | [optional]
|
||||
**state** | [**AbuseStateConstant**](AbuseStateConstant.md) | | [optional]
|
||||
**moderation_comment** | **str** | | [optional]
|
||||
**video** | [**VideoInfo**](VideoInfo.md) | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.abuse import Abuse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Abuse from a JSON string
|
||||
abuse_instance = Abuse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print Abuse.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
abuse_dict = abuse_instance.to_dict()
|
||||
# create an instance of Abuse from a dict
|
||||
abuse_form_dict = abuse.from_dict(abuse_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
33
docs/AbuseMessage.md
Normal file
33
docs/AbuseMessage.md
Normal file
@ -0,0 +1,33 @@
|
||||
# AbuseMessage
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**message** | **str** | | [optional]
|
||||
**by_moderator** | **bool** | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**account** | [**AccountSummary**](AccountSummary.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.abuse_message import AbuseMessage
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AbuseMessage from a JSON string
|
||||
abuse_message_instance = AbuseMessage.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AbuseMessage.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
abuse_message_dict = abuse_message_instance.to_dict()
|
||||
# create an instance of AbuseMessage from a dict
|
||||
abuse_message_form_dict = abuse_message.from_dict(abuse_message_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/AbuseStateConstant.md
Normal file
30
docs/AbuseStateConstant.md
Normal file
@ -0,0 +1,30 @@
|
||||
# AbuseStateConstant
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**AbuseStateSet**](AbuseStateSet.md) | | [optional]
|
||||
**label** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.abuse_state_constant import AbuseStateConstant
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AbuseStateConstant from a JSON string
|
||||
abuse_state_constant_instance = AbuseStateConstant.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AbuseStateConstant.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
abuse_state_constant_dict = abuse_state_constant_instance.to_dict()
|
||||
# create an instance of AbuseStateConstant from a dict
|
||||
abuse_state_constant_form_dict = abuse_state_constant.from_dict(abuse_state_constant_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
docs/AbuseStateSet.md
Normal file
12
docs/AbuseStateSet.md
Normal file
@ -0,0 +1,12 @@
|
||||
# AbuseStateSet
|
||||
|
||||
The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
635
docs/AbusesApi.md
Normal file
635
docs/AbusesApi.md
Normal file
@ -0,0 +1,635 @@
|
||||
# peertube.AbusesApi
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**api_v1_abuses_abuse_id_delete**](AbusesApi.md#api_v1_abuses_abuse_id_delete) | **DELETE** /api/v1/abuses/{abuseId} | Delete an abuse
|
||||
[**api_v1_abuses_abuse_id_messages_abuse_message_id_delete**](AbusesApi.md#api_v1_abuses_abuse_id_messages_abuse_message_id_delete) | **DELETE** /api/v1/abuses/{abuseId}/messages/{abuseMessageId} | Delete an abuse message
|
||||
[**api_v1_abuses_abuse_id_messages_get**](AbusesApi.md#api_v1_abuses_abuse_id_messages_get) | **GET** /api/v1/abuses/{abuseId}/messages | List messages of an abuse
|
||||
[**api_v1_abuses_abuse_id_messages_post**](AbusesApi.md#api_v1_abuses_abuse_id_messages_post) | **POST** /api/v1/abuses/{abuseId}/messages | Add message to an abuse
|
||||
[**api_v1_abuses_abuse_id_put**](AbusesApi.md#api_v1_abuses_abuse_id_put) | **PUT** /api/v1/abuses/{abuseId} | Update an abuse
|
||||
[**api_v1_abuses_post**](AbusesApi.md#api_v1_abuses_post) | **POST** /api/v1/abuses | Report an abuse
|
||||
[**get_abuses**](AbusesApi.md#get_abuses) | **GET** /api/v1/abuses | List abuses
|
||||
[**get_my_abuses**](AbusesApi.md#get_my_abuses) | **GET** /api/v1/users/me/abuses | List my abuses
|
||||
|
||||
|
||||
# **api_v1_abuses_abuse_id_delete**
|
||||
> api_v1_abuses_abuse_id_delete(abuse_id)
|
||||
|
||||
Delete an abuse
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
|
||||
try:
|
||||
# Delete an abuse
|
||||
api_instance.api_v1_abuses_abuse_id_delete(abuse_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_delete: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**abuse_id** | **int**| Abuse id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
**404** | block not found | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_abuses_abuse_id_messages_abuse_message_id_delete**
|
||||
> api_v1_abuses_abuse_id_messages_abuse_message_id_delete(abuse_id, abuse_message_id)
|
||||
|
||||
Delete an abuse message
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
abuse_message_id = 56 # int | Abuse message id
|
||||
|
||||
try:
|
||||
# Delete an abuse message
|
||||
api_instance.api_v1_abuses_abuse_id_messages_abuse_message_id_delete(abuse_id, abuse_message_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_messages_abuse_message_id_delete: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**abuse_id** | **int**| Abuse id |
|
||||
**abuse_message_id** | **int**| Abuse message id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_abuses_abuse_id_messages_get**
|
||||
> ApiV1AbusesAbuseIdMessagesGet200Response api_v1_abuses_abuse_id_messages_get(abuse_id)
|
||||
|
||||
List messages of an abuse
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_abuses_abuse_id_messages_get200_response import ApiV1AbusesAbuseIdMessagesGet200Response
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
|
||||
try:
|
||||
# List messages of an abuse
|
||||
api_response = api_instance.api_v1_abuses_abuse_id_messages_get(abuse_id)
|
||||
print("The response of AbusesApi->api_v1_abuses_abuse_id_messages_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_messages_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**abuse_id** | **int**| Abuse id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ApiV1AbusesAbuseIdMessagesGet200Response**](ApiV1AbusesAbuseIdMessagesGet200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_abuses_abuse_id_messages_post**
|
||||
> api_v1_abuses_abuse_id_messages_post(abuse_id, api_v1_abuses_abuse_id_messages_post_request)
|
||||
|
||||
Add message to an abuse
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_abuses_abuse_id_messages_post_request import ApiV1AbusesAbuseIdMessagesPostRequest
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
api_v1_abuses_abuse_id_messages_post_request = peertube.ApiV1AbusesAbuseIdMessagesPostRequest() # ApiV1AbusesAbuseIdMessagesPostRequest |
|
||||
|
||||
try:
|
||||
# Add message to an abuse
|
||||
api_instance.api_v1_abuses_abuse_id_messages_post(abuse_id, api_v1_abuses_abuse_id_messages_post_request)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_messages_post: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**abuse_id** | **int**| Abuse id |
|
||||
**api_v1_abuses_abuse_id_messages_post_request** | [**ApiV1AbusesAbuseIdMessagesPostRequest**](ApiV1AbusesAbuseIdMessagesPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
**400** | incorrect request parameters | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_abuses_abuse_id_put**
|
||||
> api_v1_abuses_abuse_id_put(abuse_id, api_v1_abuses_abuse_id_put_request=api_v1_abuses_abuse_id_put_request)
|
||||
|
||||
Update an abuse
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_abuses_abuse_id_put_request import ApiV1AbusesAbuseIdPutRequest
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
abuse_id = 56 # int | Abuse id
|
||||
api_v1_abuses_abuse_id_put_request = peertube.ApiV1AbusesAbuseIdPutRequest() # ApiV1AbusesAbuseIdPutRequest | (optional)
|
||||
|
||||
try:
|
||||
# Update an abuse
|
||||
api_instance.api_v1_abuses_abuse_id_put(abuse_id, api_v1_abuses_abuse_id_put_request=api_v1_abuses_abuse_id_put_request)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_abuse_id_put: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**abuse_id** | **int**| Abuse id |
|
||||
**api_v1_abuses_abuse_id_put_request** | [**ApiV1AbusesAbuseIdPutRequest**](ApiV1AbusesAbuseIdPutRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
**404** | abuse not found | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_abuses_post**
|
||||
> ApiV1AbusesPost200Response api_v1_abuses_post(api_v1_abuses_post_request)
|
||||
|
||||
Report an abuse
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_abuses_post200_response import ApiV1AbusesPost200Response
|
||||
from peertube.models.api_v1_abuses_post_request import ApiV1AbusesPostRequest
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
api_v1_abuses_post_request = peertube.ApiV1AbusesPostRequest() # ApiV1AbusesPostRequest |
|
||||
|
||||
try:
|
||||
# Report an abuse
|
||||
api_response = api_instance.api_v1_abuses_post(api_v1_abuses_post_request)
|
||||
print("The response of AbusesApi->api_v1_abuses_post:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->api_v1_abuses_post: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**api_v1_abuses_post_request** | [**ApiV1AbusesPostRequest**](ApiV1AbusesPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ApiV1AbusesPost200Response**](ApiV1AbusesPost200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
**400** | incorrect request parameters | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_abuses**
|
||||
> GetMyAbuses200Response get_abuses(id=id, predefined_reason=predefined_reason, search=search, state=state, search_reporter=search_reporter, search_reportee=search_reportee, search_video=search_video, search_video_channel=search_video_channel, video_is=video_is, filter=filter, start=start, count=count, sort=sort)
|
||||
|
||||
List abuses
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.abuse_state_set import AbuseStateSet
|
||||
from peertube.models.get_my_abuses200_response import GetMyAbuses200Response
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
id = 56 # int | only list the report with this id (optional)
|
||||
predefined_reason = ['predefined_reason_example'] # List[str] | predefined reason the listed reports should contain (optional)
|
||||
search = 'search_example' # str | plain search that will match with video titles, reporter names and more (optional)
|
||||
state = peertube.AbuseStateSet() # AbuseStateSet | (optional)
|
||||
search_reporter = 'search_reporter_example' # str | only list reports of a specific reporter (optional)
|
||||
search_reportee = 'search_reportee_example' # str | only list reports of a specific reportee (optional)
|
||||
search_video = 'search_video_example' # str | only list reports of a specific video (optional)
|
||||
search_video_channel = 'search_video_channel_example' # str | only list reports of a specific video channel (optional)
|
||||
video_is = 'video_is_example' # str | only list deleted or blocklisted videos (optional)
|
||||
filter = 'filter_example' # str | only list account, comment or video reports (optional)
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = 'sort_example' # str | Sort abuses by criteria (optional)
|
||||
|
||||
try:
|
||||
# List abuses
|
||||
api_response = api_instance.get_abuses(id=id, predefined_reason=predefined_reason, search=search, state=state, search_reporter=search_reporter, search_reportee=search_reportee, search_video=search_video, search_video_channel=search_video_channel, video_is=video_is, filter=filter, start=start, count=count, sort=sort)
|
||||
print("The response of AbusesApi->get_abuses:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->get_abuses: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| only list the report with this id | [optional]
|
||||
**predefined_reason** | [**List[str]**](str.md)| predefined reason the listed reports should contain | [optional]
|
||||
**search** | **str**| plain search that will match with video titles, reporter names and more | [optional]
|
||||
**state** | [**AbuseStateSet**](.md)| | [optional]
|
||||
**search_reporter** | **str**| only list reports of a specific reporter | [optional]
|
||||
**search_reportee** | **str**| only list reports of a specific reportee | [optional]
|
||||
**search_video** | **str**| only list reports of a specific video | [optional]
|
||||
**search_video_channel** | **str**| only list reports of a specific video channel | [optional]
|
||||
**video_is** | **str**| only list deleted or blocklisted videos | [optional]
|
||||
**filter** | **str**| only list account, comment or video reports | [optional]
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort abuses by criteria | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetMyAbuses200Response**](GetMyAbuses200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_my_abuses**
|
||||
> GetMyAbuses200Response get_my_abuses(id=id, state=state, sort=sort, start=start, count=count)
|
||||
|
||||
List my abuses
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.abuse_state_set import AbuseStateSet
|
||||
from peertube.models.get_my_abuses200_response import GetMyAbuses200Response
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AbusesApi(api_client)
|
||||
id = 56 # int | only list the report with this id (optional)
|
||||
state = peertube.AbuseStateSet() # AbuseStateSet | (optional)
|
||||
sort = 'sort_example' # str | Sort abuses by criteria (optional)
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
|
||||
try:
|
||||
# List my abuses
|
||||
api_response = api_instance.get_my_abuses(id=id, state=state, sort=sort, start=start, count=count)
|
||||
print("The response of AbusesApi->get_my_abuses:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AbusesApi->get_my_abuses: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| only list the report with this id | [optional]
|
||||
**state** | [**AbuseStateSet**](.md)| | [optional]
|
||||
**sort** | **str**| Sort abuses by criteria | [optional]
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetMyAbuses200Response**](GetMyAbuses200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
40
docs/Account.md
Normal file
40
docs/Account.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Account
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**url** | **str** | | [optional]
|
||||
**name** | **str** | immutable name of the actor, used to find or mention it | [optional]
|
||||
**host** | **str** | server on which the actor is resident | [optional]
|
||||
**host_redundancy_allowed** | **bool** | whether this actor's host allows redundancy of its videos | [optional]
|
||||
**following_count** | **int** | number of actors subscribed to by this actor, as seen by this instance | [optional]
|
||||
**followers_count** | **int** | number of followers of this actor, as seen by this instance | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
**user_id** | **object** | | [optional]
|
||||
**display_name** | **str** | editable name of the account, displayed in its representations | [optional]
|
||||
**description** | **str** | text or bio displayed on the account's profile | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.account import Account
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Account from a JSON string
|
||||
account_instance = Account.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print Account.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
account_dict = account_instance.to_dict()
|
||||
# create an instance of Account from a dict
|
||||
account_form_dict = account.from_dict(account_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
297
docs/AccountBlocksApi.md
Normal file
297
docs/AccountBlocksApi.md
Normal file
@ -0,0 +1,297 @@
|
||||
# peertube.AccountBlocksApi
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**api_v1_blocklist_status_get**](AccountBlocksApi.md#api_v1_blocklist_status_get) | **GET** /api/v1/blocklist/status | Get block status of accounts/hosts
|
||||
[**api_v1_server_blocklist_accounts_account_name_delete**](AccountBlocksApi.md#api_v1_server_blocklist_accounts_account_name_delete) | **DELETE** /api/v1/server/blocklist/accounts/{accountName} | Unblock an account by its handle
|
||||
[**api_v1_server_blocklist_accounts_get**](AccountBlocksApi.md#api_v1_server_blocklist_accounts_get) | **GET** /api/v1/server/blocklist/accounts | List account blocks
|
||||
[**api_v1_server_blocklist_accounts_post**](AccountBlocksApi.md#api_v1_server_blocklist_accounts_post) | **POST** /api/v1/server/blocklist/accounts | Block an account
|
||||
|
||||
|
||||
# **api_v1_blocklist_status_get**
|
||||
> BlockStatus api_v1_blocklist_status_get(accounts=accounts, hosts=hosts)
|
||||
|
||||
Get block status of accounts/hosts
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.block_status import BlockStatus
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountBlocksApi(api_client)
|
||||
accounts = ['[\"goofy@example.com\",\"donald@example.com\"]'] # List[str] | Check if these accounts are blocked (optional)
|
||||
hosts = ['[\"example.com\"]'] # List[str] | Check if these hosts are blocked (optional)
|
||||
|
||||
try:
|
||||
# Get block status of accounts/hosts
|
||||
api_response = api_instance.api_v1_blocklist_status_get(accounts=accounts, hosts=hosts)
|
||||
print("The response of AccountBlocksApi->api_v1_blocklist_status_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountBlocksApi->api_v1_blocklist_status_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**accounts** | [**List[str]**](str.md)| Check if these accounts are blocked | [optional]
|
||||
**hosts** | [**List[str]**](str.md)| Check if these hosts are blocked | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**BlockStatus**](BlockStatus.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_server_blocklist_accounts_account_name_delete**
|
||||
> api_v1_server_blocklist_accounts_account_name_delete(account_name)
|
||||
|
||||
Unblock an account by its handle
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountBlocksApi(api_client)
|
||||
account_name = 'account_name_example' # str | account to unblock, in the form `username@domain`
|
||||
|
||||
try:
|
||||
# Unblock an account by its handle
|
||||
api_instance.api_v1_server_blocklist_accounts_account_name_delete(account_name)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountBlocksApi->api_v1_server_blocklist_accounts_account_name_delete: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**account_name** | **str**| account to unblock, in the form `username@domain` |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**201** | successful operation | - |
|
||||
**404** | account or account block does not exist | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_server_blocklist_accounts_get**
|
||||
> api_v1_server_blocklist_accounts_get(start=start, count=count, sort=sort)
|
||||
|
||||
List account blocks
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountBlocksApi(api_client)
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
|
||||
try:
|
||||
# List account blocks
|
||||
api_instance.api_v1_server_blocklist_accounts_get(start=start, count=count, sort=sort)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountBlocksApi->api_v1_server_blocklist_accounts_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_server_blocklist_accounts_post**
|
||||
> api_v1_server_blocklist_accounts_post(api_v1_server_blocklist_accounts_post_request=api_v1_server_blocklist_accounts_post_request)
|
||||
|
||||
Block an account
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_server_blocklist_accounts_post_request import ApiV1ServerBlocklistAccountsPostRequest
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountBlocksApi(api_client)
|
||||
api_v1_server_blocklist_accounts_post_request = peertube.ApiV1ServerBlocklistAccountsPostRequest() # ApiV1ServerBlocklistAccountsPostRequest | (optional)
|
||||
|
||||
try:
|
||||
# Block an account
|
||||
api_instance.api_v1_server_blocklist_accounts_post(api_v1_server_blocklist_accounts_post_request=api_v1_server_blocklist_accounts_post_request)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountBlocksApi->api_v1_server_blocklist_accounts_post: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**api_v1_server_blocklist_accounts_post_request** | [**ApiV1ServerBlocklistAccountsPostRequest**](ApiV1ServerBlocklistAccountsPostRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
**409** | self-blocking forbidden | - |
|
||||
|
||||
[[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)
|
||||
|
||||
34
docs/AccountSummary.md
Normal file
34
docs/AccountSummary.md
Normal file
@ -0,0 +1,34 @@
|
||||
# AccountSummary
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**name** | **str** | | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**url** | **str** | | [optional]
|
||||
**host** | **str** | | [optional]
|
||||
**avatars** | [**List[ActorImage]**](ActorImage.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.account_summary import AccountSummary
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AccountSummary from a JSON string
|
||||
account_summary_instance = AccountSummary.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AccountSummary.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
account_summary_dict = account_summary_instance.to_dict()
|
||||
# create an instance of AccountSummary from a dict
|
||||
account_summary_form_dict = account_summary.from_dict(account_summary_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
639
docs/AccountsApi.md
Normal file
639
docs/AccountsApi.md
Normal file
@ -0,0 +1,639 @@
|
||||
# peertube.AccountsApi
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**api_v1_accounts_name_ratings_get**](AccountsApi.md#api_v1_accounts_name_ratings_get) | **GET** /api/v1/accounts/{name}/ratings | List ratings of an account
|
||||
[**api_v1_accounts_name_video_channel_syncs_get**](AccountsApi.md#api_v1_accounts_name_video_channel_syncs_get) | **GET** /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account
|
||||
[**api_v1_accounts_name_video_channels_get**](AccountsApi.md#api_v1_accounts_name_video_channels_get) | **GET** /api/v1/accounts/{name}/video-channels | List video channels of an account
|
||||
[**api_v1_accounts_name_video_playlists_get**](AccountsApi.md#api_v1_accounts_name_video_playlists_get) | **GET** /api/v1/accounts/{name}/video-playlists | List playlists of an account
|
||||
[**get_account**](AccountsApi.md#get_account) | **GET** /api/v1/accounts/{name} | Get an account
|
||||
[**get_account_followers**](AccountsApi.md#get_account_followers) | **GET** /api/v1/accounts/{name}/followers | List followers of an account
|
||||
[**get_account_videos**](AccountsApi.md#get_account_videos) | **GET** /api/v1/accounts/{name}/videos | List videos of an account
|
||||
[**get_accounts**](AccountsApi.md#get_accounts) | **GET** /api/v1/accounts | List accounts
|
||||
|
||||
|
||||
# **api_v1_accounts_name_ratings_get**
|
||||
> List[VideoRating] api_v1_accounts_name_ratings_get(name, start=start, count=count, sort=sort, rating=rating)
|
||||
|
||||
List ratings of an account
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.video_rating import VideoRating
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
rating = 'rating_example' # str | Optionally filter which ratings to retrieve (optional)
|
||||
|
||||
try:
|
||||
# List ratings of an account
|
||||
api_response = api_instance.api_v1_accounts_name_ratings_get(name, start=start, count=count, sort=sort, rating=rating)
|
||||
print("The response of AccountsApi->api_v1_accounts_name_ratings_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->api_v1_accounts_name_ratings_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
**rating** | **str**| Optionally filter which ratings to retrieve | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[VideoRating]**](VideoRating.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_accounts_name_video_channel_syncs_get**
|
||||
> VideoChannelSyncList api_v1_accounts_name_video_channel_syncs_get(name, start=start, count=count, sort=sort)
|
||||
|
||||
List the synchronizations of video channels of an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.video_channel_sync_list import VideoChannelSyncList
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
|
||||
try:
|
||||
# List the synchronizations of video channels of an account
|
||||
api_response = api_instance.api_v1_accounts_name_video_channel_syncs_get(name, start=start, count=count, sort=sort)
|
||||
print("The response of AccountsApi->api_v1_accounts_name_video_channel_syncs_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->api_v1_accounts_name_video_channel_syncs_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**VideoChannelSyncList**](VideoChannelSyncList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_accounts_name_video_channels_get**
|
||||
> VideoChannelList api_v1_accounts_name_video_channels_get(name, with_stats=with_stats, start=start, count=count, sort=sort)
|
||||
|
||||
List video channels of an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.video_channel_list import VideoChannelList
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
with_stats = True # bool | include daily view statistics for the last 30 days and total views (only if authentified as the account user) (optional)
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
|
||||
try:
|
||||
# List video channels of an account
|
||||
api_response = api_instance.api_v1_accounts_name_video_channels_get(name, with_stats=with_stats, start=start, count=count, sort=sort)
|
||||
print("The response of AccountsApi->api_v1_accounts_name_video_channels_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->api_v1_accounts_name_video_channels_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**with_stats** | **bool**| include daily view statistics for the last 30 days and total views (only if authentified as the account user) | [optional]
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**VideoChannelList**](VideoChannelList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_accounts_name_video_playlists_get**
|
||||
> ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response api_v1_accounts_name_video_playlists_get(name, start=start, count=count, sort=sort, search=search, playlist_type=playlist_type)
|
||||
|
||||
List playlists of an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.api_v1_video_channels_channel_handle_video_playlists_get200_response import ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response
|
||||
from peertube.models.video_playlist_type_set import VideoPlaylistTypeSet
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
search = 'search_example' # str | Plain text search, applied to various parts of the model depending on endpoint (optional)
|
||||
playlist_type = peertube.VideoPlaylistTypeSet() # VideoPlaylistTypeSet | (optional)
|
||||
|
||||
try:
|
||||
# List playlists of an account
|
||||
api_response = api_instance.api_v1_accounts_name_video_playlists_get(name, start=start, count=count, sort=sort, search=search, playlist_type=playlist_type)
|
||||
print("The response of AccountsApi->api_v1_accounts_name_video_playlists_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->api_v1_accounts_name_video_playlists_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
**search** | **str**| Plain text search, applied to various parts of the model depending on endpoint | [optional]
|
||||
**playlist_type** | [**VideoPlaylistTypeSet**](.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response**](ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_account**
|
||||
> Account get_account(name)
|
||||
|
||||
Get an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.account import Account
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
|
||||
try:
|
||||
# Get an account
|
||||
api_response = api_instance.get_account(name)
|
||||
print("The response of AccountsApi->get_account:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->get_account: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Account**](Account.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
**404** | account not found | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_account_followers**
|
||||
> GetAccountFollowers200Response get_account_followers(name, start=start, count=count, sort=sort, search=search)
|
||||
|
||||
List followers of an account
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.get_account_followers200_response import GetAccountFollowers200Response
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = 'sort_example' # str | Sort followers by criteria (optional)
|
||||
search = 'search_example' # str | Plain text search, applied to various parts of the model depending on endpoint (optional)
|
||||
|
||||
try:
|
||||
# List followers of an account
|
||||
api_response = api_instance.get_account_followers(name, start=start, count=count, sort=sort, search=search)
|
||||
print("The response of AccountsApi->get_account_followers:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->get_account_followers: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort followers by criteria | [optional]
|
||||
**search** | **str**| Plain text search, applied to various parts of the model depending on endpoint | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetAccountFollowers200Response**](GetAccountFollowers200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_account_videos**
|
||||
> VideoListResponse get_account_videos(name, category_one_of=category_one_of, is_live=is_live, tags_one_of=tags_one_of, tags_all_of=tags_all_of, licence_one_of=licence_one_of, language_one_of=language_one_of, nsfw=nsfw, is_local=is_local, include=include, privacy_one_of=privacy_one_of, has_hls_files=has_hls_files, has_web_video_files=has_web_video_files, skip_count=skip_count, start=start, count=count, sort=sort, exclude_already_watched=exclude_already_watched)
|
||||
|
||||
List videos of an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.video_list_response import VideoListResponse
|
||||
from peertube.models.video_privacy_set import VideoPrivacySet
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
category_one_of = peertube.GetAccountVideosCategoryOneOfParameter() # GetAccountVideosCategoryOneOfParameter | category id of the video (see [/videos/categories](#operation/getCategories)) (optional)
|
||||
is_live = True # bool | whether or not the video is a live (optional)
|
||||
tags_one_of = peertube.GetAccountVideosTagsOneOfParameter() # GetAccountVideosTagsOneOfParameter | tag(s) of the video (optional)
|
||||
tags_all_of = peertube.GetAccountVideosTagsAllOfParameter() # GetAccountVideosTagsAllOfParameter | tag(s) of the video, where all should be present in the video (optional)
|
||||
licence_one_of = peertube.GetAccountVideosLicenceOneOfParameter() # GetAccountVideosLicenceOneOfParameter | licence id of the video (see [/videos/licences](#operation/getLicences)) (optional)
|
||||
language_one_of = peertube.GetAccountVideosLanguageOneOfParameter() # GetAccountVideosLanguageOneOfParameter | language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language (optional)
|
||||
nsfw = 'nsfw_example' # str | whether to include nsfw videos, if any (optional)
|
||||
is_local = True # bool | **PeerTube >= 4.0** Display only local or remote videos (optional)
|
||||
include = 56 # int | **PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator) - `0` NONE - `1` NOT_PUBLISHED_STATE - `2` BLACKLISTED - `4` BLOCKED_OWNER - `8` FILES (optional)
|
||||
privacy_one_of = peertube.VideoPrivacySet() # VideoPrivacySet | **PeerTube >= 4.0** Display only videos in this specific privacy/privacies (optional)
|
||||
has_hls_files = True # bool | **PeerTube >= 4.0** Display only videos that have HLS files (optional)
|
||||
has_web_video_files = True # bool | **PeerTube >= 6.0** Display only videos that have Web Video files (optional)
|
||||
skip_count = 'false' # str | if you don't need the `total` in the response (optional) (default to 'false')
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = 'sort_example' # str | (optional)
|
||||
exclude_already_watched = True # bool | Whether or not to exclude videos that are in the user's video history (optional)
|
||||
|
||||
try:
|
||||
# List videos of an account
|
||||
api_response = api_instance.get_account_videos(name, category_one_of=category_one_of, is_live=is_live, tags_one_of=tags_one_of, tags_all_of=tags_all_of, licence_one_of=licence_one_of, language_one_of=language_one_of, nsfw=nsfw, is_local=is_local, include=include, privacy_one_of=privacy_one_of, has_hls_files=has_hls_files, has_web_video_files=has_web_video_files, skip_count=skip_count, start=start, count=count, sort=sort, exclude_already_watched=exclude_already_watched)
|
||||
print("The response of AccountsApi->get_account_videos:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->get_account_videos: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**category_one_of** | [**GetAccountVideosCategoryOneOfParameter**](.md)| category id of the video (see [/videos/categories](#operation/getCategories)) | [optional]
|
||||
**is_live** | **bool**| whether or not the video is a live | [optional]
|
||||
**tags_one_of** | [**GetAccountVideosTagsOneOfParameter**](.md)| tag(s) of the video | [optional]
|
||||
**tags_all_of** | [**GetAccountVideosTagsAllOfParameter**](.md)| tag(s) of the video, where all should be present in the video | [optional]
|
||||
**licence_one_of** | [**GetAccountVideosLicenceOneOfParameter**](.md)| licence id of the video (see [/videos/licences](#operation/getLicences)) | [optional]
|
||||
**language_one_of** | [**GetAccountVideosLanguageOneOfParameter**](.md)| language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language | [optional]
|
||||
**nsfw** | **str**| whether to include nsfw videos, if any | [optional]
|
||||
**is_local** | **bool**| **PeerTube >= 4.0** Display only local or remote videos | [optional]
|
||||
**include** | **int**| **PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator) - `0` NONE - `1` NOT_PUBLISHED_STATE - `2` BLACKLISTED - `4` BLOCKED_OWNER - `8` FILES | [optional]
|
||||
**privacy_one_of** | [**VideoPrivacySet**](.md)| **PeerTube >= 4.0** Display only videos in this specific privacy/privacies | [optional]
|
||||
**has_hls_files** | **bool**| **PeerTube >= 4.0** Display only videos that have HLS files | [optional]
|
||||
**has_web_video_files** | **bool**| **PeerTube >= 6.0** Display only videos that have Web Video files | [optional]
|
||||
**skip_count** | **str**| if you don't need the `total` in the response | [optional] [default to 'false']
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| | [optional]
|
||||
**exclude_already_watched** | **bool**| Whether or not to exclude videos that are in the user's video history | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**VideoListResponse**](VideoListResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_accounts**
|
||||
> GetAccounts200Response get_accounts(start=start, count=count, sort=sort)
|
||||
|
||||
List accounts
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.get_accounts200_response import GetAccounts200Response
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.AccountsApi(api_client)
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
|
||||
try:
|
||||
# List accounts
|
||||
api_response = api_instance.get_accounts(start=start, count=count, sort=sort)
|
||||
print("The response of AccountsApi->get_accounts:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AccountsApi->get_accounts: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetAccounts200Response**](GetAccounts200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
37
docs/Actor.md
Normal file
37
docs/Actor.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Actor
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**url** | **str** | | [optional]
|
||||
**name** | **str** | immutable name of the actor, used to find or mention it | [optional]
|
||||
**host** | **str** | server on which the actor is resident | [optional]
|
||||
**host_redundancy_allowed** | **bool** | whether this actor's host allows redundancy of its videos | [optional]
|
||||
**following_count** | **int** | number of actors subscribed to by this actor, as seen by this instance | [optional]
|
||||
**followers_count** | **int** | number of followers of this actor, as seen by this instance | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.actor import Actor
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Actor from a JSON string
|
||||
actor_instance = Actor.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print Actor.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
actor_dict = actor_instance.to_dict()
|
||||
# create an instance of Actor from a dict
|
||||
actor_form_dict = actor.from_dict(actor_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
32
docs/ActorImage.md
Normal file
32
docs/ActorImage.md
Normal file
@ -0,0 +1,32 @@
|
||||
# ActorImage
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**path** | **str** | | [optional]
|
||||
**width** | **int** | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.actor_image import ActorImage
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ActorImage from a JSON string
|
||||
actor_image_instance = ActorImage.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ActorImage.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
actor_image_dict = actor_image_instance.to_dict()
|
||||
# create an instance of ActorImage from a dict
|
||||
actor_image_form_dict = actor_image.from_dict(actor_image_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
33
docs/ActorInfo.md
Normal file
33
docs/ActorInfo.md
Normal file
@ -0,0 +1,33 @@
|
||||
# ActorInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**name** | **str** | | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**host** | **str** | | [optional]
|
||||
**avatars** | [**List[ActorImage]**](ActorImage.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.actor_info import ActorInfo
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ActorInfo from a JSON string
|
||||
actor_info_instance = ActorInfo.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ActorInfo.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
actor_info_dict = actor_info_instance.to_dict()
|
||||
# create an instance of ActorInfo from a dict
|
||||
actor_info_form_dict = actor_info.from_dict(actor_info_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddIntroOptions.md
Normal file
29
docs/AddIntroOptions.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddIntroOptions
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**file** | **bytearray** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_intro_options import AddIntroOptions
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddIntroOptions from a JSON string
|
||||
add_intro_options_instance = AddIntroOptions.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddIntroOptions.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_intro_options_dict = add_intro_options_instance.to_dict()
|
||||
# create an instance of AddIntroOptions from a dict
|
||||
add_intro_options_form_dict = add_intro_options.from_dict(add_intro_options_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddPlaylist200Response.md
Normal file
29
docs/AddPlaylist200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddPlaylist200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_playlist** | [**AddPlaylist200ResponseVideoPlaylist**](AddPlaylist200ResponseVideoPlaylist.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_playlist200_response import AddPlaylist200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddPlaylist200Response from a JSON string
|
||||
add_playlist200_response_instance = AddPlaylist200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddPlaylist200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_playlist200_response_dict = add_playlist200_response_instance.to_dict()
|
||||
# create an instance of AddPlaylist200Response from a dict
|
||||
add_playlist200_response_form_dict = add_playlist200_response.from_dict(add_playlist200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/AddPlaylist200ResponseVideoPlaylist.md
Normal file
31
docs/AddPlaylist200ResponseVideoPlaylist.md
Normal file
@ -0,0 +1,31 @@
|
||||
# AddPlaylist200ResponseVideoPlaylist
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**uuid** | [**Uuid**](Uuid.md) | | [optional]
|
||||
**short_uuid** | **str** | translation of a uuid v4 with a bigger alphabet to have a shorter uuid | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_playlist200_response_video_playlist import AddPlaylist200ResponseVideoPlaylist
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddPlaylist200ResponseVideoPlaylist from a JSON string
|
||||
add_playlist200_response_video_playlist_instance = AddPlaylist200ResponseVideoPlaylist.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddPlaylist200ResponseVideoPlaylist.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_playlist200_response_video_playlist_dict = add_playlist200_response_video_playlist_instance.to_dict()
|
||||
# create an instance of AddPlaylist200ResponseVideoPlaylist from a dict
|
||||
add_playlist200_response_video_playlist_form_dict = add_playlist200_response_video_playlist.from_dict(add_playlist200_response_video_playlist_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/AddPluginRequest.md
Normal file
30
docs/AddPluginRequest.md
Normal file
@ -0,0 +1,30 @@
|
||||
# AddPluginRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**npm_name** | **str** | |
|
||||
**path** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_plugin_request import AddPluginRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddPluginRequest from a JSON string
|
||||
add_plugin_request_instance = AddPluginRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddPluginRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_plugin_request_dict = add_plugin_request_instance.to_dict()
|
||||
# create an instance of AddPluginRequest from a dict
|
||||
add_plugin_request_form_dict = add_plugin_request.from_dict(add_plugin_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddPluginRequestOneOf.md
Normal file
29
docs/AddPluginRequestOneOf.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddPluginRequestOneOf
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**npm_name** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_plugin_request_one_of import AddPluginRequestOneOf
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddPluginRequestOneOf from a JSON string
|
||||
add_plugin_request_one_of_instance = AddPluginRequestOneOf.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddPluginRequestOneOf.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_plugin_request_one_of_dict = add_plugin_request_one_of_instance.to_dict()
|
||||
# create an instance of AddPluginRequestOneOf from a dict
|
||||
add_plugin_request_one_of_form_dict = add_plugin_request_one_of.from_dict(add_plugin_request_one_of_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddPluginRequestOneOf1.md
Normal file
29
docs/AddPluginRequestOneOf1.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddPluginRequestOneOf1
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**path** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_plugin_request_one_of1 import AddPluginRequestOneOf1
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddPluginRequestOneOf1 from a JSON string
|
||||
add_plugin_request_one_of1_instance = AddPluginRequestOneOf1.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddPluginRequestOneOf1.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_plugin_request_one_of1_dict = add_plugin_request_one_of1_instance.to_dict()
|
||||
# create an instance of AddPluginRequestOneOf1 from a dict
|
||||
add_plugin_request_one_of1_form_dict = add_plugin_request_one_of1.from_dict(add_plugin_request_one_of1_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
36
docs/AddUser.md
Normal file
36
docs/AddUser.md
Normal file
@ -0,0 +1,36 @@
|
||||
# AddUser
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**username** | **str** | immutable name of the user, used to find or mention its actor |
|
||||
**password** | **str** | |
|
||||
**email** | **str** | The user email |
|
||||
**video_quota** | **int** | The user video quota in bytes | [optional]
|
||||
**video_quota_daily** | **int** | The user daily video quota in bytes | [optional]
|
||||
**channel_name** | **str** | immutable name of the channel, used to interact with its actor | [optional]
|
||||
**role** | [**UserRole**](UserRole.md) | |
|
||||
**admin_flags** | [**UserAdminFlags**](UserAdminFlags.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_user import AddUser
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddUser from a JSON string
|
||||
add_user_instance = AddUser.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddUser.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_user_dict = add_user_instance.to_dict()
|
||||
# create an instance of AddUser from a dict
|
||||
add_user_form_dict = add_user.from_dict(add_user_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddUserResponse.md
Normal file
29
docs/AddUserResponse.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddUserResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**user** | [**AddUserResponseUser**](AddUserResponseUser.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_user_response import AddUserResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddUserResponse from a JSON string
|
||||
add_user_response_instance = AddUserResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddUserResponse.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_user_response_dict = add_user_response_instance.to_dict()
|
||||
# create an instance of AddUserResponse from a dict
|
||||
add_user_response_form_dict = add_user_response.from_dict(add_user_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/AddUserResponseUser.md
Normal file
30
docs/AddUserResponseUser.md
Normal file
@ -0,0 +1,30 @@
|
||||
# AddUserResponseUser
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**account** | [**ApiV1AbusesPost200ResponseAbuse**](ApiV1AbusesPost200ResponseAbuse.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_user_response_user import AddUserResponseUser
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddUserResponseUser from a JSON string
|
||||
add_user_response_user_instance = AddUserResponseUser.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddUserResponseUser.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_user_response_user_dict = add_user_response_user_instance.to_dict()
|
||||
# create an instance of AddUserResponseUser from a dict
|
||||
add_user_response_user_form_dict = add_user_response_user.from_dict(add_user_response_user_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddVideoChannel200Response.md
Normal file
29
docs/AddVideoChannel200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddVideoChannel200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_channel** | [**ApiV1AbusesPost200ResponseAbuse**](ApiV1AbusesPost200ResponseAbuse.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_channel200_response import AddVideoChannel200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoChannel200Response from a JSON string
|
||||
add_video_channel200_response_instance = AddVideoChannel200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoChannel200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_channel200_response_dict = add_video_channel200_response_instance.to_dict()
|
||||
# create an instance of AddVideoChannel200Response from a dict
|
||||
add_video_channel200_response_form_dict = add_video_channel200_response.from_dict(add_video_channel200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddVideoChannelSync200Response.md
Normal file
29
docs/AddVideoChannelSync200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddVideoChannelSync200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_channel_sync** | [**VideoChannelSync**](VideoChannelSync.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_channel_sync200_response import AddVideoChannelSync200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoChannelSync200Response from a JSON string
|
||||
add_video_channel_sync200_response_instance = AddVideoChannelSync200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoChannelSync200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_channel_sync200_response_dict = add_video_channel_sync200_response_instance.to_dict()
|
||||
# create an instance of AddVideoChannelSync200Response from a dict
|
||||
add_video_channel_sync200_response_form_dict = add_video_channel_sync200_response.from_dict(add_video_channel_sync200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddVideoPlaylistVideo200Response.md
Normal file
29
docs/AddVideoPlaylistVideo200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddVideoPlaylistVideo200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_playlist_element** | [**AddVideoPlaylistVideo200ResponseVideoPlaylistElement**](AddVideoPlaylistVideo200ResponseVideoPlaylistElement.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_playlist_video200_response import AddVideoPlaylistVideo200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoPlaylistVideo200Response from a JSON string
|
||||
add_video_playlist_video200_response_instance = AddVideoPlaylistVideo200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoPlaylistVideo200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_playlist_video200_response_dict = add_video_playlist_video200_response_instance.to_dict()
|
||||
# create an instance of AddVideoPlaylistVideo200Response from a dict
|
||||
add_video_playlist_video200_response_form_dict = add_video_playlist_video200_response.from_dict(add_video_playlist_video200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddVideoPlaylistVideo200ResponseVideoPlaylistElement.md
Normal file
29
docs/AddVideoPlaylistVideo200ResponseVideoPlaylistElement.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddVideoPlaylistVideo200ResponseVideoPlaylistElement
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_playlist_video200_response_video_playlist_element import AddVideoPlaylistVideo200ResponseVideoPlaylistElement
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoPlaylistVideo200ResponseVideoPlaylistElement from a JSON string
|
||||
add_video_playlist_video200_response_video_playlist_element_instance = AddVideoPlaylistVideo200ResponseVideoPlaylistElement.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoPlaylistVideo200ResponseVideoPlaylistElement.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_playlist_video200_response_video_playlist_element_dict = add_video_playlist_video200_response_video_playlist_element_instance.to_dict()
|
||||
# create an instance of AddVideoPlaylistVideo200ResponseVideoPlaylistElement from a dict
|
||||
add_video_playlist_video200_response_video_playlist_element_form_dict = add_video_playlist_video200_response_video_playlist_element.from_dict(add_video_playlist_video200_response_video_playlist_element_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/AddVideoPlaylistVideoRequest.md
Normal file
31
docs/AddVideoPlaylistVideoRequest.md
Normal file
@ -0,0 +1,31 @@
|
||||
# AddVideoPlaylistVideoRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_id** | [**AddVideoPlaylistVideoRequestVideoId**](AddVideoPlaylistVideoRequestVideoId.md) | |
|
||||
**start_timestamp** | **int** | Start the video at this specific timestamp | [optional]
|
||||
**stop_timestamp** | **int** | Stop the video at this specific timestamp | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_playlist_video_request import AddVideoPlaylistVideoRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoPlaylistVideoRequest from a JSON string
|
||||
add_video_playlist_video_request_instance = AddVideoPlaylistVideoRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoPlaylistVideoRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_playlist_video_request_dict = add_video_playlist_video_request_instance.to_dict()
|
||||
# create an instance of AddVideoPlaylistVideoRequest from a dict
|
||||
add_video_playlist_video_request_form_dict = add_video_playlist_video_request.from_dict(add_video_playlist_video_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/AddVideoPlaylistVideoRequestVideoId.md
Normal file
29
docs/AddVideoPlaylistVideoRequestVideoId.md
Normal file
@ -0,0 +1,29 @@
|
||||
# AddVideoPlaylistVideoRequestVideoId
|
||||
|
||||
Video to add in the playlist
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.add_video_playlist_video_request_video_id import AddVideoPlaylistVideoRequestVideoId
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AddVideoPlaylistVideoRequestVideoId from a JSON string
|
||||
add_video_playlist_video_request_video_id_instance = AddVideoPlaylistVideoRequestVideoId.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AddVideoPlaylistVideoRequestVideoId.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
add_video_playlist_video_request_video_id_dict = add_video_playlist_video_request_video_id_instance.to_dict()
|
||||
# create an instance of AddVideoPlaylistVideoRequestVideoId from a dict
|
||||
add_video_playlist_video_request_video_id_form_dict = add_video_playlist_video_request_video_id.from_dict(add_video_playlist_video_request_video_id_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1AbusesAbuseIdMessagesGet200Response.md
Normal file
30
docs/ApiV1AbusesAbuseIdMessagesGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1AbusesAbuseIdMessagesGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[AbuseMessage]**](AbuseMessage.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_abuse_id_messages_get200_response import ApiV1AbusesAbuseIdMessagesGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesAbuseIdMessagesGet200Response from a JSON string
|
||||
api_v1_abuses_abuse_id_messages_get200_response_instance = ApiV1AbusesAbuseIdMessagesGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesAbuseIdMessagesGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_abuse_id_messages_get200_response_dict = api_v1_abuses_abuse_id_messages_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesAbuseIdMessagesGet200Response from a dict
|
||||
api_v1_abuses_abuse_id_messages_get200_response_form_dict = api_v1_abuses_abuse_id_messages_get200_response.from_dict(api_v1_abuses_abuse_id_messages_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1AbusesAbuseIdMessagesPostRequest.md
Normal file
29
docs/ApiV1AbusesAbuseIdMessagesPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1AbusesAbuseIdMessagesPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**message** | **str** | Message to send |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_abuse_id_messages_post_request import ApiV1AbusesAbuseIdMessagesPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesAbuseIdMessagesPostRequest from a JSON string
|
||||
api_v1_abuses_abuse_id_messages_post_request_instance = ApiV1AbusesAbuseIdMessagesPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesAbuseIdMessagesPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_abuse_id_messages_post_request_dict = api_v1_abuses_abuse_id_messages_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesAbuseIdMessagesPostRequest from a dict
|
||||
api_v1_abuses_abuse_id_messages_post_request_form_dict = api_v1_abuses_abuse_id_messages_post_request.from_dict(api_v1_abuses_abuse_id_messages_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1AbusesAbuseIdPutRequest.md
Normal file
30
docs/ApiV1AbusesAbuseIdPutRequest.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1AbusesAbuseIdPutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**state** | [**AbuseStateSet**](AbuseStateSet.md) | | [optional]
|
||||
**moderation_comment** | **str** | Update the report comment visible only to the moderation team | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_abuse_id_put_request import ApiV1AbusesAbuseIdPutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesAbuseIdPutRequest from a JSON string
|
||||
api_v1_abuses_abuse_id_put_request_instance = ApiV1AbusesAbuseIdPutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesAbuseIdPutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_abuse_id_put_request_dict = api_v1_abuses_abuse_id_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesAbuseIdPutRequest from a dict
|
||||
api_v1_abuses_abuse_id_put_request_form_dict = api_v1_abuses_abuse_id_put_request.from_dict(api_v1_abuses_abuse_id_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1AbusesPost200Response.md
Normal file
29
docs/ApiV1AbusesPost200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1AbusesPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**abuse** | [**ApiV1AbusesPost200ResponseAbuse**](ApiV1AbusesPost200ResponseAbuse.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post200_response import ApiV1AbusesPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPost200Response from a JSON string
|
||||
api_v1_abuses_post200_response_instance = ApiV1AbusesPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post200_response_dict = api_v1_abuses_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPost200Response from a dict
|
||||
api_v1_abuses_post200_response_form_dict = api_v1_abuses_post200_response.from_dict(api_v1_abuses_post200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1AbusesPost200ResponseAbuse.md
Normal file
29
docs/ApiV1AbusesPost200ResponseAbuse.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1AbusesPost200ResponseAbuse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post200_response_abuse import ApiV1AbusesPost200ResponseAbuse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPost200ResponseAbuse from a JSON string
|
||||
api_v1_abuses_post200_response_abuse_instance = ApiV1AbusesPost200ResponseAbuse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPost200ResponseAbuse.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post200_response_abuse_dict = api_v1_abuses_post200_response_abuse_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPost200ResponseAbuse from a dict
|
||||
api_v1_abuses_post200_response_abuse_form_dict = api_v1_abuses_post200_response_abuse.from_dict(api_v1_abuses_post200_response_abuse_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
33
docs/ApiV1AbusesPostRequest.md
Normal file
33
docs/ApiV1AbusesPostRequest.md
Normal file
@ -0,0 +1,33 @@
|
||||
# ApiV1AbusesPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**reason** | **str** | Reason why the user reports this video |
|
||||
**predefined_reasons** | **List[str]** | Reason categories that help triage reports | [optional]
|
||||
**video** | [**ApiV1AbusesPostRequestVideo**](ApiV1AbusesPostRequestVideo.md) | | [optional]
|
||||
**comment** | [**ApiV1AbusesPostRequestComment**](ApiV1AbusesPostRequestComment.md) | | [optional]
|
||||
**account** | [**ApiV1AbusesPostRequestAccount**](ApiV1AbusesPostRequestAccount.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post_request import ApiV1AbusesPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPostRequest from a JSON string
|
||||
api_v1_abuses_post_request_instance = ApiV1AbusesPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post_request_dict = api_v1_abuses_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPostRequest from a dict
|
||||
api_v1_abuses_post_request_form_dict = api_v1_abuses_post_request.from_dict(api_v1_abuses_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1AbusesPostRequestAccount.md
Normal file
29
docs/ApiV1AbusesPostRequestAccount.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1AbusesPostRequestAccount
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Account id to report | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post_request_account import ApiV1AbusesPostRequestAccount
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPostRequestAccount from a JSON string
|
||||
api_v1_abuses_post_request_account_instance = ApiV1AbusesPostRequestAccount.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPostRequestAccount.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post_request_account_dict = api_v1_abuses_post_request_account_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPostRequestAccount from a dict
|
||||
api_v1_abuses_post_request_account_form_dict = api_v1_abuses_post_request_account.from_dict(api_v1_abuses_post_request_account_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1AbusesPostRequestComment.md
Normal file
29
docs/ApiV1AbusesPostRequestComment.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1AbusesPostRequestComment
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Comment id to report | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post_request_comment import ApiV1AbusesPostRequestComment
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPostRequestComment from a JSON string
|
||||
api_v1_abuses_post_request_comment_instance = ApiV1AbusesPostRequestComment.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPostRequestComment.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post_request_comment_dict = api_v1_abuses_post_request_comment_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPostRequestComment from a dict
|
||||
api_v1_abuses_post_request_comment_form_dict = api_v1_abuses_post_request_comment.from_dict(api_v1_abuses_post_request_comment_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/ApiV1AbusesPostRequestVideo.md
Normal file
31
docs/ApiV1AbusesPostRequestVideo.md
Normal file
@ -0,0 +1,31 @@
|
||||
# ApiV1AbusesPostRequestVideo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Video id to report | [optional]
|
||||
**start_at** | **int** | Timestamp in the video that marks the beginning of the report | [optional]
|
||||
**end_at** | **int** | Timestamp in the video that marks the ending of the report | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_abuses_post_request_video import ApiV1AbusesPostRequestVideo
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1AbusesPostRequestVideo from a JSON string
|
||||
api_v1_abuses_post_request_video_instance = ApiV1AbusesPostRequestVideo.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1AbusesPostRequestVideo.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_abuses_post_request_video_dict = api_v1_abuses_post_request_video_instance.to_dict()
|
||||
# create an instance of ApiV1AbusesPostRequestVideo from a dict
|
||||
api_v1_abuses_post_request_video_form_dict = api_v1_abuses_post_request_video.from_dict(api_v1_abuses_post_request_video_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1CustomPagesHomepageInstancePutRequest.md
Normal file
29
docs/ApiV1CustomPagesHomepageInstancePutRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1CustomPagesHomepageInstancePutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **str** | content of the homepage, that will be injected in the client | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_custom_pages_homepage_instance_put_request import ApiV1CustomPagesHomepageInstancePutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1CustomPagesHomepageInstancePutRequest from a JSON string
|
||||
api_v1_custom_pages_homepage_instance_put_request_instance = ApiV1CustomPagesHomepageInstancePutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1CustomPagesHomepageInstancePutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_custom_pages_homepage_instance_put_request_dict = api_v1_custom_pages_homepage_instance_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1CustomPagesHomepageInstancePutRequest from a dict
|
||||
api_v1_custom_pages_homepage_instance_put_request_form_dict = api_v1_custom_pages_homepage_instance_put_request.from_dict(api_v1_custom_pages_homepage_instance_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1PluginsNpmNameSettingsPutRequest.md
Normal file
29
docs/ApiV1PluginsNpmNameSettingsPutRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1PluginsNpmNameSettingsPutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**settings** | **Dict[str, object]** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_plugins_npm_name_settings_put_request import ApiV1PluginsNpmNameSettingsPutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1PluginsNpmNameSettingsPutRequest from a JSON string
|
||||
api_v1_plugins_npm_name_settings_put_request_instance = ApiV1PluginsNpmNameSettingsPutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1PluginsNpmNameSettingsPutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_plugins_npm_name_settings_put_request_dict = api_v1_plugins_npm_name_settings_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1PluginsNpmNameSettingsPutRequest from a dict
|
||||
api_v1_plugins_npm_name_settings_put_request_form_dict = api_v1_plugins_npm_name_settings_put_request.from_dict(api_v1_plugins_npm_name_settings_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1RunnersGet200Response.md
Normal file
30
docs/ApiV1RunnersGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1RunnersGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[Runner]**](Runner.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_get200_response import ApiV1RunnersGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersGet200Response from a JSON string
|
||||
api_v1_runners_get200_response_instance = ApiV1RunnersGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_get200_response_dict = api_v1_runners_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersGet200Response from a dict
|
||||
api_v1_runners_get200_response_form_dict = api_v1_runners_get200_response.from_dict(api_v1_runners_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1RunnersJobsGet200Response.md
Normal file
30
docs/ApiV1RunnersJobsGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1RunnersJobsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[RunnerJobAdmin]**](RunnerJobAdmin.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_get200_response import ApiV1RunnersJobsGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsGet200Response from a JSON string
|
||||
api_v1_runners_jobs_get200_response_instance = ApiV1RunnersJobsGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_get200_response_dict = api_v1_runners_jobs_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsGet200Response from a dict
|
||||
api_v1_runners_jobs_get200_response_form_dict = api_v1_runners_jobs_get200_response.from_dict(api_v1_runners_jobs_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/ApiV1RunnersJobsJobUUIDAbortPostRequest.md
Normal file
31
docs/ApiV1RunnersJobsJobUUIDAbortPostRequest.md
Normal file
@ -0,0 +1,31 @@
|
||||
# ApiV1RunnersJobsJobUUIDAbortPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**runner_token** | **str** | |
|
||||
**job_token** | **str** | |
|
||||
**reason** | **str** | Why the runner aborts this job |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_abort_post_request import ApiV1RunnersJobsJobUUIDAbortPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAbortPostRequest from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_abort_post_request_instance = ApiV1RunnersJobsJobUUIDAbortPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDAbortPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_abort_post_request_dict = api_v1_runners_jobs_job_uuid_abort_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAbortPostRequest from a dict
|
||||
api_v1_runners_jobs_job_uuid_abort_post_request_form_dict = api_v1_runners_jobs_job_uuid_abort_post_request.from_dict(api_v1_runners_jobs_job_uuid_abort_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1RunnersJobsJobUUIDAcceptPost200Response.md
Normal file
29
docs/ApiV1RunnersJobsJobUUIDAcceptPost200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1RunnersJobsJobUUIDAcceptPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**job** | [**ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob**](ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_accept_post200_response import ApiV1RunnersJobsJobUUIDAcceptPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAcceptPost200Response from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_instance = ApiV1RunnersJobsJobUUIDAcceptPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDAcceptPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_dict = api_v1_runners_jobs_job_uuid_accept_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAcceptPost200Response from a dict
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_form_dict = api_v1_runners_jobs_job_uuid_accept_post200_response.from_dict(api_v1_runners_jobs_job_uuid_accept_post200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
43
docs/ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.md
Normal file
43
docs/ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.md
Normal file
@ -0,0 +1,43 @@
|
||||
# ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**uuid** | **str** | | [optional]
|
||||
**type** | [**RunnerJobType**](RunnerJobType.md) | | [optional]
|
||||
**state** | [**RunnerJobStateConstant**](RunnerJobStateConstant.md) | | [optional]
|
||||
**payload** | [**RunnerJobPayload**](RunnerJobPayload.md) | | [optional]
|
||||
**failures** | **int** | Number of times a remote runner failed to process this job. After too many failures, the job in \"error\" state | [optional]
|
||||
**error** | **str** | Error message if the job is errored | [optional]
|
||||
**progress** | **int** | Percentage progress | [optional]
|
||||
**priority** | **int** | Job priority (less has more priority) | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**started_at** | **datetime** | | [optional]
|
||||
**finished_at** | **datetime** | | [optional]
|
||||
**parent** | [**RunnerJobParent**](RunnerJobParent.md) | | [optional]
|
||||
**runner** | [**RunnerJobRunner**](RunnerJobRunner.md) | | [optional]
|
||||
**job_token** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_accept_post200_response_job import ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_job_instance = ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_job_dict = api_v1_runners_jobs_job_uuid_accept_post200_response_job_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDAcceptPost200ResponseJob from a dict
|
||||
api_v1_runners_jobs_job_uuid_accept_post200_response_job_form_dict = api_v1_runners_jobs_job_uuid_accept_post200_response_job.from_dict(api_v1_runners_jobs_job_uuid_accept_post200_response_job_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/ApiV1RunnersJobsJobUUIDErrorPostRequest.md
Normal file
31
docs/ApiV1RunnersJobsJobUUIDErrorPostRequest.md
Normal file
@ -0,0 +1,31 @@
|
||||
# ApiV1RunnersJobsJobUUIDErrorPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**runner_token** | **str** | |
|
||||
**job_token** | **str** | |
|
||||
**message** | **str** | Why the runner failed to process this job |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_error_post_request import ApiV1RunnersJobsJobUUIDErrorPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDErrorPostRequest from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_error_post_request_instance = ApiV1RunnersJobsJobUUIDErrorPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDErrorPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_error_post_request_dict = api_v1_runners_jobs_job_uuid_error_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDErrorPostRequest from a dict
|
||||
api_v1_runners_jobs_job_uuid_error_post_request_form_dict = api_v1_runners_jobs_job_uuid_error_post_request.from_dict(api_v1_runners_jobs_job_uuid_error_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/ApiV1RunnersJobsJobUUIDSuccessPostRequest.md
Normal file
31
docs/ApiV1RunnersJobsJobUUIDSuccessPostRequest.md
Normal file
@ -0,0 +1,31 @@
|
||||
# ApiV1RunnersJobsJobUUIDSuccessPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**runner_token** | **str** | |
|
||||
**job_token** | **str** | |
|
||||
**payload** | [**ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload**](ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_success_post_request import ApiV1RunnersJobsJobUUIDSuccessPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDSuccessPostRequest from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_instance = ApiV1RunnersJobsJobUUIDSuccessPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDSuccessPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_dict = api_v1_runners_jobs_job_uuid_success_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDSuccessPostRequest from a dict
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_form_dict = api_v1_runners_jobs_job_uuid_success_post_request.from_dict(api_v1_runners_jobs_job_uuid_success_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.md
Normal file
30
docs/ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_file** | **bytearray** | | [optional]
|
||||
**resolution_playlist_file** | **bytearray** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_success_post_request_payload import ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_payload_instance = ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_payload_dict = api_v1_runners_jobs_job_uuid_success_post_request_payload_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDSuccessPostRequestPayload from a dict
|
||||
api_v1_runners_jobs_job_uuid_success_post_request_payload_form_dict = api_v1_runners_jobs_job_uuid_success_post_request_payload.from_dict(api_v1_runners_jobs_job_uuid_success_post_request_payload_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
32
docs/ApiV1RunnersJobsJobUUIDUpdatePostRequest.md
Normal file
32
docs/ApiV1RunnersJobsJobUUIDUpdatePostRequest.md
Normal file
@ -0,0 +1,32 @@
|
||||
# ApiV1RunnersJobsJobUUIDUpdatePostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**runner_token** | **str** | |
|
||||
**job_token** | **str** | |
|
||||
**progress** | **int** | Update job progression percentage (optional) | [optional]
|
||||
**payload** | [**ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload**](ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_update_post_request import ApiV1RunnersJobsJobUUIDUpdatePostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDUpdatePostRequest from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_instance = ApiV1RunnersJobsJobUUIDUpdatePostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDUpdatePostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_dict = api_v1_runners_jobs_job_uuid_update_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDUpdatePostRequest from a dict
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_form_dict = api_v1_runners_jobs_job_uuid_update_post_request.from_dict(api_v1_runners_jobs_job_uuid_update_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
35
docs/ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.md
Normal file
35
docs/ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.md
Normal file
@ -0,0 +1,35 @@
|
||||
# ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload
|
||||
|
||||
Provide live transcoding chunks update
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **str** | | [optional]
|
||||
**master_playlist_file** | **bytearray** | | [optional]
|
||||
**resolution_playlist_file** | **bytearray** | | [optional]
|
||||
**resolution_playlist_filename** | **str** | | [optional]
|
||||
**video_chunk_file** | **bytearray** | | [optional]
|
||||
**video_chunk_filename** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_job_uuid_update_post_request_payload import ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload from a JSON string
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_payload_instance = ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_payload_dict = api_v1_runners_jobs_job_uuid_update_post_request_payload_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsJobUUIDUpdatePostRequestPayload from a dict
|
||||
api_v1_runners_jobs_job_uuid_update_post_request_payload_form_dict = api_v1_runners_jobs_job_uuid_update_post_request_payload.from_dict(api_v1_runners_jobs_job_uuid_update_post_request_payload_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1RunnersJobsRequestPost200Response.md
Normal file
29
docs/ApiV1RunnersJobsRequestPost200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1RunnersJobsRequestPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**available_jobs** | [**List[ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner]**](ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_request_post200_response import ApiV1RunnersJobsRequestPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsRequestPost200Response from a JSON string
|
||||
api_v1_runners_jobs_request_post200_response_instance = ApiV1RunnersJobsRequestPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsRequestPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_request_post200_response_dict = api_v1_runners_jobs_request_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsRequestPost200Response from a dict
|
||||
api_v1_runners_jobs_request_post200_response_form_dict = api_v1_runners_jobs_request_post200_response.from_dict(api_v1_runners_jobs_request_post200_response_dict)
|
||||
```
|
||||
[[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,31 @@
|
||||
# ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**uuid** | **str** | | [optional]
|
||||
**type** | [**RunnerJobType**](RunnerJobType.md) | | [optional]
|
||||
**payload** | [**RunnerJobPayload**](RunnerJobPayload.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_jobs_request_post200_response_available_jobs_inner import ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner from a JSON string
|
||||
api_v1_runners_jobs_request_post200_response_available_jobs_inner_instance = ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_jobs_request_post200_response_available_jobs_inner_dict = api_v1_runners_jobs_request_post200_response_available_jobs_inner_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersJobsRequestPost200ResponseAvailableJobsInner from a dict
|
||||
api_v1_runners_jobs_request_post200_response_available_jobs_inner_form_dict = api_v1_runners_jobs_request_post200_response_available_jobs_inner.from_dict(api_v1_runners_jobs_request_post200_response_available_jobs_inner_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1RunnersRegisterPost200Response.md
Normal file
30
docs/ApiV1RunnersRegisterPost200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1RunnersRegisterPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Runner id | [optional]
|
||||
**runner_token** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_register_post200_response import ApiV1RunnersRegisterPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersRegisterPost200Response from a JSON string
|
||||
api_v1_runners_register_post200_response_instance = ApiV1RunnersRegisterPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersRegisterPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_register_post200_response_dict = api_v1_runners_register_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersRegisterPost200Response from a dict
|
||||
api_v1_runners_register_post200_response_form_dict = api_v1_runners_register_post200_response.from_dict(api_v1_runners_register_post200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
docs/ApiV1RunnersRegisterPostRequest.md
Normal file
31
docs/ApiV1RunnersRegisterPostRequest.md
Normal file
@ -0,0 +1,31 @@
|
||||
# ApiV1RunnersRegisterPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**registration_token** | **str** | |
|
||||
**name** | **str** | |
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_register_post_request import ApiV1RunnersRegisterPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersRegisterPostRequest from a JSON string
|
||||
api_v1_runners_register_post_request_instance = ApiV1RunnersRegisterPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersRegisterPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_register_post_request_dict = api_v1_runners_register_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersRegisterPostRequest from a dict
|
||||
api_v1_runners_register_post_request_form_dict = api_v1_runners_register_post_request.from_dict(api_v1_runners_register_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1RunnersRegistrationTokensGet200Response.md
Normal file
30
docs/ApiV1RunnersRegistrationTokensGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1RunnersRegistrationTokensGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[RunnerRegistrationToken]**](RunnerRegistrationToken.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_registration_tokens_get200_response import ApiV1RunnersRegistrationTokensGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersRegistrationTokensGet200Response from a JSON string
|
||||
api_v1_runners_registration_tokens_get200_response_instance = ApiV1RunnersRegistrationTokensGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersRegistrationTokensGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_registration_tokens_get200_response_dict = api_v1_runners_registration_tokens_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersRegistrationTokensGet200Response from a dict
|
||||
api_v1_runners_registration_tokens_get200_response_form_dict = api_v1_runners_registration_tokens_get200_response.from_dict(api_v1_runners_registration_tokens_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1RunnersUnregisterPostRequest.md
Normal file
29
docs/ApiV1RunnersUnregisterPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1RunnersUnregisterPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**runner_token** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_runners_unregister_post_request import ApiV1RunnersUnregisterPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1RunnersUnregisterPostRequest from a JSON string
|
||||
api_v1_runners_unregister_post_request_instance = ApiV1RunnersUnregisterPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1RunnersUnregisterPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_runners_unregister_post_request_dict = api_v1_runners_unregister_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1RunnersUnregisterPostRequest from a dict
|
||||
api_v1_runners_unregister_post_request_form_dict = api_v1_runners_unregister_post_request.from_dict(api_v1_runners_unregister_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1ServerBlocklistAccountsPostRequest.md
Normal file
29
docs/ApiV1ServerBlocklistAccountsPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1ServerBlocklistAccountsPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account_name** | **str** | account to block, in the form `username@domain` |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_server_blocklist_accounts_post_request import ApiV1ServerBlocklistAccountsPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1ServerBlocklistAccountsPostRequest from a JSON string
|
||||
api_v1_server_blocklist_accounts_post_request_instance = ApiV1ServerBlocklistAccountsPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1ServerBlocklistAccountsPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_server_blocklist_accounts_post_request_dict = api_v1_server_blocklist_accounts_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1ServerBlocklistAccountsPostRequest from a dict
|
||||
api_v1_server_blocklist_accounts_post_request_form_dict = api_v1_server_blocklist_accounts_post_request.from_dict(api_v1_server_blocklist_accounts_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1ServerBlocklistServersPostRequest.md
Normal file
29
docs/ApiV1ServerBlocklistServersPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1ServerBlocklistServersPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**host** | **str** | server domain to block |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_server_blocklist_servers_post_request import ApiV1ServerBlocklistServersPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1ServerBlocklistServersPostRequest from a JSON string
|
||||
api_v1_server_blocklist_servers_post_request_instance = ApiV1ServerBlocklistServersPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1ServerBlocklistServersPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_server_blocklist_servers_post_request_dict = api_v1_server_blocklist_servers_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1ServerBlocklistServersPostRequest from a dict
|
||||
api_v1_server_blocklist_servers_post_request_form_dict = api_v1_server_blocklist_servers_post_request.from_dict(api_v1_server_blocklist_servers_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1ServerFollowingPostRequest.md
Normal file
30
docs/ApiV1ServerFollowingPostRequest.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1ServerFollowingPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**hosts** | **List[str]** | | [optional]
|
||||
**handles** | **List[str]** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_server_following_post_request import ApiV1ServerFollowingPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1ServerFollowingPostRequest from a JSON string
|
||||
api_v1_server_following_post_request_instance = ApiV1ServerFollowingPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1ServerFollowingPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_server_following_post_request_dict = api_v1_server_following_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1ServerFollowingPostRequest from a dict
|
||||
api_v1_server_following_post_request_form_dict = api_v1_server_following_post_request.from_dict(api_v1_server_following_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1ServerRedundancyHostPutRequest.md
Normal file
29
docs/ApiV1ServerRedundancyHostPutRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1ServerRedundancyHostPutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**redundancy_allowed** | **bool** | allow mirroring of the host's local videos |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_server_redundancy_host_put_request import ApiV1ServerRedundancyHostPutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1ServerRedundancyHostPutRequest from a JSON string
|
||||
api_v1_server_redundancy_host_put_request_instance = ApiV1ServerRedundancyHostPutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1ServerRedundancyHostPutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_server_redundancy_host_put_request_dict = api_v1_server_redundancy_host_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1ServerRedundancyHostPutRequest from a dict
|
||||
api_v1_server_redundancy_host_put_request_form_dict = api_v1_server_redundancy_host_put_request.from_dict(api_v1_server_redundancy_host_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1UsersMeAvatarPickPost200Response.md
Normal file
29
docs/ApiV1UsersMeAvatarPickPost200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1UsersMeAvatarPickPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**avatars** | [**List[ActorImage]**](ActorImage.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_avatar_pick_post200_response import ApiV1UsersMeAvatarPickPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeAvatarPickPost200Response from a JSON string
|
||||
api_v1_users_me_avatar_pick_post200_response_instance = ApiV1UsersMeAvatarPickPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeAvatarPickPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_avatar_pick_post200_response_dict = api_v1_users_me_avatar_pick_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeAvatarPickPost200Response from a dict
|
||||
api_v1_users_me_avatar_pick_post200_response_form_dict = api_v1_users_me_avatar_pick_post200_response.from_dict(api_v1_users_me_avatar_pick_post200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
40
docs/ApiV1UsersMeNotificationSettingsPutRequest.md
Normal file
40
docs/ApiV1UsersMeNotificationSettingsPutRequest.md
Normal file
@ -0,0 +1,40 @@
|
||||
# ApiV1UsersMeNotificationSettingsPutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**new_video_from_subscription** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**new_comment_on_my_video** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**abuse_as_moderator** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**video_auto_blacklist_as_moderator** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**blacklist_on_my_video** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**my_video_published** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**my_video_import_finished** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**new_follow** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**new_user_registration** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**comment_mention** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**new_instance_follower** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
**auto_instance_following** | **int** | Notification type. One of the following values, or a sum of multiple values: - `0` NONE - `1` WEB - `2` EMAIL | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_notification_settings_put_request import ApiV1UsersMeNotificationSettingsPutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeNotificationSettingsPutRequest from a JSON string
|
||||
api_v1_users_me_notification_settings_put_request_instance = ApiV1UsersMeNotificationSettingsPutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeNotificationSettingsPutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_notification_settings_put_request_dict = api_v1_users_me_notification_settings_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeNotificationSettingsPutRequest from a dict
|
||||
api_v1_users_me_notification_settings_put_request_form_dict = api_v1_users_me_notification_settings_put_request.from_dict(api_v1_users_me_notification_settings_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1UsersMeNotificationsReadPostRequest.md
Normal file
29
docs/ApiV1UsersMeNotificationsReadPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1UsersMeNotificationsReadPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ids** | **List[int]** | ids of the notifications to mark as read |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_notifications_read_post_request import ApiV1UsersMeNotificationsReadPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeNotificationsReadPostRequest from a JSON string
|
||||
api_v1_users_me_notifications_read_post_request_instance = ApiV1UsersMeNotificationsReadPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeNotificationsReadPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_notifications_read_post_request_dict = api_v1_users_me_notifications_read_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeNotificationsReadPostRequest from a dict
|
||||
api_v1_users_me_notifications_read_post_request_form_dict = api_v1_users_me_notifications_read_post_request.from_dict(api_v1_users_me_notifications_read_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1UsersMeSubscriptionsPostRequest.md
Normal file
29
docs/ApiV1UsersMeSubscriptionsPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1UsersMeSubscriptionsPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**uri** | **str** | uri of the video channels to subscribe to |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_subscriptions_post_request import ApiV1UsersMeSubscriptionsPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeSubscriptionsPostRequest from a JSON string
|
||||
api_v1_users_me_subscriptions_post_request_instance = ApiV1UsersMeSubscriptionsPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeSubscriptionsPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_subscriptions_post_request_dict = api_v1_users_me_subscriptions_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeSubscriptionsPostRequest from a dict
|
||||
api_v1_users_me_subscriptions_post_request_form_dict = api_v1_users_me_subscriptions_post_request.from_dict(api_v1_users_me_subscriptions_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1UsersMeVideoPlaylistsVideosExistGet200Response.md
Normal file
29
docs/ApiV1UsersMeVideoPlaylistsVideosExistGet200Response.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1UsersMeVideoPlaylistsVideosExistGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_id** | [**List[ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner]**](ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_video_playlists_videos_exist_get200_response import ApiV1UsersMeVideoPlaylistsVideosExistGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeVideoPlaylistsVideosExistGet200Response from a JSON string
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_instance = ApiV1UsersMeVideoPlaylistsVideosExistGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeVideoPlaylistsVideosExistGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_dict = api_v1_users_me_video_playlists_videos_exist_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeVideoPlaylistsVideosExistGet200Response from a dict
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_form_dict = api_v1_users_me_video_playlists_videos_exist_get200_response.from_dict(api_v1_users_me_video_playlists_videos_exist_get200_response_dict)
|
||||
```
|
||||
[[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,32 @@
|
||||
# ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**playlist_element_id** | **int** | | [optional]
|
||||
**playlist_id** | **int** | | [optional]
|
||||
**start_timestamp** | **int** | | [optional]
|
||||
**stop_timestamp** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner import ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner from a JSON string
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner_instance = ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner_dict = api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeVideoPlaylistsVideosExistGet200ResponseVideoIdInner from a dict
|
||||
api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner_form_dict = api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner.from_dict(api_v1_users_me_video_playlists_videos_exist_get200_response_video_id_inner_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1UsersMeVideoQuotaUsedGet200Response.md
Normal file
30
docs/ApiV1UsersMeVideoQuotaUsedGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1UsersMeVideoQuotaUsedGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**video_quota_used** | **float** | The user video quota used so far in bytes | [optional]
|
||||
**video_quota_used_daily** | **float** | The user video quota used today in bytes | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_users_me_video_quota_used_get200_response import ApiV1UsersMeVideoQuotaUsedGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1UsersMeVideoQuotaUsedGet200Response from a JSON string
|
||||
api_v1_users_me_video_quota_used_get200_response_instance = ApiV1UsersMeVideoQuotaUsedGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1UsersMeVideoQuotaUsedGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_users_me_video_quota_used_get200_response_dict = api_v1_users_me_video_quota_used_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1UsersMeVideoQuotaUsedGet200Response from a dict
|
||||
api_v1_users_me_video_quota_used_get200_response_form_dict = api_v1_users_me_video_quota_used_get200_response.from_dict(api_v1_users_me_video_quota_used_get200_response_dict)
|
||||
```
|
||||
[[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,29 @@
|
||||
# ApiV1VideoChannelsChannelHandleBannerPickPost200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**banners** | [**List[ActorImage]**](ActorImage.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_video_channels_channel_handle_banner_pick_post200_response import ApiV1VideoChannelsChannelHandleBannerPickPost200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideoChannelsChannelHandleBannerPickPost200Response from a JSON string
|
||||
api_v1_video_channels_channel_handle_banner_pick_post200_response_instance = ApiV1VideoChannelsChannelHandleBannerPickPost200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideoChannelsChannelHandleBannerPickPost200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_video_channels_channel_handle_banner_pick_post200_response_dict = api_v1_video_channels_channel_handle_banner_pick_post200_response_instance.to_dict()
|
||||
# create an instance of ApiV1VideoChannelsChannelHandleBannerPickPost200Response from a dict
|
||||
api_v1_video_channels_channel_handle_banner_pick_post200_response_form_dict = api_v1_video_channels_channel_handle_banner_pick_post200_response.from_dict(api_v1_video_channels_channel_handle_banner_pick_post200_response_dict)
|
||||
```
|
||||
[[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,30 @@
|
||||
# ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[VideoPlaylist]**](VideoPlaylist.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_video_channels_channel_handle_video_playlists_get200_response import ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response from a JSON string
|
||||
api_v1_video_channels_channel_handle_video_playlists_get200_response_instance = ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_video_channels_channel_handle_video_playlists_get200_response_dict = api_v1_video_channels_channel_handle_video_playlists_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1VideoChannelsChannelHandleVideoPlaylistsGet200Response from a dict
|
||||
api_v1_video_channels_channel_handle_video_playlists_get200_response_form_dict = api_v1_video_channels_channel_handle_video_playlists_get200_response.from_dict(api_v1_video_channels_channel_handle_video_playlists_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1VideosIdCommentThreadsPostRequest.md
Normal file
29
docs/ApiV1VideosIdCommentThreadsPostRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1VideosIdCommentThreadsPostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**text** | [**Text**](Text.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_videos_id_comment_threads_post_request import ApiV1VideosIdCommentThreadsPostRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideosIdCommentThreadsPostRequest from a JSON string
|
||||
api_v1_videos_id_comment_threads_post_request_instance = ApiV1VideosIdCommentThreadsPostRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideosIdCommentThreadsPostRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_videos_id_comment_threads_post_request_dict = api_v1_videos_id_comment_threads_post_request_instance.to_dict()
|
||||
# create an instance of ApiV1VideosIdCommentThreadsPostRequest from a dict
|
||||
api_v1_videos_id_comment_threads_post_request_form_dict = api_v1_videos_id_comment_threads_post_request.from_dict(api_v1_videos_id_comment_threads_post_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1VideosIdPasswordsPutRequest.md
Normal file
29
docs/ApiV1VideosIdPasswordsPutRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1VideosIdPasswordsPutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**passwords** | **List[str]** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_videos_id_passwords_put_request import ApiV1VideosIdPasswordsPutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideosIdPasswordsPutRequest from a JSON string
|
||||
api_v1_videos_id_passwords_put_request_instance = ApiV1VideosIdPasswordsPutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideosIdPasswordsPutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_videos_id_passwords_put_request_dict = api_v1_videos_id_passwords_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1VideosIdPasswordsPutRequest from a dict
|
||||
api_v1_videos_id_passwords_put_request_form_dict = api_v1_videos_id_passwords_put_request.from_dict(api_v1_videos_id_passwords_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/ApiV1VideosIdRatePutRequest.md
Normal file
29
docs/ApiV1VideosIdRatePutRequest.md
Normal file
@ -0,0 +1,29 @@
|
||||
# ApiV1VideosIdRatePutRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rating** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_videos_id_rate_put_request import ApiV1VideosIdRatePutRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideosIdRatePutRequest from a JSON string
|
||||
api_v1_videos_id_rate_put_request_instance = ApiV1VideosIdRatePutRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideosIdRatePutRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_videos_id_rate_put_request_dict = api_v1_videos_id_rate_put_request_instance.to_dict()
|
||||
# create an instance of ApiV1VideosIdRatePutRequest from a dict
|
||||
api_v1_videos_id_rate_put_request_form_dict = api_v1_videos_id_rate_put_request.from_dict(api_v1_videos_id_rate_put_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/ApiV1VideosLiveIdSessionsGet200Response.md
Normal file
30
docs/ApiV1VideosLiveIdSessionsGet200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ApiV1VideosLiveIdSessionsGet200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[LiveVideoSessionResponse]**](LiveVideoSessionResponse.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_videos_live_id_sessions_get200_response import ApiV1VideosLiveIdSessionsGet200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideosLiveIdSessionsGet200Response from a JSON string
|
||||
api_v1_videos_live_id_sessions_get200_response_instance = ApiV1VideosLiveIdSessionsGet200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideosLiveIdSessionsGet200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_videos_live_id_sessions_get200_response_dict = api_v1_videos_live_id_sessions_get200_response_instance.to_dict()
|
||||
# create an instance of ApiV1VideosLiveIdSessionsGet200Response from a dict
|
||||
api_v1_videos_live_id_sessions_get200_response_form_dict = api_v1_videos_live_id_sessions_get200_response.from_dict(api_v1_videos_live_id_sessions_get200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/ApiV1VideosOwnershipIdAcceptPostIdParameter.md
Normal file
28
docs/ApiV1VideosOwnershipIdAcceptPostIdParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# ApiV1VideosOwnershipIdAcceptPostIdParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.api_v1_videos_ownership_id_accept_post_id_parameter import ApiV1VideosOwnershipIdAcceptPostIdParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ApiV1VideosOwnershipIdAcceptPostIdParameter from a JSON string
|
||||
api_v1_videos_ownership_id_accept_post_id_parameter_instance = ApiV1VideosOwnershipIdAcceptPostIdParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ApiV1VideosOwnershipIdAcceptPostIdParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
api_v1_videos_ownership_id_accept_post_id_parameter_dict = api_v1_videos_ownership_id_accept_post_id_parameter_instance.to_dict()
|
||||
# create an instance of ApiV1VideosOwnershipIdAcceptPostIdParameter from a dict
|
||||
api_v1_videos_ownership_id_accept_post_id_parameter_form_dict = api_v1_videos_ownership_id_accept_post_id_parameter.from_dict(api_v1_videos_ownership_id_accept_post_id_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/BlockStatus.md
Normal file
30
docs/BlockStatus.md
Normal file
@ -0,0 +1,30 @@
|
||||
# BlockStatus
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accounts** | [**Dict[str, BlockStatusAccountsValue]**](BlockStatusAccountsValue.md) | | [optional]
|
||||
**hosts** | [**Dict[str, BlockStatusHostsValue]**](BlockStatusHostsValue.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.block_status import BlockStatus
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BlockStatus from a JSON string
|
||||
block_status_instance = BlockStatus.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print BlockStatus.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
block_status_dict = block_status_instance.to_dict()
|
||||
# create an instance of BlockStatus from a dict
|
||||
block_status_form_dict = block_status.from_dict(block_status_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/BlockStatusAccountsValue.md
Normal file
30
docs/BlockStatusAccountsValue.md
Normal file
@ -0,0 +1,30 @@
|
||||
# BlockStatusAccountsValue
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**blocked_by_server** | **bool** | | [optional]
|
||||
**blocked_by_user** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.block_status_accounts_value import BlockStatusAccountsValue
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BlockStatusAccountsValue from a JSON string
|
||||
block_status_accounts_value_instance = BlockStatusAccountsValue.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print BlockStatusAccountsValue.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
block_status_accounts_value_dict = block_status_accounts_value_instance.to_dict()
|
||||
# create an instance of BlockStatusAccountsValue from a dict
|
||||
block_status_accounts_value_form_dict = block_status_accounts_value.from_dict(block_status_accounts_value_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/BlockStatusHostsValue.md
Normal file
30
docs/BlockStatusHostsValue.md
Normal file
@ -0,0 +1,30 @@
|
||||
# BlockStatusHostsValue
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**blocked_by_server** | **bool** | | [optional]
|
||||
**blocked_by_user** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.block_status_hosts_value import BlockStatusHostsValue
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BlockStatusHostsValue from a JSON string
|
||||
block_status_hosts_value_instance = BlockStatusHostsValue.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print BlockStatusHostsValue.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
block_status_hosts_value_dict = block_status_hosts_value_instance.to_dict()
|
||||
# create an instance of BlockStatusHostsValue from a dict
|
||||
block_status_hosts_value_form_dict = block_status_hosts_value.from_dict(block_status_hosts_value_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
374
docs/ChannelsSyncApi.md
Normal file
374
docs/ChannelsSyncApi.md
Normal file
@ -0,0 +1,374 @@
|
||||
# peertube.ChannelsSyncApi
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**add_video_channel_sync**](ChannelsSyncApi.md#add_video_channel_sync) | **POST** /api/v1/video-channel-syncs | Create a synchronization for a video channel
|
||||
[**api_v1_accounts_name_video_channel_syncs_get**](ChannelsSyncApi.md#api_v1_accounts_name_video_channel_syncs_get) | **GET** /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account
|
||||
[**api_v1_video_channels_channel_handle_import_videos_post**](ChannelsSyncApi.md#api_v1_video_channels_channel_handle_import_videos_post) | **POST** /api/v1/video-channels/{channelHandle}/import-videos | Import videos in channel
|
||||
[**del_video_channel_sync**](ChannelsSyncApi.md#del_video_channel_sync) | **DELETE** /api/v1/video-channel-syncs/{channelSyncId} | Delete a video channel synchronization
|
||||
[**trigger_video_channel_sync**](ChannelsSyncApi.md#trigger_video_channel_sync) | **POST** /api/v1/video-channel-syncs/{channelSyncId}/sync | Triggers the channel synchronization job, fetching all the videos from the remote channel
|
||||
|
||||
|
||||
# **add_video_channel_sync**
|
||||
> AddVideoChannelSync200Response add_video_channel_sync(video_channel_sync_create=video_channel_sync_create)
|
||||
|
||||
Create a synchronization for a video channel
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.add_video_channel_sync200_response import AddVideoChannelSync200Response
|
||||
from peertube.models.video_channel_sync_create import VideoChannelSyncCreate
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ChannelsSyncApi(api_client)
|
||||
video_channel_sync_create = peertube.VideoChannelSyncCreate() # VideoChannelSyncCreate | (optional)
|
||||
|
||||
try:
|
||||
# Create a synchronization for a video channel
|
||||
api_response = api_instance.add_video_channel_sync(video_channel_sync_create=video_channel_sync_create)
|
||||
print("The response of ChannelsSyncApi->add_video_channel_sync:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ChannelsSyncApi->add_video_channel_sync: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**video_channel_sync_create** | [**VideoChannelSyncCreate**](VideoChannelSyncCreate.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**AddVideoChannelSync200Response**](AddVideoChannelSync200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_accounts_name_video_channel_syncs_get**
|
||||
> VideoChannelSyncList api_v1_accounts_name_video_channel_syncs_get(name, start=start, count=count, sort=sort)
|
||||
|
||||
List the synchronizations of video channels of an account
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.video_channel_sync_list import VideoChannelSyncList
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ChannelsSyncApi(api_client)
|
||||
name = 'chocobozzz | chocobozzz@example.org' # str | The username or handle of the account
|
||||
start = 56 # int | Offset used to paginate results (optional)
|
||||
count = 15 # int | Number of items to return (optional) (default to 15)
|
||||
sort = '-createdAt' # str | Sort column (optional)
|
||||
|
||||
try:
|
||||
# List the synchronizations of video channels of an account
|
||||
api_response = api_instance.api_v1_accounts_name_video_channel_syncs_get(name, start=start, count=count, sort=sort)
|
||||
print("The response of ChannelsSyncApi->api_v1_accounts_name_video_channel_syncs_get:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ChannelsSyncApi->api_v1_accounts_name_video_channel_syncs_get: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| The username or handle of the account |
|
||||
**start** | **int**| Offset used to paginate results | [optional]
|
||||
**count** | **int**| Number of items to return | [optional] [default to 15]
|
||||
**sort** | **str**| Sort column | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**VideoChannelSyncList**](VideoChannelSyncList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **api_v1_video_channels_channel_handle_import_videos_post**
|
||||
> api_v1_video_channels_channel_handle_import_videos_post(channel_handle, import_videos_in_channel_create=import_videos_in_channel_create)
|
||||
|
||||
Import videos in channel
|
||||
|
||||
Import a remote channel/playlist videos into a channel
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.import_videos_in_channel_create import ImportVideosInChannelCreate
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ChannelsSyncApi(api_client)
|
||||
channel_handle = 'my_username | my_username@example.com' # str | The video channel handle
|
||||
import_videos_in_channel_create = peertube.ImportVideosInChannelCreate() # ImportVideosInChannelCreate | (optional)
|
||||
|
||||
try:
|
||||
# Import videos in channel
|
||||
api_instance.api_v1_video_channels_channel_handle_import_videos_post(channel_handle, import_videos_in_channel_create=import_videos_in_channel_create)
|
||||
except Exception as e:
|
||||
print("Exception when calling ChannelsSyncApi->api_v1_video_channels_channel_handle_import_videos_post: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**channel_handle** | **str**| The video channel handle |
|
||||
**import_videos_in_channel_create** | [**ImportVideosInChannelCreate**](ImportVideosInChannelCreate.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **del_video_channel_sync**
|
||||
> del_video_channel_sync(channel_sync_id)
|
||||
|
||||
Delete a video channel synchronization
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ChannelsSyncApi(api_client)
|
||||
channel_sync_id = 56 # int | Channel Sync id
|
||||
|
||||
try:
|
||||
# Delete a video channel synchronization
|
||||
api_instance.del_video_channel_sync(channel_sync_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ChannelsSyncApi->del_video_channel_sync: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**channel_sync_id** | **int**| Channel Sync id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **trigger_video_channel_sync**
|
||||
> trigger_video_channel_sync(channel_sync_id)
|
||||
|
||||
Triggers the channel synchronization job, fetching all the videos from the remote channel
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ChannelsSyncApi(api_client)
|
||||
channel_sync_id = 56 # int | Channel Sync id
|
||||
|
||||
try:
|
||||
# Triggers the channel synchronization job, fetching all the videos from the remote channel
|
||||
api_instance.trigger_video_channel_sync(channel_sync_id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ChannelsSyncApi->trigger_video_channel_sync: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**channel_sync_id** | **int**| Channel Sync id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**204** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
29
docs/CommentThreadPostResponse.md
Normal file
29
docs/CommentThreadPostResponse.md
Normal file
@ -0,0 +1,29 @@
|
||||
# CommentThreadPostResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comment** | [**VideoComment**](VideoComment.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.comment_thread_post_response import CommentThreadPostResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CommentThreadPostResponse from a JSON string
|
||||
comment_thread_post_response_instance = CommentThreadPostResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print CommentThreadPostResponse.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
comment_thread_post_response_dict = comment_thread_post_response_instance.to_dict()
|
||||
# create an instance of CommentThreadPostResponse from a dict
|
||||
comment_thread_post_response_form_dict = comment_thread_post_response.from_dict(comment_thread_post_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/CommentThreadResponse.md
Normal file
30
docs/CommentThreadResponse.md
Normal file
@ -0,0 +1,30 @@
|
||||
# CommentThreadResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[VideoComment]**](VideoComment.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.comment_thread_response import CommentThreadResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CommentThreadResponse from a JSON string
|
||||
comment_thread_response_instance = CommentThreadResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print CommentThreadResponse.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
comment_thread_response_dict = comment_thread_response_instance.to_dict()
|
||||
# create an instance of CommentThreadResponse from a dict
|
||||
comment_thread_response_form_dict = comment_thread_response.from_dict(comment_thread_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
339
docs/ConfigApi.md
Normal file
339
docs/ConfigApi.md
Normal file
@ -0,0 +1,339 @@
|
||||
# peertube.ConfigApi
|
||||
|
||||
All URIs are relative to *https://peertube2.cpy.re*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**del_custom_config**](ConfigApi.md#del_custom_config) | **DELETE** /api/v1/config/custom | Delete instance runtime configuration
|
||||
[**get_about**](ConfigApi.md#get_about) | **GET** /api/v1/config/about | Get instance \"About\" information
|
||||
[**get_config**](ConfigApi.md#get_config) | **GET** /api/v1/config | Get instance public configuration
|
||||
[**get_custom_config**](ConfigApi.md#get_custom_config) | **GET** /api/v1/config/custom | Get instance runtime configuration
|
||||
[**put_custom_config**](ConfigApi.md#put_custom_config) | **PUT** /api/v1/config/custom | Set instance runtime configuration
|
||||
|
||||
|
||||
# **del_custom_config**
|
||||
> del_custom_config()
|
||||
|
||||
Delete instance runtime configuration
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ConfigApi(api_client)
|
||||
|
||||
try:
|
||||
# Delete instance runtime configuration
|
||||
api_instance.del_custom_config()
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigApi->del_custom_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_about**
|
||||
> ServerConfigAbout get_about()
|
||||
|
||||
Get instance \"About\" information
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.server_config_about import ServerConfigAbout
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ConfigApi(api_client)
|
||||
|
||||
try:
|
||||
# Get instance \"About\" information
|
||||
api_response = api_instance.get_about()
|
||||
print("The response of ConfigApi->get_about:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigApi->get_about: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServerConfigAbout**](ServerConfigAbout.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_config**
|
||||
> ServerConfig get_config()
|
||||
|
||||
Get instance public configuration
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.server_config import ServerConfig
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ConfigApi(api_client)
|
||||
|
||||
try:
|
||||
# Get instance public configuration
|
||||
api_response = api_instance.get_config()
|
||||
print("The response of ConfigApi->get_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigApi->get_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServerConfig**](ServerConfig.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **get_custom_config**
|
||||
> ServerConfigCustom get_custom_config()
|
||||
|
||||
Get instance runtime configuration
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.models.server_config_custom import ServerConfigCustom
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ConfigApi(api_client)
|
||||
|
||||
try:
|
||||
# Get instance runtime configuration
|
||||
api_response = api_instance.get_custom_config()
|
||||
print("The response of ConfigApi->get_custom_config:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigApi->get_custom_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ServerConfigCustom**](ServerConfigCustom.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
|
||||
[[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)
|
||||
|
||||
# **put_custom_config**
|
||||
> put_custom_config()
|
||||
|
||||
Set instance runtime configuration
|
||||
|
||||
### Example
|
||||
|
||||
* OAuth Authentication (OAuth2):
|
||||
|
||||
```python
|
||||
import peertube
|
||||
from peertube.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to https://peertube2.cpy.re
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = peertube.Configuration(
|
||||
host = "https://peertube2.cpy.re"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with peertube.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = peertube.ConfigApi(api_client)
|
||||
|
||||
try:
|
||||
# Set instance runtime configuration
|
||||
api_instance.put_custom_config()
|
||||
except Exception as e:
|
||||
print("Exception when calling ConfigApi->put_custom_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2](../README.md#OAuth2)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | successful operation | - |
|
||||
**400** | Arises when: - the emailer is disabled and the instance is open to registrations - web videos and hls are disabled with transcoding enabled - you need at least one enabled | - |
|
||||
|
||||
[[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)
|
||||
|
||||
30
docs/ConfirmTwoFactorRequestRequest.md
Normal file
30
docs/ConfirmTwoFactorRequestRequest.md
Normal file
@ -0,0 +1,30 @@
|
||||
# ConfirmTwoFactorRequestRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**request_token** | **str** | Token to identify the two factor request |
|
||||
**otp_token** | **str** | OTP token generated by the app |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.confirm_two_factor_request_request import ConfirmTwoFactorRequestRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ConfirmTwoFactorRequestRequest from a JSON string
|
||||
confirm_two_factor_request_request_instance = ConfirmTwoFactorRequestRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ConfirmTwoFactorRequestRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
confirm_two_factor_request_request_dict = confirm_two_factor_request_request_instance.to_dict()
|
||||
# create an instance of ConfirmTwoFactorRequestRequest from a dict
|
||||
confirm_two_factor_request_request_form_dict = confirm_two_factor_request_request.from_dict(confirm_two_factor_request_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/CreateVideoTranscodingRequest.md
Normal file
30
docs/CreateVideoTranscodingRequest.md
Normal file
@ -0,0 +1,30 @@
|
||||
# CreateVideoTranscodingRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**transcoding_type** | **str** | |
|
||||
**force_transcoding** | **bool** | If the video is stuck in transcoding state, do it anyway | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.create_video_transcoding_request import CreateVideoTranscodingRequest
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CreateVideoTranscodingRequest from a JSON string
|
||||
create_video_transcoding_request_instance = CreateVideoTranscodingRequest.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print CreateVideoTranscodingRequest.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
create_video_transcoding_request_dict = create_video_transcoding_request_instance.to_dict()
|
||||
# create an instance of CreateVideoTranscodingRequest from a dict
|
||||
create_video_transcoding_request_form_dict = create_video_transcoding_request.from_dict(create_video_transcoding_request_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
29
docs/CustomHomepage.md
Normal file
29
docs/CustomHomepage.md
Normal file
@ -0,0 +1,29 @@
|
||||
# CustomHomepage
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.custom_homepage import CustomHomepage
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CustomHomepage from a JSON string
|
||||
custom_homepage_instance = CustomHomepage.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print CustomHomepage.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
custom_homepage_dict = custom_homepage_instance.to_dict()
|
||||
# create an instance of CustomHomepage from a dict
|
||||
custom_homepage_form_dict = custom_homepage.from_dict(custom_homepage_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/CutOptions.md
Normal file
30
docs/CutOptions.md
Normal file
@ -0,0 +1,30 @@
|
||||
# CutOptions
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**start** | **int** | | [optional]
|
||||
**end** | **int** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.cut_options import CutOptions
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CutOptions from a JSON string
|
||||
cut_options_instance = CutOptions.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print CutOptions.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
cut_options_dict = cut_options_instance.to_dict()
|
||||
# create an instance of CutOptions from a dict
|
||||
cut_options_form_dict = cut_options.from_dict(cut_options_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
35
docs/FileRedundancyInformation.md
Normal file
35
docs/FileRedundancyInformation.md
Normal file
@ -0,0 +1,35 @@
|
||||
# FileRedundancyInformation
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**file_url** | **str** | | [optional]
|
||||
**strategy** | **str** | | [optional]
|
||||
**size** | **int** | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
**expires_on** | **datetime** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.file_redundancy_information import FileRedundancyInformation
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FileRedundancyInformation from a JSON string
|
||||
file_redundancy_information_instance = FileRedundancyInformation.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print FileRedundancyInformation.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
file_redundancy_information_dict = file_redundancy_information_instance.to_dict()
|
||||
# create an instance of FileRedundancyInformation from a dict
|
||||
file_redundancy_information_form_dict = file_redundancy_information.from_dict(file_redundancy_information_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
35
docs/Follow.md
Normal file
35
docs/Follow.md
Normal file
@ -0,0 +1,35 @@
|
||||
# Follow
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**follower** | [**Actor**](Actor.md) | | [optional]
|
||||
**following** | [**Actor**](Actor.md) | | [optional]
|
||||
**score** | **float** | score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`. | [optional]
|
||||
**state** | **str** | | [optional]
|
||||
**created_at** | **datetime** | | [optional]
|
||||
**updated_at** | **datetime** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.follow import Follow
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Follow from a JSON string
|
||||
follow_instance = Follow.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print Follow.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
follow_dict = follow_instance.to_dict()
|
||||
# create an instance of Follow from a dict
|
||||
follow_form_dict = follow.from_dict(follow_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/GetAccountFollowers200Response.md
Normal file
30
docs/GetAccountFollowers200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# GetAccountFollowers200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[Follow]**](Follow.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_followers200_response import GetAccountFollowers200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountFollowers200Response from a JSON string
|
||||
get_account_followers200_response_instance = GetAccountFollowers200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountFollowers200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_followers200_response_dict = get_account_followers200_response_instance.to_dict()
|
||||
# create an instance of GetAccountFollowers200Response from a dict
|
||||
get_account_followers200_response_form_dict = get_account_followers200_response.from_dict(get_account_followers200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/GetAccountVideosCategoryOneOfParameter.md
Normal file
28
docs/GetAccountVideosCategoryOneOfParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# GetAccountVideosCategoryOneOfParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_videos_category_one_of_parameter import GetAccountVideosCategoryOneOfParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountVideosCategoryOneOfParameter from a JSON string
|
||||
get_account_videos_category_one_of_parameter_instance = GetAccountVideosCategoryOneOfParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountVideosCategoryOneOfParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_videos_category_one_of_parameter_dict = get_account_videos_category_one_of_parameter_instance.to_dict()
|
||||
# create an instance of GetAccountVideosCategoryOneOfParameter from a dict
|
||||
get_account_videos_category_one_of_parameter_form_dict = get_account_videos_category_one_of_parameter.from_dict(get_account_videos_category_one_of_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/GetAccountVideosLanguageOneOfParameter.md
Normal file
28
docs/GetAccountVideosLanguageOneOfParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# GetAccountVideosLanguageOneOfParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_videos_language_one_of_parameter import GetAccountVideosLanguageOneOfParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountVideosLanguageOneOfParameter from a JSON string
|
||||
get_account_videos_language_one_of_parameter_instance = GetAccountVideosLanguageOneOfParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountVideosLanguageOneOfParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_videos_language_one_of_parameter_dict = get_account_videos_language_one_of_parameter_instance.to_dict()
|
||||
# create an instance of GetAccountVideosLanguageOneOfParameter from a dict
|
||||
get_account_videos_language_one_of_parameter_form_dict = get_account_videos_language_one_of_parameter.from_dict(get_account_videos_language_one_of_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/GetAccountVideosLicenceOneOfParameter.md
Normal file
28
docs/GetAccountVideosLicenceOneOfParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# GetAccountVideosLicenceOneOfParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_videos_licence_one_of_parameter import GetAccountVideosLicenceOneOfParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountVideosLicenceOneOfParameter from a JSON string
|
||||
get_account_videos_licence_one_of_parameter_instance = GetAccountVideosLicenceOneOfParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountVideosLicenceOneOfParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_videos_licence_one_of_parameter_dict = get_account_videos_licence_one_of_parameter_instance.to_dict()
|
||||
# create an instance of GetAccountVideosLicenceOneOfParameter from a dict
|
||||
get_account_videos_licence_one_of_parameter_form_dict = get_account_videos_licence_one_of_parameter.from_dict(get_account_videos_licence_one_of_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/GetAccountVideosTagsAllOfParameter.md
Normal file
28
docs/GetAccountVideosTagsAllOfParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# GetAccountVideosTagsAllOfParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_videos_tags_all_of_parameter import GetAccountVideosTagsAllOfParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountVideosTagsAllOfParameter from a JSON string
|
||||
get_account_videos_tags_all_of_parameter_instance = GetAccountVideosTagsAllOfParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountVideosTagsAllOfParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_videos_tags_all_of_parameter_dict = get_account_videos_tags_all_of_parameter_instance.to_dict()
|
||||
# create an instance of GetAccountVideosTagsAllOfParameter from a dict
|
||||
get_account_videos_tags_all_of_parameter_form_dict = get_account_videos_tags_all_of_parameter.from_dict(get_account_videos_tags_all_of_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
28
docs/GetAccountVideosTagsOneOfParameter.md
Normal file
28
docs/GetAccountVideosTagsOneOfParameter.md
Normal file
@ -0,0 +1,28 @@
|
||||
# GetAccountVideosTagsOneOfParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_account_videos_tags_one_of_parameter import GetAccountVideosTagsOneOfParameter
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccountVideosTagsOneOfParameter from a JSON string
|
||||
get_account_videos_tags_one_of_parameter_instance = GetAccountVideosTagsOneOfParameter.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccountVideosTagsOneOfParameter.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_account_videos_tags_one_of_parameter_dict = get_account_videos_tags_one_of_parameter_instance.to_dict()
|
||||
# create an instance of GetAccountVideosTagsOneOfParameter from a dict
|
||||
get_account_videos_tags_one_of_parameter_form_dict = get_account_videos_tags_one_of_parameter.from_dict(get_account_videos_tags_one_of_parameter_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
30
docs/GetAccounts200Response.md
Normal file
30
docs/GetAccounts200Response.md
Normal file
@ -0,0 +1,30 @@
|
||||
# GetAccounts200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**total** | **int** | | [optional]
|
||||
**data** | [**List[Account]**](Account.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from peertube.models.get_accounts200_response import GetAccounts200Response
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GetAccounts200Response from a JSON string
|
||||
get_accounts200_response_instance = GetAccounts200Response.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print GetAccounts200Response.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
get_accounts200_response_dict = get_accounts200_response_instance.to_dict()
|
||||
# create an instance of GetAccounts200Response from a dict
|
||||
get_accounts200_response_form_dict = get_accounts200_response.from_dict(get_accounts200_response_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user