mux-python 3.9.0__py3.11.egg → 3.10.0__py3.11.egg

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. EGG-INFO/PKG-INFO +1 -1
  2. EGG-INFO/SOURCES.txt +2 -0
  3. mux_python/__init__.py +2 -1
  4. mux_python/__pycache__/__init__.cpython-311.pyc +0 -0
  5. mux_python/__pycache__/api_client.cpython-311.pyc +0 -0
  6. mux_python/__pycache__/configuration.cpython-311.pyc +0 -0
  7. mux_python/__pycache__/exceptions.cpython-311.pyc +0 -0
  8. mux_python/__pycache__/rest.cpython-311.pyc +0 -0
  9. mux_python/api/__init__.py +1 -0
  10. mux_python/api/__pycache__/__init__.cpython-311.pyc +0 -0
  11. mux_python/api/__pycache__/assets_api.cpython-311.pyc +0 -0
  12. mux_python/api/__pycache__/delivery_usage_api.cpython-311.pyc +0 -0
  13. mux_python/api/__pycache__/dimensions_api.cpython-311.pyc +0 -0
  14. mux_python/api/__pycache__/direct_uploads_api.cpython-311.pyc +0 -0
  15. mux_python/api/__pycache__/errors_api.cpython-311.pyc +0 -0
  16. mux_python/api/__pycache__/exports_api.cpython-311.pyc +0 -0
  17. mux_python/api/__pycache__/filters_api.cpython-311.pyc +0 -0
  18. mux_python/api/__pycache__/incidents_api.cpython-311.pyc +0 -0
  19. mux_python/api/__pycache__/live_streams_api.cpython-311.pyc +0 -0
  20. mux_python/api/__pycache__/metrics_api.cpython-311.pyc +0 -0
  21. mux_python/api/__pycache__/monitoring_api.cpython-311.pyc +0 -0
  22. mux_python/api/__pycache__/playback_id_api.cpython-311.pyc +0 -0
  23. mux_python/api/__pycache__/playback_restrictions_api.cpython-311.pyc +0 -0
  24. mux_python/api/__pycache__/real_time_api.cpython-311.pyc +0 -0
  25. mux_python/api/__pycache__/signing_keys_api.cpython-311.pyc +0 -0
  26. mux_python/api/__pycache__/spaces_api.cpython-311.pyc +0 -0
  27. mux_python/api/__pycache__/transcription_vocabularies_api.cpython-311.pyc +0 -0
  28. mux_python/api/__pycache__/url_signing_keys_api.cpython-311.pyc +0 -0
  29. mux_python/api/__pycache__/video_views_api.cpython-311.pyc +0 -0
  30. mux_python/api/direct_uploads_api.py +2 -2
  31. mux_python/api/monitoring_api.py +8 -1
  32. mux_python/api/real_time_api.py +8 -1
  33. mux_python/api/signing_keys_api.py +564 -0
  34. mux_python/api/url_signing_keys_api.py +8 -8
  35. mux_python/api_client.py +1 -1
  36. mux_python/configuration.py +1 -1
  37. mux_python/models/__pycache__/__init__.cpython-311.pyc +0 -0
  38. mux_python/models/__pycache__/abridged_video_view.cpython-311.pyc +0 -0
  39. mux_python/models/__pycache__/asset.cpython-311.pyc +0 -0
  40. mux_python/models/__pycache__/asset_errors.cpython-311.pyc +0 -0
  41. mux_python/models/__pycache__/asset_master.cpython-311.pyc +0 -0
  42. mux_python/models/__pycache__/asset_non_standard_input_reasons.cpython-311.pyc +0 -0
  43. mux_python/models/__pycache__/asset_recording_times.cpython-311.pyc +0 -0
  44. mux_python/models/__pycache__/asset_response.cpython-311.pyc +0 -0
  45. mux_python/models/__pycache__/asset_static_renditions.cpython-311.pyc +0 -0
  46. mux_python/models/__pycache__/asset_static_renditions_files.cpython-311.pyc +0 -0
  47. mux_python/models/__pycache__/breakdown_value.cpython-311.pyc +0 -0
  48. mux_python/models/__pycache__/broadcast.cpython-311.pyc +0 -0
  49. mux_python/models/__pycache__/broadcast_layout.cpython-311.pyc +0 -0
  50. mux_python/models/__pycache__/broadcast_resolution.cpython-311.pyc +0 -0
  51. mux_python/models/__pycache__/broadcast_response.cpython-311.pyc +0 -0
  52. mux_python/models/__pycache__/broadcast_status.cpython-311.pyc +0 -0
  53. mux_python/models/__pycache__/create_asset_request.cpython-311.pyc +0 -0
  54. mux_python/models/__pycache__/create_broadcast_request.cpython-311.pyc +0 -0
  55. mux_python/models/__pycache__/create_live_stream_request.cpython-311.pyc +0 -0
  56. mux_python/models/__pycache__/create_playback_id_request.cpython-311.pyc +0 -0
  57. mux_python/models/__pycache__/create_playback_id_response.cpython-311.pyc +0 -0
  58. mux_python/models/__pycache__/create_playback_restriction_request.cpython-311.pyc +0 -0
  59. mux_python/models/__pycache__/create_simulcast_target_request.cpython-311.pyc +0 -0
  60. mux_python/models/__pycache__/create_space_request.cpython-311.pyc +0 -0
  61. mux_python/models/__pycache__/create_track_request.cpython-311.pyc +0 -0
  62. mux_python/models/__pycache__/create_track_response.cpython-311.pyc +0 -0
  63. mux_python/models/__pycache__/create_transcription_vocabulary_request.cpython-311.pyc +0 -0
  64. mux_python/models/__pycache__/create_upload_request.cpython-311.pyc +0 -0
  65. mux_python/models/__pycache__/delivery_report.cpython-311.pyc +0 -0
  66. mux_python/models/__pycache__/delivery_report_delivered_seconds_by_resolution.cpython-311.pyc +0 -0
  67. mux_python/models/__pycache__/dimension_value.cpython-311.pyc +0 -0
  68. mux_python/models/__pycache__/disable_live_stream_response.cpython-311.pyc +0 -0
  69. mux_python/models/__pycache__/enable_live_stream_response.cpython-311.pyc +0 -0
  70. mux_python/models/__pycache__/error.cpython-311.pyc +0 -0
  71. mux_python/models/__pycache__/export_date.cpython-311.pyc +0 -0
  72. mux_python/models/__pycache__/export_file.cpython-311.pyc +0 -0
  73. mux_python/models/__pycache__/filter_value.cpython-311.pyc +0 -0
  74. mux_python/models/__pycache__/get_asset_input_info_response.cpython-311.pyc +0 -0
  75. mux_python/models/__pycache__/get_asset_or_live_stream_id_response.cpython-311.pyc +0 -0
  76. mux_python/models/__pycache__/get_asset_or_live_stream_id_response_data.cpython-311.pyc +0 -0
  77. mux_python/models/__pycache__/get_asset_or_live_stream_id_response_data_object.cpython-311.pyc +0 -0
  78. mux_python/models/__pycache__/get_asset_playback_id_response.cpython-311.pyc +0 -0
  79. mux_python/models/__pycache__/get_live_stream_playback_id_response.cpython-311.pyc +0 -0
  80. mux_python/models/__pycache__/get_metric_timeseries_data_response.cpython-311.pyc +0 -0
  81. mux_python/models/__pycache__/get_monitoring_breakdown_response.cpython-311.pyc +0 -0
  82. mux_python/models/__pycache__/get_monitoring_histogram_timeseries_response.cpython-311.pyc +0 -0
  83. mux_python/models/__pycache__/get_monitoring_histogram_timeseries_response_meta.cpython-311.pyc +0 -0
  84. mux_python/models/__pycache__/get_monitoring_timeseries_response.cpython-311.pyc +0 -0
  85. mux_python/models/__pycache__/get_overall_values_response.cpython-311.pyc +0 -0
  86. mux_python/models/__pycache__/get_real_time_breakdown_response.cpython-311.pyc +0 -0
  87. mux_python/models/__pycache__/get_real_time_histogram_timeseries_response.cpython-311.pyc +0 -0
  88. mux_python/models/__pycache__/get_real_time_histogram_timeseries_response_meta.cpython-311.pyc +0 -0
  89. mux_python/models/__pycache__/get_real_time_timeseries_response.cpython-311.pyc +0 -0
  90. mux_python/models/__pycache__/incident.cpython-311.pyc +0 -0
  91. mux_python/models/__pycache__/incident_breakdown.cpython-311.pyc +0 -0
  92. mux_python/models/__pycache__/incident_notification.cpython-311.pyc +0 -0
  93. mux_python/models/__pycache__/incident_notification_rule.cpython-311.pyc +0 -0
  94. mux_python/models/__pycache__/incident_response.cpython-311.pyc +0 -0
  95. mux_python/models/__pycache__/input_file.cpython-311.pyc +0 -0
  96. mux_python/models/__pycache__/input_info.cpython-311.pyc +0 -0
  97. mux_python/models/__pycache__/input_settings.cpython-311.pyc +0 -0
  98. mux_python/models/__pycache__/input_settings_overlay_settings.cpython-311.pyc +0 -0
  99. mux_python/models/__pycache__/input_track.cpython-311.pyc +0 -0
  100. mux_python/models/__pycache__/insight.cpython-311.pyc +0 -0
  101. mux_python/models/__pycache__/list_all_metric_values_response.cpython-311.pyc +0 -0
  102. mux_python/models/__pycache__/list_assets_response.cpython-311.pyc +0 -0
  103. mux_python/models/__pycache__/list_breakdown_values_response.cpython-311.pyc +0 -0
  104. mux_python/models/__pycache__/list_delivery_usage_response.cpython-311.pyc +0 -0
  105. mux_python/models/__pycache__/list_dimension_values_response.cpython-311.pyc +0 -0
  106. mux_python/models/__pycache__/list_dimensions_response.cpython-311.pyc +0 -0
  107. mux_python/models/__pycache__/list_errors_response.cpython-311.pyc +0 -0
  108. mux_python/models/__pycache__/list_exports_response.cpython-311.pyc +0 -0
  109. mux_python/models/__pycache__/list_filter_values_response.cpython-311.pyc +0 -0
  110. mux_python/models/__pycache__/list_filters_response.cpython-311.pyc +0 -0
  111. mux_python/models/__pycache__/list_filters_response_data.cpython-311.pyc +0 -0
  112. mux_python/models/__pycache__/list_incidents_response.cpython-311.pyc +0 -0
  113. mux_python/models/__pycache__/list_insights_response.cpython-311.pyc +0 -0
  114. mux_python/models/__pycache__/list_live_streams_response.cpython-311.pyc +0 -0
  115. mux_python/models/__pycache__/list_monitoring_dimensions_response.cpython-311.pyc +0 -0
  116. mux_python/models/__pycache__/list_monitoring_dimensions_response_data.cpython-311.pyc +0 -0
  117. mux_python/models/__pycache__/list_monitoring_metrics_response.cpython-311.pyc +0 -0
  118. mux_python/models/__pycache__/list_playback_restrictions_response.cpython-311.pyc +0 -0
  119. mux_python/models/__pycache__/list_real_time_dimensions_response.cpython-311.pyc +0 -0
  120. mux_python/models/__pycache__/list_real_time_metrics_response.cpython-311.pyc +0 -0
  121. mux_python/models/__pycache__/list_related_incidents_response.cpython-311.pyc +0 -0
  122. mux_python/models/__pycache__/list_signing_keys_response.cpython-311.pyc +0 -0
  123. mux_python/models/__pycache__/list_spaces_response.cpython-311.pyc +0 -0
  124. mux_python/models/__pycache__/list_transcription_vocabularies_response.cpython-311.pyc +0 -0
  125. mux_python/models/__pycache__/list_uploads_response.cpython-311.pyc +0 -0
  126. mux_python/models/__pycache__/list_video_view_exports_response.cpython-311.pyc +0 -0
  127. mux_python/models/__pycache__/list_video_views_response.cpython-311.pyc +0 -0
  128. mux_python/models/__pycache__/live_stream.cpython-311.pyc +0 -0
  129. mux_python/models/__pycache__/live_stream_embedded_subtitle_settings.cpython-311.pyc +0 -0
  130. mux_python/models/__pycache__/live_stream_generated_subtitle_settings.cpython-311.pyc +0 -0
  131. mux_python/models/__pycache__/live_stream_response.cpython-311.pyc +0 -0
  132. mux_python/models/__pycache__/live_stream_status.cpython-311.pyc +0 -0
  133. mux_python/models/__pycache__/metric.cpython-311.pyc +0 -0
  134. mux_python/models/__pycache__/monitoring_breakdown_value.cpython-311.pyc +0 -0
  135. mux_python/models/__pycache__/monitoring_histogram_timeseries_bucket.cpython-311.pyc +0 -0
  136. mux_python/models/__pycache__/monitoring_histogram_timeseries_bucket_values.cpython-311.pyc +0 -0
  137. mux_python/models/__pycache__/monitoring_histogram_timeseries_datapoint.cpython-311.pyc +0 -0
  138. mux_python/models/__pycache__/monitoring_timeseries_datapoint.cpython-311.pyc +0 -0
  139. mux_python/models/__pycache__/notification_rule.cpython-311.pyc +0 -0
  140. mux_python/models/__pycache__/overall_values.cpython-311.pyc +0 -0
  141. mux_python/models/__pycache__/playback_id.cpython-311.pyc +0 -0
  142. mux_python/models/__pycache__/playback_policy.cpython-311.pyc +0 -0
  143. mux_python/models/__pycache__/playback_restriction.cpython-311.pyc +0 -0
  144. mux_python/models/__pycache__/playback_restriction_response.cpython-311.pyc +0 -0
  145. mux_python/models/__pycache__/real_time_breakdown_value.cpython-311.pyc +0 -0
  146. mux_python/models/__pycache__/real_time_histogram_timeseries_bucket.cpython-311.pyc +0 -0
  147. mux_python/models/__pycache__/real_time_histogram_timeseries_bucket_values.cpython-311.pyc +0 -0
  148. mux_python/models/__pycache__/real_time_histogram_timeseries_datapoint.cpython-311.pyc +0 -0
  149. mux_python/models/__pycache__/real_time_timeseries_datapoint.cpython-311.pyc +0 -0
  150. mux_python/models/__pycache__/referrer_domain_restriction.cpython-311.pyc +0 -0
  151. mux_python/models/__pycache__/score.cpython-311.pyc +0 -0
  152. mux_python/models/__pycache__/signal_live_stream_complete_response.cpython-311.pyc +0 -0
  153. mux_python/models/__pycache__/signing_key.cpython-311.pyc +0 -0
  154. mux_python/models/__pycache__/signing_key_response.cpython-311.pyc +0 -0
  155. mux_python/models/__pycache__/simulcast_target.cpython-311.pyc +0 -0
  156. mux_python/models/__pycache__/simulcast_target_response.cpython-311.pyc +0 -0
  157. mux_python/models/__pycache__/space.cpython-311.pyc +0 -0
  158. mux_python/models/__pycache__/space_response.cpython-311.pyc +0 -0
  159. mux_python/models/__pycache__/space_status.cpython-311.pyc +0 -0
  160. mux_python/models/__pycache__/space_type.cpython-311.pyc +0 -0
  161. mux_python/models/__pycache__/start_space_broadcast_response.cpython-311.pyc +0 -0
  162. mux_python/models/__pycache__/stop_space_broadcast_response.cpython-311.pyc +0 -0
  163. mux_python/models/__pycache__/track.cpython-311.pyc +0 -0
  164. mux_python/models/__pycache__/transcription_vocabulary.cpython-311.pyc +0 -0
  165. mux_python/models/__pycache__/transcription_vocabulary_response.cpython-311.pyc +0 -0
  166. mux_python/models/__pycache__/update_asset_master_access_request.cpython-311.pyc +0 -0
  167. mux_python/models/__pycache__/update_asset_mp4_support_request.cpython-311.pyc +0 -0
  168. mux_python/models/__pycache__/update_asset_request.cpython-311.pyc +0 -0
  169. mux_python/models/__pycache__/update_live_stream_embedded_subtitles_request.cpython-311.pyc +0 -0
  170. mux_python/models/__pycache__/update_live_stream_generated_subtitles_request.cpython-311.pyc +0 -0
  171. mux_python/models/__pycache__/update_live_stream_request.cpython-311.pyc +0 -0
  172. mux_python/models/__pycache__/update_referrer_domain_restriction_request.cpython-311.pyc +0 -0
  173. mux_python/models/__pycache__/update_transcription_vocabulary_request.cpython-311.pyc +0 -0
  174. mux_python/models/__pycache__/upload.cpython-311.pyc +0 -0
  175. mux_python/models/__pycache__/upload_error.cpython-311.pyc +0 -0
  176. mux_python/models/__pycache__/upload_response.cpython-311.pyc +0 -0
  177. mux_python/models/__pycache__/video_view.cpython-311.pyc +0 -0
  178. mux_python/models/__pycache__/video_view_event.cpython-311.pyc +0 -0
  179. mux_python/models/__pycache__/video_view_response.cpython-311.pyc +0 -0
  180. mux_python/models/asset_non_standard_input_reasons.py +31 -3
  181. mux_python/models/create_live_stream_request.py +2 -2
  182. mux_python/models/delivery_report_delivered_seconds_by_resolution.py +59 -3
  183. mux_python/models/live_stream.py +4 -4
  184. mux_python/models/live_stream_embedded_subtitle_settings.py +1 -1
  185. mux_python/models/update_live_stream_request.py +2 -2
  186. mux_python/models/video_view.py +380 -3
