flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/api/custom_filters_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -37,9 +30,11 @@ class CustomFiltersApi(object):
         Creates a custom filter for the user  Args:     filter_input: The input model for creating a filter     auth_session: The user auth session for permission Checks  Returns:     Filter: A customer saved filter  Raises:     BusinessLogicError: when auth session does not have user set
         This method makes a synchronous HTTP request by default.
 
-        :param FilterInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: Filter
+        :param body:
+        :type body: FilterInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Filter
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ class CustomFiltersApi(object):
         Creates a custom filter for the user  Args:     filter_input: The input model for creating a filter     auth_session: The user auth session for permission Checks  Returns:     Filter: A customer saved filter  Raises:     BusinessLogicError: when auth session does not have user set
         This method makes a synchronous HTTP request by default.
 
-        :param FilterInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: Filter
+        :param body:
+        :type body: FilterInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Filter
         """
 
         all_params = ['body',]  # noqa: E501
@@ -145,9 +142,11 @@ class CustomFiltersApi(object):
         Deletes a custom filter for the authenticated user  Args:     custom_filter_id: The ID of the filter to delete     auth_session: The user auth session for permission checks  Returns:     DeletedResult: Result indicating the number of deleted filters  Raises:     BusinessLogicError: when auth session does not have user privilege     ResourceNotFound: when the filter doesn't exist     PermissionError: when the filter doesn't belong to the user's origin
         This method makes a synchronous HTTP request by default.
 
-        :param str custom_filter_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param custom_filter_id:
+        :type custom_filter_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -171,9 +170,11 @@ class CustomFiltersApi(object):
         Deletes a custom filter for the authenticated user  Args:     custom_filter_id: The ID of the filter to delete     auth_session: The user auth session for permission checks  Returns:     DeletedResult: Result indicating the number of deleted filters  Raises:     BusinessLogicError: when auth session does not have user privilege     ResourceNotFound: when the filter doesn't exist     PermissionError: when the filter doesn't belong to the user's origin
         This method makes a synchronous HTTP request by default.
 
-        :param str custom_filter_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param custom_filter_id:
+        :type custom_filter_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
 
         all_params = ['custom_filter_id',]  # noqa: E501
@@ -242,14 +243,21 @@ class CustomFiltersApi(object):
         Retrieves all custom filters for the authenticated user's origin  Args:     pagination: Pagination parameters for the query     auth_session: The user auth session for permission checks  Returns:     Page[Filter]: A paginated list of custom filters matching the user's origin  Raises:     BusinessLogicError: when auth session does not have user privilege
         This method makes a synchronous HTTP request by default.
 
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param bool async_: Perform the request asynchronously
-        :return: PageGenericFilter
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: PageGenericFilter
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -273,14 +281,21 @@ class CustomFiltersApi(object):
         Retrieves all custom filters for the authenticated user's origin  Args:     pagination: Pagination parameters for the query     auth_session: The user auth session for permission checks  Returns:     Page[Filter]: A paginated list of custom filters matching the user's origin  Raises:     BusinessLogicError: when auth session does not have user privilege
         This method makes a synchronous HTTP request by default.
 
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param bool async_: Perform the request asynchronously
-        :return: PageGenericFilter
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: PageGenericFilter
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -355,10 +370,13 @@ class CustomFiltersApi(object):
         Updates an existing custom filter  Args:     custom_filter_id: The ID of the filter to update     filter_input: The input model for updating a filter     auth_session: The user auth session for permission checks  Returns:     Filter: The updated custom filter  Raises:     BusinessLogicError: when auth session does not have user privilege or origin mismatch
         This method makes a synchronous HTTP request by default.
 
-        :param str custom_filter_id: (required)
-        :param FilterInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: Filter
+        :param custom_filter_id:
+        :type custom_filter_id: str
+        :param body:
+        :type body: FilterInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Filter
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -382,10 +400,13 @@ class CustomFiltersApi(object):
         Updates an existing custom filter  Args:     custom_filter_id: The ID of the filter to update     filter_input: The input model for updating a filter     auth_session: The user auth session for permission checks  Returns:     Filter: The updated custom filter  Raises:     BusinessLogicError: when auth session does not have user privilege or origin mismatch
         This method makes a synchronous HTTP request by default.
 
-        :param str custom_filter_id: (required)
-        :param FilterInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: Filter
+        :param custom_filter_id:
+        :type custom_filter_id: str
+        :param body:
+        :type body: FilterInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: Filter
         """
 
         all_params = ['custom_filter_id','body',]  # noqa: E501

