TeamPiped-mirror/piped_dart
1
0
Fork 0
mirror of https://github.com/TeamPiped/piped_dart.git synced 2024-08-14 22:27:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update bindings with openapi generator.

Browse source
This commit is contained in:
Kavin 2022-06-17 14:18:44 +01:00
parent 8d3d6d14b0
commit abc390a2e1
No known key found for this signature in database
GPG key ID: 49451E4482CC5BCD
27 changed files with 2941 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/ChannelInfo.md
View file

@ -14,7 +14,7 @@ Name | Type | Description | Notes
**id** | **String** | The ID of the channel. | [optional]
**name** | **String** | The name of the channel. | [optional]
**nextpage** | **String** | The parameter used to get the next page of related videos. | [optional]
**relatedStreams** | [**BuiltList<StreamItem>**](StreamItem.md) | | [optional]
**relatedStreams** | [**BuiltList&lt;StreamItem&gt;**](StreamItem.md) | | [optional]
**subscriberCount** | **int** | The number of subscribers the channel has. | [optional]
**verified** | **bool** | Whether the channel is verified. | [optional]

16
doc/StreamsPage.md Normal file
View file

@ -0,0 +1,16 @@
# piped_api.model.StreamsPage
## Load the model package
```dart
import 'package:piped_api/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**relatedStreams** | [**BuiltList&lt;StreamItem&gt;**](StreamItem.md) | | [optional]
**nextpage** | **String** | The parameter used to get the next page of this page. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

98
doc/UnauthenticatedApi.md
View file

@ -12,6 +12,7 @@ Method | HTTP request | Description
[**channelInfoId**](UnauthenticatedApi.md#channelinfoid) | **GET** /channel/{channelId} | Gets Channel Information
[**channelInfoName**](UnauthenticatedApi.md#channelinfoname) | **GET** /c/{name} | Gets Channel Information
[**channelInfoUsername**](UnauthenticatedApi.md#channelinfousername) | **GET** /user/{username} | Gets Channel Information
[**channelNextPage**](UnauthenticatedApi.md#channelnextpage) | **GET** /nextpage/channel/{channelId} | Gets more channel videos
[**streamInfo**](UnauthenticatedApi.md#streaminfo) | **GET** /streams/{videoId} | Gets Video Information
[**trending**](UnauthenticatedApi.md#trending) | **GET** /trending | Gets all Trending Videos
@ -27,13 +28,13 @@ Gets all available Channel information about a channel.
```dart
import 'package:piped_api/api.dart';
var api_instance = new UnauthenticatedApi();
var channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.
final api = PipedApi().getUnauthenticatedApi();
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get information about.
try {
var result = api_instance.channelInfoId(channelId);
print(result);
} catch (e) {
final response = api.channelInfoId(channelId);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->channelInfoId: $e\n');
}
```
@ -70,13 +71,13 @@ Gets all available Channel information about a channel.
```dart
import 'package:piped_api/api.dart';
var api_instance = new UnauthenticatedApi();
var name = Dream; // String | The name of the YouTube channel you want to get information about.
final api = PipedApi().getUnauthenticatedApi();
final String name = Dream; // String | The name of the YouTube channel you want to get information about.
try {
var result = api_instance.channelInfoName(name);
print(result);
} catch (e) {
final response = api.channelInfoName(name);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->channelInfoName: $e\n');
}
```
@ -113,13 +114,13 @@ Gets all available Channel information about a channel.
```dart
import 'package:piped_api/api.dart';
var api_instance = new UnauthenticatedApi();
var username = DreamTraps; // String | The username of the YouTube channel you want to get information about.
final api = PipedApi().getUnauthenticatedApi();
final String username = DreamTraps; // String | The username of the YouTube channel you want to get information about.
try {
var result = api_instance.channelInfoUsername(username);
print(result);
} catch (e) {
final response = api.channelInfoUsername(username);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->channelInfoUsername: $e\n');
}
```
@ -145,6 +146,51 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **channelNextPage**
> StreamsPage channelNextPage(channelId, nextpage)
Gets more channel videos
Gets more channel videos.
### Example
```dart
import 'package:piped_api/api.dart';
final api = PipedApi().getUnauthenticatedApi();
final String channelId = UCs6KfncB4OV6Vug4o_bzijg; // String | The channel ID of the YouTube channel you want to get more videos from.
final String nextpage = nextpage_example; // String | The next page token to get more videos from.
try {
final response = api.channelNextPage(channelId, nextpage);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->channelNextPage: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**channelId** | **String**| The channel ID of the YouTube channel you want to get more videos from. |
**nextpage** | **String**| The next page token to get more videos from. |
### Return type
[**StreamsPage**](StreamsPage.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **streamInfo**
> VideoInfo streamInfo(videoId)
@ -156,13 +202,13 @@ Gets all available Stream information about a video.
```dart
import 'package:piped_api/api.dart';
var api_instance = new UnauthenticatedApi();
var videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get information about.
final api = PipedApi().getUnauthenticatedApi();
final String videoId = dQw4w9WgXcQ; // String | The video ID of the YouTube video you want to get information about.
try {
var result = api_instance.streamInfo(videoId);
print(result);
} catch (e) {
final response = api.streamInfo(videoId);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->streamInfo: $e\n');
}
```
@ -199,13 +245,13 @@ Gets all Trending Videos in the requested country.
```dart
import 'package:piped_api/api.dart';
var api_instance = new UnauthenticatedApi();
var region = US; // Regions | The Region to get trending videos from.
final api = PipedApi().getUnauthenticatedApi();
final Regions region = US; // Regions | The Region to get trending videos from.
try {
var result = api_instance.trending(region);
print(result);
} catch (e) {
final response = api.trending(region);
print(response);
} catch on DioError (e) {
print('Exception when calling UnauthenticatedApi->trending: $e\n');
}
```
@ -218,7 +264,7 @@ Name | Type | Description | Notes
### Return type
[**BuiltList<StreamItem>**](StreamItem.md)
[**BuiltList&lt;StreamItem&gt;**](StreamItem.md)
### Authorization

8
doc/VideoInfo.md
View file

@ -8,8 +8,8 @@ import 'package:piped_api/api.dart';
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**audioStreams** | [**BuiltList<Stream>**](Stream.md) | | [optional]
**videoStreams** | [**BuiltList<Stream>**](Stream.md) | | [optional]
**audioStreams** | [**BuiltList&lt;Stream&gt;**](Stream.md) | | [optional]
**videoStreams** | [**BuiltList&lt;Stream&gt;**](Stream.md) | | [optional]
**description** | **String** | The video's description. | [optional]
**dislikes** | **int** | The number of dislikes the video has. | [optional]
**duration** | **int** | The video's duration in seconds. | [optional]
@ -18,7 +18,7 @@ Name | Type | Description | Notes
**likes** | **int** | The number of likes the video has. | [optional]
**livestream** | **bool** | Whether the video is a livestream. | [optional]
**proxyUrl** | **String** | The base URL of the backend instance's proxy. | [optional]
**subtitles** | [**BuiltList<Subtitle>**](Subtitle.md) | | [optional]
**subtitles** | [**BuiltList&lt;Subtitle&gt;**](Subtitle.md) | | [optional]
**dash** | **String** | The URL of the DASH manifest. | [optional]
**thumbnailUrl** | **String** | The URL of the video's thumbnail. | [optional]
**title** | **String** | The video's title. | [optional]
@ -27,7 +27,7 @@ Name | Type | Description | Notes
**uploaderAvatar** | **String** | The URL of the video's uploader's avatar. | [optional]
**uploaderUrl** | **String** | The relative URL of the video's uploader. | [optional]
**uploaderVerified** | **bool** | Whether the video's uploader is verified. | [optional]
**relatedStreams** | [**BuiltList<StreamItem>**](StreamItem.md) | | [optional]
**relatedStreams** | [**BuiltList&lt;StreamItem&gt;**](StreamItem.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)