Update get live streams sortby attribute

apivideo · Dec 20, 2023 · af5fa0c · af5fa0c
1 parent ff2c347
commit af5fa0c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/apivideo/api/live_streams_api.py b/apivideo/api/live_streams_api.py
@@ -572,7 +572,7 @@ def list(
             Keyword Args:
                 stream_key (str): The unique stream key that allows you to stream videos.. [optional]
                 name (str): You can filter live streams by their name or a part of their name.. [optional]
-                sort_by (str): Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format.. [optional]
+                sort_by (str): Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created. `updatedAt` - the time a live stream was last updated.  When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format. . [optional]
                 sort_order (str): Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending.. [optional]
                 current_page (int): Choose the number of search results to return per page. Minimum value: 1. [optional] if omitted the server will use the default value of 1
                 page_size (int): Results per page. Allowed values 1-100, default is 25.. [optional] if omitted the server will use the default value of 25
@@ -623,6 +623,7 @@ def list(
                     '_request_timeout'
                 ],
                 'enum': [
+                    'sort_by',
                     'sort_order',
                 ],
                 'validation': [
@@ -631,6 +632,12 @@ def list(
             validations = {
             }
             allowed_values = {
+                ('sort_by',): {
+
+                    "NAME": "name",
+                    "CREATEDAT": "createdAt",
+                    "UPDATEDAT": "updatedAt"
+                },
                 ('sort_order',): {
 
                     "ASC": "asc",

diff --git a/docs/LiveStreamsApi.md b/docs/LiveStreamsApi.md
@@ -282,7 +282,7 @@ with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
     api_instance = live_streams_api.LiveStreamsApi(api_client)
     stream_key = "dw-dew8-q6w9-k67w-1ws8" # str | The unique stream key that allows you to stream videos. (optional)
     name = "My Video" # str | You can filter live streams by their name or a part of their name. (optional)
-    sort_by = "createdAt" # str | Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. (optional)
+    sort_by = "createdAt" # str | Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created. `updatedAt` - the time a live stream was last updated.  When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format.  (optional)
     sort_order = "desc" # str | Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)
     current_page = 2 # int | Choose the number of search results to return per page. Minimum value: 1 (optional) if omitted the server will use the default value of 1
     page_size = 30 # int | Results per page. Allowed values 1-100, default is 25. (optional) if omitted the server will use the default value of 25
@@ -304,7 +304,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **stream_key** | **str**| The unique stream key that allows you to stream videos. | [optional]
  **name** | **str**| You can filter live streams by their name or a part of their name. | [optional]
- **sort_by** | **str**| Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. | [optional]
+ **sort_by** | **str**| Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ISO-8601 time format.  | [optional]
  **sort_order** | **str**| Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. | [optional]
  **current_page** | **int**| Choose the number of search results to return per page. Minimum value: 1 | [optional] if omitted the server will use the default value of 1
  **page_size** | **int**| Results per page. Allowed values 1-100, default is 25. | [optional] if omitted the server will use the default value of 25