@@ -0,0 +1,564 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Mux API
5
+
6
+ Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before. # noqa: E501
7
+
8
+ The version of the OpenAPI document: v1
9
+ Contact: devex@mux.com
10
+ Generated by: https://openapi-generator.tech
11
+ """
12
+
13
+
14
+ from __future__ import absolute_import
15
+
16
+ import re # noqa: F401
17
+
18
+ # python 2 and python 3 compatibility library
19
+ import six
20
+
21
+ from mux_python.api_client import ApiClient
22
+ from mux_python.exceptions import ( # noqa: F401
23
+ ApiTypeError,
24
+ ApiValueError
25
+ )
26
+
27
+
28
+ class SigningKeysApi(object):
29
+ """NOTE: This class is auto generated by OpenAPI Generator
30
+ Ref: https://openapi-generator.tech
31
+
32
+ Do not edit the class manually.
33
+ """
34
+
35
+ def __init__(self, api_client=None):
36
+ if api_client is None:
37
+ api_client = ApiClient()
38
+ self.api_client = api_client
39
+
40
+ def create_signing_key(self, **kwargs): # noqa: E501
41
+ """Create a signing key # noqa: E501
42
+
43
+ Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. # noqa: E501
44
+ This method makes a synchronous HTTP request by default. To make an
45
+ asynchronous HTTP request, please pass async_req=True
46
+
47
+ >>> thread = api.create_signing_key(async_req=True)
48
+ >>> result = thread.get()
49
+
50
+ :param async_req: Whether to execute the request asynchronously.
51
+ :type async_req: bool, optional
52
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
53
+ be returned without reading/decoding response
54
+ data. Default is True.
55
+ :type _preload_content: bool, optional
56
+ :param _request_timeout: timeout setting for this request. If one
57
+ number provided, it will be total request
58
+ timeout. It can also be a pair (tuple) of
59
+ (connection, read) timeouts.
60
+ :return: Returns the result object.
61
+ If the method is called asynchronously,
62
+ returns the request thread.
63
+ :rtype: SigningKeyResponse
64
+ """
65
+ kwargs['_return_http_data_only'] = True
66
+ return self.create_signing_key_with_http_info(**kwargs) # noqa: E501
67
+
68
+ def create_signing_key_with_http_info(self, **kwargs): # noqa: E501
69
+ """Create a signing key # noqa: E501
70
+
71
+ Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. # noqa: E501
72
+ This method makes a synchronous HTTP request by default. To make an
73
+ asynchronous HTTP request, please pass async_req=True
74
+
75
+ >>> thread = api.create_signing_key_with_http_info(async_req=True)
76
+ >>> result = thread.get()
77
+
78
+ :param async_req: Whether to execute the request asynchronously.
79
+ :type async_req: bool, optional
80
+ :param _return_http_data_only: response data without head status code
81
+ and headers
82
+ :type _return_http_data_only: bool, optional
83
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
84
+ be returned without reading/decoding response
85
+ data. Default is True.
86
+ :type _preload_content: bool, optional
87
+ :param _request_timeout: timeout setting for this request. If one
88
+ number provided, it will be total request
89
+ timeout. It can also be a pair (tuple) of
90
+ (connection, read) timeouts.
91
+ :param _request_auth: set to override the auth_settings for an a single
92
+ request; this effectively ignores the authentication
93
+ in the spec for a single request.
94
+ :type _request_auth: dict, optional
95
+ :return: Returns the result object.
96
+ If the method is called asynchronously,
97
+ returns the request thread.
98
+ :rtype: tuple(SigningKeyResponse, status_code(int), headers(HTTPHeaderDict))
99
+ """
100
+
101
+ local_var_params = locals()
102
+
103
+ all_params = [
104
+ ]
105
+ all_params.extend(
106
+ [
107
+ 'async_req',
108
+ '_return_http_data_only',
109
+ '_preload_content',
110
+ '_request_timeout',
111
+ '_request_auth'
112
+ ]
113
+ )
114
+
115
+ for key, val in six.iteritems(local_var_params['kwargs']):
116
+ if key not in all_params:
117
+ raise ApiTypeError(
118
+ "Got an unexpected keyword argument '%s'"
119
+ " to method create_signing_key" % key
120
+ )
121
+ local_var_params[key] = val
122
+ del local_var_params['kwargs']
123
+
124
+ collection_formats = {}
125
+
126
+ path_params = {}
127
+
128
+ query_params = []
129
+
130
+ header_params = {}
131
+
132
+ form_params = []
133
+ local_var_files = {}
134
+
135
+ body_params = None
136
+ # HTTP header `Accept`
137
+ header_params['Accept'] = self.api_client.select_header_accept(
138
+ ['application/json']) # noqa: E501
139
+
140
+ # Authentication setting
141
+ auth_settings = ['accessToken'] # noqa: E501
142
+
143
+ response_types_map = {
144
+ 201: "SigningKeyResponse",
145
+ }
146
+
147
+ return self.api_client.call_api(
148
+ '/system/v1/signing-keys', 'POST',
149
+ path_params,
150
+ query_params,
151
+ header_params,
152
+ body=body_params,
153
+ post_params=form_params,
154
+ files=local_var_files,
155
+ response_types_map=response_types_map,
156
+ auth_settings=auth_settings,
157
+ async_req=local_var_params.get('async_req'),
158
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
159
+ _preload_content=local_var_params.get('_preload_content', True),
160
+ _request_timeout=local_var_params.get('_request_timeout'),
161
+ collection_formats=collection_formats,
162
+ _request_auth=local_var_params.get('_request_auth'))
163
+
164
+ def delete_signing_key(self, signing_key_id, **kwargs): # noqa: E501
165
+ """Delete a signing key # noqa: E501
166
+
167
+ Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again. # noqa: E501
168
+ This method makes a synchronous HTTP request by default. To make an
169
+ asynchronous HTTP request, please pass async_req=True
170
+
171
+ >>> thread = api.delete_signing_key(signing_key_id, async_req=True)
172
+ >>> result = thread.get()
173
+
174
+ :param signing_key_id: The ID of the signing key. (required)
175
+ :type signing_key_id: str
176
+ :param async_req: Whether to execute the request asynchronously.
177
+ :type async_req: bool, optional
178
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
179
+ be returned without reading/decoding response
180
+ data. Default is True.
181
+ :type _preload_content: bool, optional
182
+ :param _request_timeout: timeout setting for this request. If one
183
+ number provided, it will be total request
184
+ timeout. It can also be a pair (tuple) of
185
+ (connection, read) timeouts.
186
+ :return: Returns the result object.
187
+ If the method is called asynchronously,
188
+ returns the request thread.
189
+ :rtype: None
190
+ """
191
+ kwargs['_return_http_data_only'] = True
192
+ return self.delete_signing_key_with_http_info(signing_key_id, **kwargs) # noqa: E501
193
+
194
+ def delete_signing_key_with_http_info(self, signing_key_id, **kwargs): # noqa: E501
195
+ """Delete a signing key # noqa: E501
196
+
197
+ Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no JWTs can be signed using the key again. # noqa: E501
198
+ This method makes a synchronous HTTP request by default. To make an
199
+ asynchronous HTTP request, please pass async_req=True
200
+
201
+ >>> thread = api.delete_signing_key_with_http_info(signing_key_id, async_req=True)
202
+ >>> result = thread.get()
203
+
204
+ :param signing_key_id: The ID of the signing key. (required)
205
+ :type signing_key_id: str
206
+ :param async_req: Whether to execute the request asynchronously.
207
+ :type async_req: bool, optional
208
+ :param _return_http_data_only: response data without head status code
209
+ and headers
210
+ :type _return_http_data_only: bool, optional
211
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
212
+ be returned without reading/decoding response
213
+ data. Default is True.
214
+ :type _preload_content: bool, optional
215
+ :param _request_timeout: timeout setting for this request. If one
216
+ number provided, it will be total request
217
+ timeout. It can also be a pair (tuple) of
218
+ (connection, read) timeouts.
219
+ :param _request_auth: set to override the auth_settings for an a single
220
+ request; this effectively ignores the authentication
221
+ in the spec for a single request.
222
+ :type _request_auth: dict, optional
223
+ :return: Returns the result object.
224
+ If the method is called asynchronously,
225
+ returns the request thread.
226
+ :rtype: None
227
+ """
228
+
229
+ local_var_params = locals()
230
+
231
+ all_params = [
232
+ 'signing_key_id'
233
+ ]
234
+ all_params.extend(
235
+ [
236
+ 'async_req',
237
+ '_return_http_data_only',
238
+ '_preload_content',
239
+ '_request_timeout',
240
+ '_request_auth'
241
+ ]
242
+ )
243
+
244
+ for key, val in six.iteritems(local_var_params['kwargs']):
245
+ if key not in all_params:
246
+ raise ApiTypeError(
247
+ "Got an unexpected keyword argument '%s'"
248
+ " to method delete_signing_key" % key
249
+ )
250
+ local_var_params[key] = val
251
+ del local_var_params['kwargs']
252
+ # verify the required parameter 'signing_key_id' is set
253
+ if self.api_client.client_side_validation and ('signing_key_id' not in local_var_params or # noqa: E501
254
+ local_var_params['signing_key_id'] is None): # noqa: E501
255
+ raise ApiValueError("Missing the required parameter `signing_key_id` when calling `delete_signing_key`") # noqa: E501
256
+
257
+ collection_formats = {}
258
+
259
+ path_params = {}
260
+ if 'signing_key_id' in local_var_params:
261
+ path_params['SIGNING_KEY_ID'] = local_var_params['signing_key_id'] # noqa: E501
262
+
263
+ query_params = []
264
+
265
+ header_params = {}
266
+
267
+ form_params = []
268
+ local_var_files = {}
269
+
270
+ body_params = None
271
+ # Authentication setting
272
+ auth_settings = ['accessToken'] # noqa: E501
273
+
274
+ response_types_map = {}
275
+
276
+ return self.api_client.call_api(
277
+ '/system/v1/signing-keys/{SIGNING_KEY_ID}', 'DELETE',
278
+ path_params,
279
+ query_params,
280
+ header_params,
281
+ body=body_params,
282
+ post_params=form_params,
283
+ files=local_var_files,
284
+ response_types_map=response_types_map,
285
+ auth_settings=auth_settings,
286
+ async_req=local_var_params.get('async_req'),
287
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
288
+ _preload_content=local_var_params.get('_preload_content', True),
289
+ _request_timeout=local_var_params.get('_request_timeout'),
290
+ collection_formats=collection_formats,
291
+ _request_auth=local_var_params.get('_request_auth'))
292
+
293
+ def get_signing_key(self, signing_key_id, **kwargs): # noqa: E501
294
+ """Retrieve a signing key # noqa: E501
295
+
296
+ Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** # noqa: E501
297
+ This method makes a synchronous HTTP request by default. To make an
298
+ asynchronous HTTP request, please pass async_req=True
299
+
300
+ >>> thread = api.get_signing_key(signing_key_id, async_req=True)
301
+ >>> result = thread.get()
302
+
303
+ :param signing_key_id: The ID of the signing key. (required)
304
+ :type signing_key_id: str
305
+ :param async_req: Whether to execute the request asynchronously.
306
+ :type async_req: bool, optional
307
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
308
+ be returned without reading/decoding response
309
+ data. Default is True.
310
+ :type _preload_content: bool, optional
311
+ :param _request_timeout: timeout setting for this request. If one
312
+ number provided, it will be total request
313
+ timeout. It can also be a pair (tuple) of
314
+ (connection, read) timeouts.
315
+ :return: Returns the result object.
316
+ If the method is called asynchronously,
317
+ returns the request thread.
318
+ :rtype: SigningKeyResponse
319
+ """
320
+ kwargs['_return_http_data_only'] = True
321
+ return self.get_signing_key_with_http_info(signing_key_id, **kwargs) # noqa: E501
322
+
323
+ def get_signing_key_with_http_info(self, signing_key_id, **kwargs): # noqa: E501
324
+ """Retrieve a signing key # noqa: E501
325
+
326
+ Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** # noqa: E501
327
+ This method makes a synchronous HTTP request by default. To make an
328
+ asynchronous HTTP request, please pass async_req=True
329
+
330
+ >>> thread = api.get_signing_key_with_http_info(signing_key_id, async_req=True)
331
+ >>> result = thread.get()
332
+
333
+ :param signing_key_id: The ID of the signing key. (required)
334
+ :type signing_key_id: str
335
+ :param async_req: Whether to execute the request asynchronously.
336
+ :type async_req: bool, optional
337
+ :param _return_http_data_only: response data without head status code
338
+ and headers
339
+ :type _return_http_data_only: bool, optional
340
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
341
+ be returned without reading/decoding response
342
+ data. Default is True.
343
+ :type _preload_content: bool, optional
344
+ :param _request_timeout: timeout setting for this request. If one
345
+ number provided, it will be total request
346
+ timeout. It can also be a pair (tuple) of
347
+ (connection, read) timeouts.
348
+ :param _request_auth: set to override the auth_settings for an a single
349
+ request; this effectively ignores the authentication
350
+ in the spec for a single request.
351
+ :type _request_auth: dict, optional
352
+ :return: Returns the result object.
353
+ If the method is called asynchronously,
354
+ returns the request thread.
355
+ :rtype: tuple(SigningKeyResponse, status_code(int), headers(HTTPHeaderDict))
356
+ """
357
+
358
+ local_var_params = locals()
359
+
360
+ all_params = [
361
+ 'signing_key_id'
362
+ ]
363
+ all_params.extend(
364
+ [
365
+ 'async_req',
366
+ '_return_http_data_only',
367
+ '_preload_content',
368
+ '_request_timeout',
369
+ '_request_auth'
370
+ ]
371
+ )
372
+
373
+ for key, val in six.iteritems(local_var_params['kwargs']):
374
+ if key not in all_params:
375
+ raise ApiTypeError(
376
+ "Got an unexpected keyword argument '%s'"
377
+ " to method get_signing_key" % key
378
+ )
379
+ local_var_params[key] = val
380
+ del local_var_params['kwargs']
381
+ # verify the required parameter 'signing_key_id' is set
382
+ if self.api_client.client_side_validation and ('signing_key_id' not in local_var_params or # noqa: E501
383
+ local_var_params['signing_key_id'] is None): # noqa: E501
384
+ raise ApiValueError("Missing the required parameter `signing_key_id` when calling `get_signing_key`") # noqa: E501
385
+
386
+ collection_formats = {}
387
+
388
+ path_params = {}
389
+ if 'signing_key_id' in local_var_params:
390
+ path_params['SIGNING_KEY_ID'] = local_var_params['signing_key_id'] # noqa: E501
391
+
392
+ query_params = []
393
+
394
+ header_params = {}
395
+
396
+ form_params = []
397
+ local_var_files = {}
398
+
399
+ body_params = None
400
+ # HTTP header `Accept`
401
+ header_params['Accept'] = self.api_client.select_header_accept(
402
+ ['application/json']) # noqa: E501
403
+
404
+ # Authentication setting
405
+ auth_settings = ['accessToken'] # noqa: E501
406
+
407
+ response_types_map = {
408
+ 200: "SigningKeyResponse",
409
+ }
410
+
411
+ return self.api_client.call_api(
412
+ '/system/v1/signing-keys/{SIGNING_KEY_ID}', 'GET',
413
+ path_params,
414
+ query_params,
415
+ header_params,
416
+ body=body_params,
417
+ post_params=form_params,
418
+ files=local_var_files,
419
+ response_types_map=response_types_map,
420
+ auth_settings=auth_settings,
421
+ async_req=local_var_params.get('async_req'),
422
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
423
+ _preload_content=local_var_params.get('_preload_content', True),
424
+ _request_timeout=local_var_params.get('_request_timeout'),
425
+ collection_formats=collection_formats,
426
+ _request_auth=local_var_params.get('_request_auth'))
427
+
428
+ def list_signing_keys(self, **kwargs): # noqa: E501
429
+ """List signing keys # noqa: E501
430
+
431
+ Returns a list of signing keys. # noqa: E501
432
+ This method makes a synchronous HTTP request by default. To make an
433
+ asynchronous HTTP request, please pass async_req=True
434
+
435
+ >>> thread = api.list_signing_keys(async_req=True)
436
+ >>> result = thread.get()
437
+
438
+ :param limit: Number of items to include in the response
439
+ :type limit: int
440
+ :param page: Offset by this many pages, of the size of `limit`
441
+ :type page: int
442
+ :param async_req: Whether to execute the request asynchronously.
443
+ :type async_req: bool, optional
444
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
445
+ be returned without reading/decoding response
446
+ data. Default is True.
447
+ :type _preload_content: bool, optional
448
+ :param _request_timeout: timeout setting for this request. If one
449
+ number provided, it will be total request
450
+ timeout. It can also be a pair (tuple) of
451
+ (connection, read) timeouts.
452
+ :return: Returns the result object.
453
+ If the method is called asynchronously,
454
+ returns the request thread.
455
+ :rtype: ListSigningKeysResponse
456
+ """
457
+ kwargs['_return_http_data_only'] = True
458
+ return self.list_signing_keys_with_http_info(**kwargs) # noqa: E501
459
+
460
+ def list_signing_keys_with_http_info(self, **kwargs): # noqa: E501
461
+ """List signing keys # noqa: E501
462
+
463
+ Returns a list of signing keys. # noqa: E501
464
+ This method makes a synchronous HTTP request by default. To make an
465
+ asynchronous HTTP request, please pass async_req=True
466
+
467
+ >>> thread = api.list_signing_keys_with_http_info(async_req=True)
468
+ >>> result = thread.get()
469
+
470
+ :param limit: Number of items to include in the response
471
+ :type limit: int
472
+ :param page: Offset by this many pages, of the size of `limit`
473
+ :type page: int
474
+ :param async_req: Whether to execute the request asynchronously.
475
+ :type async_req: bool, optional
476
+ :param _return_http_data_only: response data without head status code
477
+ and headers
478
+ :type _return_http_data_only: bool, optional
479
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
480
+ be returned without reading/decoding response
481
+ data. Default is True.
482
+ :type _preload_content: bool, optional
483
+ :param _request_timeout: timeout setting for this request. If one
484
+ number provided, it will be total request
485
+ timeout. It can also be a pair (tuple) of
486
+ (connection, read) timeouts.
487
+ :param _request_auth: set to override the auth_settings for an a single
488
+ request; this effectively ignores the authentication
489
+ in the spec for a single request.
490
+ :type _request_auth: dict, optional
491
+ :return: Returns the result object.
492
+ If the method is called asynchronously,
493
+ returns the request thread.
494
+ :rtype: tuple(ListSigningKeysResponse, status_code(int), headers(HTTPHeaderDict))
495
+ """
496
+
497
+ local_var_params = locals()
498
+
499
+ all_params = [
500
+ 'limit',
501
+ 'page'
502
+ ]
503
+ all_params.extend(
504
+ [
505
+ 'async_req',
506
+ '_return_http_data_only',
507
+ '_preload_content',
508
+ '_request_timeout',
509
+ '_request_auth'
510
+ ]
511
+ )
512
+
513
+ for key, val in six.iteritems(local_var_params['kwargs']):
514
+ if key not in all_params:
515
+ raise ApiTypeError(
516
+ "Got an unexpected keyword argument '%s'"
517
+ " to method list_signing_keys" % key
518
+ )
519
+ local_var_params[key] = val
520
+ del local_var_params['kwargs']
521
+
522
+ collection_formats = {}
523
+
524
+ path_params = {}
525
+
526
+ query_params = []
527
+ if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
528
+ query_params.append(('limit', local_var_params['limit'])) # noqa: E501
529
+ if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
530
+ query_params.append(('page', local_var_params['page'])) # noqa: E501
531
+
532
+ header_params = {}
533
+
534
+ form_params = []
535
+ local_var_files = {}
536
+
537
+ body_params = None
538
+ # HTTP header `Accept`
539
+ header_params['Accept'] = self.api_client.select_header_accept(
540
+ ['application/json']) # noqa: E501
541
+
542
+ # Authentication setting
543
+ auth_settings = ['accessToken'] # noqa: E501
544
+
545
+ response_types_map = {
546
+ 200: "ListSigningKeysResponse",
547
+ }
548
+
549
+ return self.api_client.call_api(
550
+ '/system/v1/signing-keys', 'GET',
551
+ path_params,
552
+ query_params,
553
+ header_params,
554
+ body=body_params,
555
+ post_params=form_params,
556
+ files=local_var_files,
557
+ response_types_map=response_types_map,
558
+ auth_settings=auth_settings,
559
+ async_req=local_var_params.get('async_req'),
560
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
561
+ _preload_content=local_var_params.get('_preload_content', True),
562
+ _request_timeout=local_var_params.get('_request_timeout'),
563
+ collection_formats=collection_formats,
564
+ _request_auth=local_var_params.get('_request_auth'))
@@ -40,7 +40,7 @@ class URLSigningKeysApi(object):
40
40
  def create_url_signing_key(self, **kwargs): # noqa: E501
41
41
  """Create a URL signing key # noqa: E501
42
42
 
43
- Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. # noqa: E501
43
+ This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
44
44
  This method makes a synchronous HTTP request by default. To make an
45
45
  asynchronous HTTP request, please pass async_req=True
46
46
 
@@ -68,7 +68,7 @@ class URLSigningKeysApi(object):
68
68
  def create_url_signing_key_with_http_info(self, **kwargs): # noqa: E501
69
69
  """Create a URL signing key # noqa: E501
70
70
 
71
- Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. # noqa: E501
71
+ This route is now deprecated, please use the `Signing Keys` API. Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
72
72
  This method makes a synchronous HTTP request by default. To make an
73
73
  asynchronous HTTP request, please pass async_req=True
74
74
 
@@ -164,7 +164,7 @@ class URLSigningKeysApi(object):
164
164
  def delete_url_signing_key(self, signing_key_id, **kwargs): # noqa: E501
165
165
  """Delete a URL signing key # noqa: E501
166
166
 
167
- Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. # noqa: E501
167
+ This route is now deprecated, please use the `Signing Keys` API. Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
168
168
  This method makes a synchronous HTTP request by default. To make an
169
169
  asynchronous HTTP request, please pass async_req=True
170
170
 
@@ -194,7 +194,7 @@ class URLSigningKeysApi(object):
194
194
  def delete_url_signing_key_with_http_info(self, signing_key_id, **kwargs): # noqa: E501
