From b0780e796c1dfee308ef3ecc8c2861e6d95b0b45 Mon Sep 17 00:00:00 2001 From: olivierapivideo Date: Tue, 4 Jun 2024 14:49:31 +0000 Subject: [PATCH] [DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec --- README.md | 27 ++- apivideo/api/analytics_api.py | 4 +- ... analytics_aggregated_metrics_response.py} | 36 ++-- ...cs_aggregated_metrics_response_context.py} | 45 ++-- ...ted_metrics_response_context_timeframe.py} | 16 +- ...> analytics_metrics_breakdown_response.py} | 38 ++-- ...tics_metrics_breakdown_response_context.py | 192 +++++++++++++++++ ...lytics_metrics_breakdown_response_data.py} | 19 +- ...> analytics_metrics_over_time_response.py} | 41 ++-- ...ics_metrics_over_time_response_context.py} | 40 ++-- ...lytics_metrics_over_time_response_data.py} | 19 +- apivideo/model/live_stream_session.py | 195 ------------------ .../model/live_stream_session_location.py | 168 --------------- ..._device.py => unrecognized_request_url.py} | 18 +- apivideo/model/video_session.py | 195 ------------------ apivideo/model/video_session_os.py | 171 --------------- ... => AnalyticsAggregatedMetricsResponse.md} | 8 +- ...alyticsAggregatedMetricsResponseContext.md | 12 ++ ...gregatedMetricsResponseContextTimeframe.md | 12 ++ docs/AnalyticsApi.md | 4 +- docs/AnalyticsMetricsBreakdownResponse.md | 12 ++ ...nalyticsMetricsBreakdownResponseContext.md | 12 ++ docs/AnalyticsMetricsBreakdownResponseData.md | 11 + docs/AnalyticsMetricsOverTimeResponse.md | 12 ++ ...AnalyticsMetricsOverTimeResponseContext.md | 12 ++ docs/AnalyticsMetricsOverTimeResponseData.md | 11 + docs/LiveStreamSession.md | 15 -- docs/LiveStreamSessionClient.md | 13 -- docs/LiveStreamSessionDevice.md | 13 -- docs/LiveStreamSessionReferrer.md | 13 -- docs/LiveStreamSessionSession.md | 12 -- ...nLocation.md => UnrecognizedRequestUrl.md} | 8 +- docs/VideoSession.md | 15 -- docs/VideoSessionClient.md | 13 -- docs/VideoSessionDevice.md | 13 -- docs/VideoSessionOs.md | 13 -- docs/VideoSessionReferrer.md | 13 -- docs/VideoSessionSession.md | 13 -- 38 files changed, 474 insertions(+), 1010 deletions(-) rename apivideo/model/{live_stream_session_session.py => analytics_aggregated_metrics_response.py} (84%) rename apivideo/model/{video_session_referrer.py => analytics_aggregated_metrics_response_context.py} (81%) rename apivideo/model/{video_session_location.py => analytics_aggregated_metrics_response_context_timeframe.py} (90%) rename apivideo/model/{live_stream_session_device.py => analytics_metrics_breakdown_response.py} (81%) create mode 100644 apivideo/model/analytics_metrics_breakdown_response_context.py rename apivideo/model/{video_session_client.py => analytics_metrics_breakdown_response_data.py} (89%) rename apivideo/model/{live_stream_session_referrer.py => analytics_metrics_over_time_response.py} (81%) rename apivideo/model/{video_session_session.py => analytics_metrics_over_time_response_context.py} (83%) rename apivideo/model/{live_stream_session_client.py => analytics_metrics_over_time_response_data.py} (89%) delete mode 100644 apivideo/model/live_stream_session.py delete mode 100644 apivideo/model/live_stream_session_location.py rename apivideo/model/{video_session_device.py => unrecognized_request_url.py} (91%) delete mode 100644 apivideo/model/video_session.py delete mode 100644 apivideo/model/video_session_os.py rename docs/{VideoSessionLocation.md => AnalyticsAggregatedMetricsResponse.md} (53%) create mode 100644 docs/AnalyticsAggregatedMetricsResponseContext.md create mode 100644 docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md create mode 100644 docs/AnalyticsMetricsBreakdownResponse.md create mode 100644 docs/AnalyticsMetricsBreakdownResponseContext.md create mode 100644 docs/AnalyticsMetricsBreakdownResponseData.md create mode 100644 docs/AnalyticsMetricsOverTimeResponse.md create mode 100644 docs/AnalyticsMetricsOverTimeResponseContext.md create mode 100644 docs/AnalyticsMetricsOverTimeResponseData.md delete mode 100644 docs/LiveStreamSession.md delete mode 100644 docs/LiveStreamSessionClient.md delete mode 100644 docs/LiveStreamSessionDevice.md delete mode 100644 docs/LiveStreamSessionReferrer.md delete mode 100644 docs/LiveStreamSessionSession.md rename docs/{LiveStreamSessionLocation.md => UnrecognizedRequestUrl.md} (56%) delete mode 100644 docs/VideoSession.md delete mode 100644 docs/VideoSessionClient.md delete mode 100644 docs/VideoSessionDevice.md delete mode 100644 docs/VideoSessionOs.md delete mode 100644 docs/VideoSessionReferrer.md delete mode 100644 docs/VideoSessionSession.md diff --git a/README.md b/README.md index 94da7ed..166fd95 100644 --- a/README.md +++ b/README.md @@ -119,8 +119,8 @@ All URIs are relative to *https://ws.api.video* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_live_streams_plays**](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsApi.md#get_live_streams_plays) | **GET** /analytics/live-streams/plays | Get play events for live stream -[**get_videos_plays**](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsApi.md#get_videos_plays) | **GET** /analytics/videos/plays | Get play events for video +**(deprecated)** [**get_live_streams_plays**](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsApi.md#get_live_streams_plays) | **GET** /analytics/live-streams/plays | Get play events for live stream +**(deprecated)** [**get_videos_plays**](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsApi.md#get_videos_plays) | **GET** /analytics/videos/plays | Get play events for video ### CaptionsApi @@ -229,7 +229,16 @@ Method | HTTP request | Description - [AccessToken](https://github.com/apivideo/api.video-python-client/blob/main/docs/AccessToken.md) - [AdditionalBadRequestErrors](https://github.com/apivideo/api.video-python-client/blob/main/docs/AdditionalBadRequestErrors.md) + - [AnalyticsAggregatedMetricsResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsAggregatedMetricsResponse.md) + - [AnalyticsAggregatedMetricsResponseContext](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsAggregatedMetricsResponseContext.md) + - [AnalyticsAggregatedMetricsResponseContextTimeframe](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md) - [AnalyticsData](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsData.md) + - [AnalyticsMetricsBreakdownResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsBreakdownResponse.md) + - [AnalyticsMetricsBreakdownResponseContext](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsBreakdownResponseContext.md) + - [AnalyticsMetricsBreakdownResponseData](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsBreakdownResponseData.md) + - [AnalyticsMetricsOverTimeResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsOverTimeResponse.md) + - [AnalyticsMetricsOverTimeResponseContext](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsOverTimeResponseContext.md) + - [AnalyticsMetricsOverTimeResponseData](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsMetricsOverTimeResponseData.md) - [AnalyticsPlays400Error](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsPlays400Error.md) - [AnalyticsPlaysResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/AnalyticsPlaysResponse.md) - [AuthenticatePayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/AuthenticatePayload.md) @@ -245,12 +254,6 @@ Method | HTTP request | Description - [LiveStreamAssets](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamAssets.md) - [LiveStreamCreationPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamCreationPayload.md) - [LiveStreamListResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamListResponse.md) - - [LiveStreamSession](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSession.md) - - [LiveStreamSessionClient](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSessionClient.md) - - [LiveStreamSessionDevice](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSessionDevice.md) - - [LiveStreamSessionLocation](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSessionLocation.md) - - [LiveStreamSessionReferrer](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSessionReferrer.md) - - [LiveStreamSessionSession](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamSessionSession.md) - [LiveStreamUpdatePayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/LiveStreamUpdatePayload.md) - [Metadata](https://github.com/apivideo/api.video-python-client/blob/main/docs/Metadata.md) - [Model403ErrorSchema](https://github.com/apivideo/api.video-python-client/blob/main/docs/Model403ErrorSchema.md) @@ -270,18 +273,12 @@ Method | HTTP request | Description - [TokenCreationPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenCreationPayload.md) - [TokenListResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenListResponse.md) - [TooManyRequests](https://github.com/apivideo/api.video-python-client/blob/main/docs/TooManyRequests.md) + - [UnrecognizedRequestUrl](https://github.com/apivideo/api.video-python-client/blob/main/docs/UnrecognizedRequestUrl.md) - [UploadToken](https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadToken.md) - [Video](https://github.com/apivideo/api.video-python-client/blob/main/docs/Video.md) - [VideoAssets](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoAssets.md) - [VideoClip](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoClip.md) - [VideoCreationPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoCreationPayload.md) - - [VideoSession](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSession.md) - - [VideoSessionClient](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionClient.md) - - [VideoSessionDevice](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionDevice.md) - - [VideoSessionLocation](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionLocation.md) - - [VideoSessionOs](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionOs.md) - - [VideoSessionReferrer](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionReferrer.md) - - [VideoSessionSession](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSessionSession.md) - [VideoSource](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSource.md) - [VideoSourceLiveStream](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSourceLiveStream.md) - [VideoSourceLiveStreamLink](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoSourceLiveStreamLink.md) diff --git a/apivideo/api/analytics_api.py b/apivideo/api/analytics_api.py index d1eeda8..40b4cf0 100644 --- a/apivideo/api/analytics_api.py +++ b/apivideo/api/analytics_api.py @@ -42,7 +42,7 @@ def get_live_streams_plays( ): """Get play events for live stream # noqa: E501 - Retrieve filtered analytics about the number of plays for your live streams in a project. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -214,7 +214,7 @@ def get_videos_plays( ): """Get play events for video # noqa: E501 - Retrieve filtered analytics about the number of plays for your videos in a project. # noqa: E501 + 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/apivideo/model/live_stream_session_session.py b/apivideo/model/analytics_aggregated_metrics_response.py similarity index 84% rename from apivideo/model/live_stream_session_session.py rename to apivideo/model/analytics_aggregated_metrics_response.py index 1fc6c4c..f188250 100644 --- a/apivideo/model/live_stream_session_session.py +++ b/apivideo/model/analytics_aggregated_metrics_response.py @@ -25,8 +25,14 @@ validate_get_composed_info, ) +def lazy_import(): + from apivideo.model.analytics_aggregated_metrics_response_context import AnalyticsAggregatedMetricsResponseContext + from apivideo.model.pagination import Pagination + globals()['AnalyticsAggregatedMetricsResponseContext'] = AnalyticsAggregatedMetricsResponseContext + globals()['Pagination'] = Pagination -class LiveStreamSessionSession(ModelNormal): + +class AnalyticsAggregatedMetricsResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -70,10 +76,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { - 'session_id': (str,), # noqa: E501 - 'loaded_at': (datetime,), # noqa: E501 - 'ended_at': (datetime,), # noqa: E501 + 'context': (AnalyticsAggregatedMetricsResponseContext,), # noqa: E501 + 'data': ([float],), # noqa: E501 + 'pagination': (Pagination,), # noqa: E501 } @cached_property @@ -82,9 +89,9 @@ def discriminator(): attribute_map = { - 'session_id': 'sessionId', # noqa: E501 - 'loaded_at': 'loadedAt', # noqa: E501 - 'ended_at': 'endedAt', # noqa: E501 + 'context': 'context', # noqa: E501 + 'data': 'data', # noqa: E501 + 'pagination': 'pagination', # noqa: E501 } _composed_schemas = {} @@ -99,8 +106,13 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSessionSession - a model defined in OpenAPI + def __init__(self, context, data, pagination, *args, **kwargs): # noqa: E501 + """AnalyticsAggregatedMetricsResponse - a model defined in OpenAPI + + Args: + context (AnalyticsAggregatedMetricsResponseContext): + data ([float]): + pagination (Pagination): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,9 +145,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - session_id (str): A unique identifier for your session. You can use this to track what happens during a specific session.. [optional] # noqa: E501 - loaded_at (datetime): When the session started, with the date and time presented in ISO-8601 format.. [optional] # noqa: E501 - ended_at (datetime): When the session ended, with the date and time presented in ISO-8601 format.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -161,6 +170,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.context = context + self.data = data + self.pagination = pagination for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/apivideo/model/video_session_referrer.py b/apivideo/model/analytics_aggregated_metrics_response_context.py similarity index 81% rename from apivideo/model/video_session_referrer.py rename to apivideo/model/analytics_aggregated_metrics_response_context.py index bbaaa3f..38e41e8 100644 --- a/apivideo/model/video_session_referrer.py +++ b/apivideo/model/analytics_aggregated_metrics_response_context.py @@ -25,8 +25,12 @@ validate_get_composed_info, ) +def lazy_import(): + from apivideo.model.analytics_aggregated_metrics_response_context_timeframe import AnalyticsAggregatedMetricsResponseContextTimeframe + globals()['AnalyticsAggregatedMetricsResponseContextTimeframe'] = AnalyticsAggregatedMetricsResponseContextTimeframe -class VideoSessionReferrer(ModelNormal): + +class AnalyticsAggregatedMetricsResponseContext(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -51,6 +55,21 @@ class VideoSessionReferrer(ModelNormal): """ allowed_values = { + ('metric',): { + 'PLAY': "play", + 'START': "start", + 'END': "end", + 'IMPRESSION': "impression", + 'IMPRESSION-TIME': "impression-time", + 'WATCH-TIME': "watch-time", + }, + ('aggregation',): { + 'COUNT': "count", + 'RATE': "rate", + 'TOTAL': "total", + 'AVERAGE': "average", + 'SUM': "sum", + }, } validations = { @@ -70,11 +89,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { - 'url': (str, none_type,), # noqa: E501 - 'medium': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - 'search_term': (str,), # noqa: E501 + 'metric': (str,), # noqa: E501 + 'aggregation': (str,), # noqa: E501 + 'timeframe': (AnalyticsAggregatedMetricsResponseContextTimeframe,), # noqa: E501 } @cached_property @@ -83,10 +102,9 @@ def discriminator(): attribute_map = { - 'url': 'url', # noqa: E501 - 'medium': 'medium', # noqa: E501 - 'source': 'source', # noqa: E501 - 'search_term': 'searchTerm', # noqa: E501 + 'metric': 'metric', # noqa: E501 + 'aggregation': 'aggregation', # noqa: E501 + 'timeframe': 'timeframe', # noqa: E501 } _composed_schemas = {} @@ -102,7 +120,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionReferrer - a model defined in OpenAPI + """AnalyticsAggregatedMetricsResponseContext - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -135,10 +153,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - url (str, none_type): The link the viewer used to reach the video session.. [optional] # noqa: E501 - medium (str): 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] # noqa: E501 - source (str): The source the referrer came from to the video session. For example if they searched through google to find the stream.. [optional] # noqa: E501 - search_term (str): The search term they typed to arrive at the video session.. [optional] # noqa: E501 + metric (str): Returns the metric you selected.. [optional] # noqa: E501 + aggregation (str): Returns the aggregation you selected.. [optional] # noqa: E501 + timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/video_session_location.py b/apivideo/model/analytics_aggregated_metrics_response_context_timeframe.py similarity index 90% rename from apivideo/model/video_session_location.py rename to apivideo/model/analytics_aggregated_metrics_response_context_timeframe.py index 3d7ba39..ce6627f 100644 --- a/apivideo/model/video_session_location.py +++ b/apivideo/model/analytics_aggregated_metrics_response_context_timeframe.py @@ -26,7 +26,7 @@ ) -class VideoSessionLocation(ModelNormal): +class AnalyticsAggregatedMetricsResponseContextTimeframe(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -71,8 +71,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'country': (str,), # noqa: E501 - 'city': (str, none_type,), # noqa: E501 + '_from': (datetime,), # noqa: E501 + 'to': (datetime,), # noqa: E501 } @cached_property @@ -81,8 +81,8 @@ def discriminator(): attribute_map = { - 'country': 'country', # noqa: E501 - 'city': 'city', # noqa: E501 + '_from': 'from', # noqa: E501 + 'to': 'to', # noqa: E501 } _composed_schemas = {} @@ -98,7 +98,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionLocation - a model defined in OpenAPI + """AnalyticsAggregatedMetricsResponseContextTimeframe - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -131,8 +131,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - country (str): The country of the viewer.. [optional] # noqa: E501 - city (str, none_type): The city of the viewer.. [optional] # noqa: E501 + _from (datetime): Returns the starting date-time of the period you want analytics for in ATOM date-time format.. [optional] # noqa: E501 + to (datetime): Returns the starting date-time of the period you want analytics for in ATOM date-time format.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/live_stream_session_device.py b/apivideo/model/analytics_metrics_breakdown_response.py similarity index 81% rename from apivideo/model/live_stream_session_device.py rename to apivideo/model/analytics_metrics_breakdown_response.py index 5abfcd5..ec0b3d4 100644 --- a/apivideo/model/live_stream_session_device.py +++ b/apivideo/model/analytics_metrics_breakdown_response.py @@ -25,8 +25,16 @@ validate_get_composed_info, ) +def lazy_import(): + from apivideo.model.analytics_metrics_breakdown_response_context import AnalyticsMetricsBreakdownResponseContext + from apivideo.model.analytics_metrics_breakdown_response_data import AnalyticsMetricsBreakdownResponseData + from apivideo.model.pagination import Pagination + globals()['AnalyticsMetricsBreakdownResponseContext'] = AnalyticsMetricsBreakdownResponseContext + globals()['AnalyticsMetricsBreakdownResponseData'] = AnalyticsMetricsBreakdownResponseData + globals()['Pagination'] = Pagination -class LiveStreamSessionDevice(ModelNormal): + +class AnalyticsMetricsBreakdownResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -70,10 +78,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { - 'type': (str,), # noqa: E501 - 'vendor': (str,), # noqa: E501 - 'model': (str,), # noqa: E501 + 'context': (AnalyticsMetricsBreakdownResponseContext,), # noqa: E501 + 'data': ([AnalyticsMetricsBreakdownResponseData],), # noqa: E501 + 'pagination': (Pagination,), # noqa: E501 } @cached_property @@ -82,9 +91,9 @@ def discriminator(): attribute_map = { - 'type': 'type', # noqa: E501 - 'vendor': 'vendor', # noqa: E501 - 'model': 'model', # noqa: E501 + 'context': 'context', # noqa: E501 + 'data': 'data', # noqa: E501 + 'pagination': 'pagination', # noqa: E501 } _composed_schemas = {} @@ -99,8 +108,13 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSessionDevice - a model defined in OpenAPI + def __init__(self, context, data, pagination, *args, **kwargs): # noqa: E501 + """AnalyticsMetricsBreakdownResponse - a model defined in OpenAPI + + Args: + context (AnalyticsMetricsBreakdownResponseContext): + data ([AnalyticsMetricsBreakdownResponseData]): Returns an array of dimensions and their respective metrics. + pagination (Pagination): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,9 +147,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - type (str): What the type is like desktop, laptop, mobile.. [optional] # noqa: E501 - vendor (str): If known, what the brand of the device is, like Apple, Dell, etc.. [optional] # noqa: E501 - model (str): The specific model of the device, if known.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -161,6 +172,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.context = context + self.data = data + self.pagination = pagination for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/apivideo/model/analytics_metrics_breakdown_response_context.py b/apivideo/model/analytics_metrics_breakdown_response_context.py new file mode 100644 index 0000000..9e0954f --- /dev/null +++ b/apivideo/model/analytics_metrics_breakdown_response_context.py @@ -0,0 +1,192 @@ +""" + api.video + + 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. # noqa: E501 + + Contact: ecosystem@api.video +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apivideo.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, +) + +def lazy_import(): + from apivideo.model.analytics_aggregated_metrics_response_context_timeframe import AnalyticsAggregatedMetricsResponseContextTimeframe + globals()['AnalyticsAggregatedMetricsResponseContextTimeframe'] = AnalyticsAggregatedMetricsResponseContextTimeframe + + +class AnalyticsMetricsBreakdownResponseContext(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('metric',): { + 'PLAY': "play", + 'PLAY-RATE': "play-rate", + 'START': "start", + 'END': "end", + 'IMPRESSION': "impression", + }, + ('breakdown',): { + 'MEDIA-ID': "media-id", + 'MEDIA-TYPE': "media-type", + 'CONTINENT': "continent", + 'COUNTRY': "country", + 'DEVICE-TYPE': "device-type", + 'OPERATING-SYSTEM': "operating-system", + 'BROWSER': "browser", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'metric': (str,), # noqa: E501 + 'breakdown': (str,), # noqa: E501 + 'timeframe': (AnalyticsAggregatedMetricsResponseContextTimeframe,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'metric': 'metric', # noqa: E501 + 'breakdown': 'breakdown', # noqa: E501 + 'timeframe': 'timeframe', # noqa: E501 + } + + _composed_schemas = {} + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AnalyticsMetricsBreakdownResponseContext - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + metric (str): Returns the metric you selected.. [optional] # noqa: E501 + breakdown (str): Returns the dimension you selected.. [optional] # noqa: E501 + timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) diff --git a/apivideo/model/video_session_client.py b/apivideo/model/analytics_metrics_breakdown_response_data.py similarity index 89% rename from apivideo/model/video_session_client.py rename to apivideo/model/analytics_metrics_breakdown_response_data.py index ad22401..bffb808 100644 --- a/apivideo/model/video_session_client.py +++ b/apivideo/model/analytics_metrics_breakdown_response_data.py @@ -26,7 +26,7 @@ ) -class VideoSessionClient(ModelNormal): +class AnalyticsMetricsBreakdownResponseData(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -71,9 +71,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'name': (str,), # noqa: E501 - 'version': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 + 'dimension_value': (str,), # noqa: E501 + 'metric_value': (float,), # noqa: E501 } @cached_property @@ -82,9 +81,8 @@ def discriminator(): attribute_map = { - 'name': 'name', # noqa: E501 - 'version': 'version', # noqa: E501 - 'type': 'type', # noqa: E501 + 'dimension_value': 'dimensionValue', # noqa: E501 + 'metric_value': 'metricValue', # noqa: E501 } _composed_schemas = {} @@ -100,7 +98,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionClient - a model defined in OpenAPI + """AnalyticsMetricsBreakdownResponseData - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,9 +131,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - name (str): The name of the browser used to view the video session.. [optional] # noqa: E501 - version (str): The version of the browser used to view the video session.. [optional] # noqa: E501 - type (str): The type of client used to view the video session.. [optional] # noqa: E501 + dimension_value (str): 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] # noqa: E501 + metric_value (float): Returns the data for a specific dimension value.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/live_stream_session_referrer.py b/apivideo/model/analytics_metrics_over_time_response.py similarity index 81% rename from apivideo/model/live_stream_session_referrer.py rename to apivideo/model/analytics_metrics_over_time_response.py index 3f28517..a0c504f 100644 --- a/apivideo/model/live_stream_session_referrer.py +++ b/apivideo/model/analytics_metrics_over_time_response.py @@ -25,8 +25,16 @@ validate_get_composed_info, ) +def lazy_import(): + from apivideo.model.analytics_metrics_over_time_response_context import AnalyticsMetricsOverTimeResponseContext + from apivideo.model.analytics_metrics_over_time_response_data import AnalyticsMetricsOverTimeResponseData + from apivideo.model.pagination import Pagination + globals()['AnalyticsMetricsOverTimeResponseContext'] = AnalyticsMetricsOverTimeResponseContext + globals()['AnalyticsMetricsOverTimeResponseData'] = AnalyticsMetricsOverTimeResponseData + globals()['Pagination'] = Pagination -class LiveStreamSessionReferrer(ModelNormal): + +class AnalyticsMetricsOverTimeResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -70,11 +78,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { - 'url': (str,), # noqa: E501 - 'medium': (str,), # noqa: E501 - 'source': (str,), # noqa: E501 - 'search_term': (str,), # noqa: E501 + 'context': (AnalyticsMetricsOverTimeResponseContext,), # noqa: E501 + 'data': ([AnalyticsMetricsOverTimeResponseData],), # noqa: E501 + 'pagination': (Pagination,), # noqa: E501 } @cached_property @@ -83,10 +91,9 @@ def discriminator(): attribute_map = { - 'url': 'url', # noqa: E501 - 'medium': 'medium', # noqa: E501 - 'source': 'source', # noqa: E501 - 'search_term': 'searchTerm', # noqa: E501 + 'context': 'context', # noqa: E501 + 'data': 'data', # noqa: E501 + 'pagination': 'pagination', # noqa: E501 } _composed_schemas = {} @@ -101,8 +108,13 @@ def discriminator(): ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSessionReferrer - a model defined in OpenAPI + def __init__(self, context, data, pagination, *args, **kwargs): # noqa: E501 + """AnalyticsMetricsOverTimeResponse - a model defined in OpenAPI + + Args: + context (AnalyticsMetricsOverTimeResponseContext): + data ([AnalyticsMetricsOverTimeResponseData]): Returns an array of metrics and the timestamps . + pagination (Pagination): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -135,10 +147,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - url (str): The website the viewer of the live stream was referred to in order to view the live stream.. [optional] # noqa: E501 - medium (str): 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] # noqa: E501 - source (str): Where the viewer came from to see the live stream (usually where they searched from).. [optional] # noqa: E501 - search_term (str): What term they searched for that led them to the live stream.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -164,6 +172,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.context = context + self.data = data + self.pagination = pagination for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/apivideo/model/video_session_session.py b/apivideo/model/analytics_metrics_over_time_response_context.py similarity index 83% rename from apivideo/model/video_session_session.py rename to apivideo/model/analytics_metrics_over_time_response_context.py index 468e814..fcac832 100644 --- a/apivideo/model/video_session_session.py +++ b/apivideo/model/analytics_metrics_over_time_response_context.py @@ -26,11 +26,11 @@ ) def lazy_import(): - from apivideo.model.metadata import Metadata - globals()['Metadata'] = Metadata + from apivideo.model.analytics_aggregated_metrics_response_context_timeframe import AnalyticsAggregatedMetricsResponseContextTimeframe + globals()['AnalyticsAggregatedMetricsResponseContextTimeframe'] = AnalyticsAggregatedMetricsResponseContextTimeframe -class VideoSessionSession(ModelNormal): +class AnalyticsMetricsOverTimeResponseContext(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -55,6 +55,17 @@ class VideoSessionSession(ModelNormal): """ allowed_values = { + ('metric',): { + 'PLAY': "play", + 'PLAY-RATE': "play-rate", + 'START': "start", + 'END': "end", + 'IMPRESSION': "impression", + }, + ('interval',): { + 'HOUR': "hour", + 'DAY': "day", + }, } validations = { @@ -76,10 +87,9 @@ def openapi_types(): """ lazy_import() return { - 'session_id': (str,), # noqa: E501 - 'loaded_at': (datetime,), # noqa: E501 - 'ended_at': (datetime,), # noqa: E501 - 'metadata': ([Metadata],), # noqa: E501 + 'metric': (str,), # noqa: E501 + 'interval': (str,), # noqa: E501 + 'timeframe': (AnalyticsAggregatedMetricsResponseContextTimeframe,), # noqa: E501 } @cached_property @@ -88,10 +98,9 @@ def discriminator(): attribute_map = { - 'session_id': 'sessionId', # noqa: E501 - 'loaded_at': 'loadedAt', # noqa: E501 - 'ended_at': 'endedAt', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 + 'metric': 'metric', # noqa: E501 + 'interval': 'interval', # noqa: E501 + 'timeframe': 'timeframe', # noqa: E501 } _composed_schemas = {} @@ -107,7 +116,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionSession - a model defined in OpenAPI + """AnalyticsMetricsOverTimeResponseContext - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -140,10 +149,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - session_id (str): The unique identifier for the session that you can use to track what happens during it.. [optional] # noqa: E501 - loaded_at (datetime): When the video session started, presented in ISO-8601 format.. [optional] # noqa: E501 - ended_at (datetime): When the video session ended, presented in ISO-8601 format.. [optional] # noqa: E501 - metadata ([Metadata]): 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] # noqa: E501 + metric (str): Returns the metric you selected.. [optional] # noqa: E501 + interval (str): Returns the interval you selected.. [optional] # noqa: E501 + timeframe (AnalyticsAggregatedMetricsResponseContextTimeframe): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/live_stream_session_client.py b/apivideo/model/analytics_metrics_over_time_response_data.py similarity index 89% rename from apivideo/model/live_stream_session_client.py rename to apivideo/model/analytics_metrics_over_time_response_data.py index 1894db5..e9092cc 100644 --- a/apivideo/model/live_stream_session_client.py +++ b/apivideo/model/analytics_metrics_over_time_response_data.py @@ -26,7 +26,7 @@ ) -class LiveStreamSessionClient(ModelNormal): +class AnalyticsMetricsOverTimeResponseData(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -71,9 +71,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'name': (str,), # noqa: E501 - 'version': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 + 'emitted_at': (str,), # noqa: E501 + 'metric_value': (float,), # noqa: E501 } @cached_property @@ -82,9 +81,8 @@ def discriminator(): attribute_map = { - 'name': 'name', # noqa: E501 - 'version': 'version', # noqa: E501 - 'type': 'type', # noqa: E501 + 'emitted_at': 'emittedAt', # noqa: E501 + 'metric_value': 'metricValue', # noqa: E501 } _composed_schemas = {} @@ -100,7 +98,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSessionClient - a model defined in OpenAPI + """AnalyticsMetricsOverTimeResponseData - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,9 +131,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - name (str): The name of the browser used to view the live stream session.. [optional] # noqa: E501 - version (str): The version of the browser used to view the live stream session.. [optional] # noqa: E501 - type (str): The type of client used to view the live stream session.. [optional] # noqa: E501 + emitted_at (str): 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] # noqa: E501 + metric_value (float): Returns the data for a specific metric value.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/live_stream_session.py b/apivideo/model/live_stream_session.py deleted file mode 100644 index a19145a..0000000 --- a/apivideo/model/live_stream_session.py +++ /dev/null @@ -1,195 +0,0 @@ -""" - api.video - - 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. # noqa: E501 - - Contact: ecosystem@api.video -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from apivideo.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from apivideo.model.live_stream_session_client import LiveStreamSessionClient - from apivideo.model.live_stream_session_device import LiveStreamSessionDevice - from apivideo.model.live_stream_session_location import LiveStreamSessionLocation - from apivideo.model.live_stream_session_referrer import LiveStreamSessionReferrer - from apivideo.model.live_stream_session_session import LiveStreamSessionSession - from apivideo.model.video_session_os import VideoSessionOs - globals()['LiveStreamSessionClient'] = LiveStreamSessionClient - globals()['LiveStreamSessionDevice'] = LiveStreamSessionDevice - globals()['LiveStreamSessionLocation'] = LiveStreamSessionLocation - globals()['LiveStreamSessionReferrer'] = LiveStreamSessionReferrer - globals()['LiveStreamSessionSession'] = LiveStreamSessionSession - globals()['VideoSessionOs'] = VideoSessionOs - - -class LiveStreamSession(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'session': (LiveStreamSessionSession,), # noqa: E501 - 'location': (LiveStreamSessionLocation,), # noqa: E501 - 'referrer': (LiveStreamSessionReferrer,), # noqa: E501 - 'device': (LiveStreamSessionDevice,), # noqa: E501 - 'os': (VideoSessionOs,), # noqa: E501 - 'client': (LiveStreamSessionClient,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'session': 'session', # noqa: E501 - 'location': 'location', # noqa: E501 - 'referrer': 'referrer', # noqa: E501 - 'device': 'device', # noqa: E501 - 'os': 'os', # noqa: E501 - 'client': 'client', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSession - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - session (LiveStreamSessionSession): [optional] # noqa: E501 - location (LiveStreamSessionLocation): [optional] # noqa: E501 - referrer (LiveStreamSessionReferrer): [optional] # noqa: E501 - device (LiveStreamSessionDevice): [optional] # noqa: E501 - os (VideoSessionOs): [optional] # noqa: E501 - client (LiveStreamSessionClient): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/apivideo/model/live_stream_session_location.py b/apivideo/model/live_stream_session_location.py deleted file mode 100644 index a9914b9..0000000 --- a/apivideo/model/live_stream_session_location.py +++ /dev/null @@ -1,168 +0,0 @@ -""" - api.video - - 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. # noqa: E501 - - Contact: ecosystem@api.video -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from apivideo.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class LiveStreamSessionLocation(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'country': (str,), # noqa: E501 - 'city': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'country': 'country', # noqa: E501 - 'city': 'city', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """LiveStreamSessionLocation - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - country (str): The country of the viewer of the live stream.. [optional] # noqa: E501 - city (str): The city of the viewer of the live stream.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/apivideo/model/video_session_device.py b/apivideo/model/unrecognized_request_url.py similarity index 91% rename from apivideo/model/video_session_device.py rename to apivideo/model/unrecognized_request_url.py index 6865802..a7d4306 100644 --- a/apivideo/model/video_session_device.py +++ b/apivideo/model/unrecognized_request_url.py @@ -26,7 +26,7 @@ ) -class VideoSessionDevice(ModelNormal): +class UnrecognizedRequestUrl(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -72,8 +72,8 @@ def openapi_types(): """ return { 'type': (str,), # noqa: E501 - 'vendor': (str,), # noqa: E501 - 'model': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'status': (int,), # noqa: E501 } @cached_property @@ -83,8 +83,8 @@ def discriminator(): attribute_map = { 'type': 'type', # noqa: E501 - 'vendor': 'vendor', # noqa: E501 - 'model': 'model', # noqa: E501 + 'title': 'title', # noqa: E501 + 'status': 'status', # noqa: E501 } _composed_schemas = {} @@ -100,7 +100,7 @@ def discriminator(): @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionDevice - a model defined in OpenAPI + """UnrecognizedRequestUrl - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -133,9 +133,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - type (str): What the type is like desktop, laptop, mobile.. [optional] # noqa: E501 - vendor (str): If known, what the brand of the device is, like Apple, Dell, etc.. [optional] # noqa: E501 - model (str): The specific model of the device, if known.. [optional] # noqa: E501 + type (str): A link to the error documentation.. [optional] # noqa: E501 + title (str): A description of the error that occurred.. [optional] # noqa: E501 + status (int): The HTTP status code.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/apivideo/model/video_session.py b/apivideo/model/video_session.py deleted file mode 100644 index 65d4a4f..0000000 --- a/apivideo/model/video_session.py +++ /dev/null @@ -1,195 +0,0 @@ -""" - api.video - - 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. # noqa: E501 - - Contact: ecosystem@api.video -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from apivideo.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - -def lazy_import(): - from apivideo.model.video_session_client import VideoSessionClient - from apivideo.model.video_session_device import VideoSessionDevice - from apivideo.model.video_session_location import VideoSessionLocation - from apivideo.model.video_session_os import VideoSessionOs - from apivideo.model.video_session_referrer import VideoSessionReferrer - from apivideo.model.video_session_session import VideoSessionSession - globals()['VideoSessionClient'] = VideoSessionClient - globals()['VideoSessionDevice'] = VideoSessionDevice - globals()['VideoSessionLocation'] = VideoSessionLocation - globals()['VideoSessionOs'] = VideoSessionOs - globals()['VideoSessionReferrer'] = VideoSessionReferrer - globals()['VideoSessionSession'] = VideoSessionSession - - -class VideoSession(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - lazy_import() - return { - 'session': (VideoSessionSession,), # noqa: E501 - 'location': (VideoSessionLocation,), # noqa: E501 - 'referrer': (VideoSessionReferrer,), # noqa: E501 - 'device': (VideoSessionDevice,), # noqa: E501 - 'os': (VideoSessionOs,), # noqa: E501 - 'client': (VideoSessionClient,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'session': 'session', # noqa: E501 - 'location': 'location', # noqa: E501 - 'referrer': 'referrer', # noqa: E501 - 'device': 'device', # noqa: E501 - 'os': 'os', # noqa: E501 - 'client': 'client', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSession - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - session (VideoSessionSession): [optional] # noqa: E501 - location (VideoSessionLocation): [optional] # noqa: E501 - referrer (VideoSessionReferrer): [optional] # noqa: E501 - device (VideoSessionDevice): [optional] # noqa: E501 - os (VideoSessionOs): [optional] # noqa: E501 - client (VideoSessionClient): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/apivideo/model/video_session_os.py b/apivideo/model/video_session_os.py deleted file mode 100644 index 4106f6d..0000000 --- a/apivideo/model/video_session_os.py +++ /dev/null @@ -1,171 +0,0 @@ -""" - api.video - - 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. # noqa: E501 - - Contact: ecosystem@api.video -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from apivideo.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, -) - - -class VideoSessionOs(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - additional_properties_type = None - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'name': (str,), # noqa: E501 - 'shortname': (str,), # noqa: E501 - 'version': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'name': 'name', # noqa: E501 - 'shortname': 'shortname', # noqa: E501 - 'version': 'version', # noqa: E501 - } - - _composed_schemas = {} - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """VideoSessionOs - a model defined in OpenAPI - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - name (str): The name of the operating system.. [optional] # noqa: E501 - shortname (str): The nickname for the operating system, often representing the version.. [optional] # noqa: E501 - version (str): The version of the operating system.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) diff --git a/docs/VideoSessionLocation.md b/docs/AnalyticsAggregatedMetricsResponse.md similarity index 53% rename from docs/VideoSessionLocation.md rename to docs/AnalyticsAggregatedMetricsResponse.md index 11cceb1..8083cd4 100644 --- a/docs/VideoSessionLocation.md +++ b/docs/AnalyticsAggregatedMetricsResponse.md @@ -1,11 +1,11 @@ -# VideoSessionLocation +# AnalyticsAggregatedMetricsResponse -The location of the viewer. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**country** | **str** | The country of the viewer. | [optional] -**city** | **str, none_type** | The city of the viewer. | [optional] +**context** | [**AnalyticsAggregatedMetricsResponseContext**](AnalyticsAggregatedMetricsResponseContext.md) | | +**data** | **[float]** | | +**pagination** | [**Pagination**](Pagination.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AnalyticsAggregatedMetricsResponseContext.md b/docs/AnalyticsAggregatedMetricsResponseContext.md new file mode 100644 index 0000000..98d5b54 --- /dev/null +++ b/docs/AnalyticsAggregatedMetricsResponseContext.md @@ -0,0 +1,12 @@ +# AnalyticsAggregatedMetricsResponseContext + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | **str** | Returns the metric you selected. | [optional] +**aggregation** | **str** | Returns the aggregation you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md b/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md new file mode 100644 index 0000000..f639178 --- /dev/null +++ b/docs/AnalyticsAggregatedMetricsResponseContextTimeframe.md @@ -0,0 +1,12 @@ +# AnalyticsAggregatedMetricsResponseContextTimeframe + +Returns the starting and ending date-times of the period you want analytics for. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **datetime** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [optional] +**to** | **datetime** | Returns the starting date-time of the period you want analytics for in ATOM date-time format. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md index a5cd767..5ee1198 100644 --- a/docs/AnalyticsApi.md +++ b/docs/AnalyticsApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description Get play events for live stream -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. ### Example @@ -95,7 +95,7 @@ Name | Type | Description | Notes Get play events for video -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. ### Example diff --git a/docs/AnalyticsMetricsBreakdownResponse.md b/docs/AnalyticsMetricsBreakdownResponse.md new file mode 100644 index 0000000..61de32d --- /dev/null +++ b/docs/AnalyticsMetricsBreakdownResponse.md @@ -0,0 +1,12 @@ +# AnalyticsMetricsBreakdownResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**AnalyticsMetricsBreakdownResponseContext**](AnalyticsMetricsBreakdownResponseContext.md) | | +**data** | [**[AnalyticsMetricsBreakdownResponseData]**](AnalyticsMetricsBreakdownResponseData.md) | Returns an array of dimensions and their respective metrics. | +**pagination** | [**Pagination**](Pagination.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsMetricsBreakdownResponseContext.md b/docs/AnalyticsMetricsBreakdownResponseContext.md new file mode 100644 index 0000000..88856f0 --- /dev/null +++ b/docs/AnalyticsMetricsBreakdownResponseContext.md @@ -0,0 +1,12 @@ +# AnalyticsMetricsBreakdownResponseContext + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | **str** | Returns the metric you selected. | [optional] +**breakdown** | **str** | Returns the dimension you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsMetricsBreakdownResponseData.md b/docs/AnalyticsMetricsBreakdownResponseData.md new file mode 100644 index 0000000..2b8a536 --- /dev/null +++ b/docs/AnalyticsMetricsBreakdownResponseData.md @@ -0,0 +1,11 @@ +# AnalyticsMetricsBreakdownResponseData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimension_value** | **str** | 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] +**metric_value** | **float** | Returns the data for a specific dimension value. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsMetricsOverTimeResponse.md b/docs/AnalyticsMetricsOverTimeResponse.md new file mode 100644 index 0000000..7394403 --- /dev/null +++ b/docs/AnalyticsMetricsOverTimeResponse.md @@ -0,0 +1,12 @@ +# AnalyticsMetricsOverTimeResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**AnalyticsMetricsOverTimeResponseContext**](AnalyticsMetricsOverTimeResponseContext.md) | | +**data** | [**[AnalyticsMetricsOverTimeResponseData]**](AnalyticsMetricsOverTimeResponseData.md) | Returns an array of metrics and the timestamps . | +**pagination** | [**Pagination**](Pagination.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsMetricsOverTimeResponseContext.md b/docs/AnalyticsMetricsOverTimeResponseContext.md new file mode 100644 index 0000000..22f3ad5 --- /dev/null +++ b/docs/AnalyticsMetricsOverTimeResponseContext.md @@ -0,0 +1,12 @@ +# AnalyticsMetricsOverTimeResponseContext + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metric** | **str** | Returns the metric you selected. | [optional] +**interval** | **str** | Returns the interval you selected. | [optional] +**timeframe** | [**AnalyticsAggregatedMetricsResponseContextTimeframe**](AnalyticsAggregatedMetricsResponseContextTimeframe.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsMetricsOverTimeResponseData.md b/docs/AnalyticsMetricsOverTimeResponseData.md new file mode 100644 index 0000000..510c95d --- /dev/null +++ b/docs/AnalyticsMetricsOverTimeResponseData.md @@ -0,0 +1,11 @@ +# AnalyticsMetricsOverTimeResponseData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**emitted_at** | **str** | 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] +**metric_value** | **float** | Returns the data for a specific metric value. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LiveStreamSession.md b/docs/LiveStreamSession.md deleted file mode 100644 index 59a3c3b..0000000 --- a/docs/LiveStreamSession.md +++ /dev/null @@ -1,15 +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] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LiveStreamSessionClient.md b/docs/LiveStreamSessionClient.md deleted file mode 100644 index be7cdcf..0000000 --- a/docs/LiveStreamSessionClient.md +++ /dev/null @@ -1,13 +0,0 @@ -# LiveStreamSessionClient - -What kind of browser the viewer is using for the live stream session. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the browser used to view the live stream session. | [optional] -**version** | **str** | The version of the browser used to view the live stream session. | [optional] -**type** | **str** | The type of client used to view the live stream session. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LiveStreamSessionDevice.md b/docs/LiveStreamSessionDevice.md deleted file mode 100644 index ead0457..0000000 --- a/docs/LiveStreamSessionDevice.md +++ /dev/null @@ -1,13 +0,0 @@ -# LiveStreamSessionDevice - -What type of device the user is on when in the live stream session. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | What the type is like desktop, laptop, mobile. | [optional] -**vendor** | **str** | If known, what the brand of the device is, like Apple, Dell, etc. | [optional] -**model** | **str** | The specific model of the device, if known. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LiveStreamSessionReferrer.md b/docs/LiveStreamSessionReferrer.md deleted file mode 100644 index 72329bb..0000000 --- a/docs/LiveStreamSessionReferrer.md +++ /dev/null @@ -1,13 +0,0 @@ -# LiveStreamSessionReferrer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str** | The website the viewer of the live stream was referred to in order to view the live stream. | [optional] -**medium** | **str** | 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** | **str** | Where the viewer came from to see the live stream (usually where they searched from). | [optional] -**search_term** | **str** | What term they searched for that led them to the live stream. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LiveStreamSessionSession.md b/docs/LiveStreamSessionSession.md deleted file mode 100644 index 8061bdf..0000000 --- a/docs/LiveStreamSessionSession.md +++ /dev/null @@ -1,12 +0,0 @@ -# LiveStreamSessionSession - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**session_id** | **str** | A unique identifier for your session. You can use this to track what happens during a specific session. | [optional] -**loaded_at** | **datetime** | When the session started, with the date and time presented in ISO-8601 format. | [optional] -**ended_at** | **datetime** | When the session ended, with the date and time presented in ISO-8601 format. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LiveStreamSessionLocation.md b/docs/UnrecognizedRequestUrl.md similarity index 56% rename from docs/LiveStreamSessionLocation.md rename to docs/UnrecognizedRequestUrl.md index e811e0f..ca010cc 100644 --- a/docs/LiveStreamSessionLocation.md +++ b/docs/UnrecognizedRequestUrl.md @@ -1,11 +1,11 @@ -# LiveStreamSessionLocation +# UnrecognizedRequestUrl -The location of the viewer of the live stream. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**country** | **str** | The country of the viewer of the live stream. | [optional] -**city** | **str** | The city of the viewer of the live stream. | [optional] +**type** | **str** | A link to the error documentation. | [optional] +**title** | **str** | A description of the error that occurred. | [optional] +**status** | **int** | The HTTP status code. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VideoSession.md b/docs/VideoSession.md deleted file mode 100644 index 7964c36..0000000 --- a/docs/VideoSession.md +++ /dev/null @@ -1,15 +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] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VideoSessionClient.md b/docs/VideoSessionClient.md deleted file mode 100644 index 4b8c095..0000000 --- a/docs/VideoSessionClient.md +++ /dev/null @@ -1,13 +0,0 @@ -# VideoSessionClient - -What kind of browser the viewer is using for the video session. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the browser used to view the video session. | [optional] -**version** | **str** | The version of the browser used to view the video session. | [optional] -**type** | **str** | The type of client used to view the video session. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VideoSessionDevice.md b/docs/VideoSessionDevice.md deleted file mode 100644 index f40a88a..0000000 --- a/docs/VideoSessionDevice.md +++ /dev/null @@ -1,13 +0,0 @@ -# VideoSessionDevice - -What type of device the user is on when in the video session. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | What the type is like desktop, laptop, mobile. | [optional] -**vendor** | **str** | If known, what the brand of the device is, like Apple, Dell, etc. | [optional] -**model** | **str** | The specific model of the device, if known. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VideoSessionOs.md b/docs/VideoSessionOs.md deleted file mode 100644 index f704393..0000000 --- a/docs/VideoSessionOs.md +++ /dev/null @@ -1,13 +0,0 @@ -# VideoSessionOs - -The operating system the viewer is on. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the operating system. | [optional] -**shortname** | **str** | The nickname for the operating system, often representing the version. | [optional] -**version** | **str** | The version of the operating system. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VideoSessionReferrer.md b/docs/VideoSessionReferrer.md deleted file mode 100644 index 2a4db95..0000000 --- a/docs/VideoSessionReferrer.md +++ /dev/null @@ -1,13 +0,0 @@ -# VideoSessionReferrer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **str, none_type** | The link the viewer used to reach the video session. | [optional] -**medium** | **str** | 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** | **str** | The source the referrer came from to the video session. For example if they searched through google to find the stream. | [optional] -**search_term** | **str** | The search term they typed to arrive at the video session. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VideoSessionSession.md b/docs/VideoSessionSession.md deleted file mode 100644 index 9d40891..0000000 --- a/docs/VideoSessionSession.md +++ /dev/null @@ -1,13 +0,0 @@ -# VideoSessionSession - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**session_id** | **str** | The unique identifier for the session that you can use to track what happens during it. | [optional] -**loaded_at** | **datetime** | When the video session started, presented in ISO-8601 format. | [optional] -**ended_at** | **datetime** | When the video session ended, presented in ISO-8601 format. | [optional] -**metadata** | [**[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] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - -