Skip to content

Commit

Permalink
Update VideoStatusIngest enum descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierapivideo authored Feb 19, 2024
1 parent 35430c3 commit 677d377
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/model/VideoStatusIngest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: - `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. | [optional]
**filesize** | **number** | The size of your file in bytes. | [optional]
**receivedBytes** | [**Array<BytesRange>**](BytesRange.md) | The total number of bytes received, listed for each chunk of the upload. | [optional]
**receivedParts** | [**VideoStatusIngestReceivedParts**](VideoStatusIngestReceivedParts.md) | | [optional]
Expand All @@ -17,9 +17,10 @@ Name | Type | Description | Notes

Name | Value
---- | -----
Missing | 'missing'
Uploading | 'uploading'
Uploaded | 'uploaded'
Ingesting | 'ingesting'
Ingested | 'ingested'



2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/HttpClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
? {
Expand Down
8 changes: 6 additions & 2 deletions src/model/VideoStatusIngest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down Expand Up @@ -65,4 +65,8 @@ export default class VideoStatusIngest {
}
}

export type VideoStatusIngestStatusEnum = 'missing' | 'uploading' | 'uploaded';
export type VideoStatusIngestStatusEnum =
| 'uploading'
| 'uploaded'
| 'ingesting'
| 'ingested';

0 comments on commit 677d377

Please sign in to comment.