195
195
  """Delete a URL signing key # noqa: E501
196
196
 
197
- Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. # noqa: E501
197
+ This route is now deprecated, please use the `Signing Keys` API. Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
198
198
  This method makes a synchronous HTTP request by default. To make an
199
199
  asynchronous HTTP request, please pass async_req=True
200
200
 
@@ -293,7 +293,7 @@ class URLSigningKeysApi(object):
293
293
  def get_url_signing_key(self, signing_key_id, **kwargs): # noqa: E501
294
294
  """Retrieve a URL signing key # noqa: E501
295
295
 
296
- Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** # noqa: E501
296
+ This route is now deprecated, please use the `Signing Keys` API. Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
297
297
  This method makes a synchronous HTTP request by default. To make an
298
298
  asynchronous HTTP request, please pass async_req=True
299
299
 
@@ -323,7 +323,7 @@ class URLSigningKeysApi(object):
323
323
  def get_url_signing_key_with_http_info(self, signing_key_id, **kwargs): # noqa: E501
324
324
  """Retrieve a URL signing key # noqa: E501
325
325
 
326
- Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** # noqa: E501
326
+ This route is now deprecated, please use the `Signing Keys` API. Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
327
327
  This method makes a synchronous HTTP request by default. To make an
328
328
  asynchronous HTTP request, please pass async_req=True
329
329
 
@@ -428,7 +428,7 @@ class URLSigningKeysApi(object):
428
428
  def list_url_signing_keys(self, **kwargs): # noqa: E501
429
429
  """List URL signing keys # noqa: E501
