Merge pull request #215 from apivideo/update-video-status-endpoint-de…

…scription Update VideoStatusIngest enum descriptions
apivideo · Feb 19, 2024 · b5b12cd · b5b12cd
2 parents 35430c3 + 677d377
commit b5b12cd
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 6 deletions.
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.5.6] - 2024-02-19
+- Update VideoStatusIngest enum
+
 ## [2.5.5] - 2023-12-19
 - Fix documentation links
 

diff --git a/docs/model/VideoStatusIngest.md b/docs/model/VideoStatusIngest.md
@@ -6,7 +6,7 @@ Details about the capturing, transferring, and storing of your video for use imm
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | [**VideoStatusIngestStatusEnum**](#VideoStatusIngestStatusEnum) | There are three possible ingest statuses. missing - you are missing information required to ingest the video. uploading - the video is in the process of being uploaded. uploaded - the video is ready for use. |  [optional]
+**status** | [**VideoStatusIngestStatusEnum**](#VideoStatusIngestStatusEnum) | There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. - &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. - &#x60;ingested&#x60; - the video file is fully stored.  |  [optional]
 **filesize** | **number** | The size of your file in bytes. |  [optional]
 **receivedBytes** | [**Array&lt;BytesRange&gt;**](BytesRange.md) | The total number of bytes received, listed for each chunk of the upload. |  [optional]
 **receivedParts** | [**VideoStatusIngestReceivedParts**](VideoStatusIngestReceivedParts.md) |  |  [optional]
@@ -17,9 +17,10 @@ Name | Type | Description | Notes
 
 Name | Value
 ---- | -----
-Missing | &#39;missing&#39;
 Uploading | &#39;uploading&#39;
 Uploaded | &#39;uploaded&#39;
+Ingesting | &#39;ingesting&#39;
+Ingested | &#39;ingested&#39;
 
 
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@api.video/nodejs-client",
-  "version": "2.5.5",
+  "version": "2.5.6",
   "description": "api.video nodejs API client",
    "keywords": [
     "api.video",

diff --git a/src/HttpClient.ts b/src/HttpClient.ts
@@ -44,7 +44,7 @@ export default class HttpClient {
     this.chunkSize = params.chunkSize;
     this.headers = new AxiosHeaders({
       Accept: 'application/json, */*;q=0.8',
-      'AV-Origin-Client': 'nodejs:2.5.5',
+      'AV-Origin-Client': 'nodejs:2.5.6',
       Authorization: this.apiKey ? `Basic ${encode(`${this.apiKey}:`)}` : '',
       ...(params.applicationName && params.applicationVersion
         ? {

diff --git a/src/model/VideoStatusIngest.ts b/src/model/VideoStatusIngest.ts
@@ -18,7 +18,7 @@ import VideoStatusIngestReceivedParts from './VideoStatusIngestReceivedParts.js'
  */
 export default class VideoStatusIngest {
   /**
-   * There are three possible ingest statuses. missing - you are missing information required to ingest the video. uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.
+   * There are four possible statuses depending on how you provide a video file: - `uploading` - the API is gathering the video source file from an upload. - `uploaded` - the video file is fully uploaded. - `ingesting` - the API is gathering the video source file from either a URL, or from cloning. - `ingested` - the video file is fully stored.
    */
   'status'?: VideoStatusIngestStatusEnum;
   /**
@@ -65,4 +65,8 @@ export default class VideoStatusIngest {
   }
 }
 
-export type VideoStatusIngestStatusEnum = 'missing' | 'uploading' | 'uploaded';
+export type VideoStatusIngestStatusEnum =
+  | 'uploading'
+  | 'uploaded'
+  | 'ingesting'
+  | 'ingested';