Skip to content

Commit

Permalink
[release] 3.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
eropple committed Feb 17, 2022
1 parent 06a6f4f commit 82003fa
Show file tree
Hide file tree
Showing 16 changed files with 270 additions and 37 deletions.
3 changes: 2 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ docs/ListFiltersResponseData.md
docs/ListIncidentsResponse.md
docs/ListInsightsResponse.md
docs/ListLiveStreamsResponse.md
docs/ListPlaybackRestrictionsResponse.md
docs/ListRealTimeDimensionsResponse.md
docs/ListRealTimeDimensionsResponseData.md
docs/ListRealTimeMetricsResponse.md
Expand Down Expand Up @@ -209,6 +210,7 @@ mux_python/models/list_filters_response_data.py
mux_python/models/list_incidents_response.py
mux_python/models/list_insights_response.py
mux_python/models/list_live_streams_response.py
mux_python/models/list_playback_restrictions_response.py
mux_python/models/list_real_time_dimensions_response.py
mux_python/models/list_real_time_dimensions_response_data.py
mux_python/models/list_real_time_metrics_response.py
Expand Down Expand Up @@ -259,5 +261,4 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_live_stream_status.py
tox.ini
10 changes: 10 additions & 0 deletions docs/ListPlaybackRestrictionsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ListPlaybackRestrictionsResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**list[PlaybackRestriction]**](PlaybackRestriction.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)


6 changes: 3 additions & 3 deletions docs/MetricsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Method | HTTP request | Description
Get metric timeseries data

Returns timeseries data for a specific metric.
Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value

### Example

Expand Down Expand Up @@ -53,7 +53,7 @@ timeframe = ['timeframe_example'] # list[str] | Timeframe window to limit result
filters = ['filters_example'] # list[str] | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` (optional)
measurement = 'measurement_example' # str | Measurement for the provided metric. If omitted, the default for the metric will be used. (optional)
order_direction = 'order_direction_example' # str | Sort order. (optional)
group_by = 'group_by_example' # str | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. (optional)
group_by = 'group_by_example' # str | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. (optional)

try:
# Get metric timeseries data
Expand All @@ -72,7 +72,7 @@ Name | Type | Description | Notes
**filters** | [**list[str]**](str.md)| Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` | [optional]
**measurement** | **str**| Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional]
**order_direction** | **str**| Sort order. | [optional]
**group_by** | **str**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional]
**group_by** | **str**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/PlaybackRestrictionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**PlaybackRestriction**](.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)

Expand Down
18 changes: 9 additions & 9 deletions docs/PlaybackRestrictionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **create_playback_restriction**
> PlaybackRestriction create_playback_restriction(create_playback_restriction_request)
> PlaybackRestrictionResponse create_playback_restriction(create_playback_restriction_request)
Create a Playback Restriction

Expand Down Expand Up @@ -66,7 +66,7 @@ Name | Type | Description | Notes

### Return type

[**PlaybackRestriction**](PlaybackRestriction.md)
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)

### Authorization

Expand Down Expand Up @@ -157,7 +157,7 @@ void (empty response body)
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_playback_restriction**
> PlaybackRestriction get_playback_restriction(playback_restriction_id)
> PlaybackRestrictionResponse get_playback_restriction(playback_restriction_id)
Retrieve a Playback Restriction

Expand Down Expand Up @@ -211,7 +211,7 @@ Name | Type | Description | Notes

### Return type

[**PlaybackRestriction**](PlaybackRestriction.md)
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)

### Authorization

Expand All @@ -230,7 +230,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_playback_restrictions**
> list[PlaybackRestriction] list_playback_restrictions(page=page, limit=limit)
> ListPlaybackRestrictionsResponse list_playback_restrictions(page=page, limit=limit)
List Playback Restrictions

Expand Down Expand Up @@ -286,7 +286,7 @@ Name | Type | Description | Notes

### Return type

[**list[PlaybackRestriction]**](PlaybackRestriction.md)
[**ListPlaybackRestrictionsResponse**](ListPlaybackRestrictionsResponse.md)

### Authorization

Expand All @@ -305,11 +305,11 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_referrer_domain_restriction**
> PlaybackRestriction update_referrer_domain_restriction(playback_restriction_id, body)
> PlaybackRestrictionResponse update_referrer_domain_restriction(playback_restriction_id, body)
Update the Referrer Playback Restriction

Allows you to modify the list of domians or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.

### Example

Expand Down Expand Up @@ -361,7 +361,7 @@ Name | Type | Description | Notes

### Return type

[**PlaybackRestriction**](PlaybackRestriction.md)
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)

### Authorization

Expand Down
2 changes: 1 addition & 1 deletion gen/generator-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md",
"packageName": "mux_python",
"projectName": "mux_python",
"packageVersion": "3.3.0"
"packageVersion": "3.3.1"
}
3 changes: 2 additions & 1 deletion mux_python/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from __future__ import absolute_import

__version__ = "3.3.0"
__version__ = "3.3.1"

# import apis into sdk package
from mux_python.api.assets_api import AssetsApi
Expand Down Expand Up @@ -108,6 +108,7 @@
from mux_python.models.list_incidents_response import ListIncidentsResponse
from mux_python.models.list_insights_response import ListInsightsResponse
from mux_python.models.list_live_streams_response import ListLiveStreamsResponse
from mux_python.models.list_playback_restrictions_response import ListPlaybackRestrictionsResponse
from mux_python.models.list_real_time_dimensions_response import ListRealTimeDimensionsResponse
from mux_python.models.list_real_time_dimensions_response_data import ListRealTimeDimensionsResponseData
from mux_python.models.list_real_time_metrics_response import ListRealTimeMetricsResponse
Expand Down
8 changes: 4 additions & 4 deletions mux_python/api/metrics_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def __init__(self, api_client=None):
def get_metric_timeseries_data(self, metric_id, **kwargs): # noqa: E501
"""Get metric timeseries data # noqa: E501
Returns timeseries data for a specific metric. # noqa: E501
Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
Expand All @@ -57,7 +57,7 @@ def get_metric_timeseries_data(self, metric_id, **kwargs): # noqa: E501
:type measurement: str
:param order_direction: Sort order.
:type order_direction: str
:param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
:param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
:type group_by: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
Expand All @@ -80,7 +80,7 @@ def get_metric_timeseries_data(self, metric_id, **kwargs): # noqa: E501
def get_metric_timeseries_data_with_http_info(self, metric_id, **kwargs): # noqa: E501
"""Get metric timeseries data # noqa: E501
Returns timeseries data for a specific metric. # noqa: E501
Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
Expand All @@ -97,7 +97,7 @@ def get_metric_timeseries_data_with_http_info(self, metric_id, **kwargs): # noq
:type measurement: str
:param order_direction: Sort order.
:type order_direction: str
:param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
:param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.
:type group_by: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
Expand Down
Loading

0 comments on commit 82003fa

Please sign in to comment.