430
430
 
431
- Returns a list of URL signing keys. # noqa: E501
431
+ This route is now deprecated, please use the `Signing Keys` API. Returns a list of URL signing keys. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
432
432
  This method makes a synchronous HTTP request by default. To make an
433
433
  asynchronous HTTP request, please pass async_req=True
434
434
 
@@ -460,7 +460,7 @@ class URLSigningKeysApi(object):
460
460
  def list_url_signing_keys_with_http_info(self, **kwargs): # noqa: E501
461
461
  """List URL signing keys # noqa: E501
462
462
 
463
- Returns a list of URL signing keys. # noqa: E501
463
+ This route is now deprecated, please use the `Signing Keys` API. Returns a list of URL signing keys. Note: Any new access tokens authenticating this route will be required to have `System` level permissions. # noqa: E501
464
464
  This method makes a synchronous HTTP request by default. To make an
465
465
  asynchronous HTTP request, please pass async_req=True
466
466
 
mux_python/api_client.py CHANGED
@@ -79,7 +79,7 @@ class ApiClient(object):
79
79
  self.default_headers[header_name] = header_value
80
80
  self.cookie = cookie
81
81
  # Set default User-Agent.
82
- self.user_agent = 'OpenAPI-Generator/3.9.0/python'
82
+ self.user_agent = 'OpenAPI-Generator/3.10.0/python'
83
83
  self.client_side_validation = configuration.client_side_validation
84
84
 
85
85
  def __enter__(self):
@@ -406,7 +406,7 @@ conf = mux_python.Configuration(
406
406
  "OS: {env}\n"\
407
407
  "Python Version: {pyversion}\n"\
408
408
  "Version of the API: v1\n"\
409
- "SDK Package Version: 3.9.0".\
409
+ "SDK Package Version: 3.10.0".\
410
410
  format(env=sys.platform, pyversion=sys.version)
411
411
 
412
412
  def get_host_settings(self):