Merge pull request #34 from apivideo/date-rage-required-in-analytics

feat(all) Date range param is required in analytics endpoints

Author: bot-api-video

.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256

@@ -1 +1 @@
-fa7ac2451c4cf442853cb5c85c8372aa1c7969a3232442adf3109d7346edc5f2
+94990465713a14b6421dfb20f4a7e9ad69bcdc31aa22b7789aa907bbb3144304

ApiVideoClient.podspec

@@ -4,8 +4,8 @@ Pod::Spec.new do |s|
   s.osx.deployment_target = '10.12'
   s.tvos.deployment_target = '10.0'
   s.watchos.deployment_target = '3.0'
-  s.version = '1.0.5'
-  s.source = { :git => 'https://github.com/apivideo/api.video-ios-client', :tag => 'v1.0.5' }
+  s.version = '1.0.6'
+  s.source = { :git => 'https://github.com/apivideo/api.video-ios-client', :tag => 'v1.0.6' }
   s.authors = { 'Ecosystem Team' => 'ecosystem@api.video' }
   s.license = { :type => 'MIT' }
   s.homepage = 'https://docs.api.video'

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.6] - 2022-09-13
+- period parameter is now mandatory in analytics endpoints
+
 ## [1.0.5] - 2022-06-30
 - Add SDK origin header
 

README.md

@@ -42,14 +42,14 @@ api.video's iOS  streamlines the coding process. Chunking files is handled for y
 Specify it in your `Cartfile`:
 
 ```
-github "apivideo/api.video-ios-client" ~> 1.0.5
+github "apivideo/api.video-ios-client" ~> 1.0.6
 ```
 
 Run `carthage update`
 
 ### CocoaPods
 
-Add `pod 'ApiVideoClient', '1.0.5'` in your `Podfile`
+Add `pod 'ApiVideoClient', '1.0.6'` in your `Podfile`
 
 Run `pod install`
 

Sources/APIs.swift

