Merge pull request #121 from apivideo/sort-params-in-analytics

Add sort parameters in analytics routes
apivideo · Sep 5, 2024 · 9aa0d85 · 9aa0d85
2 parents 79ae94c + 6dcab26
commit 9aa0d85
Show file tree

Hide file tree

Showing 152 changed files with 1,304 additions and 567 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.
 
+## [1.4.1] - 2024-09-05
+- Add sort parameters in analytics endpoints
+
 ## [1.4.0] - 2024-07-29
 - Add new analytics methods
 - Add livestream complete() method

diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>video.api</groupId>
   <artifactId>java-api-client</artifactId>
-  <version>1.4.0</version>
+  <version>1.4.1</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -78,7 +78,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-implementation "video.api:java-api-client:1.4.0"
+implementation "video.api:java-api-client:1.4.1"
 ```
 
 #### Others
@@ -91,7 +91,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/java-api-client-1.4.0.jar`
+* `target/java-api-client-1.4.1.jar`
 * `target/lib/*.jar`
 
 ### Code sample

diff --git a/api/openapi.yaml b/api/openapi.yaml
diff --git a/build.gradle b/build.gradle
@@ -4,7 +4,7 @@ apply plugin: 'com.diffplug.spotless'
 apply plugin: 'maven-publish'
 
 group = 'video.api'
-version = '1.4.0'
+version = '1.4.1'
 
 buildscript {
     repositories {

diff --git a/docs/AccessToken.md b/docs/AccessToken.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AdditionalBadRequestErrors.md b/docs/AdditionalBadRequestErrors.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsAggregatedMetricsResponse.md b/docs/AnalyticsAggregatedMetricsResponse.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsAggregatedMetricsResponseContext.md b/docs/AnalyticsAggregatedMetricsResponseContext.md
@@ -39,5 +39,6 @@ SUM | &quot;sum&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md b/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md
@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md
diff --git a/docs/AnalyticsData.md b/docs/AnalyticsData.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsBreakdownResponse.md b/docs/AnalyticsMetricsBreakdownResponse.md
@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsBreakdownResponseContext.md b/docs/AnalyticsMetricsBreakdownResponseContext.md
@@ -40,5 +40,6 @@ BROWSER | &quot;browser&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsBreakdownResponseData.md b/docs/AnalyticsMetricsBreakdownResponseData.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsOverTimeResponse.md b/docs/AnalyticsMetricsOverTimeResponse.md
@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsOverTimeResponseContext.md b/docs/AnalyticsMetricsOverTimeResponseContext.md
@@ -35,5 +35,6 @@ DAY | &quot;day&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsMetricsOverTimeResponseData.md b/docs/AnalyticsMetricsOverTimeResponseData.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsPlays400Error.md b/docs/AnalyticsPlays400Error.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AnalyticsPlaysResponse.md b/docs/AnalyticsPlaysResponse.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/AuthenticatePayload.md b/docs/AuthenticatePayload.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/BadRequest.md b/docs/BadRequest.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/BytesRange.md b/docs/BytesRange.md
@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/Caption.md b/docs/Caption.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/CaptionsListResponse.md b/docs/CaptionsListResponse.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/CaptionsUpdatePayload.md b/docs/CaptionsUpdatePayload.md
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/Chapter.md b/docs/Chapter.md
@@ -14,5 +14,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/ChaptersListResponse.md b/docs/ChaptersListResponse.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/FilterBy.md b/docs/FilterBy.md
@@ -6,13 +6,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
+**mediaId** | **List&lt;String&gt;** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
 **mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) |  |  [optional]
-**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
-**country** | **String** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
-**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
-**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
-**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
+**continent** | [**List&lt;ContinentEnum&gt;**](#List&lt;ContinentEnum&gt;) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
+**country** | **List&lt;String&gt;** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
+**deviceType** | **List&lt;String&gt;** | Returns analytics based on the type of device used by the viewers. Response values can include: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
+**operatingSystem** | **List&lt;String&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
+**browser** | **List&lt;String&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **String** | Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata). |  [optional]
 
 
@@ -26,7 +26,7 @@ LIVE_STREAM | &quot;live-stream&quot;
 
 
 
-## Enum: ContinentEnum
+## Enum: List&lt;ContinentEnum&gt;
 
 Name | Value
 ---- | -----
@@ -42,5 +42,6 @@ AZ | &quot;AZ&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/FilterBy1.md b/docs/FilterBy1.md
@@ -6,13 +6,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
+**mediaId** | **List&lt;String&gt;** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
 **mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) |  |  [optional]
