Merge pull request #54 from apivideo/add-player-theme-name

bot-api-video · web-flow · commit 21571deb9e88 · 2021-12-06T12:36:51.000+01:00
feat(all): a name property in player themes
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [2.1.0] - 2021-12-06
+- Add `name` attribute in player themes
+
 ## [2.0.14] - 2021-12-03
 - Fix ProgressiveSession import
 
diff --git a/README.md b/README.md
@@ -166,7 +166,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete**](doc/api/PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player
 [**deleteLogo**](doc/api/PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo
-[**list**](doc/api/PlayerThemesApi.md#list) | **GET** /players | List all players
+[**list**](doc/api/PlayerThemesApi.md#list) | **GET** /players | List all player themes
 [**get**](doc/api/PlayerThemesApi.md#get) | **GET** /players/{playerId} | Show a player
 [**update**](doc/api/PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player
 [**create**](doc/api/PlayerThemesApi.md#create) | **POST** /players | Create a player
diff --git a/doc/api/PlayerThemesApi.md b/doc/api/PlayerThemesApi.md
@@ -6,7 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete**](PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player
 [**deleteLogo**](PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo
-[**list**](PlayerThemesApi.md#list) | **GET** /players | List all players
+[**list**](PlayerThemesApi.md#list) | **GET** /players | List all player themes
 [**get**](PlayerThemesApi.md#get) | **GET** /players/{playerId} | Show a player
 [**update**](PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player
 [**create**](PlayerThemesApi.md#create) | **POST** /players | Create a player
@@ -123,7 +123,7 @@ Name | Type | Description  | Notes
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sortBy** | **&#39;createdAt&#39; | &#39;updatedAt&#39;**| createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. | [optional] [default to undefined] [enum: createdAt, updatedAt]
+ **sortBy** | **&#39;name&#39; | &#39;createdAt&#39; | &#39;updatedAt&#39;**| createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. | [optional] [default to undefined] [enum: name, createdAt, updatedAt]
  **sortOrder** | **&#39;asc&#39; | &#39;desc&#39;**| Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. | [optional] [default to undefined] [enum: asc, desc]
  **currentPage** | **number**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1]
  **pageSize** | **number**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
@@ -195,6 +195,7 @@ Name | Type | Description  | Notes
 
         const playerId = 'pl45d5vFFGrfdsdsd156dGhh'; // The unique identifier for the player.
         const playerThemeUpdatePayload = {
+			name: "name_example", // Add a name for your player theme here.
 			text: "text_example", // RGBA color for timer text. Default: rgba(255, 255, 255, 1)
 			link: "link_example", // RGBA color for all controls. Default: rgba(255, 255, 255, 1)
 			linkHover: "linkHover_example", // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
@@ -252,6 +253,7 @@ Name | Type | Description  | Notes
         const client = new ApiVideoClient({ apiKey: "YOUR_API_TOKEN" });
 
         const playerThemeCreationPayload = {
+			name: "name_example", // Add a name for your player theme here.
 			text: "text_example", // RGBA color for timer text. Default: rgba(255, 255, 255, 1)
 			link: "link_example", // RGBA color for all controls. Default: rgba(255, 255, 255, 1)
 			linkHover: "linkHover_example", // RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
diff --git a/doc/model/PlayerTheme.md b/doc/model/PlayerTheme.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the player theme |  [optional]
 **text** | **string** | RGBA color for timer text. Default: rgba(255, 255, 255, 1) |  [optional]
 **link** | **string** | RGBA color for all controls. Default: rgba(255, 255, 255, 1) |  [optional]
 **linkHover** | **string** | RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1) |  [optional]
diff --git a/doc/model/PlayerThemeCreationPayload.md b/doc/model/PlayerThemeCreationPayload.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**name** | **string** | Add a name for your player theme here. |  [optional]
 **text** | **string** | RGBA color for timer text. Default: rgba(255, 255, 255, 1) |  [optional]
 **link** | **string** | RGBA color for all controls. Default: rgba(255, 255, 255, 1) |  [optional]
 **linkHover** | **string** | RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1) |  [optional]
diff --git a/doc/model/PlayerThemeUpdatePayload.md b/doc/model/PlayerThemeUpdatePayload.md
@@ -5,6 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**name** | **string** | Add a name for your player theme here. |  [optional]
 **text** | **string** | RGBA color for timer text. Default: rgba(255, 255, 255, 1) |  [optional]
 **link** | **string** | RGBA color for all controls. Default: rgba(255, 255, 255, 1) |  [optional]
 **linkHover** | **string** | RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1) |  [optional]
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@api.video/nodejs-client",
-  "version": "2.0.14",
+  "version": "2.1.0",
   "description": "api.video nodejs client",
   "author": "api.video ecosystem team",
   "repository": {
diff --git a/src/HttpClient.ts b/src/HttpClient.ts
@@ -37,7 +37,7 @@ export default class HttpClient {
     this.chunkSize = params.chunkSize;
     this.tokenType = 'Bearer';
     this.headers = {
-      'User-Agent': `api.video client (nodejs; v:2.0.14; )`,
+      'User-Agent': `api.video client (nodejs; v:2.1.0; )`,
       Accept: 'application/json, */*;q=0.8',
     };
     this.baseRequest = got.extend({
diff --git a/src/api/PlayerThemesApi.ts b/src/api/PlayerThemesApi.ts
@@ -111,10 +111,10 @@ export default class PlayerThemesApi {
   }
 
   /**
-   * Retrieve a list of all the players you created, as well as details about each one. Tutorials that use the [player endpoint](https://api.video/blog/endpoints/player).
-   * List all players
+   * Retrieve a list of all the player themes you created, as well as details about each one. Tutorials that use the [player endpoint](https://api.video/blog/endpoints/player).
+   * List all player themes
    * @param {Object} searchParams
-   * @param { &#39;createdAt&#39; | &#39;updatedAt&#39; } searchParams.sortBy createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format.
+   * @param { &#39;name&#39; | &#39;createdAt&#39; | &#39;updatedAt&#39; } searchParams.sortBy createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format.
    * @param { &#39;asc&#39; | &#39;desc&#39; } searchParams.sortOrder Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.
    * @param { number } searchParams.currentPage Choose the number of search results to return per page. Minimum value: 1
    * @param { number } searchParams.pageSize Results per page. Allowed values 1-100, default is 25.
@@ -125,7 +125,7 @@ export default class PlayerThemesApi {
     currentPage,
     pageSize,
   }: {
-    sortBy?: 'createdAt' | 'updatedAt';
+    sortBy?: 'name' | 'createdAt' | 'updatedAt';
     sortOrder?: 'asc' | 'desc';
     currentPage?: number;
     pageSize?: number;
@@ -141,7 +141,11 @@ export default class PlayerThemesApi {
     if (sortBy !== undefined) {
       urlSearchParams.append(
         'sortBy',
-        ObjectSerializer.serialize(sortBy, "'createdAt' | 'updatedAt'", '')
+        ObjectSerializer.serialize(
+          sortBy,
+          "'name' | 'createdAt' | 'updatedAt'",
+          ''
+        )
       );
     }
     if (sortOrder !== undefined) {
diff --git a/src/api/VideosApi.ts b/src/api/VideosApi.ts
@@ -503,7 +503,7 @@ export default class VideosApi {
     return new UploadWithUploadTokenProgressiveSession<Video>(this.httpClient);
   }
   /**
-   * When given a token, anyone can upload a file to the URI `https://ws.api.video/upload?token=<tokenId>`.  Example with cURL:  ```curl $ curl  --request POST --url 'https://ws.api.video/upload?token=toXXX'  --header 'content-type: multipart/form-data'  -F file=@video.mp4 ```  Or in an HTML form, with a little JavaScript to convert the form into JSON: ```html <!--form for user interaction--> <form name=\"videoUploadForm\" >   <label for=video>Video:</label>   <input type=file name=source/><br/>   <input value=\"Submit\" type=\"submit\"> </form> <div></div> <!--JS takes the form data      uses FormData to turn the response into JSON.     then uses POST to upload the video file.     Update the token parameter in the url to your upload token.     --> <script>    var form = document.forms.namedItem(\"videoUploadForm\");     form.addEventListener('submit', function(ev) {   ev.preventDefault();      var oOutput = document.querySelector(\"div\"),          oData = new FormData(form);      var oReq = new XMLHttpRequest();         oReq.open(\"POST\", \"https://ws.api.video/upload?token=toXXX\", true);      oReq.send(oData);   oReq.onload = function(oEvent) {        if (oReq.status ==201) {          oOutput.innerHTML = \"Your video is uploaded!<br/>\"  + oReq.response;        } else {          oOutput.innerHTML = \"Error \" + oReq.status + \" occurred when trying to upload your file.<br />\";        }      };    }, false);  </script> ```   ### Dealing with large files  We have created a <a href='https://api.video/blog/tutorials/uploading-large-files-with-javascript'>tutorial</a> to walk through the steps required.
+   * When given a token, anyone can upload a file to the URI `https://ws.api.video/upload?token=<tokenId>`.  Example with cURL:  ```curl $ curl  --request POST --url 'https://ws.api.video/upload?token=toXXX'  --header 'content-type: multipart/form-data'  -F file=@video.mp4 ```  Or in an HTML form, with a little JavaScript to convert the form into JSON: ```html <!--form for user interaction--> <form name=\"videoUploadForm\" >   <label for=video>Video:</label>   <input type=file name=source/><br/>   <input value=\"Submit\" type=\"submit\"> </form> <div></div> <!--JS takes the form data      uses FormData to turn the response into JSON.     then uses POST to upload the video file.     Update the token parameter in the url to your upload token.     --> <script>    var form = document.forms.namedItem(\"videoUploadForm\");     form.addEventListener('submit', function(ev) {   ev.preventDefault();      var oOutput = document.querySelector(\"div\"),          oData = new FormData(form);      var oReq = new XMLHttpRequest();         oReq.open(\"POST\", \"https://ws.api.video/upload?token=toXXX\", true);      oReq.send(oData);   oReq.onload = function(oEvent) {        if (oReq.status ==201) {          oOutput.innerHTML = \"Your video is uploaded!<br/>\"  + oReq.response;        } else {          oOutput.innerHTML = \"Error \" + oReq.status + \" occurred when trying to upload your file.<br />\";        }      };    }, false);  </script> ```   ### Dealing with large files  You can upload large files on api.video with <a href='https://docs.api.video/reference/post_videos-videoid-source'>Progressive Upload</a>. Alternatively, if you want to use regular upload, we have created a <a href='https://api.video/blog/tutorials/uploading-large-files-with-javascript'>tutorial</a> to walk through the steps required.
    * Upload with an upload token
    * @param token The unique identifier for the token you want to use to upload a video.
    * @param file The path to the video you want to upload.
@@ -792,7 +792,7 @@ export default class VideosApi {
     return new UploadProgressiveSession<Video>(this.httpClient);
   }
   /**
-   * To upload a video to the videoId you created. Replace {videoId} with the id you'd like to use, {access_token} with your token, and /path/to/video.mp4 with the path to the video you'd like to upload. You can only upload your video to the videoId once.\\nWe offer 2 types of upload: * Regular uploads * Progressive uploads The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to * (1) allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload) * (2) allow to send a video source \"progressively\", i.e., before before knowing the total size of the video.\\nOnce all chunks have been sent, they are reaggregated to one source file. The video source is considered as \"completely sent\" when the \"last\" chunk is sent (i.e., the chunk that \"completes\" the upload). ```bash curl https://ws.api.video/videos/{videoId}/source \\   -H 'Authorization: Bearer {access_token}' \\   -F file=@/path/to/video.mp4    ``` Tutorials using [video upload](https://api.video/blog/endpoints/video-upload).
+   * To upload a video to the videoId you created. Replace {videoId} with the id you'd like to use, {access_token} with your token, and /path/to/video.mp4 with the path to the video you'd like to upload. You can only upload your video to the videoId once. We offer 2 types of upload:  * Regular upload  * Progressive upload The latter allows you to split a video source into X chunks and send those chunks independently (concurrently or sequentially). The 2 main goals for our users are to   * allow the upload of video sources > 200 MiB (200 MiB = the max. allowed file size for regular upload)   * allow to send a video source \"progressively\", i.e., before before knowing the total size of the video.   Once all chunks have been sent, they are reaggregated to one source file. The video source is considered as \"completely sent\" when the \"last\" chunk is sent (i.e., the chunk that \"completes\" the upload). ```bash curl https://ws.api.video/videos/{videoId}/source \\   -H 'Authorization: Bearer {access_token}' \\   -F file=@/path/to/video.mp4    ``` Tutorials using [video upload](https://api.video/blog/endpoints/video-upload).
    * Upload a video
    * @param videoId Enter the videoId you want to use to upload your video.
    * @param file The path to the video you would like to upload. The path must be local. If you want to use a video from an online source, you must use the \\\&quot;/videos\\\&quot; endpoint and add the \\\&quot;source\\\&quot; parameter when you create a new video.
diff --git a/src/model/PlayerTheme.ts b/src/model/PlayerTheme.ts
@@ -13,6 +13,10 @@ import AttributeType from './AttributeType';
 import PlayerThemeAssets from './PlayerThemeAssets';
 
 export default class PlayerTheme {
+  /**
+   * The name of the player theme
+   */
+  'name'?: string;
   /**
    * RGBA color for timer text. Default: rgba(255, 255, 255, 1)
    */
@@ -87,6 +91,12 @@ export default class PlayerTheme {
   static readonly discriminator?: string = undefined;
 
   static readonly attributeTypeMap: Array<AttributeType> = [
+    {
+      name: 'name',
+      baseName: 'name',
+      type: 'string',
+      format: '',
+    },
     {
       name: 'text',
       baseName: 'text',
diff --git a/src/model/PlayerThemeCreationPayload.ts b/src/model/PlayerThemeCreationPayload.ts
@@ -12,6 +12,10 @@
 import AttributeType from './AttributeType';
 
 export default class PlayerThemeCreationPayload {
+  /**
+   * Add a name for your player theme here.
+   */
+  'name'?: string;
   /**
    * RGBA color for timer text. Default: rgba(255, 255, 255, 1)
    */
@@ -72,6 +76,12 @@ export default class PlayerThemeCreationPayload {
   static readonly discriminator?: string = undefined;
 
   static readonly attributeTypeMap: Array<AttributeType> = [
+    {
+      name: 'name',
+      baseName: 'name',
+      type: 'string',
+      format: '',
+    },
     {
       name: 'text',
       baseName: 'text',
diff --git a/src/model/PlayerThemeUpdatePayload.ts b/src/model/PlayerThemeUpdatePayload.ts
@@ -12,6 +12,10 @@
 import AttributeType from './AttributeType';
 
 export default class PlayerThemeUpdatePayload {
+  /**
+   * Add a name for your player theme here.
+   */
+  'name'?: string;
   /**
    * RGBA color for timer text. Default: rgba(255, 255, 255, 1)
    */
@@ -72,6 +76,12 @@ export default class PlayerThemeUpdatePayload {
   static readonly discriminator?: string = undefined;
 
   static readonly attributeTypeMap: Array<AttributeType> = [
+    {
+      name: 'name',
+      baseName: 'name',
+      type: 'string',
+      format: '',
+    },
     {
       name: 'text',
       baseName: 'text',
diff --git a/test/sandbox.spec.ts b/test/sandbox.spec.ts
@@ -224,13 +224,15 @@ describe('ApiVideoClient', () => {
     // Delete video resource
     await client.videos.delete(videoId);
 
-    // Create a player theme with default values
-    const { playerId } = await client.playerThemes.create();
-    expect(playerId).to.be.a('string');
+    // Create a player theme with a custom name
+    const playerThemeName = 'my player theme';
+    const theme = await client.playerThemes.create({ name: playerThemeName });
+    expect(theme.playerId).to.be.a('string');
 
     // Get a playerTheme
-    await client.playerThemes.get(playerId).then((playerTheme) => {
-      expect(playerId).to.equals(playerTheme.playerId);
+    await client.playerThemes.get(theme.playerId).then((playerTheme) => {
+      expect(theme.playerId).to.equals(playerTheme.playerId);
+      expect(playerThemeName).to.equals(playerTheme.name);
     });
 
     // Search a player theme with paginate results
@@ -256,7 +258,7 @@ describe('ApiVideoClient', () => {
     };
 
     await client.playerThemes
-      .update(playerId, properties)
+      .update(theme.playerId, properties)
       .then((playerTheme) => {
         Object.keys(properties).forEach((property) => {
           // @ts-ignore
@@ -265,12 +267,12 @@ describe('ApiVideoClient', () => {
       });
 
     await client.playerThemes
-      .uploadLogo(playerId, 'test/data/test.jpg', 'https://api.video')
+      .uploadLogo(theme.playerId, 'test/data/test.jpg', 'https://api.video')
       .then((playerTheme) =>
         expect(playerTheme.assets?.link).to.equals('https://api.video')
       );
 
-    await client.playerThemes.delete(playerId);
+    await client.playerThemes.delete(theme.playerId);
 
     // Create a live
     const name = 'This is a live';

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@api.video/nodejs-client",`
`3`		`- "version": "2.0.14",`
	`3`	`+ "version": "2.1.0",`
`4`	`4`	`"description": "api.video nodejs client",`
`5`	`5`	`"author": "api.video ecosystem team",`
`6`	`6`	`"repository": {`