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

flywheel/api/devices_api.py

@@ -30,11 +30,9 @@ class DevicesApi(object):
         Will create a new device record together with an api key. Request must be an admin request.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeviceCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param DeviceCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class DevicesApi(object):
         Will create a new device record together with an api key. Request must be an admin request.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeviceCreate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param DeviceCreate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
 
         all_params = ['body',]  # noqa: E501
@@ -142,11 +138,9 @@ class DevicesApi(object):
         Delete a device
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str device_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -170,11 +164,9 @@ class DevicesApi(object):
         Delete a device
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str device_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['device_id',]  # noqa: E501
@@ -242,13 +234,10 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param key_id:
-        :type key_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str device_id: (required)
+        :param str key_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -271,13 +260,10 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param key_id:
-        :type key_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str device_id: (required)
+        :param str key_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['device_id','key_id',]  # noqa: E501
@@ -352,13 +338,10 @@ class DevicesApi(object):
         Regenerate device API key
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param body:
-        :type body: ApiKeyInputWithOptionalLabel, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ApiKeyOutput
+        :param str device_id: (required)
+        :param ApiKeyInputWithOptionalLabel body:
+        :param bool async_: Perform the request asynchronously
+        :return: ApiKeyOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -382,13 +365,10 @@ class DevicesApi(object):
         Regenerate device API key
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param body:
-        :type body: ApiKeyInputWithOptionalLabel, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ApiKeyOutput
+        :param str device_id: (required)
+        :param ApiKeyInputWithOptionalLabel body:
+        :param bool async_: Perform the request asynchronously
+        :return: ApiKeyOutput
         """
 
         all_params = ['device_id','body',]  # noqa: E501
@@ -470,25 +450,16 @@ class DevicesApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :param join_keys: Return device key. Admins only, defaults to false
-        :type join_keys: 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[list[EgressDevice],EgressDevicePage]
+        :param bool join_keys: Return device key. Admins only
+        :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[list[EgressDevice],EgressDevicePage]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -512,25 +483,16 @@ class DevicesApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :param join_keys: Return device key. Admins only, defaults to false
-        :type join_keys: 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[list[EgressDevice],EgressDevicePage]
+        :param bool join_keys: Return device key. Admins only
+        :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[list[EgressDevice],EgressDevicePage]
         """
 
         all_params = ['join_keys','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -610,9 +572,8 @@ class DevicesApi(object):
         ok - missing - error - unknown
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, DeviceStatusEntry)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, DeviceStatusEntry)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -636,9 +597,8 @@ class DevicesApi(object):
         ok - missing - error - unknown
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, DeviceStatusEntry)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, DeviceStatusEntry)
         """
 
         all_params = []  # noqa: E501
@@ -701,9 +661,8 @@ class DevicesApi(object):
         Get current device.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -727,9 +686,8 @@ class DevicesApi(object):
         Get current device.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
 
         all_params = []  # noqa: E501
@@ -791,11 +749,9 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param str device_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -818,11 +774,9 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param str device_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
 
         all_params = ['device_id',]  # noqa: E501
@@ -891,13 +845,10 @@ class DevicesApi(object):
         Update a device
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param body:
-        :type body: DeviceAdminUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param str device_id: (required)
+        :param DeviceAdminUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -921,13 +872,10 @@ class DevicesApi(object):
         Update a device
         This method makes a synchronous HTTP request by default.
 
-        :param device_id:
-        :type device_id: str
-        :param body:
-        :type body: DeviceAdminUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param str device_id: (required)
+        :param DeviceAdminUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
 
         all_params = ['device_id','body',]  # noqa: E501
@@ -1013,11 +961,9 @@ class DevicesApi(object):
         Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeviceSelfUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param DeviceSelfUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1041,11 +987,9 @@ class DevicesApi(object):
         Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: DeviceSelfUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: EgressDevice
+        :param DeviceSelfUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: EgressDevice
         """
 
         all_params = ['body',]  # noqa: E501

flywheel/api/dimse_api.py

@@ -30,11 +30,9 @@ class DimseApi(object):
         Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ProjectAETInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: BaseAET
+        :param ProjectAETInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: BaseAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class DimseApi(object):
         Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: ProjectAETInput
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: BaseAET
+        :param ProjectAETInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: BaseAET
         """
 
         all_params = ['body',]  # noqa: E501
@@ -142,11 +138,9 @@ class DimseApi(object):
         Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: union[ProjectAETInput,ServiceAETInput]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ServiceAET
+        :param union[ProjectAETInput,ServiceAETInput] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ServiceAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -170,11 +164,9 @@ class DimseApi(object):
         Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: union[ProjectAETInput,ServiceAETInput]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ServiceAET
+        :param union[ProjectAETInput,ServiceAETInput] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ServiceAET
         """
 
         all_params = ['body',]  # noqa: E501
@@ -254,11 +246,9 @@ class DimseApi(object):
         Delete DIMSE project by AET. AETs can only be deleted by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param project_aet:
-        :type project_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param str project_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -282,11 +272,9 @@ class DimseApi(object):
         Delete DIMSE project by AET. AETs can only be deleted by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param project_aet:
-        :type project_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param str project_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
 
         all_params = ['project_aet',]  # noqa: E501
@@ -355,11 +343,9 @@ class DimseApi(object):
         Delete DIMSE service by AET. AETs can only be deleted by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param service_aet:
-        :type service_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param str service_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -383,11 +369,9 @@ class DimseApi(object):
         Delete DIMSE service by AET. AETs can only be deleted by admins.
         This method makes a synchronous HTTP request by default.
 
-        :param service_aet:
-        :type service_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: dict(str, int)
+        :param str service_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: dict(str, int)
         """
 
         all_params = ['service_aet',]  # noqa: E501
@@ -456,9 +440,8 @@ class DimseApi(object):
         Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ProjectAET]
+        :param bool async_: Perform the request asynchronously
+        :return: list[ProjectAET]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -482,9 +465,8 @@ class DimseApi(object):
         Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ProjectAET]
+        :param bool async_: Perform the request asynchronously
+        :return: list[ProjectAET]
         """
 
         all_params = []  # noqa: E501
@@ -547,9 +529,8 @@ class DimseApi(object):
         Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ServiceAET]
+        :param bool async_: Perform the request asynchronously
+        :return: list[ServiceAET]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -573,9 +554,8 @@ class DimseApi(object):
         Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: list[ServiceAET]
+        :param bool async_: Perform the request asynchronously
+        :return: list[ServiceAET]
         """
 
         all_params = []  # noqa: E501
@@ -638,11 +618,9 @@ class DimseApi(object):
         Get DIMSE project by AET, id or project id. Requires admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param project_aet:
-        :type project_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ProjectAET
+        :param str project_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -666,11 +644,9 @@ class DimseApi(object):
         Get DIMSE project by AET, id or project id. Requires admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param project_aet:
-        :type project_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ProjectAET
+        :param str project_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ProjectAET
         """
 
         all_params = ['project_aet',]  # noqa: E501
@@ -739,11 +715,9 @@ class DimseApi(object):
         Get a DIMSE service. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param service_aet:
-        :type service_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ServiceAET
+        :param str service_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ServiceAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -767,11 +741,9 @@ class DimseApi(object):
         Get a DIMSE service. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param service_aet:
-        :type service_aet: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ServiceAET
+        :param str service_aet: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ServiceAET
         """
 
         all_params = ['service_aet',]  # noqa: E501