-**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
-**country** | **String** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
-**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
-**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
-**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
+**continent** | [**List&lt;ContinentEnum&gt;**](#List&lt;ContinentEnum&gt;) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
+**country** | **List&lt;String&gt;** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
+**deviceType** | **List&lt;String&gt;** | Returns analytics based on the type of device used by the viewers. Response values can include: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
+**operatingSystem** | **List&lt;String&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
+**browser** | **List&lt;String&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **String** | Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata). |  [optional]
 
 
@@ -26,7 +26,7 @@ LIVE_STREAM | &quot;live-stream&quot;
 
 
 
-## Enum: ContinentEnum
+## Enum: List&lt;ContinentEnum&gt;
 
 Name | Value
 ---- | -----
@@ -42,5 +42,6 @@ AZ | &quot;AZ&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/FilterBy2.md b/docs/FilterBy2.md
@@ -6,13 +6,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**mediaId** | **String** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
+**mediaId** | **List&lt;String&gt;** | Returns analytics based on the unique identifiers of a video or a live stream. |  [optional]
 **mediaType** | [**MediaTypeEnum**](#MediaTypeEnum) |  |  [optional]
-**continent** | [**ContinentEnum**](#ContinentEnum) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
-**country** | **String** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
-**deviceType** | **String** | Returns analytics based on the type of device used by the viewers. Possible response values are: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
-**operatingSystem** | **String** | Returns analytics based on the operating system used by the viewers. Response values include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
-**browser** | **String** | Returns analytics based on the browser used by the viewers. Response values include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
+**continent** | [**List&lt;ContinentEnum&gt;**](#List&lt;ContinentEnum&gt;) | Returns analytics based on the viewers&#39; continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;EU&#x60;. |  [optional]
+**country** | **List&lt;String&gt;** | Returns analytics based on the viewers&#39; country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example &#x60;FR&#x60;. |  [optional]
+**deviceType** | **List&lt;String&gt;** | Returns analytics based on the type of device used by the viewers. Response values can include: &#x60;computer&#x60;, &#x60;phone&#x60;, &#x60;tablet&#x60;, &#x60;tv&#x60;, &#x60;console&#x60;, &#x60;wearable&#x60;, &#x60;unknown&#x60;. |  [optional]
+**operatingSystem** | **List&lt;String&gt;** | Returns analytics based on the operating system used by the viewers. Response values can include &#x60;windows&#x60;, &#x60;mac osx&#x60;, &#x60;android&#x60;, &#x60;ios&#x60;, &#x60;linux&#x60;. |  [optional]
+**browser** | **List&lt;String&gt;** | Returns analytics based on the browser used by the viewers. Response values can include &#x60;chrome&#x60;, &#x60;firefox&#x60;, &#x60;edge&#x60;, &#x60;opera&#x60;. |  [optional]
 **tag** | **String** | Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata). |  [optional]
 
 
@@ -26,7 +26,7 @@ LIVE_STREAM | &quot;live-stream&quot;
 
 
 
-## Enum: ContinentEnum
+## Enum: List&lt;ContinentEnum&gt;
 
 Name | Value
 ---- | -----
@@ -42,5 +42,6 @@ AZ | &quot;AZ&quot;
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/Link.md b/docs/Link.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/LiveStream.md b/docs/LiveStream.md
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/LiveStreamAssets.md b/docs/LiveStreamAssets.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/LiveStreamCreationPayload.md b/docs/LiveStreamCreationPayload.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/LiveStreamListResponse.md b/docs/LiveStreamListResponse.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/LiveStreamUpdatePayload.md b/docs/LiveStreamUpdatePayload.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/Metadata.md b/docs/Metadata.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/Model403ErrorSchema.md b/docs/Model403ErrorSchema.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/NotFound.md b/docs/NotFound.md
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/PaginationLink.md b/docs/PaginationLink.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/PlayerSessionEvent.md b/docs/PlayerSessionEvent.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/PlayerTheme.md b/docs/PlayerTheme.md
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
 
 
diff --git a/docs/PlayerThemeAssets.md b/docs/PlayerThemeAssets.md
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 ## Implemented Interfaces
 
 * Serializable
+* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,5 +15,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,5 +13,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,5 +39,6 @@ SUM \| "sum"
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,5 +14,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,5 +40,6 @@ BROWSER \| "browser"
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,5 +35,6 @@ DAY \| "day"
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,5 +16,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,5 +12,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,5 +21,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,5 +31,6 @@ Name \| Type \| Description \| Notes
		## Implemented Interfaces

		* Serializable
		* DeepObject