From 57a94bf84ceb46a824a3c2441710bf3127623386 Mon Sep 17 00:00:00 2001 From: olivierapivideo Date: Tue, 4 Jun 2024 14:49:54 +0000 Subject: [PATCH] [DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec --- README.md | 27 ++++--- docs/api/AnalyticsApi.md | 12 ++++ .../AnalyticsAggregatedMetricsResponse.md | 13 ++++ ...alyticsAggregatedMetricsResponseContext.md | 38 ++++++++++ ...gregatedMetricsResponseContextTimeframe.md | 13 ++++ .../AnalyticsMetricsBreakdownResponse.md | 13 ++++ ...nalyticsMetricsBreakdownResponseContext.md | 39 ++++++++++ .../AnalyticsMetricsBreakdownResponseData.md | 12 ++++ .../model/AnalyticsMetricsOverTimeResponse.md | 13 ++++ ...AnalyticsMetricsOverTimeResponseContext.md | 34 +++++++++ .../AnalyticsMetricsOverTimeResponseData.md | 12 ++++ docs/model/LiveStreamSession.md | 16 ----- docs/model/LiveStreamSessionClient.md | 14 ---- docs/model/LiveStreamSessionDevice.md | 14 ---- docs/model/LiveStreamSessionLocation.md | 13 ---- docs/model/LiveStreamSessionReferrer.md | 14 ---- docs/model/LiveStreamSessionSession.md | 13 ---- docs/model/UnrecognizedRequestUrl.md | 13 ++++ docs/model/VideoSession.md | 16 ----- docs/model/VideoSessionClient.md | 14 ---- docs/model/VideoSessionDevice.md | 14 ---- docs/model/VideoSessionLocation.md | 13 ---- docs/model/VideoSessionOs.md | 14 ---- docs/model/VideoSessionReferrer.md | 14 ---- docs/model/VideoSessionSession.md | 14 ---- src/ObjectSerializer.ts | 56 ++++++++------- src/api/AnalyticsApi.ts | 8 +-- ... => AnalyticsAggregatedMetricsResponse.ts} | 44 +++++------- ...alyticsAggregatedMetricsResponseContext.ts | 66 +++++++++++++++++ ...regatedMetricsResponseContextTimeframe.ts} | 33 ++++----- .../AnalyticsMetricsBreakdownResponse.ts | 51 +++++++++++++ ...nalyticsMetricsBreakdownResponseContext.ts | 67 +++++++++++++++++ ... AnalyticsMetricsBreakdownResponseData.ts} | 27 ++++--- src/model/AnalyticsMetricsOverTimeResponse.ts | 51 +++++++++++++ ...AnalyticsMetricsOverTimeResponseContext.ts | 62 ++++++++++++++++ ...> AnalyticsMetricsOverTimeResponseData.ts} | 37 ++++------ src/model/LiveStreamSession.ts | 72 ------------------- src/model/LiveStreamSessionClient.ts | 57 --------------- src/model/LiveStreamSessionLocation.ts | 47 ------------ src/model/LiveStreamSessionReferrer.ts | 64 ----------------- ...ionDevice.ts => UnrecognizedRequestUrl.ts} | 27 ++++--- src/model/VideoSession.ts | 72 ------------------- src/model/VideoSessionClient.ts | 57 --------------- src/model/VideoSessionReferrer.ts | 64 ----------------- src/model/VideoSessionSession.ts | 65 ----------------- 45 files changed, 621 insertions(+), 828 deletions(-) create mode 100644 docs/model/AnalyticsAggregatedMetricsResponse.md create mode 100644 docs/model/AnalyticsAggregatedMetricsResponseContext.md create mode 100644 docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md create mode 100644 docs/model/AnalyticsMetricsBreakdownResponse.md create mode 100644 docs/model/AnalyticsMetricsBreakdownResponseContext.md create mode 100644 docs/model/AnalyticsMetricsBreakdownResponseData.md create mode 100644 docs/model/AnalyticsMetricsOverTimeResponse.md create mode 100644 docs/model/AnalyticsMetricsOverTimeResponseContext.md create mode 100644 docs/model/AnalyticsMetricsOverTimeResponseData.md delete mode 100644 docs/model/LiveStreamSession.md delete mode 100644 docs/model/LiveStreamSessionClient.md delete mode 100644 docs/model/LiveStreamSessionDevice.md delete mode 100644 docs/model/LiveStreamSessionLocation.md delete mode 100644 docs/model/LiveStreamSessionReferrer.md delete mode 100644 docs/model/LiveStreamSessionSession.md create mode 100644 docs/model/UnrecognizedRequestUrl.md delete mode 100644 docs/model/VideoSession.md delete mode 100644 docs/model/VideoSessionClient.md delete mode 100644 docs/model/VideoSessionDevice.md delete mode 100644 docs/model/VideoSessionLocation.md delete mode 100644 docs/model/VideoSessionOs.md delete mode 100644 docs/model/VideoSessionReferrer.md delete mode 100644 docs/model/VideoSessionSession.md rename src/model/{VideoSessionOs.ts => AnalyticsAggregatedMetricsResponse.ts} (51%) create mode 100644 src/model/AnalyticsAggregatedMetricsResponseContext.ts rename src/model/{LiveStreamSessionSession.ts => AnalyticsAggregatedMetricsResponseContextTimeframe.ts} (53%) create mode 100644 src/model/AnalyticsMetricsBreakdownResponse.ts create mode 100644 src/model/AnalyticsMetricsBreakdownResponseContext.ts rename src/model/{VideoSessionLocation.ts => AnalyticsMetricsBreakdownResponseData.ts} (54%) create mode 100644 src/model/AnalyticsMetricsOverTimeResponse.ts create mode 100644 src/model/AnalyticsMetricsOverTimeResponseContext.ts rename src/model/{LiveStreamSessionDevice.ts => AnalyticsMetricsOverTimeResponseData.ts} (51%) delete mode 100644 src/model/LiveStreamSession.ts delete mode 100644 src/model/LiveStreamSessionClient.ts delete mode 100644 src/model/LiveStreamSessionLocation.ts delete mode 100644 src/model/LiveStreamSessionReferrer.ts rename src/model/{VideoSessionDevice.ts => UnrecognizedRequestUrl.ts} (63%) delete mode 100644 src/model/VideoSession.ts delete mode 100644 src/model/VideoSessionClient.ts delete mode 100644 src/model/VideoSessionReferrer.ts delete mode 100644 src/model/VideoSessionSession.ts diff --git a/README.md b/README.md index 4f291a0..23e0a79 100644 --- a/README.md +++ b/README.md @@ -108,8 +108,8 @@ const ApiVideoClient = require('@api.video/nodejs-client'); Method | Description | HTTP request ------------- | ------------- | ------------- -[**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays -[**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays +**(deprecated)** [**getLiveStreamsPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays +**(deprecated)** [**getVideosPlays()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays #### CaptionsApi @@ -209,7 +209,16 @@ Method | Description | HTTP request - [AccessToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AccessToken.md) - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AdditionalBadRequestErrors.md) + - [AnalyticsAggregatedMetricsResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponse.md) + - [AnalyticsAggregatedMetricsResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContext.md) + - [AnalyticsAggregatedMetricsResponseContextTimeframe](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md) - [AnalyticsData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsData.md) + - [AnalyticsMetricsBreakdownResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponse.md) + - [AnalyticsMetricsBreakdownResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseContext.md) + - [AnalyticsMetricsBreakdownResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsBreakdownResponseData.md) + - [AnalyticsMetricsOverTimeResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponse.md) + - [AnalyticsMetricsOverTimeResponseContext](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseContext.md) + - [AnalyticsMetricsOverTimeResponseData](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsMetricsOverTimeResponseData.md) - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlays400Error.md) - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AnalyticsPlaysResponse.md) - [AuthenticatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/AuthenticatePayload.md) @@ -225,12 +234,6 @@ Method | Description | HTTP request - [LiveStreamAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamAssets.md) - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamCreationPayload.md) - [LiveStreamListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamSessionSession.md) - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/LiveStreamUpdatePayload.md) - [Metadata](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Metadata.md) - [Model403ErrorSchema](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Model403ErrorSchema.md) @@ -250,18 +253,12 @@ Method | Description | HTTP request - [TokenCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenCreationPayload.md) - [TokenListResponse](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TokenListResponse.md) - [TooManyRequests](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/TooManyRequests.md) + - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UnrecognizedRequestUrl.md) - [UploadToken](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/UploadToken.md) - [Video](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/Video.md) - [VideoAssets](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoAssets.md) - [VideoClip](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoClip.md) - [VideoCreationPayload](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSessionSession.md) - [VideoSource](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSource.md) - [VideoSourceLiveStream](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStream.md) - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/model/VideoSourceLiveStreamLink.md) diff --git a/docs/api/AnalyticsApi.md b/docs/api/AnalyticsApi.md index 25bad22..a060d9a 100644 --- a/docs/api/AnalyticsApi.md +++ b/docs/api/AnalyticsApi.md @@ -14,6 +14,12 @@ All URIs are relative to *https://ws.api.video* Retrieve filtered analytics about the number of plays for your live streams in a project. + + +This endpoint will be deprecated with the release of Analytics v2.0. + + + ### Parameters | Name | Type | Required | Description | @@ -41,6 +47,12 @@ Promise<[**AnalyticsPlaysResponse**](../model/AnalyticsPlaysResponse.md)>. Retrieve filtered analytics about the number of plays for your videos in a project. + + +This endpoint will be deprecated with the release of Analytics v2.0. + + + ### Parameters | Name | Type | Required | Description | diff --git a/docs/model/AnalyticsAggregatedMetricsResponse.md b/docs/model/AnalyticsAggregatedMetricsResponse.md new file mode 100644 index 0000000..445a1f0 --- /dev/null +++ b/docs/model/AnalyticsAggregatedMetricsResponse.md @@ -0,0 +1,13 @@ + +# AnalyticsAggregatedMetricsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**AnalyticsAggregatedMetricsResponseContext**](AnalyticsAggregatedMetricsResponseContext.md) | | +**data** | **Array<number>** | | +**pagination** | [**Pagination**](Pagination.md) | | + + + diff --git a/docs/model/AnalyticsAggregatedMetricsResponseContext.md b/docs/model/AnalyticsAggregatedMetricsResponseContext.md new file mode 100644 index 0000000..f674467 --- /dev/null +++ b/docs/model/AnalyticsAggregatedMetricsResponseContext.md @@ -0,0 +1,38 @@ + +# AnalyticsAggregatedMetricsResponseContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | [**AnalyticsAggregatedMetricsResponseContextMetricEnum**](#AnalyticsAggregatedMetricsResponseContextMetricEnum) | Returns the metric you selected. | [optional] +**aggregation** | [**AnalyticsAggregatedMetricsResponseContextAggregationEnum**](#AnalyticsAggregatedMetricsResponseContextAggregationEnum) | Returns the aggregation you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + + + +## Enum: AnalyticsAggregatedMetricsResponseContextMetricEnum + +Name | Value +---- | ----- +Play | 'play' +Start | 'start' +End | 'end' +Impression | 'impression' +ImpressionTime | 'impression-time' +WatchTime | 'watch-time' + + + +## Enum: AnalyticsAggregatedMetricsResponseContextAggregationEnum + +Name | Value +---- | ----- +Count | 'count' +Rate | 'rate' +Total | 'total' +Average | 'average' +Sum | 'sum' + + + diff --git a/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md b/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md new file mode 100644 index 0000000..3682e42 --- /dev/null +++ b/docs/model/AnalyticsAggregatedMetricsResponseContextTimeframe.md @@ -0,0 +1,13 @@ + +# AnalyticsAggregatedMetricsResponseContextTimeframe + +Returns the starting and ending date-times of the period you want analytics for. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **Date** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [optional] +**to** | **Date** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [optional] + + + diff --git a/docs/model/AnalyticsMetricsBreakdownResponse.md b/docs/model/AnalyticsMetricsBreakdownResponse.md new file mode 100644 index 0000000..6543742 --- /dev/null +++ b/docs/model/AnalyticsMetricsBreakdownResponse.md @@ -0,0 +1,13 @@ + +# AnalyticsMetricsBreakdownResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**AnalyticsMetricsBreakdownResponseContext**](AnalyticsMetricsBreakdownResponseContext.md) | | +**data** | [**Array<AnalyticsMetricsBreakdownResponseData>**](AnalyticsMetricsBreakdownResponseData.md) | Returns an array of dimensions and their respective metrics. | +**pagination** | [**Pagination**](Pagination.md) | | + + + diff --git a/docs/model/AnalyticsMetricsBreakdownResponseContext.md b/docs/model/AnalyticsMetricsBreakdownResponseContext.md new file mode 100644 index 0000000..f3b0e50 --- /dev/null +++ b/docs/model/AnalyticsMetricsBreakdownResponseContext.md @@ -0,0 +1,39 @@ + +# AnalyticsMetricsBreakdownResponseContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | [**AnalyticsMetricsBreakdownResponseContextMetricEnum**](#AnalyticsMetricsBreakdownResponseContextMetricEnum) | Returns the metric you selected. | [optional] +**breakdown** | [**AnalyticsMetricsBreakdownResponseContextBreakdownEnum**](#AnalyticsMetricsBreakdownResponseContextBreakdownEnum) | Returns the dimension you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + + + +## Enum: AnalyticsMetricsBreakdownResponseContextMetricEnum + +Name | Value +---- | ----- +Play | 'play' +PlayRate | 'play-rate' +Start | 'start' +End | 'end' +Impression | 'impression' + + + +## Enum: AnalyticsMetricsBreakdownResponseContextBreakdownEnum + +Name | Value +---- | ----- +MediaId | 'media-id' +MediaType | 'media-type' +Continent | 'continent' +Country | 'country' +DeviceType | 'device-type' +OperatingSystem | 'operating-system' +Browser | 'browser' + + + diff --git a/docs/model/AnalyticsMetricsBreakdownResponseData.md b/docs/model/AnalyticsMetricsBreakdownResponseData.md new file mode 100644 index 0000000..ff381e6 --- /dev/null +++ b/docs/model/AnalyticsMetricsBreakdownResponseData.md @@ -0,0 +1,12 @@ + +# AnalyticsMetricsBreakdownResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimensionValue** | **string** | Returns a specific value for the dimension you selected, based on the data. For example if you select `continent` as a dimension, then `dimensionValue` returns values like `EU` or \"AZ\". | [optional] +**metricValue** | **number** | Returns the data for a specific dimension value. | [optional] + + + diff --git a/docs/model/AnalyticsMetricsOverTimeResponse.md b/docs/model/AnalyticsMetricsOverTimeResponse.md new file mode 100644 index 0000000..083b163 --- /dev/null +++ b/docs/model/AnalyticsMetricsOverTimeResponse.md @@ -0,0 +1,13 @@ + +# AnalyticsMetricsOverTimeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) | | +**data** | [**Array<AnalyticsMetricsOverTimeResponseData>**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | +**pagination** | [**Pagination**](Pagination.md) | | + + + diff --git a/docs/model/AnalyticsMetricsOverTimeResponseContext.md b/docs/model/AnalyticsMetricsOverTimeResponseContext.md new file mode 100644 index 0000000..d3775b6 --- /dev/null +++ b/docs/model/AnalyticsMetricsOverTimeResponseContext.md @@ -0,0 +1,34 @@ + +# AnalyticsMetricsOverTimeResponseContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | [**AnalyticsMetricsOverTimeResponseContextMetricEnum**](#AnalyticsMetricsOverTimeResponseContextMetricEnum) | Returns the metric you selected. | [optional] +**interval** | [**AnalyticsMetricsOverTimeResponseContextIntervalEnum**](#AnalyticsMetricsOverTimeResponseContextIntervalEnum) | Returns the interval you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + + + +## Enum: AnalyticsMetricsOverTimeResponseContextMetricEnum + +Name | Value +---- | ----- +Play | 'play' +PlayRate | 'play-rate' +Start | 'start' +End | 'end' +Impression | 'impression' + + + +## Enum: AnalyticsMetricsOverTimeResponseContextIntervalEnum + +Name | Value +---- | ----- +Hour | 'hour' +Day | 'day' + + + diff --git a/docs/model/AnalyticsMetricsOverTimeResponseData.md b/docs/model/AnalyticsMetricsOverTimeResponseData.md new file mode 100644 index 0000000..1a6712c --- /dev/null +++ b/docs/model/AnalyticsMetricsOverTimeResponseData.md @@ -0,0 +1,12 @@ + +# AnalyticsMetricsOverTimeResponseData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**emittedAt** | **string** | Returns the timestamp of the event that belongs to a specific metric in ATOM date-time format. For example, if you set `play` with an `hour` interval in your request, then `emittedAt` returns the hourly timestamps of every play event within the timeframe you defined. | [optional] +**metricValue** | **number** | Returns the data for a specific metric value. | [optional] + + + diff --git a/docs/model/LiveStreamSession.md b/docs/model/LiveStreamSession.md deleted file mode 100644 index 52d25a6..0000000 --- a/docs/model/LiveStreamSession.md +++ /dev/null @@ -1,16 +0,0 @@ - -# LiveStreamSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**session** | [**LiveStreamSessionSession**](LiveStreamSessionSession.md) | | [optional] -**location** | [**LiveStreamSessionLocation**](LiveStreamSessionLocation.md) | | [optional] -**referrer** | [**LiveStreamSessionReferrer**](LiveStreamSessionReferrer.md) | | [optional] -**device** | [**LiveStreamSessionDevice**](LiveStreamSessionDevice.md) | | [optional] -**os** | [**VideoSessionOs**](VideoSessionOs.md) | | [optional] -**client** | [**LiveStreamSessionClient**](LiveStreamSessionClient.md) | | [optional] - - - diff --git a/docs/model/LiveStreamSessionClient.md b/docs/model/LiveStreamSessionClient.md deleted file mode 100644 index 012d4f4..0000000 --- a/docs/model/LiveStreamSessionClient.md +++ /dev/null @@ -1,14 +0,0 @@ - -# LiveStreamSessionClient - -What kind of browser the viewer is using for the live stream session. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **string** | The name of the browser used to view the live stream session. | [optional] -**version** | **string** | The version of the browser used to view the live stream session. | [optional] -**type** | **string** | The type of client used to view the live stream session. | [optional] - - - diff --git a/docs/model/LiveStreamSessionDevice.md b/docs/model/LiveStreamSessionDevice.md deleted file mode 100644 index e288e62..0000000 --- a/docs/model/LiveStreamSessionDevice.md +++ /dev/null @@ -1,14 +0,0 @@ - -# LiveStreamSessionDevice - -What type of device the user is on when in the live stream session. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **string** | What the type is like desktop, laptop, mobile. | [optional] -**vendor** | **string** | If known, what the brand of the device is, like Apple, Dell, etc. | [optional] -**model** | **string** | The specific model of the device, if known. | [optional] - - - diff --git a/docs/model/LiveStreamSessionLocation.md b/docs/model/LiveStreamSessionLocation.md deleted file mode 100644 index 01fa46e..0000000 --- a/docs/model/LiveStreamSessionLocation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# LiveStreamSessionLocation - -The location of the viewer of the live stream. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **string** | The country of the viewer of the live stream. | [optional] -**city** | **string** | The city of the viewer of the live stream. | [optional] - - - diff --git a/docs/model/LiveStreamSessionReferrer.md b/docs/model/LiveStreamSessionReferrer.md deleted file mode 100644 index 4173b81..0000000 --- a/docs/model/LiveStreamSessionReferrer.md +++ /dev/null @@ -1,14 +0,0 @@ - -# LiveStreamSessionReferrer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | The website the viewer of the live stream was referred to in order to view the live stream. | [optional] -**medium** | **string** | The type of search that brought the viewer to the live stream. Organic would be they found it on their own, paid would be they found it via an advertisement. | [optional] -**source** | **string** | Where the viewer came from to see the live stream (usually where they searched from). | [optional] -**searchTerm** | **string** | What term they searched for that led them to the live stream. | [optional] - - - diff --git a/docs/model/LiveStreamSessionSession.md b/docs/model/LiveStreamSessionSession.md deleted file mode 100644 index 50032b7..0000000 --- a/docs/model/LiveStreamSessionSession.md +++ /dev/null @@ -1,13 +0,0 @@ - -# LiveStreamSessionSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sessionId** | **string** | A unique identifier for your session. You can use this to track what happens during a specific session. | [optional] -**loadedAt** | **Date** | When the session started, with the date and time presented in ISO-8601 format. | [optional] -**endedAt** | **Date** | When the session ended, with the date and time presented in ISO-8601 format. | [optional] - - - diff --git a/docs/model/UnrecognizedRequestUrl.md b/docs/model/UnrecognizedRequestUrl.md new file mode 100644 index 0000000..b44c75c --- /dev/null +++ b/docs/model/UnrecognizedRequestUrl.md @@ -0,0 +1,13 @@ + +# UnrecognizedRequestUrl + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | A link to the error documentation. | [optional] +**title** | **string** | A description of the error that occurred. | [optional] +**status** | **number** | The HTTP status code. | [optional] + + + diff --git a/docs/model/VideoSession.md b/docs/model/VideoSession.md deleted file mode 100644 index 2ee8027..0000000 --- a/docs/model/VideoSession.md +++ /dev/null @@ -1,16 +0,0 @@ - -# VideoSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**session** | [**VideoSessionSession**](VideoSessionSession.md) | | [optional] -**location** | [**VideoSessionLocation**](VideoSessionLocation.md) | | [optional] -**referrer** | [**VideoSessionReferrer**](VideoSessionReferrer.md) | | [optional] -**device** | [**VideoSessionDevice**](VideoSessionDevice.md) | | [optional] -**os** | [**VideoSessionOs**](VideoSessionOs.md) | | [optional] -**client** | [**VideoSessionClient**](VideoSessionClient.md) | | [optional] - - - diff --git a/docs/model/VideoSessionClient.md b/docs/model/VideoSessionClient.md deleted file mode 100644 index f68b762..0000000 --- a/docs/model/VideoSessionClient.md +++ /dev/null @@ -1,14 +0,0 @@ - -# VideoSessionClient - -What kind of browser the viewer is using for the video session. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **string** | The name of the browser used to view the video session. | [optional] -**version** | **string** | The version of the browser used to view the video session. | [optional] -**type** | **string** | The type of client used to view the video session. | [optional] - - - diff --git a/docs/model/VideoSessionDevice.md b/docs/model/VideoSessionDevice.md deleted file mode 100644 index ede79b1..0000000 --- a/docs/model/VideoSessionDevice.md +++ /dev/null @@ -1,14 +0,0 @@ - -# VideoSessionDevice - -What type of device the user is on when in the video session. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **string** | What the type is like desktop, laptop, mobile. | [optional] -**vendor** | **string** | If known, what the brand of the device is, like Apple, Dell, etc. | [optional] -**model** | **string** | The specific model of the device, if known. | [optional] - - - diff --git a/docs/model/VideoSessionLocation.md b/docs/model/VideoSessionLocation.md deleted file mode 100644 index c8b411b..0000000 --- a/docs/model/VideoSessionLocation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# VideoSessionLocation - -The location of the viewer. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **string** | The country of the viewer. | [optional] -**city** | **string** | The city of the viewer. | [optional] - - - diff --git a/docs/model/VideoSessionOs.md b/docs/model/VideoSessionOs.md deleted file mode 100644 index 640df9e..0000000 --- a/docs/model/VideoSessionOs.md +++ /dev/null @@ -1,14 +0,0 @@ - -# VideoSessionOs - -The operating system the viewer is on. -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **string** | The name of the operating system. | [optional] -**shortname** | **string** | The nickname for the operating system, often representing the version. | [optional] -**version** | **string** | The version of the operating system. | [optional] - - - diff --git a/docs/model/VideoSessionReferrer.md b/docs/model/VideoSessionReferrer.md deleted file mode 100644 index 7d39a8d..0000000 --- a/docs/model/VideoSessionReferrer.md +++ /dev/null @@ -1,14 +0,0 @@ - -# VideoSessionReferrer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | The link the viewer used to reach the video session. | [optional] -**medium** | **string** | How they arrived at the site, for example organic or paid. Organic meaning they found it themselves and paid meaning they followed a link from an advertisement. | [optional] -**source** | **string** | The source the referrer came from to the video session. For example if they searched through google to find the stream. | [optional] -**searchTerm** | **string** | The search term they typed to arrive at the video session. | [optional] - - - diff --git a/docs/model/VideoSessionSession.md b/docs/model/VideoSessionSession.md deleted file mode 100644 index ac947ac..0000000 --- a/docs/model/VideoSessionSession.md +++ /dev/null @@ -1,14 +0,0 @@ - -# VideoSessionSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sessionId** | **string** | The unique identifier for the session that you can use to track what happens during it. | [optional] -**loadedAt** | **Date** | When the video session started, presented in ISO-8601 format. | [optional] -**endedAt** | **Date** | When the video session ended, presented in ISO-8601 format. | [optional] -**metadata** | [**Array<Metadata>**](Metadata.md) | A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. You can also just use the pairs as another way to tag and categorize your videos. | [optional] - - - diff --git a/src/ObjectSerializer.ts b/src/ObjectSerializer.ts index 3ce5832..fc1a0ba 100644 --- a/src/ObjectSerializer.ts +++ b/src/ObjectSerializer.ts @@ -12,7 +12,16 @@ import AccessToken from './model/AccessToken'; import AdditionalBadRequestErrors from './model/AdditionalBadRequestErrors'; +import AnalyticsAggregatedMetricsResponse from './model/AnalyticsAggregatedMetricsResponse'; +import AnalyticsAggregatedMetricsResponseContext from './model/AnalyticsAggregatedMetricsResponseContext'; +import AnalyticsAggregatedMetricsResponseContextTimeframe from './model/AnalyticsAggregatedMetricsResponseContextTimeframe'; import AnalyticsData from './model/AnalyticsData'; +import AnalyticsMetricsBreakdownResponse from './model/AnalyticsMetricsBreakdownResponse'; +import AnalyticsMetricsBreakdownResponseContext from './model/AnalyticsMetricsBreakdownResponseContext'; +import AnalyticsMetricsBreakdownResponseData from './model/AnalyticsMetricsBreakdownResponseData'; +import AnalyticsMetricsOverTimeResponse from './model/AnalyticsMetricsOverTimeResponse'; +import AnalyticsMetricsOverTimeResponseContext from './model/AnalyticsMetricsOverTimeResponseContext'; +import AnalyticsMetricsOverTimeResponseData from './model/AnalyticsMetricsOverTimeResponseData'; import AnalyticsPlays400Error from './model/AnalyticsPlays400Error'; import AnalyticsPlaysResponse from './model/AnalyticsPlaysResponse'; import AuthenticatePayload from './model/AuthenticatePayload'; @@ -28,12 +37,6 @@ import LiveStream from './model/LiveStream'; import LiveStreamAssets from './model/LiveStreamAssets'; import LiveStreamCreationPayload from './model/LiveStreamCreationPayload'; import LiveStreamListResponse from './model/LiveStreamListResponse'; -import LiveStreamSession from './model/LiveStreamSession'; -import LiveStreamSessionClient from './model/LiveStreamSessionClient'; -import LiveStreamSessionDevice from './model/LiveStreamSessionDevice'; -import LiveStreamSessionLocation from './model/LiveStreamSessionLocation'; -import LiveStreamSessionReferrer from './model/LiveStreamSessionReferrer'; -import LiveStreamSessionSession from './model/LiveStreamSessionSession'; import LiveStreamUpdatePayload from './model/LiveStreamUpdatePayload'; import Metadata from './model/Metadata'; import Model403ErrorSchema from './model/Model403ErrorSchema'; @@ -53,18 +56,12 @@ import RestreamsResponseObject from './model/RestreamsResponseObject'; import TokenCreationPayload from './model/TokenCreationPayload'; import TokenListResponse from './model/TokenListResponse'; import TooManyRequests from './model/TooManyRequests'; +import UnrecognizedRequestUrl from './model/UnrecognizedRequestUrl'; import UploadToken from './model/UploadToken'; import Video from './model/Video'; import VideoAssets from './model/VideoAssets'; import VideoClip from './model/VideoClip'; import VideoCreationPayload from './model/VideoCreationPayload'; -import VideoSession from './model/VideoSession'; -import VideoSessionClient from './model/VideoSessionClient'; -import VideoSessionDevice from './model/VideoSessionDevice'; -import VideoSessionLocation from './model/VideoSessionLocation'; -import VideoSessionOs from './model/VideoSessionOs'; -import VideoSessionReferrer from './model/VideoSessionReferrer'; -import VideoSessionSession from './model/VideoSessionSession'; import VideoSource from './model/VideoSource'; import VideoSourceLiveStream from './model/VideoSourceLiveStream'; import VideoSourceLiveStreamLink from './model/VideoSourceLiveStreamLink'; @@ -101,6 +98,12 @@ const supportedMediaTypes: { [mediaType: string]: number } = { }; const enumsMap: Set = new Set([ + 'AnalyticsAggregatedMetricsResponseContextMetricEnum', + 'AnalyticsAggregatedMetricsResponseContextAggregationEnum', + 'AnalyticsMetricsBreakdownResponseContextMetricEnum', + 'AnalyticsMetricsBreakdownResponseContextBreakdownEnum', + 'AnalyticsMetricsOverTimeResponseContextMetricEnum', + 'AnalyticsMetricsOverTimeResponseContextIntervalEnum', 'QualityTypeEnum', 'QualityQualityEnum', 'QualityStatusEnum', @@ -110,7 +113,20 @@ const enumsMap: Set = new Set([ const typeMap: { [index: string]: any } = { AccessToken: AccessToken, AdditionalBadRequestErrors: AdditionalBadRequestErrors, + AnalyticsAggregatedMetricsResponse: AnalyticsAggregatedMetricsResponse, + AnalyticsAggregatedMetricsResponseContext: + AnalyticsAggregatedMetricsResponseContext, + AnalyticsAggregatedMetricsResponseContextTimeframe: + AnalyticsAggregatedMetricsResponseContextTimeframe, AnalyticsData: AnalyticsData, + AnalyticsMetricsBreakdownResponse: AnalyticsMetricsBreakdownResponse, + AnalyticsMetricsBreakdownResponseContext: + AnalyticsMetricsBreakdownResponseContext, + AnalyticsMetricsBreakdownResponseData: AnalyticsMetricsBreakdownResponseData, + AnalyticsMetricsOverTimeResponse: AnalyticsMetricsOverTimeResponse, + AnalyticsMetricsOverTimeResponseContext: + AnalyticsMetricsOverTimeResponseContext, + AnalyticsMetricsOverTimeResponseData: AnalyticsMetricsOverTimeResponseData, AnalyticsPlays400Error: AnalyticsPlays400Error, AnalyticsPlaysResponse: AnalyticsPlaysResponse, AuthenticatePayload: AuthenticatePayload, @@ -126,12 +142,6 @@ const typeMap: { [index: string]: any } = { LiveStreamAssets: LiveStreamAssets, LiveStreamCreationPayload: LiveStreamCreationPayload, LiveStreamListResponse: LiveStreamListResponse, - LiveStreamSession: LiveStreamSession, - LiveStreamSessionClient: LiveStreamSessionClient, - LiveStreamSessionDevice: LiveStreamSessionDevice, - LiveStreamSessionLocation: LiveStreamSessionLocation, - LiveStreamSessionReferrer: LiveStreamSessionReferrer, - LiveStreamSessionSession: LiveStreamSessionSession, LiveStreamUpdatePayload: LiveStreamUpdatePayload, Metadata: Metadata, Model403ErrorSchema: Model403ErrorSchema, @@ -151,18 +161,12 @@ const typeMap: { [index: string]: any } = { TokenCreationPayload: TokenCreationPayload, TokenListResponse: TokenListResponse, TooManyRequests: TooManyRequests, + UnrecognizedRequestUrl: UnrecognizedRequestUrl, UploadToken: UploadToken, Video: Video, VideoAssets: VideoAssets, VideoClip: VideoClip, VideoCreationPayload: VideoCreationPayload, - VideoSession: VideoSession, - VideoSessionClient: VideoSessionClient, - VideoSessionDevice: VideoSessionDevice, - VideoSessionLocation: VideoSessionLocation, - VideoSessionOs: VideoSessionOs, - VideoSessionReferrer: VideoSessionReferrer, - VideoSessionSession: VideoSessionSession, VideoSource: VideoSource, VideoSourceLiveStream: VideoSourceLiveStream, VideoSourceLiveStreamLink: VideoSourceLiveStreamLink, diff --git a/src/api/AnalyticsApi.ts b/src/api/AnalyticsApi.ts index 903c825..a1a5293 100644 --- a/src/api/AnalyticsApi.ts +++ b/src/api/AnalyticsApi.ts @@ -25,7 +25,7 @@ export default class AnalyticsApi { } /** - * Retrieve filtered analytics about the number of plays for your live streams in a project. + * Retrieve filtered analytics about the number of plays for your live streams in a project. This endpoint will be deprecated with the release of Analytics v2.0. * Get play events for live stream * @param {Object} searchParams * @param { string } searchParams.from Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. @@ -55,7 +55,7 @@ export default class AnalyticsApi { } /** - * Retrieve filtered analytics about the number of plays for your live streams in a project. + * Retrieve filtered analytics about the number of plays for your live streams in a project. This endpoint will be deprecated with the release of Analytics v2.0. * Get play events for live stream * @param {Object} searchParams * @param { string } searchParams.from Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. @@ -165,7 +165,7 @@ export default class AnalyticsApi { } /** - * Retrieve filtered analytics about the number of plays for your videos in a project. + * Retrieve filtered analytics about the number of plays for your videos in a project. This endpoint will be deprecated with the release of Analytics v2.0. * Get play events for video * @param {Object} searchParams * @param { string } searchParams.from Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. @@ -193,7 +193,7 @@ export default class AnalyticsApi { } /** - * Retrieve filtered analytics about the number of plays for your videos in a project. + * Retrieve filtered analytics about the number of plays for your videos in a project. This endpoint will be deprecated with the release of Analytics v2.0. * Get play events for video * @param {Object} searchParams * @param { string } searchParams.from Use this query parameter to set the start date for the time period that you want analytics for. - The API returns analytics data including the day you set in `from`. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. diff --git a/src/model/VideoSessionOs.ts b/src/model/AnalyticsAggregatedMetricsResponse.ts similarity index 51% rename from src/model/VideoSessionOs.ts rename to src/model/AnalyticsAggregatedMetricsResponse.ts index 27e3dc2..b814c9b 100644 --- a/src/model/VideoSessionOs.ts +++ b/src/model/AnalyticsAggregatedMetricsResponse.ts @@ -10,48 +10,38 @@ */ import AttributeType from './AttributeType.js'; +import AnalyticsAggregatedMetricsResponseContext from './AnalyticsAggregatedMetricsResponseContext.js'; +import Pagination from './Pagination.js'; -/** - * The operating system the viewer is on. - */ -export default class VideoSessionOs { - /** - * The name of the operating system. - */ - 'name'?: string; - /** - * The nickname for the operating system, often representing the version. - */ - 'shortname'?: string; - /** - * The version of the operating system. - */ - 'version'?: string; +export default class AnalyticsAggregatedMetricsResponse { + 'context': AnalyticsAggregatedMetricsResponseContext; + 'data': Array; + 'pagination': Pagination; static readonly discriminator?: string = undefined; static readonly attributeTypeMap: Array = [ { - name: 'name', - baseName: 'name', - type: 'string', + name: 'context', + baseName: 'context', + type: 'AnalyticsAggregatedMetricsResponseContext', format: '', }, { - name: 'shortname', - baseName: 'shortname', - type: 'string', - format: '', + name: 'data', + baseName: 'data', + type: 'Array', + format: 'float', }, { - name: 'version', - baseName: 'version', - type: 'string', + name: 'pagination', + baseName: 'pagination', + type: 'Pagination', format: '', }, ]; static getAttributeTypeMap(): Array { - return VideoSessionOs.attributeTypeMap; + return AnalyticsAggregatedMetricsResponse.attributeTypeMap; } } diff --git a/src/model/AnalyticsAggregatedMetricsResponseContext.ts b/src/model/AnalyticsAggregatedMetricsResponseContext.ts new file mode 100644 index 0000000..b02c32d --- /dev/null +++ b/src/model/AnalyticsAggregatedMetricsResponseContext.ts @@ -0,0 +1,66 @@ +/** + * @api.video/nodejs-client + * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. + * + * The version of the OpenAPI document: 1 + * + * + * NOTE: This class is auto generated. + * Do not edit the class manually. + */ + +import AttributeType from './AttributeType.js'; +import AnalyticsAggregatedMetricsResponseContextTimeframe from './AnalyticsAggregatedMetricsResponseContextTimeframe.js'; + +export default class AnalyticsAggregatedMetricsResponseContext { + /** + * Returns the metric you selected. + */ + 'metric'?: AnalyticsAggregatedMetricsResponseContextMetricEnum; + /** + * Returns the aggregation you selected. + */ + 'aggregation'?: AnalyticsAggregatedMetricsResponseContextAggregationEnum; + 'timeframe'?: AnalyticsAggregatedMetricsResponseContextTimeframe; + + static readonly discriminator?: string = undefined; + + static readonly attributeTypeMap: Array = [ + { + name: 'metric', + baseName: 'metric', + type: 'AnalyticsAggregatedMetricsResponseContextMetricEnum', + format: '', + }, + { + name: 'aggregation', + baseName: 'aggregation', + type: 'AnalyticsAggregatedMetricsResponseContextAggregationEnum', + format: '', + }, + { + name: 'timeframe', + baseName: 'timeframe', + type: 'AnalyticsAggregatedMetricsResponseContextTimeframe', + format: '', + }, + ]; + + static getAttributeTypeMap(): Array { + return AnalyticsAggregatedMetricsResponseContext.attributeTypeMap; + } +} + +export type AnalyticsAggregatedMetricsResponseContextMetricEnum = + | 'play' + | 'start' + | 'end' + | 'impression' + | 'impression-time' + | 'watch-time'; +export type AnalyticsAggregatedMetricsResponseContextAggregationEnum = + | 'count' + | 'rate' + | 'total' + | 'average' + | 'sum'; diff --git a/src/model/LiveStreamSessionSession.ts b/src/model/AnalyticsAggregatedMetricsResponseContextTimeframe.ts similarity index 53% rename from src/model/LiveStreamSessionSession.ts rename to src/model/AnalyticsAggregatedMetricsResponseContextTimeframe.ts index ac1c3aa..8677aa3 100644 --- a/src/model/LiveStreamSessionSession.ts +++ b/src/model/AnalyticsAggregatedMetricsResponseContextTimeframe.ts @@ -11,44 +11,37 @@ import AttributeType from './AttributeType.js'; -export default class LiveStreamSessionSession { - /** - * A unique identifier for your session. You can use this to track what happens during a specific session. - */ - 'sessionId'?: string; +/** + * Returns the starting and ending date-times of the period you want analytics for. + */ +export default class AnalyticsAggregatedMetricsResponseContextTimeframe { /** - * When the session started, with the date and time presented in ISO-8601 format. + * Returns the starting date-time of the period you want analytics for in ATOM date-time format. */ - 'loadedAt'?: Date; + 'from'?: Date; /** - * When the session ended, with the date and time presented in ISO-8601 format. + * Returns the starting date-time of the period you want analytics for in ATOM date-time format. */ - 'endedAt'?: Date; + 'to'?: Date; static readonly discriminator?: string = undefined; static readonly attributeTypeMap: Array = [ { - name: 'sessionId', - baseName: 'sessionId', - type: 'string', - format: '', - }, - { - name: 'loadedAt', - baseName: 'loadedAt', + name: 'from', + baseName: 'from', type: 'Date', format: 'date-time', }, { - name: 'endedAt', - baseName: 'endedAt', + name: 'to', + baseName: 'to', type: 'Date', format: 'date-time', }, ]; static getAttributeTypeMap(): Array { - return LiveStreamSessionSession.attributeTypeMap; + return AnalyticsAggregatedMetricsResponseContextTimeframe.attributeTypeMap; } } diff --git a/src/model/AnalyticsMetricsBreakdownResponse.ts b/src/model/AnalyticsMetricsBreakdownResponse.ts new file mode 100644 index 0000000..d21ef6b --- /dev/null +++ b/src/model/AnalyticsMetricsBreakdownResponse.ts @@ -0,0 +1,51 @@ +/** + * @api.video/nodejs-client + * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. + * + * The version of the OpenAPI document: 1 + * + * + * NOTE: This class is auto generated. + * Do not edit the class manually. + */ + +import AttributeType from './AttributeType.js'; +import AnalyticsMetricsBreakdownResponseContext from './AnalyticsMetricsBreakdownResponseContext.js'; +import AnalyticsMetricsBreakdownResponseData from './AnalyticsMetricsBreakdownResponseData.js'; +import Pagination from './Pagination.js'; + +export default class AnalyticsMetricsBreakdownResponse { + 'context': AnalyticsMetricsBreakdownResponseContext; + /** + * Returns an array of dimensions and their respective metrics. + */ + 'data': Array; + 'pagination': Pagination; + + static readonly discriminator?: string = undefined; + + static readonly attributeTypeMap: Array = [ + { + name: 'context', + baseName: 'context', + type: 'AnalyticsMetricsBreakdownResponseContext', + format: '', + }, + { + name: 'data', + baseName: 'data', + type: 'Array', + format: '', + }, + { + name: 'pagination', + baseName: 'pagination', + type: 'Pagination', + format: '', + }, + ]; + + static getAttributeTypeMap(): Array { + return AnalyticsMetricsBreakdownResponse.attributeTypeMap; + } +} diff --git a/src/model/AnalyticsMetricsBreakdownResponseContext.ts b/src/model/AnalyticsMetricsBreakdownResponseContext.ts new file mode 100644 index 0000000..be016a6 --- /dev/null +++ b/src/model/AnalyticsMetricsBreakdownResponseContext.ts @@ -0,0 +1,67 @@ +/** + * @api.video/nodejs-client + * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. + * + * The version of the OpenAPI document: 1 + * + * + * NOTE: This class is auto generated. + * Do not edit the class manually. + */ + +import AttributeType from './AttributeType.js'; +import AnalyticsAggregatedMetricsResponseContextTimeframe from './AnalyticsAggregatedMetricsResponseContextTimeframe.js'; + +export default class AnalyticsMetricsBreakdownResponseContext { + /** + * Returns the metric you selected. + */ + 'metric'?: AnalyticsMetricsBreakdownResponseContextMetricEnum; + /** + * Returns the dimension you selected. + */ + 'breakdown'?: AnalyticsMetricsBreakdownResponseContextBreakdownEnum; + 'timeframe'?: AnalyticsAggregatedMetricsResponseContextTimeframe; + + static readonly discriminator?: string = undefined; + + static readonly attributeTypeMap: Array = [ + { + name: 'metric', + baseName: 'metric', + type: 'AnalyticsMetricsBreakdownResponseContextMetricEnum', + format: '', + }, + { + name: 'breakdown', + baseName: 'breakdown', + type: 'AnalyticsMetricsBreakdownResponseContextBreakdownEnum', + format: '', + }, + { + name: 'timeframe', + baseName: 'timeframe', + type: 'AnalyticsAggregatedMetricsResponseContextTimeframe', + format: '', + }, + ]; + + static getAttributeTypeMap(): Array { + return AnalyticsMetricsBreakdownResponseContext.attributeTypeMap; + } +} + +export type AnalyticsMetricsBreakdownResponseContextMetricEnum = + | 'play' + | 'play-rate' + | 'start' + | 'end' + | 'impression'; +export type AnalyticsMetricsBreakdownResponseContextBreakdownEnum = + | 'media-id' + | 'media-type' + | 'continent' + | 'country' + | 'device-type' + | 'operating-system' + | 'browser'; diff --git a/src/model/VideoSessionLocation.ts b/src/model/AnalyticsMetricsBreakdownResponseData.ts similarity index 54% rename from src/model/VideoSessionLocation.ts rename to src/model/AnalyticsMetricsBreakdownResponseData.ts index b23bab9..88b735e 100644 --- a/src/model/VideoSessionLocation.ts +++ b/src/model/AnalyticsMetricsBreakdownResponseData.ts @@ -11,37 +11,34 @@ import AttributeType from './AttributeType.js'; -/** - * The location of the viewer. - */ -export default class VideoSessionLocation { +export default class AnalyticsMetricsBreakdownResponseData { /** - * The country of the viewer. + * Returns a specific value for the dimension you selected, based on the data. For example if you select `continent` as a dimension, then `dimensionValue` returns values like `EU` or \"AZ\". */ - 'country'?: string; + 'dimensionValue'?: string; /** - * The city of the viewer. + * Returns the data for a specific dimension value. */ - 'city'?: string; + 'metricValue'?: number; static readonly discriminator?: string = undefined; static readonly attributeTypeMap: Array = [ { - name: 'country', - baseName: 'country', + name: 'dimensionValue', + baseName: 'dimensionValue', type: 'string', format: '', }, { - name: 'city', - baseName: 'city', - type: 'string', - format: '', + name: 'metricValue', + baseName: 'metricValue', + type: 'number', + format: 'float', }, ]; static getAttributeTypeMap(): Array { - return VideoSessionLocation.attributeTypeMap; + return AnalyticsMetricsBreakdownResponseData.attributeTypeMap; } } diff --git a/src/model/AnalyticsMetricsOverTimeResponse.ts b/src/model/AnalyticsMetricsOverTimeResponse.ts new file mode 100644 index 0000000..7c11238 --- /dev/null +++ b/src/model/AnalyticsMetricsOverTimeResponse.ts @@ -0,0 +1,51 @@ +/** + * @api.video/nodejs-client + * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. + * + * The version of the OpenAPI document: 1 + * + * + * NOTE: This class is auto generated. + * Do not edit the class manually. + */ + +import AttributeType from './AttributeType.js'; +import AnalyticsMetricsOverTimeResponseContext from './AnalyticsMetricsOverTimeResponseContext.js'; +import AnalyticsMetricsOverTimeResponseData from './AnalyticsMetricsOverTimeResponseData.js'; +import Pagination from './Pagination.js'; + +export default class AnalyticsMetricsOverTimeResponse { + 'context': AnalyticsMetricsOverTimeResponseContext; + /** + * Returns an array of metrics and the timestamps . + */ + 'data': Array; + 'pagination': Pagination; + + static readonly discriminator?: string = undefined; + + static readonly attributeTypeMap: Array = [ + { + name: 'context', + baseName: 'context', + type: 'AnalyticsMetricsOverTimeResponseContext', + format: '', + }, + { + name: 'data', + baseName: 'data', + type: 'Array', + format: '', + }, + { + name: 'pagination', + baseName: 'pagination', + type: 'Pagination', + format: '', + }, + ]; + + static getAttributeTypeMap(): Array { + return AnalyticsMetricsOverTimeResponse.attributeTypeMap; + } +} diff --git a/src/model/AnalyticsMetricsOverTimeResponseContext.ts b/src/model/AnalyticsMetricsOverTimeResponseContext.ts new file mode 100644 index 0000000..0f6af99 --- /dev/null +++ b/src/model/AnalyticsMetricsOverTimeResponseContext.ts @@ -0,0 +1,62 @@ +/** + * @api.video/nodejs-client + * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. + * + * The version of the OpenAPI document: 1 + * + * + * NOTE: This class is auto generated. + * Do not edit the class manually. + */ + +import AttributeType from './AttributeType.js'; +import AnalyticsAggregatedMetricsResponseContextTimeframe from './AnalyticsAggregatedMetricsResponseContextTimeframe.js'; + +export default class AnalyticsMetricsOverTimeResponseContext { + /** + * Returns the metric you selected. + */ + 'metric'?: AnalyticsMetricsOverTimeResponseContextMetricEnum; + /** + * Returns the interval you selected. + */ + 'interval'?: AnalyticsMetricsOverTimeResponseContextIntervalEnum; + 'timeframe'?: AnalyticsAggregatedMetricsResponseContextTimeframe; + + static readonly discriminator?: string = undefined; + + static readonly attributeTypeMap: Array = [ + { + name: 'metric', + baseName: 'metric', + type: 'AnalyticsMetricsOverTimeResponseContextMetricEnum', + format: '', + }, + { + name: 'interval', + baseName: 'interval', + type: 'AnalyticsMetricsOverTimeResponseContextIntervalEnum', + format: '', + }, + { + name: 'timeframe', + baseName: 'timeframe', + type: 'AnalyticsAggregatedMetricsResponseContextTimeframe', + format: '', + }, + ]; + + static getAttributeTypeMap(): Array { + return AnalyticsMetricsOverTimeResponseContext.attributeTypeMap; + } +} + +export type AnalyticsMetricsOverTimeResponseContextMetricEnum = + | 'play' + | 'play-rate' + | 'start' + | 'end' + | 'impression'; +export type AnalyticsMetricsOverTimeResponseContextIntervalEnum = + | 'hour' + | 'day'; diff --git a/src/model/LiveStreamSessionDevice.ts b/src/model/AnalyticsMetricsOverTimeResponseData.ts similarity index 51% rename from src/model/LiveStreamSessionDevice.ts rename to src/model/AnalyticsMetricsOverTimeResponseData.ts index 493ce07..6f3769b 100644 --- a/src/model/LiveStreamSessionDevice.ts +++ b/src/model/AnalyticsMetricsOverTimeResponseData.ts @@ -11,47 +11,34 @@ import AttributeType from './AttributeType.js'; -/** - * What type of device the user is on when in the live stream session. - */ -export default class LiveStreamSessionDevice { +export default class AnalyticsMetricsOverTimeResponseData { /** - * What the type is like desktop, laptop, mobile. + * Returns the timestamp of the event that belongs to a specific metric in ATOM date-time format. For example, if you set `play` with an `hour` interval in your request, then `emittedAt` returns the hourly timestamps of every play event within the timeframe you defined. */ - 'type'?: string; + 'emittedAt'?: string; /** - * If known, what the brand of the device is, like Apple, Dell, etc. + * Returns the data for a specific metric value. */ - 'vendor'?: string; - /** - * The specific model of the device, if known. - */ - 'model'?: string; + 'metricValue'?: number; static readonly discriminator?: string = undefined; static readonly attributeTypeMap: Array = [ { - name: 'type', - baseName: 'type', - type: 'string', - format: '', - }, - { - name: 'vendor', - baseName: 'vendor', + name: 'emittedAt', + baseName: 'emittedAt', type: 'string', format: '', }, { - name: 'model', - baseName: 'model', - type: 'string', - format: '', + name: 'metricValue', + baseName: 'metricValue', + type: 'number', + format: 'float', }, ]; static getAttributeTypeMap(): Array { - return LiveStreamSessionDevice.attributeTypeMap; + return AnalyticsMetricsOverTimeResponseData.attributeTypeMap; } } diff --git a/src/model/LiveStreamSession.ts b/src/model/LiveStreamSession.ts deleted file mode 100644 index 448a558..0000000 --- a/src/model/LiveStreamSession.ts +++ /dev/null @@ -1,72 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; -import LiveStreamSessionClient from './LiveStreamSessionClient.js'; -import LiveStreamSessionDevice from './LiveStreamSessionDevice.js'; -import LiveStreamSessionLocation from './LiveStreamSessionLocation.js'; -import LiveStreamSessionReferrer from './LiveStreamSessionReferrer.js'; -import LiveStreamSessionSession from './LiveStreamSessionSession.js'; -import VideoSessionOs from './VideoSessionOs.js'; - -export default class LiveStreamSession { - 'session'?: LiveStreamSessionSession; - 'location'?: LiveStreamSessionLocation; - 'referrer'?: LiveStreamSessionReferrer; - 'device'?: LiveStreamSessionDevice; - 'os'?: VideoSessionOs; - 'client'?: LiveStreamSessionClient; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'session', - baseName: 'session', - type: 'LiveStreamSessionSession', - format: '', - }, - { - name: 'location', - baseName: 'location', - type: 'LiveStreamSessionLocation', - format: '', - }, - { - name: 'referrer', - baseName: 'referrer', - type: 'LiveStreamSessionReferrer', - format: '', - }, - { - name: 'device', - baseName: 'device', - type: 'LiveStreamSessionDevice', - format: '', - }, - { - name: 'os', - baseName: 'os', - type: 'VideoSessionOs', - format: '', - }, - { - name: 'client', - baseName: 'client', - type: 'LiveStreamSessionClient', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return LiveStreamSession.attributeTypeMap; - } -} diff --git a/src/model/LiveStreamSessionClient.ts b/src/model/LiveStreamSessionClient.ts deleted file mode 100644 index d823ff4..0000000 --- a/src/model/LiveStreamSessionClient.ts +++ /dev/null @@ -1,57 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; - -/** - * What kind of browser the viewer is using for the live stream session. - */ -export default class LiveStreamSessionClient { - /** - * The name of the browser used to view the live stream session. - */ - 'name'?: string; - /** - * The version of the browser used to view the live stream session. - */ - 'version'?: string; - /** - * The type of client used to view the live stream session. - */ - 'type'?: string; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'name', - baseName: 'name', - type: 'string', - format: '', - }, - { - name: 'version', - baseName: 'version', - type: 'string', - format: '', - }, - { - name: 'type', - baseName: 'type', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return LiveStreamSessionClient.attributeTypeMap; - } -} diff --git a/src/model/LiveStreamSessionLocation.ts b/src/model/LiveStreamSessionLocation.ts deleted file mode 100644 index 671122d..0000000 --- a/src/model/LiveStreamSessionLocation.ts +++ /dev/null @@ -1,47 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; - -/** - * The location of the viewer of the live stream. - */ -export default class LiveStreamSessionLocation { - /** - * The country of the viewer of the live stream. - */ - 'country'?: string; - /** - * The city of the viewer of the live stream. - */ - 'city'?: string; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'country', - baseName: 'country', - type: 'string', - format: '', - }, - { - name: 'city', - baseName: 'city', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return LiveStreamSessionLocation.attributeTypeMap; - } -} diff --git a/src/model/LiveStreamSessionReferrer.ts b/src/model/LiveStreamSessionReferrer.ts deleted file mode 100644 index 2da887b..0000000 --- a/src/model/LiveStreamSessionReferrer.ts +++ /dev/null @@ -1,64 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; - -export default class LiveStreamSessionReferrer { - /** - * The website the viewer of the live stream was referred to in order to view the live stream. - */ - 'url'?: string; - /** - * The type of search that brought the viewer to the live stream. Organic would be they found it on their own, paid would be they found it via an advertisement. - */ - 'medium'?: string; - /** - * Where the viewer came from to see the live stream (usually where they searched from). - */ - 'source'?: string; - /** - * What term they searched for that led them to the live stream. - */ - 'searchTerm'?: string; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'url', - baseName: 'url', - type: 'string', - format: '', - }, - { - name: 'medium', - baseName: 'medium', - type: 'string', - format: '', - }, - { - name: 'source', - baseName: 'source', - type: 'string', - format: '', - }, - { - name: 'searchTerm', - baseName: 'searchTerm', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return LiveStreamSessionReferrer.attributeTypeMap; - } -} diff --git a/src/model/VideoSessionDevice.ts b/src/model/UnrecognizedRequestUrl.ts similarity index 63% rename from src/model/VideoSessionDevice.ts rename to src/model/UnrecognizedRequestUrl.ts index 606204e..bc8080e 100644 --- a/src/model/VideoSessionDevice.ts +++ b/src/model/UnrecognizedRequestUrl.ts @@ -11,22 +11,19 @@ import AttributeType from './AttributeType.js'; -/** - * What type of device the user is on when in the video session. - */ -export default class VideoSessionDevice { +export default class UnrecognizedRequestUrl { /** - * What the type is like desktop, laptop, mobile. + * A link to the error documentation. */ 'type'?: string; /** - * If known, what the brand of the device is, like Apple, Dell, etc. + * A description of the error that occurred. */ - 'vendor'?: string; + 'title'?: string; /** - * The specific model of the device, if known. + * The HTTP status code. */ - 'model'?: string; + 'status'?: number; static readonly discriminator?: string = undefined; @@ -38,20 +35,20 @@ export default class VideoSessionDevice { format: '', }, { - name: 'vendor', - baseName: 'vendor', + name: 'title', + baseName: 'title', type: 'string', format: '', }, { - name: 'model', - baseName: 'model', - type: 'string', + name: 'status', + baseName: 'status', + type: 'number', format: '', }, ]; static getAttributeTypeMap(): Array { - return VideoSessionDevice.attributeTypeMap; + return UnrecognizedRequestUrl.attributeTypeMap; } } diff --git a/src/model/VideoSession.ts b/src/model/VideoSession.ts deleted file mode 100644 index c530820..0000000 --- a/src/model/VideoSession.ts +++ /dev/null @@ -1,72 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; -import VideoSessionClient from './VideoSessionClient.js'; -import VideoSessionDevice from './VideoSessionDevice.js'; -import VideoSessionLocation from './VideoSessionLocation.js'; -import VideoSessionOs from './VideoSessionOs.js'; -import VideoSessionReferrer from './VideoSessionReferrer.js'; -import VideoSessionSession from './VideoSessionSession.js'; - -export default class VideoSession { - 'session'?: VideoSessionSession; - 'location'?: VideoSessionLocation; - 'referrer'?: VideoSessionReferrer; - 'device'?: VideoSessionDevice; - 'os'?: VideoSessionOs; - 'client'?: VideoSessionClient; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'session', - baseName: 'session', - type: 'VideoSessionSession', - format: '', - }, - { - name: 'location', - baseName: 'location', - type: 'VideoSessionLocation', - format: '', - }, - { - name: 'referrer', - baseName: 'referrer', - type: 'VideoSessionReferrer', - format: '', - }, - { - name: 'device', - baseName: 'device', - type: 'VideoSessionDevice', - format: '', - }, - { - name: 'os', - baseName: 'os', - type: 'VideoSessionOs', - format: '', - }, - { - name: 'client', - baseName: 'client', - type: 'VideoSessionClient', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return VideoSession.attributeTypeMap; - } -} diff --git a/src/model/VideoSessionClient.ts b/src/model/VideoSessionClient.ts deleted file mode 100644 index c16cdb2..0000000 --- a/src/model/VideoSessionClient.ts +++ /dev/null @@ -1,57 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; - -/** - * What kind of browser the viewer is using for the video session. - */ -export default class VideoSessionClient { - /** - * The name of the browser used to view the video session. - */ - 'name'?: string; - /** - * The version of the browser used to view the video session. - */ - 'version'?: string; - /** - * The type of client used to view the video session. - */ - 'type'?: string; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'name', - baseName: 'name', - type: 'string', - format: '', - }, - { - name: 'version', - baseName: 'version', - type: 'string', - format: '', - }, - { - name: 'type', - baseName: 'type', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return VideoSessionClient.attributeTypeMap; - } -} diff --git a/src/model/VideoSessionReferrer.ts b/src/model/VideoSessionReferrer.ts deleted file mode 100644 index fb107f3..0000000 --- a/src/model/VideoSessionReferrer.ts +++ /dev/null @@ -1,64 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; - -export default class VideoSessionReferrer { - /** - * The link the viewer used to reach the video session. - */ - 'url'?: string; - /** - * How they arrived at the site, for example organic or paid. Organic meaning they found it themselves and paid meaning they followed a link from an advertisement. - */ - 'medium'?: string; - /** - * The source the referrer came from to the video session. For example if they searched through google to find the stream. - */ - 'source'?: string; - /** - * The search term they typed to arrive at the video session. - */ - 'searchTerm'?: string; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'url', - baseName: 'url', - type: 'string', - format: '', - }, - { - name: 'medium', - baseName: 'medium', - type: 'string', - format: '', - }, - { - name: 'source', - baseName: 'source', - type: 'string', - format: '', - }, - { - name: 'searchTerm', - baseName: 'searchTerm', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return VideoSessionReferrer.attributeTypeMap; - } -} diff --git a/src/model/VideoSessionSession.ts b/src/model/VideoSessionSession.ts deleted file mode 100644 index ce3e431..0000000 --- a/src/model/VideoSessionSession.ts +++ /dev/null @@ -1,65 +0,0 @@ -/** - * @api.video/nodejs-client - * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. - * - * The version of the OpenAPI document: 1 - * - * - * NOTE: This class is auto generated. - * Do not edit the class manually. - */ - -import AttributeType from './AttributeType.js'; -import Metadata from './Metadata.js'; - -export default class VideoSessionSession { - /** - * The unique identifier for the session that you can use to track what happens during it. - */ - 'sessionId'?: string; - /** - * When the video session started, presented in ISO-8601 format. - */ - 'loadedAt'?: Date; - /** - * When the video session ended, presented in ISO-8601 format. - */ - 'endedAt'?: Date; - /** - * A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. You can also just use the pairs as another way to tag and categorize your videos. - */ - 'metadata'?: Array; - - static readonly discriminator?: string = undefined; - - static readonly attributeTypeMap: Array = [ - { - name: 'sessionId', - baseName: 'sessionId', - type: 'string', - format: '', - }, - { - name: 'loadedAt', - baseName: 'loadedAt', - type: 'Date', - format: 'date-time', - }, - { - name: 'endedAt', - baseName: 'endedAt', - type: 'Date', - format: 'date-time', - }, - { - name: 'metadata', - baseName: 'metadata', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap(): Array { - return VideoSessionSession.attributeTypeMap; - } -}