Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,23 @@ on:
pull_request:
branches:
- main

jobs:
run-tests:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '16'
- name: Install dependencies
run: npm install
node-version: "16"

- name: Install dependencies
run: npm install
- name: Run Prettier
run: npm run prettier

- name: Install Jest
run: npm install jest

- name: Install dotenv
run: npm install dotenv --save

- name: Install uuid
run: npm install uuid

- name: Create env file
run: |
touch .env
Expand All @@ -38,6 +29,4 @@ jobs:
echo TEST_ANONYMOUS_SECRET_KEY=${{ secrets.TEST_ANONYMOUS_SECRET_KEY }} >> .env

- name: Run tests
run: npm test


run: npm test
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Method | Description | HTTP request
[**getPlaylistPublicInfo()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#getPlaylistPublicInfo) | Get a playlist public | **GET** `/playlists/{id}/player.json`
[**getPlaylists()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#getPlaylists) | Get user's playlists | **POST** `/playlists`
[**moveVideoInPlaylist()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#moveVideoInPlaylist) | Move a video in a playlist | **PUT** `/playlists/{id}/items`
[**removeVideoFromPlaylist()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#removeVideoFromPlaylist) | Remove a video from a playlist | **DELETE** `/playlists/{id}/items/{item_id}`
[**removeMediaFromPlaylist()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#removeMediaFromPlaylist) | Remove a media from a playlist | **DELETE** `/playlists/{id}/items/{item_id}`
[**updatePlaylist()**](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/api/PlaylistApi.md#updatePlaylist) | Update a playlist | **PATCH** `/playlists/{id}`


Expand Down Expand Up @@ -156,8 +156,8 @@ Method | Description | HTTP request

### Models

- [AddMediaToPlaylistRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/AddMediaToPlaylistRequest.md)
- [AddPlayerThemesToVideoRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/AddPlayerThemesToVideoRequest.md)
- [AddVideoToPlaylistRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/AddVideoToPlaylistRequest.md)
- [ApiKey](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/ApiKey.md)
- [Asset](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/Asset.md)
- [AudioConfig](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/AudioConfig.md)
Expand Down Expand Up @@ -216,6 +216,7 @@ Method | Description | HTTP request
- [PublicPlaylistObject](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/PublicPlaylistObject.md)
- [QualityConfig](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/QualityConfig.md)
- [QualityObject](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/QualityObject.md)
- [RemoveMediasFromPlaylistRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/RemoveMediasFromPlaylistRequest.md)
- [RemovePlayerThemesFromMediaRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/RemovePlayerThemesFromMediaRequest.md)
- [RenameAPIKeyRequest](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/RenameAPIKeyRequest.md)
- [RequestCreateCaption](https://github.com/AIOZNetwork/aiozstream-nodejs-client/blob/main/docs/model/RequestCreateCaption.md)
Expand Down
16 changes: 9 additions & 7 deletions docs/api/PlaylistApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All URIs are relative to *http://localhost/api*
| [**getPlaylistPublicInfo()**](PlaylistApi.md#getPlaylistPublicInfo) | Get a playlist public | **GET** /playlists/{id}/player.json |
| [**getPlaylists()**](PlaylistApi.md#getPlaylists) | Get user's playlists | **POST** /playlists |
| [**moveVideoInPlaylist()**](PlaylistApi.md#moveVideoInPlaylist) | Move a video in a playlist | **PUT** /playlists/{id}/items |
| [**removeVideoFromPlaylist()**](PlaylistApi.md#removeVideoFromPlaylist) | Remove a video from a playlist | **DELETE** /playlists/{id}/items/{item_id} |
| [**removeMediaFromPlaylist()**](PlaylistApi.md#removeMediaFromPlaylist) | Remove a media from a playlist | **DELETE** /playlists/{id}/items/{item_id} |
| [**updatePlaylist()**](PlaylistApi.md#updatePlaylist) | Update a playlist | **PATCH** /playlists/{id} |


Expand All @@ -27,7 +27,7 @@ Add a specific video to a playlist for the authenticated user
| Name | Type | Required | Description |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| **yes**| Playlist ID |
| **payload** | [**AddVideoToPlaylistRequest**](../model/AddVideoToPlaylistRequest.md)| **yes**| Video details |
| **payload** | [**AddMediaToPlaylistRequest**](../model/AddMediaToPlaylistRequest.md)| **yes**| Video details |


### Return type
Expand Down Expand Up @@ -116,8 +116,9 @@ Retrieve a specific playlist by its ID for the current user.
| Name | Type | Required | Description |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| **yes**| Playlist ID |
| **sortBy** | **'created_at' \| 'title' \| 'duration'**| no| sort by |
| **orderBy** | **'asc' \| 'desc'**| no| allowed: asc, desc. Default: asc |
| **sortBy** | **string**| no| Sort by field (created_at, title, duration) |
| **orderBy** | **string**| no| Order by (asc, desc) |
| **search** | **string**| no| Search term |


### Return type
Expand Down Expand Up @@ -196,18 +197,19 @@ Promise<[**ResponseSuccess**](../model/ResponseSuccess.md)>.

---

<a name="removeVideoFromPlaylist"></a>
## **`removeVideoFromPlaylist()` - Remove a video from a playlist**
<a name="removeMediaFromPlaylist"></a>
## **`removeMediaFromPlaylist()` - Remove a media from a playlist**


Remove a specific video from a playlist for the authenticated user
Remove a specific media from a playlist for the authenticated user

### Parameters

| Name | Type | Required | Description |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **string**| **yes**| Playlist ID |
| **itemId** | **string**| **yes**| Playlist Item ID |
| **payload** | [**RemoveMediasFromPlaylistRequest**](../model/RemoveMediasFromPlaylistRequest.md)| **yes**| Optional payload |


### Return type
Expand Down
5 changes: 3 additions & 2 deletions docs/api/VideoApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,9 @@ get video transcoding cost

| Name | Type | Required | Description |
| ------------- | ------------- | ------------- | ------------- |
| **qualities** | **string**| **yes**| video&#39;s qualities |
| **duration** | **number**| **yes**| video&#39;s duration |
| **qualities** | **string**| **yes**| media&#39;s qualities |
| **type** | **string**| **yes**| media&#39;s type |
| **duration** | **number**| **yes**| media&#39;s duration |


### Return type
Expand Down
13 changes: 13 additions & 0 deletions docs/model/AddMediaToPlaylistRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# AddMediaToPlaylistRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mediaId** | **string** | | [optional]
**optionMediaIds** | **Array&lt;string&gt;** | | [optional]
**optionPlaylists** | **Array&lt;string&gt;** | | [optional]



17 changes: 9 additions & 8 deletions docs/model/CreateMediaRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **string** | | [optional]
**isPublic** | **boolean** | | [optional]
**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | | [optional]
**qualities** | [**Array&lt;QualityConfig&gt;**](QualityConfig.md) | | [optional]
**segmentDuration** | **number** | | [optional]
**tags** | **Array&lt;string&gt;** | | [optional]
**title** | **string** | | [optional]
**watermark** | [**VideoWatermark**](VideoWatermark.md) | | [optional]
**description** | **string** | Description of the media | [optional]
**isPublic** | **boolean** | // Is panoramic media IsPanoramic *bool &#x60;json:\&quot;is_panoramic\&quot; form:\&quot;is_panoramic\&quot;&#x60; Is public media | [optional]
**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | Metadata of the media (key-value pair, max: 50 items, key max length: 255, value max length: 255) | [optional]
**qualities** | [**Array&lt;QualityConfig&gt;**](QualityConfig.md) | Qualities of the media (default: 1080p, 720p, 360p, allow:2160p, 1440p, 1080p, 720p, 360p, 240p, 144p) | [optional]
**segmentDuration** | **number** | SegmentConfig | [optional]
**tags** | **Array&lt;string&gt;** | Tags of the media (max: 50 items, max length: 255) | [optional]
**title** | **string** | Title of the media | [optional]
**type** | **string** | Type of the media (default: video, allowed: video, audio) | [optional]
**watermark** | [**VideoWatermark**](VideoWatermark.md) | Media thumbnailConfig | [optional]



1 change: 1 addition & 0 deletions docs/model/CreatePlaylistRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | | [optional]
**name** | **string** | | [optional]
**playlistType** | **string** | | [optional]
**tags** | **Array&lt;string&gt;** | | [optional]


Expand Down
1 change: 1 addition & 0 deletions docs/model/GetPlaylistListRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | | [optional]
**offset** | **number** | | [optional]
**orderBy** | **string** | | [optional]
**playlistType** | **string** | | [optional]
**search** | **string** | | [optional]
**sortBy** | **string** | | [optional]
**tags** | **Array&lt;string&gt;** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/model/GetTranscodeCostData.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isEnough** | **boolean** | | [optional]
**price** | **string** | | [optional]
**price** | **number** | | [optional]



1 change: 1 addition & 0 deletions docs/model/GetVideoListRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**sortBy** | **string** | | [optional]
**status** | **string** | | [optional]
**tags** | **Array&lt;string&gt;** | | [optional]
**type** | **string** | | [optional]



1 change: 1 addition & 0 deletions docs/model/Media.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**status** | **string** | | [optional]
**tags** | **Array&lt;string&gt;** | | [optional]
**title** | **string** | | [optional]
**type** | **string** | | [optional]
**updatedAt** | **string** | | [optional]
**userId** | **string** | | [optional]
**view** | **number** | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/model/Playlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**itemCount** | **number** | | [optional]
**metadata** | **Map&lt;String, string&gt;** | | [optional]
**name** | **string** | | [optional]
**playlistType** | **string** | | [optional]
**playlistUrl** | **string** | | [optional]
**size** | **number** | | [optional]
**tags** | **string** | | [optional]
Expand Down
3 changes: 3 additions & 0 deletions docs/model/PlaylistItemMedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**captions** | [**Array&lt;VideoCaption&gt;**](VideoCaption.md) | | [optional]
**chapters** | [**Array&lt;VideoChapter&gt;**](VideoChapter.md) | | [optional]
**description** | **string** | | [optional]
**duration** | **number** | | [optional]
**hlsUrl** | **string** | | [optional]
**qualities** | **string** | | [optional]
**size** | **number** | | [optional]
**thumbnailUrl** | **string** | | [optional]
**title** | **string** | | [optional]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# AddVideoToPlaylistRequest
# RemoveMediasFromPlaylistRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**videoId** | **string** | | [optional]
**optionPlaylists** | **Array&lt;string&gt;** | | [optional]



7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,21 @@
},
"dependencies": {
"axios": "^1.4.0",
"js-base64": "^3.7.5"
"js-base64": "^3.7.5",
"uuid": "^8.3.2"
},
"devDependencies": {
"@tsconfig/node14": "^14.1.0",
"@types/node": "^20.3.3",
"@types/jest": "^29.5.2",
"@types/uuid": "^8.3.4",
"@typescript-eslint/eslint-plugin": "^5.61.0",
"@typescript-eslint/parser": "^5.61.0",
"dotenv": "^16.3.1",
"eslint": "^8.44.0",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-unused-imports": "^2.0.0",
"@types/jest": "^29.5.2",
"jest": "^29.6.0",
"ts-jest": "^29.1.1",
"typescript": "^5.1.6",
Expand Down
6 changes: 4 additions & 2 deletions src/ObjectSerializer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
* Do not edit the class manually.
*/

import AddMediaToPlaylistRequest from './model/AddMediaToPlaylistRequest';
import AddPlayerThemesToVideoRequest from './model/AddPlayerThemesToVideoRequest';
import AddVideoToPlaylistRequest from './model/AddVideoToPlaylistRequest';
import ApiKey from './model/ApiKey';
import Asset from './model/Asset';
import AudioConfig from './model/AudioConfig';
Expand Down Expand Up @@ -70,6 +70,7 @@ import PlaylistItemMedia from './model/PlaylistItemMedia';
import PublicPlaylistObject from './model/PublicPlaylistObject';
import QualityConfig from './model/QualityConfig';
import QualityObject from './model/QualityObject';
import RemoveMediasFromPlaylistRequest from './model/RemoveMediasFromPlaylistRequest';
import RemovePlayerThemesFromMediaRequest from './model/RemovePlayerThemesFromMediaRequest';
import RenameAPIKeyRequest from './model/RenameAPIKeyRequest';
import RequestCreateCaption from './model/RequestCreateCaption';
Expand Down Expand Up @@ -116,8 +117,8 @@ const supportedMediaTypes: { [mediaType: string]: number } = {
const enumsMap: Set<string> = new Set<string>([]);

const typeMap: { [index: string]: any } = {
AddMediaToPlaylistRequest: AddMediaToPlaylistRequest,
AddPlayerThemesToVideoRequest: AddPlayerThemesToVideoRequest,
AddVideoToPlaylistRequest: AddVideoToPlaylistRequest,
ApiKey: ApiKey,
Asset: Asset,
AudioConfig: AudioConfig,
Expand Down Expand Up @@ -176,6 +177,7 @@ const typeMap: { [index: string]: any } = {
PublicPlaylistObject: PublicPlaylistObject,
QualityConfig: QualityConfig,
QualityObject: QualityObject,
RemoveMediasFromPlaylistRequest: RemoveMediasFromPlaylistRequest,
RemovePlayerThemesFromMediaRequest: RemovePlayerThemesFromMediaRequest,
RenameAPIKeyRequest: RenameAPIKeyRequest,
RequestCreateCaption: RequestCreateCaption,
Expand Down
Loading
Loading