flywheel/api/data_view_executions_api.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -36,9 +29,11 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -61,9 +56,11 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DeletedResult
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DeletedResult
         """
 
         all_params = ['data_view_execution_id',]  # noqa: E501
@@ -131,16 +128,25 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool exhaustive: Set to return a complete list regardless of permissions
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param list[str] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: union[Page,list[DataViewExecution]]
+        :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
+        :type exhaustive: bool, optional
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param x_accept_feature:, defaults to []
+        :type x_accept_feature: list[str], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[Page,list[DataViewExecution]]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -163,16 +169,25 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param bool exhaustive: Set to return a complete list regardless of permissions
-        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :param int limit: The maximum number of entries to return.
-        :param int skip: The number of entries to skip.
-        :param int page: The page number (i.e. skip limit*page entries)
-        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :param list[str] x_accept_feature:
-        :param bool async_: Perform the request asynchronously
-        :return: union[Page,list[DataViewExecution]]
+        :param exhaustive: Set to return a complete list regardless of permissions, defaults to false
+        :type exhaustive: bool, optional
+        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :type filter: str, optional
+        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :type sort: str, optional
+        :param limit: The maximum number of entries to return.
+        :type limit: int, optional
+        :param skip: The number of entries to skip., defaults to 0
+        :type skip: int, optional
+        :param page: The page number (i.e. skip limit*page entries)
+        :type page: int, optional
+        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :type after_id: str, optional
+        :param x_accept_feature:, defaults to []
+        :type x_accept_feature: list[str], optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: union[Page,list[DataViewExecution]]
         """
 
         all_params = ['exhaustive','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -251,9 +266,11 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DataViewExecution
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DataViewExecution
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -276,9 +293,11 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: DataViewExecution
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: DataViewExecution
         """
 
         all_params = ['data_view_execution_id',]  # noqa: E501
@@ -346,12 +365,17 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param str ticket: download ticket id
-        :param FileFormat file_format:
-        :param str file_name: download ticket filename
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param ticket: download ticket id
+        :type ticket: str, optional
+        :param file_format:
+        :type file_format: FileFormat, optional
+        :param file_name: download ticket filename, defaults to view-data
+        :type file_name: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -375,12 +399,17 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param str ticket: download ticket id
-        :param FileFormat file_format:
-        :param str file_name: download ticket filename
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param ticket: download ticket id
+        :type ticket: str, optional
+        :param file_format:
+        :type file_format: FileFormat, optional
+        :param file_name: download ticket filename, defaults to view-data
+        :type file_name: str, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['data_view_execution_id','ticket','file_format','file_name',]  # noqa: E501
@@ -454,10 +483,13 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param FileFormat file_format:
-        :param bool async_: Perform the request asynchronously
-        :return: File
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param file_format:
+        :type file_format: FileFormat, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: File
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -480,10 +512,13 @@ class DataViewExecutionsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str data_view_execution_id: (required)
-        :param FileFormat file_format:
-        :param bool async_: Perform the request asynchronously
-        :return: File
+        :param data_view_execution_id:
+        :type data_view_execution_id: str
+        :param file_format:
+        :type file_format: FileFormat, optional
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: File
         """
 
         all_params = ['data_view_execution_id','file_format',]  # noqa: E501