@@ -13,7 +13,7 @@ enum ApiVideoClientError: Error {
 public class ApiVideoClient {
     public static var apiKey: String? = nil
     public static var basePath = "https://ws.api.video"
-    internal static var customHeaders:[String: String] = ["AV-Origin-Client": "ios:1.0.5"]
+    internal static var customHeaders:[String: String] = ["AV-Origin-Client": "ios:1.0.6"]
     private static var chunkSize: Int = 50 * 1024 * 1024
     internal static var requestBuilderFactory: RequestBuilderFactory = AlamofireRequestBuilderFactory()
     internal static var credential = ApiVideoCredential()

Sources/APIs/AuthenticationAPI.swift

@@ -13,7 +13,7 @@ import AnyCodable
 open class AuthenticationAPI {
 
     /**
-     Authenticate
+     Advanced - Authenticate (1/2)
 
      - parameter authenticatePayload: (body)  
      - parameter apiResponseQueue: The queue on which api response is dispatched.
@@ -33,7 +33,7 @@ open class AuthenticationAPI {
 
 
     /**
-     Authenticate
+     Advanced - Authenticate (1/2)
      - POST /auth/api-key
      - To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds). A refresh token is also returned. View a [tutorial](https://api.video/blog/tutorials/authentication-tutorial) on authentication. All tutorials using the [authentication endpoint](https://api.video/blog/endpoints/authenticate)
      - parameter authenticatePayload: (body)  
@@ -59,7 +59,7 @@ open class AuthenticationAPI {
 
 
     /**
-     Refresh token
+     Advanced - Refresh token (2/2)
 
      - parameter refreshTokenPayload: (body)  
      - parameter apiResponseQueue: The queue on which api response is dispatched.
@@ -79,7 +79,7 @@ open class AuthenticationAPI {
 
 
     /**
-     Refresh token
+     Advanced - Refresh token (2/2)
      - POST /auth/refresh
      - Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint. Send the refresh token in the body of your request. The api.video API returns a new access token that is valid for one hour (3600 seconds) and a new refresh token.  
      - parameter refreshTokenPayload: (body)  

Sources/APIs/RawStatisticsAPI.swift

@@ -16,14 +16,14 @@ open class RawStatisticsAPI {
      List live stream player sessions
 
      - parameter liveStreamId: (path) The unique identifier for the live stream you want to retrieve analytics for. 
-     - parameter period: (query) Period must have one of the following formats:  - For a day : \"2018-01-01\", - For a week: \"2018-W01\",  - For a month: \"2018-01\" - For a year: \"2018\" For a range period:  -  Date range: \"2018-01-01/2018-01-15\"  (optional)
+     - parameter period: (query) Period must have one of the following formats:  - For a day : \"2018-01-01\", - For a week: \"2018-W01\",  - For a month: \"2018-01\" - For a year: \"2018\" For a range period:  -  Date range: \"2018-01-01/2018-01-15\"  
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
      - parameter apiResponseQueue: The queue on which api response is dispatched.
      - parameter completion: completion handler to receive the data and the error objects.
      */
     @discardableResult
-    open class func listLiveStreamSessions(liveStreamId: String, period: String? = nil, currentPage: Int? = nil, pageSize: Int? = nil, apiResponseQueue: DispatchQueue = ApiVideoClient.apiResponseQueue, completion: @escaping ((_ data: RawStatisticsListLiveStreamAnalyticsResponse?, _ error: Error?) -> Void)) -> URLSessionTask? {
+    open class func listLiveStreamSessions(liveStreamId: String, period: String, currentPage: Int? = nil, pageSize: Int? = nil, apiResponseQueue: DispatchQueue = ApiVideoClient.apiResponseQueue, completion: @escaping ((_ data: RawStatisticsListLiveStreamAnalyticsResponse?, _ error: Error?) -> Void)) -> URLSessionTask? {
             return listLiveStreamSessionsWithRequestBuilder(liveStreamId: liveStreamId, period: period, currentPage: currentPage, pageSize: pageSize).execute(apiResponseQueue) { result in
                 switch result {
                 case let .success(response):
@@ -39,12 +39,12 @@ open class RawStatisticsAPI {
      List live stream player sessions
      - GET /analytics/live-streams/{liveStreamId}
      - parameter liveStreamId: (path) The unique identifier for the live stream you want to retrieve analytics for. 
-     - parameter period: (query) Period must have one of the following formats:  - For a day : \"2018-01-01\", - For a week: \"2018-W01\",  - For a month: \"2018-01\" - For a year: \"2018\" For a range period:  -  Date range: \"2018-01-01/2018-01-15\"  (optional)
+     - parameter period: (query) Period must have one of the following formats:  - For a day : \"2018-01-01\", - For a week: \"2018-W01\",  - For a month: \"2018-01\" - For a year: \"2018\" For a range period:  -  Date range: \"2018-01-01/2018-01-15\"  
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
      - returns: RequestBuilder<RawStatisticsListLiveStreamAnalyticsResponse> 
      */
-    open class func listLiveStreamSessionsWithRequestBuilder(liveStreamId: String, period: String? = nil, currentPage: Int? = nil, pageSize: Int? = nil) -> RequestBuilder<RawStatisticsListLiveStreamAnalyticsResponse> {
+    open class func listLiveStreamSessionsWithRequestBuilder(liveStreamId: String, period: String, currentPage: Int? = nil, pageSize: Int? = nil) -> RequestBuilder<RawStatisticsListLiveStreamAnalyticsResponse> {
         var localVariablePath = "/analytics/live-streams/{liveStreamId}"
         let liveStreamIdPreEscape = "\(APIHelper.mapValueToPathItem(liveStreamId))"
         let liveStreamIdPostEscape = liveStreamIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
@@ -54,7 +54,7 @@ open class RawStatisticsAPI {
 
         var localVariableUrlComponents = URLComponents(string: localVariableURLString)
         localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
-            "period": period?.encodeToJSON(),
+            "period": period.encodeToJSON(),
             "currentPage": currentPage?.encodeToJSON(),
             "pageSize": pageSize?.encodeToJSON(),
         ])
@@ -132,15 +132,15 @@ open class RawStatisticsAPI {
      List video player sessions
 
      - parameter videoId: (path) The unique identifier for the video you want to retrieve session information for. 
-     - parameter period: (query) Period must have one of the following formats:  - For a day : 2018-01-01, - For a week: 2018-W01,  - For a month: 2018-01 - For a year: 2018 For a range period:  -  Date range: 2018-01-01/2018-01-15  (optional)
+     - parameter period: (query) Period must have one of the following formats:  - For a day : 2018-01-01, - For a week: 2018-W01,  - For a month: 2018-01 - For a year: 2018 For a range period:  -  Date range: 2018-01-01/2018-01-15  
      - parameter metadata: (query) Metadata and [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) filter. Send an array of key value pairs you want to filter sessios with. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
      - parameter apiResponseQueue: The queue on which api response is dispatched.
      - parameter completion: completion handler to receive the data and the error objects.
      */
     @discardableResult
-    open class func listVideoSessions(videoId: String, period: String? = nil, metadata: [String: String]? = nil, currentPage: Int? = nil, pageSize: Int? = nil, apiResponseQueue: DispatchQueue = ApiVideoClient.apiResponseQueue, completion: @escaping ((_ data: RawStatisticsListSessionsResponse?, _ error: Error?) -> Void)) -> URLSessionTask? {
+    open class func listVideoSessions(videoId: String, period: String, metadata: [String: String]? = nil, currentPage: Int? = nil, pageSize: Int? = nil, apiResponseQueue: DispatchQueue = ApiVideoClient.apiResponseQueue, completion: @escaping ((_ data: RawStatisticsListSessionsResponse?, _ error: Error?) -> Void)) -> URLSessionTask? {
             return listVideoSessionsWithRequestBuilder(videoId: videoId, period: period, metadata: metadata, currentPage: currentPage, pageSize: pageSize).execute(apiResponseQueue) { result in
                 switch result {
                 case let .success(response):
@@ -157,13 +157,13 @@ open class RawStatisticsAPI {
      - GET /analytics/videos/{videoId}
      - Retrieve all available user sessions for a specific video. Tutorials that use the [analytics endpoint](https://api.video/blog/endpoints/analytics).
      - parameter videoId: (path) The unique identifier for the video you want to retrieve session information for. 
-     - parameter period: (query) Period must have one of the following formats:  - For a day : 2018-01-01, - For a week: 2018-W01,  - For a month: 2018-01 - For a year: 2018 For a range period:  -  Date range: 2018-01-01/2018-01-15  (optional)
+     - parameter period: (query) Period must have one of the following formats:  - For a day : 2018-01-01, - For a week: 2018-W01,  - For a month: 2018-01 - For a year: 2018 For a range period:  -  Date range: 2018-01-01/2018-01-15  
      - parameter metadata: (query) Metadata and [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) filter. Send an array of key value pairs you want to filter sessios with. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
      - returns: RequestBuilder<RawStatisticsListSessionsResponse> 
      */
-    open class func listVideoSessionsWithRequestBuilder(videoId: String, period: String? = nil, metadata: [String: String]? = nil, currentPage: Int? = nil, pageSize: Int? = nil) -> RequestBuilder<RawStatisticsListSessionsResponse> {
+    open class func listVideoSessionsWithRequestBuilder(videoId: String, period: String, metadata: [String: String]? = nil, currentPage: Int? = nil, pageSize: Int? = nil) -> RequestBuilder<RawStatisticsListSessionsResponse> {
         var localVariablePath = "/analytics/videos/{videoId}"
         let videoIdPreEscape = "\(APIHelper.mapValueToPathItem(videoId))"
         let videoIdPostEscape = videoIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
@@ -173,7 +173,7 @@ open class RawStatisticsAPI {
 
         var localVariableUrlComponents = URLComponents(string: localVariableURLString)
         localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
-            "period": period?.encodeToJSON(),
+            "period": period.encodeToJSON(),
             "metadata": metadata?.encodeToJSON(),
             "currentPage": currentPage?.encodeToJSON(),
             "pageSize": pageSize?.encodeToJSON(),

docs/AuthenticationAPI.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://ws.api.video*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**authenticate**](AuthenticationAPI.md#postauthapikey) | **POST** /auth/api-key | Authenticate
-[**refresh**](AuthenticationAPI.md#postauthrefresh) | **POST** /auth/refresh | Refresh token
+[**authenticate**](AuthenticationAPI.md#postauthapikey) | **POST** /auth/api-key | Advanced - Authenticate (1/2)
+[**refresh**](AuthenticationAPI.md#postauthrefresh) | **POST** /auth/refresh | Advanced - Refresh token (2/2)
 
 
 # **authenticate**
 ```swift
     open class func authenticate(authenticatePayload: AuthenticatePayload, completion: @escaping (_ data: AccessToken?, _ error: Error?) -> Void)
 ```
 
-Authenticate
+Advanced - Authenticate (1/2)
 
 To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds). A refresh token is also returned. View a [tutorial](https://api.video/blog/tutorials/authentication-tutorial) on authentication. All tutorials using the [authentication endpoint](https://api.video/blog/endpoints/authenticate)
 
@@ -25,7 +25,7 @@ import ApiVideoClient
 
 let authenticatePayload = authenticate-payload(apiKey: "apiKey_example") // AuthenticatePayload | 
 
-// Authenticate
+// Advanced - Authenticate (1/2)
 AuthenticationAPI.authenticate(authenticatePayload: authenticatePayload) { (response, error) in
     guard error == nil else {
         print(error)
@@ -64,7 +64,7 @@ No authorization required
     open class func refresh(refreshTokenPayload: RefreshTokenPayload, completion: @escaping (_ data: AccessToken?, _ error: Error?) -> Void)
 ```
 
-Refresh token
+Advanced - Refresh token (2/2)
 
 Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint. Send the refresh token in the body of your request. The api.video API returns a new access token that is valid for one hour (3600 seconds) and a new refresh token.  
 
@@ -76,7 +76,7 @@ import ApiVideoClient
 
 let refreshTokenPayload = refresh-token-payload(refreshToken: "refreshToken_example") // RefreshTokenPayload | 
 
-// Refresh token
+// Advanced - Refresh token (2/2)
 AuthenticationAPI.refresh(refreshTokenPayload: refreshTokenPayload) { (response, error) in
     guard error == nil else {
         print(error)